Subversion Repositories Kolibri OS

Rev

Rev 5810 | Rev 5848 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2455 mario79 1
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2
;;                                                              ;;
3
;; Copyright (C) KolibriOS team 2004-2012. All rights reserved. ;;
4
;; Distributed under terms of the GNU General Public License    ;;
5
;;                                                              ;;
6
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
7
 
1662 Nasarus 8
SYSTEM FUNCTIONS of OS Kolibri 0.7.7.0
114 mikedld 9
 
10
Number of the function is located in the register eax.
118 diamond 11
The call of the system function is executed by "int 0x40" command.
12
All registers except explicitly declared in the returned value,
13
    including eflags, are preserved.
114 mikedld 14
 
15
 
16
======================================================================
17
============== Function 0 - define and draw the window. ==============
18
======================================================================
19
Defines an application window. Draws a frame of the window, header and
133 diamond 20
working area. For skinned windows defines standard close and minimize
21
buttons.
114 mikedld 22
Parameters:
118 diamond 23
  * eax = 0 - function number
114 mikedld 24
  * ebx = [coordinate on axis x]*65536 + [size on axis x]
25
  * ecx = [coordinate on axis y]*65536 + [size on axis y]
26
  * edx = 0xXYRRGGBB, where:
27
    * Y = style of the window:
131 diamond 28
      * Y=0 - type I - fixed-size window
118 diamond 29
      * Y=1 - only define window area, draw nothing
131 diamond 30
      * Y=2 - type II - variable-size window
31
      * Y=3 - skinned window
641 diamond 32
      * Y=4 - skinned fixed-size window
33
      * other possible values (from 5 up to 15) are reserved,
114 mikedld 34
        function call with such Y is ignored
118 diamond 35
    * RR, GG, BB = accordingly red, green, blue components of a color
4051 heavyiron 36
      of the working area of the window (are ignored for style Y=1)
114 mikedld 37
    * X = DCBA (bits)
641 diamond 38
      * A = 1 - window has caption; for styles Y=3,4 caption string
118 diamond 39
                  must be passed in edi, for other styles use
40
                  subfunction 1 of function 71
41
      * B = 1 - coordinates of all graphics primitives are relative to
42
                  window client area
303 mikedld 43
      * C = 1 - don't fill working area on window draw
118 diamond 44
      * D = 0 - normal filling of the working area, 1 - gradient
45
    The following parameters are intended for windows
46
    of a type I and II, and ignored for styles Y=1,3:
47
  * esi = 0xXYRRGGBB - color of the header
48
    * RR, GG, BB define color
4051 heavyiron 49
    * Y=0 - usual window, Y=1 - unmovable window (works for all window styles)
118 diamond 50
    * X defines a gradient of header: X=0 - no gradient,
114 mikedld 51
      X=8 - usual gradient,
52
      for windows of a type II X=4 - negative gradient
118 diamond 53
    * other values of X and Y are reserved
54
  * edi = 0x00RRGGBB - color of the frame
114 mikedld 55
Returned value:
56
  * function does not return value
57
Remarks:
118 diamond 58
  * Position and sizes of the window are installed by the first
59
    call of this function and are ignored at subsequent; to change
60
    position and/or sizes of already created window use function 67.
641 diamond 61
  * For windows with styles Y=3,4 and caption (A=1) caption string
62
    is set by the first call of this function and is ignored
63
    at subsequent (strictly speaking, is ignored after a call to
64
    subfunction 2 of function 12 - end redraw); to change caption of
65
    already created window use subfunction 1 of function 71.
118 diamond 66
  * If the window has appropriate styles, position and/or sizes can be
67
    changed by user. Current position and sizes can be obtained
68
    by function 9.
69
  * The window must fit on the screen. If the transferred
70
    coordinates and sizes do not satisfy to this condition,
71
    appropriate coordinate (or, probably, both) is considered as zero,
131 diamond 72
    and if it does not help too, the appropriate size
118 diamond 73
    (or, probably, both) is installed in a size of the screen.
2409 Serge 74
 
131 diamond 75
    Further let us designate xpos,ypos,xsize,ysize - values passed
76
    in ebx,ecx. The coordinates are resulted concerning
118 diamond 77
    the left upper corner of the window, which, thus, is set as (0,0),
78
    coordinates of the right lower corner essence (xsize,ysize).
79
  * The sizes of the window are understood in sence of coordinates
80
    of the right lower corner. This concerns all other functions too.
81
    It means, that the real sizes are on 1 pixel more.
82
  * The window of type I looks as follows:
83
    * draw external frame of color indicated in edi, 1 pixel in width
84
    * draw header - rectangle with the left upper corner (1,1) and
4572 clevermous 85
      right lower (xsize-1,min(20,ysize-1)) color indicated in esi
118 diamond 86
      (taking a gradient into account)
4572 clevermous 87
    * if ysize>21, fill the working area of the window -
118 diamond 88
      rectangle with the left upper corner (1,21) and right lower
89
      (xsize-1,ysize-1) (sizes (xsize-1)*(ysize-21)) with color
90
      indicated in edx (taking a gradient into account)
91
    * if A=1 and caption has been already set by subfunction 1
92
      of function 71, it is drawn in the corresponding place of header
93
  * The window of style Y=1 looks as follows:
114 mikedld 94
    * completely defined by the application
118 diamond 95
  * The window of type II looks as follows:
96
    * draw external frame of width 1 pixel with the "shaded" color
97
      edi (all components of the color decrease twice)
98
    * draw intermediate frame of width 3 pixels with color edi
99
    * draw internal frame of width 1 pixel with the "shaded" color edi
114 mikedld 100
    * draw header - rectangle with the left upper corner (4,4)
118 diamond 101
      and right lower (xsize-4,min(20,ysize)) color, indicated in esi
102
      (taking a gradient into account)
103
    * if ysize>=26, fill the working area of the window -
114 mikedld 104
      rectangle with the left upper corner (5,20) and right lower
118 diamond 105
      (xsize-5,ysize-5) with color indicated in edx
106
      (taking a gradient into account)
107
    * if A=1 and caption has been already set by subfunction 1
108
      of function 71, it is drawn in the corresponding place of header
109
  * The skinned window looks as follows:
114 mikedld 110
    * draw external frame of width 1 pixel
118 diamond 111
      with color 'outer' from the skin
112
    * draw intermediate frame of width 3 pixel
113
      with color 'frame' from the skin
114
    * draw internal frame of width 1 pixel
115
      with color 'inner' from the skin
116
    * draw header (on bitmaps from the skin) in a rectangle
114 mikedld 117
      (0,0) - (xsize,_skinh-1)
118 diamond 118
    * if ysize>=26, fill the working area of the window -
119
      rectangle with the left upper corner (5,_skinh) and right lower
120
      (xsize-5,ysize-5) with color indicated in edx
121
      (taking a gradient into account)
133 diamond 122
    * define two standard buttons: close and minimize
114 mikedld 123
      (see function 8)
118 diamond 124
    * if A=1 and edi contains (nonzero) pointer to caption string,
125
      it is drawn in place in header defined in the skin
126
    * value _skinh is accessible as the result of call
127
      subfunction 4 of function 48
114 mikedld 128
 
129
======================================================================
118 diamond 130
================ Function 1 - put pixel in the window. ===============
114 mikedld 131
======================================================================
132
Parameters:
118 diamond 133
  * eax = 1 - function number
134
  * ebx = x-coordinate (relative to the window)
135
  * ecx = y-coordinate (relative to the window)
136
  * edx = 0x00RRGGBB - color of a pixel
137
    edx = 0x01xxxxxx - invert color of a pixel
138
          (low 24 bits are ignored)
114 mikedld 139
Returned value:
140
  * function does not return value
141
 
142
======================================================================
118 diamond 143
============ Function 2 - get the code of the pressed key. ===========
114 mikedld 144
======================================================================
145
Takes away the code of the pressed key from the buffer.
146
Parameters:
118 diamond 147
  * eax = 2 - function number
114 mikedld 148
Returned value:
118 diamond 149
  * if the buffer is empty, function returns eax=1
150
  * if the buffer is not empty, function returns al=0,
4588 mario79 151
    ah=code of the pressed key,
4612 mario79 152
    bits 16-23 = contain scancode for pressed key in ASCII mode,
153
                 in the scancodes mode this bits cleared.
4588 mario79 154
    bits 23-31 = zero
118 diamond 155
  * if there is "hotkey", function returns al=2,
156
    ah=scancode of the pressed key (0 for control keys),
157
    high word of eax contains a status of control keys at the moment
158
    of pressing a hotkey
114 mikedld 159
Remarks:
118 diamond 160
  * There is a common system buffer of the pressed keys
161
    by a size of 120 bytes, organized as queue.
162
  * There is one more common system buffer on 120 "hotkeys".
163
  * If the application with the inactive window calls this function,
164
    the buffer of the pressed keys is considered to be empty.
165
  * By default this function returns ASCII-codes; to switch
166
    to the scancodes mode (and back) use function 66.
167
    However, hotkeys are always notificated as scancodes.
168
  * To find out, what keys correspond to what codes, start
169
    the application keyascii and scancode.
170
  * Scancodes come directly from keyboard and are fixed;
171
    ASCII-codes turn out with usage of the conversion tables,
172
    which can be set by subfunction 2 of function 21
173
    and get by subfunction 2 of function 26.
174
  * As a consequence, ASCII-codes take into account current
175
    keyboard layout (rus/en) as opposed to scancodes.
176
  * This function notifies only about those hotkeys, which were
177
    defined by this thread by subfunction 4 of function 66.
114 mikedld 178
 
179
======================================================================
118 diamond 180
==================== Function 3 - get system time. ===================
114 mikedld 181
======================================================================
182
Parameters:
118 diamond 183
  * eax = 3 - function number
114 mikedld 184
Returned value:
185
  * eax = 0x00SSMMHH, where HH:MM:SS = Hours:Minutes:Seconds
118 diamond 186
  * each item is BCD-number, for example,
187
    for time 23:59:59 function returns 0x00595923
114 mikedld 188
Remarks:
118 diamond 189
  * See also subfunction 9 of function 26 - get time from
190
    the moment of start of the system; it is more convenient, because
191
    returns simply DWORD-value of the time counter.
192
  * System time can be set by function 22.
114 mikedld 193
 
194
======================================================================
118 diamond 195
============ Function 4 - draw text string in the window. ============
114 mikedld 196
======================================================================
197
Parameters:
118 diamond 198
  * eax = 4 - function number
114 mikedld 199
  * ebx = [coordinate on axis x]*65536 + [coordinate on axis y]
2536 mario79 200
  * ecx = 0xXYRRGGBB, where
118 diamond 201
    * RR, GG, BB specify text color
5682 leency 202
    * X = ABFF (bits):
203
      * A=1 - output zero terminated string
2536 mario79 204
      * B=1 - fill background with the color edi
5682 leency 205
      * FF specifies the font and encoding:
206
 
207
        2 = 8x16 UTF-16LE
208
        3 = 8x16 UTF-8
209
    * Y = CDDD (bits):
2536 mario79 210
      * C=1 redirect the output to the user area, specified in edi
5682 leency 211
      * DDD = (size multiplier)-1, so 0 = x1, 7 = x8
118 diamond 212
  * edx = pointer to the beginning of the string
5682 leency 213
  * esi = for A=0 length of the string, for A=1 is ignored
214
  * edi = for B=1 color to fill background,
215
          for C=1 pointer to user area for redirect
3780 Serge 216
 
114 mikedld 217
Returned value:
218
  * function does not return value
219
Remarks:
2536 mario79 220
  * C=1, pixel depth = 32 bits, user area is as follows:
5682 leency 221
    Xsize = dword
222
    Ysize = dword
223
    rest of the area = Xsize*Ysize*4
224
  * You can not use B=1 and C=1 at the same time, since both use edi.
114 mikedld 225
 
226
======================================================================
118 diamond 227
========================= Function 5 - delay. ========================
114 mikedld 228
======================================================================
229
Delays execution of the program on the given time.
230
Parameters:
118 diamond 231
  * eax = 5 - function number
114 mikedld 232
  * ebx = time in the 1/100 of second
233
Returned value:
234
  * function does not return value
235
Remarks:
118 diamond 236
  * Passing ebx=0 does not transfer control to the next process
237
    and does not make any operations at all. If it is really required
238
    to transfer control to the next process (to complete a current
239
    time slice), use subfunction 1 of function 68.
114 mikedld 240
 
241
======================================================================
118 diamond 242
============== Function 6 - read the file from ramdisk. ==============
114 mikedld 243
======================================================================
244
Parameters:
118 diamond 245
  * eax = 6 - function number
246
  * ebx = pointer to the filename
247
  * ecx = number of start block, beginning from 1;
248
    ecx=0 - read from the beginning of the file (same as ecx=1)
249
  * edx = number of blocks to read;
250
    edx=0 - read one block (same as edx=1)
251
  * esi = pointer to memory area for the data
114 mikedld 252
Returned value:
118 diamond 253
  * eax = file size in bytes, if the file was successfully read
254
  * eax = -1, if the file was not found
114 mikedld 255
Remarks:
118 diamond 256
  * This function is out-of-date; function 70 allows
257
    to fulfil the same operations with the extended possibilities.
114 mikedld 258
  * Block = 512 bytes.
118 diamond 259
  * For reading all file you can specify the certainly large value
260
    in edx, for example, edx = -1; but in this case be ready that
261
    the program will "fall", if the file will appear too large and can
262
    not be placed in the program memory.
263
  * The filename must be either in the format 8+3 characters
264
    (first 8 characters - name itself, last 3 - extension,
265
    the short names and extensions are supplemented with spaces),
266
    or in the format 8.3 characters "FILE.EXT"/"FILE.EX "
267
    (name no more than 8 characters, dot, extension 3 characters
268
    supplemented if necessary by spaces).
269
    The filename must be written with capital letters. The terminating
270
    character with code 0 is not necessary (not ASCIIZ-string).
271
  * This function does not support folders on the ramdisk.
114 mikedld 272
 
273
======================================================================
274
=============== Function 7 - draw image in the window. ===============
275
======================================================================
118 diamond 276
Paramters:
277
  * eax = 7 - function number
278
  * ebx = pointer to the image in the format BBGGRRBBGGRR...
114 mikedld 279
  * ecx = [size on axis x]*65536 + [size on axis y]
280
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
281
Returned value:
282
  * function does not return value
283
Remarks:
118 diamond 284
  * Coordinates of the image are coordinates of the upper left corner
285
    of the image relative to the window.
114 mikedld 286
  * Size of the image in bytes is 3*xsize*ysize.
287
 
288
======================================================================
289
=============== Function 8 - define/delete the button. ===============
290
======================================================================
118 diamond 291
Parameters for button definition:
292
  * eax = 8 - function number
114 mikedld 293
  * ebx = [coordinate on axis x]*65536 + [size on axis x]
294
  * ecx = [coordinate on axis y]*65536 + [size on axis y]
295
  * edx = 0xXYnnnnnn, where:
296
    * nnnnnn = identifier of the button
118 diamond 297
    * high (31st) bit of edx is cleared
298
    * if 30th bit of edx is set - do not draw the button
299
    * if 29th bit of edx is set - do not draw a frame
114 mikedld 300
      at pressing the button
118 diamond 301
  * esi = 0x00RRGGBB - color of the button
302
Parameters for button deleting:
303
  * eax = 8 - function number
114 mikedld 304
  * edx = 0x80nnnnnn, where nnnnnn - identifier of the button
305
Returned value:
306
  * function does not return value
307
Remarks:
118 diamond 308
  * Sizes of the button must be more than 0 and less than 0x8000.
131 diamond 309
  * For skinned windows definition of the window
118 diamond 310
    (call of 0th function) creates two standard buttons -
311
    for close of the window with identifier 1 and
312
    for minimize of the window with identifier 0xffff.
313
  * The creation of two buttons with same identifiers is admitted.
314
  * The button with the identifier 0xffff at pressing is interpreted
315
    by the system as the button of minimization, the system handles
316
    such pressing independently, not accessing to the application.
317
    In rest it is usual button.
318
  * Total number of buttons for all applications is limited to 4095.
114 mikedld 319
 
320
======================================================================
118 diamond 321
============ Function 9 - information on execution thread. ===========
114 mikedld 322
======================================================================
323
Parameters:
118 diamond 324
  * eax = 9 - function number
325
  * ebx = pointer to 1-Kb buffer
326
  * ecx = number of the slot of the thread
327
    ecx = -1 - get information on the current thread
114 mikedld 328
Returned value:
118 diamond 329
  * eax = maximum number of the slot of a thread
330
  * buffer pointed to by ebx contains the following information:
331
    * +0: dword: usage of the processor (how many time units
332
      per second leaves on execution of this thread)
114 mikedld 333
    * +4: word: position of the window of thread in the window stack
118 diamond 334
    * +6: word: (has no relation to the specified thread)
335
      number of the thread slot, which window has in the window stack
336
      position ecx
114 mikedld 337
    * +8: word: reserved
338
    * +10 = +0xA: 11 bytes: name of the process
2625 mario79 339
      (name of the started file - executable file without extension)
142 diamond 340
    * +21 = +0x15: byte: reserved, this byte is not changed
114 mikedld 341
    * +22 = +0x16: dword: address of the process in memory
342
    * +26 = +0x1A: dword: size of used memory - 1
343
    * +30 = +0x1E: dword: identifier (PID/TID)
118 diamond 344
    * +34 = +0x22: dword: coordinate of the thread window on axis x
345
    * +38 = +0x26: dword: coordinate of the thread window on axis y
346
    * +42 = +0x2A: dword: size of the thread window on axis x
347
    * +46 = +0x2E: dword: size of the thread window on axis y
348
    * +50 = +0x32: word: status of the thread slot:
349
      * 0 = thread is running
350
      * 1 = thread is suspended
351
      * 2 = thread is suspended while waiting for event
352
      * 3 = thread is terminating as a result of call to function -1
353
        or under duress as a result of call to subfunction 2
354
        of function 18 or termination of the system
355
      * 4 = thread is terminating as a result of exception
356
      * 5 = thread waits for event
357
      * 9 = requested slot is free, all other information on the slot
358
        is not meaningful
142 diamond 359
    * +52 = +0x34: word: reserved, this word is not changed
360
    * +54 = +0x36: dword: coordinate of the client area on axis x
361
    * +58 = +0x3A: dword: coordinate of the client area on axis y
362
    * +62 = +0x3E: dword: width of the client area
363
    * +66 = +0x42: dword: height of the client area
364
    * +70 = +0x46: byte: state of the window - bitfield
365
      * bit 0 (mask 1): window is maximized
366
      * bit 1 (mask 2): window is minimized to panel
367
      * bit 2 (mask 4): window is rolled up
1663 Nasarus 368
    * +71 = +0x47: dword: event mask
4264 0CodErr 369
    * +75 = +0x4B: byte: keyboard mode(ASCII = 0; SCAN = 1)
114 mikedld 370
Remarks:
118 diamond 371
  * Slots are numbered starting from 1.
372
  * Returned value is not a total number of threads, because there
373
    can be free slots.
374
  * When process is starting, system automatically creates
375
    execution thread.
376
  * Function gives information on the thread. Each process has
377
    at least one thread. One process can create many threads,
378
    in this case each thread has its own slot and the fields
379
    +10, +22, +26 in these slots coincide.
380
    Applications have no common way to define whether two threads
114 mikedld 381
    belong to one process.
118 diamond 382
  * The active window - window on top of the window stack -
383
    receives the messages on a keyboard input. For such window
384
    the position in the window stack coincides with returned value.
385
  * Slot 1 corresponds to special system thread, for which:
386
    * the window is in the bottom of the window stack, the fields
387
      +4 and +6 contain value 1
388
    * name of the process - "OS/IDLE" (supplemented by spaces)
389
    * address of the process in memory is 0, size of used memory is
114 mikedld 390
      16 Mb (0x1000000)
391
    * PID=1
142 diamond 392
    * coordinates and sizes of the window and the client area are by
393
      convention set to 0
118 diamond 394
    * status of the slot is always 0 (running)
395
    * the execution time adds of time leaving on operations itself
396
      and idle time in waiting for interrupt (which can be got by call
397
      to subfunction 4 of function 18).
398
  * Beginning from slot 2, the normal applications are placed.
1662 Nasarus 399
  * The normal applications are placed in memory at the address
400
 
118 diamond 401
    There is no intersection, as each process has its own page table.
402
  * At creation of the thread it is assigned the slot
403
    in the system table and identifier (Process/Thread IDentifier =
404
    PID/TID), which do not vary with time for given thread.
405
    After completion of the thread its slot can be anew used
406
    for another thread. The thread identifier can not be assigned
407
    to other thread even after completion of this thread.
408
    Identifiers, assigned to new threads, grow monotonously.
409
  * If the thread has not yet defined the window by call to
410
    function 0, the position and the sizes
411
    of its window are considered to be zero.
142 diamond 412
  * Coordinates of the client area are relative to the window.
118 diamond 413
  * At the moment only the part of the buffer by a size
4264 0CodErr 414
    76 = 0x4C bytes is used. Nevertheless it is recommended to use
118 diamond 415
    1-Kb buffer for the future compatibility, in the future
416
    some fields can be added.
114 mikedld 417
 
418
======================================================================
118 diamond 419
==================== Function 10 - wait for event. ===================
114 mikedld 420
======================================================================
118 diamond 421
If the message queue is empty, waits for appearance of the message
422
in queue. In this state thread does not consume CPU time.
114 mikedld 423
Then reads out the message from queue.
424
 
425
Parameters:
118 diamond 426
  * eax = 10 - function number
114 mikedld 427
Returned value:
118 diamond 428
  * eax = event (see the list of events)
114 mikedld 429
Remarks:
118 diamond 430
  * Those events are taken into account only which enter into
431
    a mask set by function 40. By default it is
432
    redraw, key and button events.
433
  * To check, whether there is a message in queue, use function 11.
434
    To wait for no more than given time, use function 23.
114 mikedld 435
 
118 diamond 436
======================================================================
437
=============== Function 11 - check for event, no wait. ==============
438
======================================================================
439
If the message queue contains event, function reads out
440
and return it. If the queue is empty, function returns 0.
114 mikedld 441
Parameters:
118 diamond 442
  * eax = 11 - function number
114 mikedld 443
Returned value:
444
  * eax = 0 - message queue is empty
118 diamond 445
  * else eax = event (see the list of events)
114 mikedld 446
Remarks:
118 diamond 447
  * Those events are taken into account only, which enter into
448
    a mask set by function 40. By default it is
449
    redraw, key and button events.
450
  * To wait for event, use function 10.
451
    To wait for no more than given time, use function 23.
114 mikedld 452
 
453
======================================================================
118 diamond 454
=============== Function 12 - begin/end window redraw. ===============
114 mikedld 455
======================================================================
456
 
139 diamond 457
---------------- Subfunction 1 - begin window redraw. ----------------
114 mikedld 458
Parameters:
118 diamond 459
  * eax = 12 - function number
460
  * ebx = 1 - subfunction number
114 mikedld 461
Returned value:
462
  * function does not return value
463
 
139 diamond 464
----------------- Subfunction 2 - end window redraw. -----------------
114 mikedld 465
Parameters:
118 diamond 466
  * eax = 12 - function number
467
  * ebx = 2 - subfunction number
114 mikedld 468
Returned value:
469
  * function does not return value
470
Remarks:
118 diamond 471
  * Subfunction 1 deletes all buttons defined with
472
    function 8, they must be defined again.
114 mikedld 473
 
474
======================================================================
475
============ Function 13 - draw a rectangle in the window. ===========
476
======================================================================
477
Parameters:
118 diamond 478
  * eax = 13 - function number
114 mikedld 479
  * ebx = [coordinate on axis x]*65536 + [size on axis x]
480
  * ecx = [coordinate on axis y]*65536 + [size on axis y]
118 diamond 481
  * edx = color 0xRRGGBB or 0x80RRGGBB for gradient fill
114 mikedld 482
Returned value:
483
  * function does not return value
484
Remarks:
485
  * Coordinates are understood as coordinates of the left upper corner
118 diamond 486
    of a rectangle relative to the window.
114 mikedld 487
 
488
======================================================================
118 diamond 489
=================== Function 14 - get screen size. ===================
114 mikedld 490
======================================================================
491
Parameters:
118 diamond 492
  * eax = 14 - function number
114 mikedld 493
Returned value:
494
  * eax = [xsize]*65536 + [ysize], where
495
  * xsize = x-coordinate of the right lower corner of the screen =
118 diamond 496
            horizontal size - 1
114 mikedld 497
  * ysize = y-coordinate of the right lower corner of the screen =
118 diamond 498
            vertical size - 1
114 mikedld 499
Remarks:
118 diamond 500
  * See also subfunction 5 of function 48 - get sizes of
501
    working area of the screen.
114 mikedld 502
 
118 diamond 503
======================================================================
504
== Function 15, subfunction 1 - set a size of the background image. ==
505
======================================================================
114 mikedld 506
Parameters:
118 diamond 507
  * eax = 15 - function number
508
  * ebx = 1 - subfunction number
114 mikedld 509
  * ecx = width of the image
510
  * edx = height of the image
511
Returned value:
512
  * function does not return value
513
Remarks:
499 diamond 514
  * Before calling subfunctions 2 and 5 you should call this function
485 heavyiron 515
    to set image size!
118 diamond 516
  * For update of the screen (after completion of a series of commands
517
    working with a background) call subfunction 3.
518
  * There is a pair function for get size of the background image -
519
    subfunction 1 of function 39.
114 mikedld 520
 
521
======================================================================
118 diamond 522
=== Function 15, subfunction 2 - put pixel on the background image. ==
114 mikedld 523
======================================================================
524
Parameters:
118 diamond 525
  * eax = 15 - function number
526
  * ebx = 2 - subfunction number
114 mikedld 527
  * ecx = offset
118 diamond 528
  * edx = color of a pixel 0xRRGGBB
114 mikedld 529
Returned value:
530
  * function does not return value
531
Remarks:
118 diamond 532
  * Offset for a pixel with coordinates (x,y) is calculated as
114 mikedld 533
    (x+y*xsize)*3.
499 diamond 534
  * If the given offset exceeds size set by subfunction 1,
118 diamond 535
    the call is ignored.
536
  * For update of the screen (after completion of a series of commands
537
    working with a background) call subfunction 3.
538
  * There is a pair function for get pixel on the background image -
539
    subfunction 2 of function 39.
114 mikedld 540
 
541
======================================================================
542
=========== Function 15, subfunction 3 - redraw background. ==========
543
======================================================================
544
Parameters:
118 diamond 545
  * eax = 15 - function number
546
  * ebx = 3 - subfunction number
114 mikedld 547
Returned value:
548
  * function does not return value
549
 
118 diamond 550
======================================================================
551
== Function 15, subfunction 4 - set drawing mode for the background. =
552
======================================================================
114 mikedld 553
Parameters:
118 diamond 554
  * eax = 15 - function number
555
  * ebx = 4 - subfunction number
556
  * ecx = drawing mode:
114 mikedld 557
    * 1 = tile
558
    * 2 = stretch
559
Returned value:
560
  * function does not return value
561
Remarks:
118 diamond 562
  * For update of the screen (after completion of a series of commands
563
    working with a background) call subfunction 3.
564
  * There is a pair function for get drawing mode of the background -
565
    subfunction 4 of function 39.
114 mikedld 566
 
118 diamond 567
======================================================================
568
===================== Function 15, subfunction 5 =====================
569
============ Put block of pixels on the background image. ============
570
======================================================================
114 mikedld 571
Parameters:
118 diamond 572
  * eax = 15 - function number
573
  * ebx = 5 - subfunction number
574
  * ecx = pointer to the data in the format BBGGRRBBGGRR...
114 mikedld 575
  * edx = offset in data of the background image
118 diamond 576
  * esi = size of data in bytes = 3 * number of pixels
114 mikedld 577
Returned value:
578
  * function does not return value
579
Remarks:
499 diamond 580
  * Offset and size are not checked for correctness.
118 diamond 581
  * Color of each pixel is stored as 3-bytes value BBGGRR.
582
  * Pixels of the background image are written sequentially
583
    from left to right, from up to down.
584
  * Offset of pixel with coordinates (x,y) is (x+y*xsize)*3.
585
  * For update of the screen (after completion of a series of commands
586
    working with a background) call subfunction 3.
114 mikedld 587
 
588
======================================================================
546 diamond 589
===================== Function 15, subfunction 6 =====================
590
======== Map background data to the address space of process. ========
591
======================================================================
592
Parameters:
593
  * eax = 15 - function number
594
  * ebx = 6 - subfunction number
595
Returned value:
596
  * eax = pointer to background data, 0 if error
597
Remarks:
598
  * Mapped data are available for read and write.
599
  * Size of background data is 3*xsize*ysize. The system blocks
600
    changes of background sizes while process works with mapped data.
601
  * Color of each pixel is stored as 3-bytes value BBGGRR.
602
  * Pixels of the background image are written sequentially
603
    from left to right, from up to down.
604
 
605
======================================================================
606
===== Function 15, subfunction 7 - close mapped background data. =====
607
======================================================================
608
Parameters:
609
  * eax = 15 - function number
610
  * ebx = 7 - subfunction number
611
  * ecx = pointer to mapped data
612
Returned value:
613
  * eax = 1 - success, 0 - error
614
 
615
======================================================================
2515 mario79 616
===================== Function 15, subfunction 8 =====================
617
============= Get coordinates of last draw the background ============
618
======================================================================
619
Parameters:
620
  * eax = 15 - function number
621
  * ebx = 8 - subfunction number
622
Returned value:
623
  * eax = [left]*65536 + [right]
624
  * ebx = [top]*65536 + [bottom]
625
Remarks:
626
  * (left,top) are coordinates of the left upper corner,
627
    (right,bottom) are coordinates of the right lower one.
628
  * For receiving more reliable information, call the function
629
    immediately after the event:
630
             5 = kernel finished redrawing of the desktop background
631
 
632
======================================================================
2547 mario79 633
===================== Function 15, subfunction 9 =====================
634
============= Redraws a rectangular part of the background ===========
635
======================================================================
636
Parameters:
637
  * eax = 15 - function number
638
  * ebx = 9 - subfunction number
639
  * ecx = [left]*65536 + [right]
640
  * edx = [top]*65536 + [bottom]
641
Returned value:
642
  * function does not return value
643
Remarks:
644
  * (left,top) are coordinates of the left upper corner,
645
    (right,bottom) are coordinates of the right lower one.
646
  * If parameters are set incorrectly then background is not redrawn.
647
 
648
======================================================================
118 diamond 649
=============== Function 16 - save ramdisk on a floppy. ==============
114 mikedld 650
======================================================================
651
Parameters:
118 diamond 652
  * eax = 16 - function number
653
  * ebx = 1 or ebx = 2 - on which floppy save
114 mikedld 654
Returned value:
118 diamond 655
  * eax = 0 - success
114 mikedld 656
  * eax = 1 - error
657
 
658
======================================================================
118 diamond 659
======= Function 17 - get the identifier of the pressed button. ======
114 mikedld 660
======================================================================
661
Takes away the code of the pressed button from the buffer.
662
Parameters:
118 diamond 663
  * eax = 17 - function number
114 mikedld 664
Returned value:
118 diamond 665
  * if the buffer is empty, function returns eax=1
1018 diamond 666
  * if the buffer is not empty:
667
    * high 24 bits of eax contain button identifier (in particular,
668
      ah contains low byte of the identifier; if all buttons have
669
      the identifier less than 256, ah is enough to distinguish)
670
    * al = 0 - the button was pressed with left mouse button
671
    * al = bit corresponding to used mouse button otherwise
114 mikedld 672
Remarks:
118 diamond 673
  * "Buffer" keeps only one button, at pressing the new button the
674
    information about old is lost.
675
  * The call of this function by an application with inactive window
676
    will return answer "buffer is empty".
1018 diamond 677
  * Returned value for al corresponds to the state of mouse buttons
678
    as in subfunction 2 of function 37 at the beginning
679
    of button press, excluding lower bit, which is cleared.
114 mikedld 680
 
681
======================================================================
2244 mario79 682
===================== Function 18, subfunction 1 =====================
683
============= Make deactive the window of the given thread. ==========
684
======================================================================
685
Parameters:
686
  * eax = 18 - function number
687
  * ebx = 1 - subfunction number
688
  * ecx = number of the thread slot
689
Returned value:
690
  * function does not return value
2409 Serge 691
 
2244 mario79 692
======================================================================
118 diamond 693
= Function 18, subfunction 2 - terminate process/thread by the slot. =
114 mikedld 694
======================================================================
695
Parameters:
118 diamond 696
  * eax = 18 - function number
697
  * ebx = 2 - subfunction number
114 mikedld 698
  * ecx = number of the slot of process/thread
699
Returned value:
700
  * function does not return value
701
Remarks:
118 diamond 702
  * It is impossible to terminate system thread OS/IDLE (with
703
    number of the slot 1),
704
    it is possible to terminate any normal process/thread.
705
  * See also subfunction 18 - terminate
706
    process/thread by the identifier.
114 mikedld 707
 
118 diamond 708
======================================================================
709
===================== Function 18, subfunction 3 =====================
710
============= Make active the window of the given thread. ============
711
======================================================================
114 mikedld 712
Parameters:
118 diamond 713
  * eax = 18 - function number
714
  * ebx = 3 - subfunction number
715
  * ecx = number of the thread slot
114 mikedld 716
Returned value:
717
  * function does not return value
718
Remarks:
118 diamond 719
  * If correct, but nonexistent slot is given,
720
    some window is made active.
721
  * To find out, which window is active, use subfunction 7.
114 mikedld 722
 
118 diamond 723
======================================================================
724
===================== Function 18, subfunction 4 =====================
725
=========== Get counter of idle time units per one second. ===========
726
======================================================================
727
Idle time units are units, in which the processor stands idle
728
in waiting for interrupt (in the command 'hlt').
114 mikedld 729
 
730
Parameters:
118 diamond 731
  * eax = 18 - function number
732
  * ebx = 4 - subfunction number
114 mikedld 733
Returned value:
118 diamond 734
  * eax = value of the counter of idle time units per one second
114 mikedld 735
 
736
======================================================================
118 diamond 737
========== Function 18, subfunction 5 - get CPU clock rate. ==========
114 mikedld 738
======================================================================
739
Parameters:
118 diamond 740
  * eax = 18 - function number
741
  * ebx = 5 - subfunction number
114 mikedld 742
Returned value:
118 diamond 743
  * eax = clock rate (modulo 2^32 clock ticks = 4GHz)
114 mikedld 744
 
118 diamond 745
======================================================================
2409 Serge 746
 Function 18, subfunction 6 - save ramdisk to the file on hard drive.
118 diamond 747
======================================================================
114 mikedld 748
Parameters:
118 diamond 749
  * eax = 18 - function number
750
  * ebx = 6 - subfunction number
341 heavyiron 751
  * ecx = pointer to the full path to file
752
    (for example, "/hd0/1/kolibri/kolibri.img")
114 mikedld 753
Returned value:
118 diamond 754
  * eax = 0 - success
755
  * else eax = error code of the file system
499 diamond 756
Remarks:
118 diamond 757
  * All folders in the given path must exist, otherwise function
758
    returns value 5, "file not found".
114 mikedld 759
 
760
======================================================================
118 diamond 761
=========== Function 18, subfunction 7 - get active window. ==========
114 mikedld 762
======================================================================
763
Parameters:
118 diamond 764
  * eax = 18 - function number
765
  * ebx = 7 - subfunction number
114 mikedld 766
Returned value:
118 diamond 767
  * eax = number of the active window
768
    (number of the slot of the thread with active window)
114 mikedld 769
Remarks:
118 diamond 770
  * Active window is at the top of the window stack and receives
771
    messages on all keyboard input.
772
  * To make a window active, use subfunction 3.
114 mikedld 773
 
118 diamond 774
======================================================================
775
== Function 18, subfunction 8 - disable/enable the internal speaker. =
776
======================================================================
777
If speaker sound is disabled, all calls to subfunction 55 of
778
function 55 are ignored. If speaker sound is enabled,
779
they are routed on builtin speaker.
114 mikedld 780
 
118 diamond 781
------------------- Subsubfunction 1 - get status. -------------------
114 mikedld 782
Parameters:
118 diamond 783
  * eax = 18 - function number
784
  * ebx = 8 - subfunction number
785
  * ecx = 1 - number of the subsubfunction
114 mikedld 786
Returned value:
118 diamond 787
  * eax = 0 - speaker sound is enabled; 1 - disabled
114 mikedld 788
 
118 diamond 789
----------------- Subsubfunction 2 - toggle status. ------------------
790
Toggles states of disable/enable.
114 mikedld 791
Parameters:
118 diamond 792
  * eax = 18 - function number
793
  * ebx = 8 - subfunction number
794
  * ecx = 2 - number of the subsubfunction
114 mikedld 795
Returned value:
796
  * function does not return value
797
 
118 diamond 798
======================================================================
1018 diamond 799
== Function 18, subfunction 9 - system shutdown with the parameter. ==
118 diamond 800
======================================================================
114 mikedld 801
Parameters:
118 diamond 802
  * eax = 18 - function number
803
  * ebx = 9 - subfunction number
114 mikedld 804
  * ecx = parameter:
118 diamond 805
    * 2 = turn off computer
806
    * 3 = reboot computer
807
    * 4 = restart the kernel from the file 'kernel.mnt' on ramdisk
114 mikedld 808
Returned value:
118 diamond 809
  * at incorrect ecx the registers do not change (i.e. eax=18)
810
  * by correct call function always returns eax=0
811
    as the tag of success
114 mikedld 812
Remarks:
118 diamond 813
  * Do not rely on returned value by incorrect call, it can be
814
    changed in future versions of the kernel.
1018 diamond 815
 
118 diamond 816
======================================================================
4573 clevermous 817
======= Function 18, subfunction 10 - minimize topmost window. =======
118 diamond 818
======================================================================
4573 clevermous 819
Minimizes the topmost (active) window.
114 mikedld 820
Parameters:
118 diamond 821
  * eax = 18 - function number
822
  * ebx = 10 - subfunction number
114 mikedld 823
Returned value:
824
  * function does not return value
825
Remarks:
118 diamond 826
  * The minimized window from the point of view of function 9
827
    keeps position and sizes.
2409 Serge 828
  * Restoring of an application window occurs at its activation by
118 diamond 829
    subfunction 3.
4573 clevermous 830
  * Usually there is no necessity to minimize/restore a window
831
    explicitly: minimization of a window is carried out by the system
118 diamond 832
    at pressing the minimization button (for skinned windows
833
    it is defined automatically by function 0,
834
    for other windows it can be defined manually by function 8),
5452 leency 835
    restore of a window is done by the application '@taskbar'.
114 mikedld 836
 
837
======================================================================
2409 Serge 838
 Function 18, subfunction 11 - get information on the disk subsystem.
114 mikedld 839
======================================================================
840
Parameters:
118 diamond 841
  * eax = 18 - function number
842
  * ebx = 11 - subfunction number
114 mikedld 843
  * ecx = type of the table:
4700 mario79 844
    * 1 = short version, 16 bytes
118 diamond 845
  * edx = pointer to the buffer (in the application) for the table
114 mikedld 846
Returned value:
847
  * function does not return value
118 diamond 848
Format of the table: short version:
849
  * +0: byte: information about FDD's (drives for floppies),
850
    AAAABBBB, where AAAA gives type of the first drive, BBBB -
851
    of the second regarding to the following list:
114 mikedld 852
    * 0 = there is no drive
853
    * 1 = 360Kb, 5.25''
854
    * 2 = 1.2Mb, 5.25''
855
    * 3 = 720Kb, 3.5''
856
    * 4 = 1.44Mb, 3.5''
118 diamond 857
    * 5 = 2.88Mb, 3.5'' (such drives are not used anymore)
858
    For example, for the standard configuration from one 1.44-drive
859
    here will be 40h, and for the case 1.2Mb on A: and 1.44Mb on B:
5452 leency 860
    the value is 24h.
861
 
4700 mario79 862
  First IDE controller:
118 diamond 863
  * +1: byte: information about hard disks and CD-drives, AABBCCDD,
114 mikedld 864
    where AA corresponds to the controller IDE0, ..., DD - IDE3:
4700 mario79 865
    * 0 = device not found
118 diamond 866
    * 1 = hard drive
867
    * 2 = CD-drive
868
    For example, in the case HD on IDE0 and CD on IDE2
869
    this field contains 48h.
870
  * +2: 4 db: number of the retrieved partitions on hard disks
5452 leency 871
    at accordingly IDE0,...,IDE3.
4700 mario79 872
 
5452 leency 873
  Second IDE controller:
874
  * +6: byte: information about hard disks and CD-drives, AABBCCDD,
875
    where AA corresponds to the controller IDE4, ..., DD - IDE7:
876
    * 0 = device not found
877
    * 1 = hard drive
878
    * 2 = CD-drive
879
    For example, in the case HD on IDE4 and CD on IDE6
880
    this field contains 48h.
881
  * +7: 4 db: number of the retrieved partitions on hard disks
882
    at accordingly IDE4,...,IDE7.
883
 
884
  Third IDE controller:
885
  * +11: byte: information about hard disks and CD-drives, AABBCCDD,
886
    where AA corresponds to the controller IDE8, ..., DD - IDE11:
887
    * 0 = device not found
888
    * 1 = hard drive
889
    * 2 = CD-drive
890
    For example, in the case HD on IDE8 and CD on IDE10
891
    this field contains 48h.
892
  * +12: 4 db: number of the retrieved partitions on hard disks
893
    at accordingly IDE8,...,IDE11.
894
 
118 diamond 895
    If the hard disk on IDEx is absent, appropriate byte is zero,
896
    otherwise it shows number of the recognized partitions, which
897
    can be not presented (if the drive is not formatted or if
898
    the file system is not supported). Current version of the kernel
4700 mario79 899
    supports only FAT12/16/32, NTFS, ext2/3/4 and XFS for hard disks.
4641 mario79 900
 
114 mikedld 901
Remarks:
4700 mario79 902
  * The table can be used for obtaining the information about
118 diamond 903
    available devices.
114 mikedld 904
 
905
======================================================================
118 diamond 906
========== Function 18, subfunction 13 - get kernel version. =========
114 mikedld 907
======================================================================
908
Parameters:
118 diamond 909
  * eax = 18 - function number
910
  * ebx = 13 - subfunction number
911
  * ecx = pointer to the buffer (not less than 16 bytes), where
912
    the information will be placed
114 mikedld 913
Returned value:
914
  * function does not return value
915
Structure of the buffer:
916
db a,b,c,d for version a.b.c.d
1675 Nasarus 917
db 0: reserved
540 victor 918
dd REV - kernel SVN revision number
1675 Nasarus 919
For Kolibri 0.7.7.0+ kernel:
1662 Nasarus 920
db 0,7,7,0
1675 Nasarus 921
db 0
1676 Nasarus 922
dd 1675
114 mikedld 923
 
118 diamond 924
======================================================================
925
======= Function 18, subfunction 14 - wait for screen retrace. =======
926
======================================================================
927
Waits for the beginning of retrace of the scanning ray of the screen
928
monitor.
114 mikedld 929
Parameters:
118 diamond 930
  * eax = 18 - function number
931
  * ebx = 14 - subfunction number
114 mikedld 932
Returned value:
118 diamond 933
  * eax = 0 as the tag of success
114 mikedld 934
Remarks:
118 diamond 935
  * Function is intended only for active high-efficiency graphics
114 mikedld 936
    applications; is used for smooth output of a graphics.
937
 
118 diamond 938
======================================================================
939
== Function 18, subfunction 15 - center mouse cursor on the screen. ==
940
======================================================================
114 mikedld 941
Parameters:
118 diamond 942
  * eax = 18 - function number
943
  * ebx = 15 - subfunction number
114 mikedld 944
Returned value:
118 diamond 945
  * eax = 0 as the tag of success
114 mikedld 946
 
947
======================================================================
118 diamond 948
========= Function 18, subfunction 16 - get size of free RAM. ========
114 mikedld 949
======================================================================
950
Parameters:
118 diamond 951
  * eax = 18 - function number
952
  * ebx = 16 - subfunction number
114 mikedld 953
Returned value:
954
  * eax = size of free memory in kilobytes
955
 
956
======================================================================
118 diamond 957
======== Function 18, subfunction 17 - get full amount of RAM. =======
114 mikedld 958
======================================================================
959
Parameters:
118 diamond 960
  * eax = 18 - function number
961
  * ebx = 17 - subfunction number
114 mikedld 962
Returned value:
118 diamond 963
  * eax = total size of existing memory in kilobytes
114 mikedld 964
 
965
======================================================================
118 diamond 966
===================== Function 18, subfunction 18 ====================
967
============= Terminate process/thread by the identifier. ============
114 mikedld 968
======================================================================
969
Parameters:
118 diamond 970
  * eax = 18 - function number
971
  * ebx = 18 - subfunction number
972
  * ecx = identifer of process/thread (PID/TID)
114 mikedld 973
Returned value:
118 diamond 974
  * eax = 0 - success
975
  * eax = -1 - error (process is not found or is system)
114 mikedld 976
Remarks:
118 diamond 977
  * It is impossible to terminate system thread OS/IDLE (identifier
978
    1), it is possible to terminate any normal process/thread.
979
  * See also subfunction 2 - terminate
980
    process/thread by given slot.
114 mikedld 981
 
982
======================================================================
131 diamond 983
======== Function 18, subfunction 19 - get/set mouse features. =======
120 mario79 984
======================================================================
131 diamond 985
 
986
---------------- Subsubfunction 0 - get mouse speed. -----------------
120 mario79 987
Parameters:
988
  * eax = 18 - function number
989
  * ebx = 19 - subfunction number
131 diamond 990
  * ecx = 0 - subsubfunction number
991
Returned value:
992
  * eax = current mouse speed
120 mario79 993
 
131 diamond 994
---------------- Subsubfunction 1 - set mouse speed. -----------------
995
Parameters:
996
  * eax = 18 - function number
997
  * ebx = 19 - subfunction number
998
  * ecx = 1 - subsubfunction number
999
  * edx = new value for speed
1000
Returned value:
1001
  * function does not return value
120 mario79 1002
 
131 diamond 1003
---------------- Subsubfunction 2 - get mouse delay. -----------------
1004
Parameters:
1005
  * eax = 18 - function number
1006
  * ebx = 19 - subfunction number
1007
  * ecx = 2 - subsubfunction number
1008
Returned value:
1009
  * eax = current mouse delay
120 mario79 1010
 
131 diamond 1011
---------------- Subsubfunction 3 - set mouse delay. -----------------
1012
Parameters:
1013
  * eax = 18 - function number
1014
  * ebx = 19 - subfunction number
1015
  * ecx = 3 - subsubfunction number
1016
  * edx = new value for mouse delay
1017
Returned value:
1018
  * function does not return value
120 mario79 1019
 
131 diamond 1020
----------- Subsubfunction 4 - set mouse pointer position. -----------
1021
Parameters:
1022
  * eax = 18 - function number
1023
  * ebx = 19 - subfunction number
1024
  * ecx = 4 - subsubfunction number
1025
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
1026
Returned value:
1027
  * function does not return value
621 mario79 1028
 
641 diamond 1029
-------- Subsubfunction 5 - simulate state of mouse buttons. ---------
621 mario79 1030
Parameters:
1031
  * eax = 18 - function number
1032
  * ebx = 19 - subfunction number
1033
  * ecx = 5 - subsubfunction number
641 diamond 1034
  * edx = information about emulated state of mouse buttons:
1035
    (same as return value in subfunction 2 of function 37)
621 mario79 1036
    * bit 0 is set = left button is pressed
1037
    * bit 1 is set = right button is pressed
1038
    * bit 2 is set = middle button is pressed
1039
    * bit 3 is set = 4th button is pressed
1040
    * bit 4 is set = 5th button is pressed
1041
Returned value:
1042
  * function does not return value
120 mario79 1043
Remarks:
131 diamond 1044
  * It is recommended to set speed of the mouse (in subsubfunction 1)
1045
    from 1 up to 9. The installed value is not inspected by the kernel
1046
    code, so set it carefully, at incorrect value the cursor
1047
    can "freeze". Speed of the mouse can be regulated through the
1048
    application SETUP.
1049
  * Recommended delay of the mouse (in subsubfunction 3) = 10. Lower
1050
    value is not handled by COM mice. At the very large values the
1051
    movement of the mouse on 1 pixel is impossible and the cursor will
1052
    jump on the value of installed speed (subsubfunction 1). The
1053
    installed value is not inspected by the kernel code.
133 diamond 1054
    Mouse delay can be regulated through the application SETUP.
131 diamond 1055
  * The subsubfunction 4 does not check the passed value. Before
1056
    its call find out current screen resolution (with function 14)
1057
    and check that the value of position is inside the limits of the
1058
    screen.
120 mario79 1059
 
1060
======================================================================
193 diamond 1061
======== Function 18, subfunction 20 - get information on RAM. =======
1062
======================================================================
1063
Parameters:
1064
  * eax = 18 - function number
1065
  * ebx = 20 - subfunction number
1066
  * ecx = pointer to the buffer for information (36 bytes)
1067
Returned value:
1068
  * eax = total size of existing RAM in pages
1069
    or -1 if error has occured
1070
  * buffer pointed to by ecx contains the following information:
1071
    * +0:  dword: total size of existing RAM in pages
1072
    * +4:  dword: size of free RAM in pages
1073
    * +8:  dword: number of page faults (exceptions #PF)
1074
                 in applications
1075
    * +12: dword: size of kernel heap in bytes
1076
    * +16: dword: free in kernel heap in bytes
1077
    * +20: dword: total number of memory blocks in kernel heap
1078
    * +24: dword: number of free memory blocks in kernel heap
1079
    * +28: dword: size of maximum free block in kernel heap
1080
                 (reserved)
1081
    * +32: dword: size of maximum allocated block in kernel heap
1082
                 (reserved)
1083
 
1084
======================================================================
641 diamond 1085
===================== Function 18, subfunction 21 ====================
1086
======== Get slot number of process/thread by the identifier. ========
608 alver 1087
======================================================================
1088
Parameters:
1089
  * eax = 18 - function number
1090
  * ebx = 21 - subfunction number
641 diamond 1091
  * ecx = identifer of process/thread (PID/TID)
608 alver 1092
Returned value:
641 diamond 1093
  * eax = 0 - error (invalid identifier)
1094
  * otherwise eax = slot number
608 alver 1095
 
1096
======================================================================
641 diamond 1097
===================== Function 18, subfunction 22 ====================
1098
============== Operations with window of another thread. =============
608 alver 1099
======================================================================
1100
Parameters:
1101
  * eax = 18 - function number
1102
  * ebx = 22 - subfunction number
641 diamond 1103
  * ecx = operation type:
1104
    * 0 = minimize window of the thread with given slot number
1105
    * 1 = minimize window of the thread with given identifier
1106
    * 2 = restore window of the thread with given slot number
1107
    * 3 = restore window of the thread with given identifier
1108
  * edx = parameter (slot number or PID/TID)
608 alver 1109
Returned value:
641 diamond 1110
  * eax = 0 - success
1111
  * eax = -1 - error (invalid identifier)
1112
Remarks:
1113
  * The thread can minimize its window with subfunction 10.
1114
  * One can restore and activate window simultaneously with
1115
    subfunction 3 (which requires slot number).
608 alver 1116
 
1117
======================================================================
2648 mario79 1118
======== Function 18, subfunction 23 - minimize all windows. ==========
1119
======================================================================
1120
Parameters:
1121
  * eax = 18 - function number
1122
  * ebx = 23 - subfunction number
1123
Returned value:
1124
  * eax = 0 - all windows have been minimized before a function call
1125
  * eax = N - number of windows minimized from function
1126
Remarks:
1127
  * Window of special thread (name begin to symbol @) is not minimize.
2654 mario79 1128
 
2648 mario79 1129
======================================================================
2654 mario79 1130
======= Function 18, subfunction 24 - set limits of screen. ==========
1131
======================================================================
1132
Parameters:
1133
  * eax = 18 - function number
1134
  * ebx = 24 - subfunction number
1135
  * ecx = new X size
1136
  * edx = new Y size
1137
Returned value:
1138
  * function does not return value
1139
Remarks:
1140
  * The function does not change the physical size of the video mode.
1141
    It is designed for non-standard displays which display the image
1142
    partially.
1143
  * The sizes specified in the function should not exceed the sizes
1144
    of the current video mode, otherwise the function will not change
1145
    anything.
1146
 
1147
======================================================================
5836 GerdtR 1148
===================== Function 18, subfunction 25 ====================
1149
===== Control position of the window relative to other windows. ======
1150
======================================================================
1151
 
1152
------------- Subsubfunction 1 - get position  -----------------------
1153
Parameters:
1154
  * eax = 18 - function number
1155
  * ebx = 25 - subfunction number
1156
  * ecx = 1 - subsubfunction number
1157
  * edx = -1(for current window) or PID application
1158
Returned value:
1159
  * eax = one of the constants window position
1160
 
1161
------------- Subsubfunction 2 - set position  -----------------------
1162
Parameters:
1163
  * eax = 18 - function number
1164
  * ebx = 25 - subfunction number
1165
  * ecx = 2 - subsubfunction number
1166
  * edx = -1(for current window) or PID application
1167
  * esi = new window position (one of the constants below)
1168
Returned value:
1169
  * eax = 0 - error
1170
  * eax = 1 - success
1171
 
1172
Constant position of the window relative to other windows:
1173
 ZPOS_NORMAL      = 0 - normal
1174
 ZPOS_ALWAYS_BACK = 1 - behind all the windows
1175
 ZPOS_DESKTOP     = 2 - on the background
1176
 ZPOS_ALWAYS_TOP  = 3 - on top of all windows
1177
 
1178
======================================================================
118 diamond 1179
==================== Function 20 - MIDI interface. ===================
114 mikedld 1180
======================================================================
1181
 
118 diamond 1182
----------------------- Subfunction 1 - reset ------------------------
114 mikedld 1183
Parameters:
118 diamond 1184
  * eax = 20 - function number
1185
  * ebx = 1 - subfunction number
114 mikedld 1186
 
1187
-------------------- Subfunction 2 - output byte ---------------------
1188
Parameters:
118 diamond 1189
  * eax = 20 - function number
1190
  * ebx = 2 - subfunction number
114 mikedld 1191
  * cl = byte for output
118 diamond 1192
Returned value (is the same for both subfunctions):
1193
  * eax = 0 - success
114 mikedld 1194
  * eax = 1 - base port is not defined
1195
Remarks:
2409 Serge 1196
  * Previously the base port must be defined by
118 diamond 1197
    subfunction 1 of function 21.
114 mikedld 1198
 
1199
======================================================================
118 diamond 1200
======== Function 21, subfunction 1 - set MPU MIDI base port. ========
114 mikedld 1201
======================================================================
1202
Parameters:
118 diamond 1203
  * eax = 21 - function number
1204
  * ebx = 1 - subfunction number
1205
  * ecx = number of base port
1206
Returned value
1207
  * eax = 0 - success
114 mikedld 1208
  * eax = -1 - erratic number of a port
1209
Remarks:
118 diamond 1210
  * Number of a port must satisfy to conditions 0x100<=ecx<=0xFFFF.
1211
  * The installation of base is necessary for function 20.
1212
  * To get base port use subfunction 1 of function 26.
114 mikedld 1213
 
1214
======================================================================
118 diamond 1215
========== Function 21, subfunction 2 - set keyboard layout. =========
114 mikedld 1216
======================================================================
118 diamond 1217
Keyboard layout is used to convert keyboard scancodes to ASCII-codes,
1218
which will be read by function 2.
114 mikedld 1219
Parameters:
118 diamond 1220
  * eax = 21 - function number
1221
  * ebx = 2 - subfunction number
1222
  * ecx = which layout to set:
114 mikedld 1223
    * 1 = normal layout
1224
    * 2 = layout at pressed Shift
1225
    * 3 = layout at pressed Alt
118 diamond 1226
  * edx = pointer to layout - table of length 128 bytes
114 mikedld 1227
Or:
1228
  * ecx = 9
118 diamond 1229
  * dx = country identifier (1=eng, 2=fi, 3=ger, 4=rus)
114 mikedld 1230
Returned value:
118 diamond 1231
  * eax = 0 - success
1232
  * eax = 1 - incorrect parameter
114 mikedld 1233
Remarks:
118 diamond 1234
  * If Alt is pressed, the layout with Alt is used;
1235
    if Alt is not pressed, but Shift is pressed,
1236
    the layout with Shift is used;
1237
    if Alt and Shift are not pressed, but Ctrl is pressed, the normal
1238
    layout is used and then from the code is subtracted 0x60;
1239
    if no control key is pressed, the normal layout is used.
2409 Serge 1240
  * To get layout and country identifier use
118 diamond 1241
    subfunction 2 of function 26.
1242
  * Country identifier is global system variable, which is not used
5452 leency 1243
    by the kernel itself; however the application '@taskbar' displays
118 diamond 1244
    the corresponding icon.
5452 leency 1245
  * The application @taskbar switches layouts on user request.
114 mikedld 1246
 
1247
======================================================================
118 diamond 1248
========== Function 21, subfunction 5 - set system language. =========
114 mikedld 1249
======================================================================
1250
Parameters:
118 diamond 1251
  * eax = 21 - function number
1252
  * ebx = 5 - subfunction number
1253
  * ecx = system language (1=eng, 2=fi, 3=ger, 4=rus)
114 mikedld 1254
Returned value:
1255
  * eax = 0
1256
Remarks:
118 diamond 1257
  * System language is global system variable and is not used
5452 leency 1258
    by the kernel itself, however application @taskbar draws the
118 diamond 1259
    appropriate icon.
1260
  * Function does not check for correctness, as the kernel does not
1261
    use this variable.
1262
  * To get system language use subfunction 5 of function 26.
114 mikedld 1263
 
1264
======================================================================
2409 Serge 1265
 Function 21, subfunction 11 - enable/disable low-level access to HD.
114 mikedld 1266
======================================================================
1267
Parameters:
118 diamond 1268
  * eax = 21 - function number
1269
  * ebx = 11 - subfunction number
1270
  * ecx = 0/1 - disable/enable
114 mikedld 1271
Returned value:
1272
  * eax = 0
1273
Remarks:
118 diamond 1274
  * Is used in LBA-read (subfunction 8 of function 58).
1275
  * The current implementation uses only low bit of ecx.
1276
  * To get current status use subfunction 11 of function 26.
114 mikedld 1277
 
1278
======================================================================
2409 Serge 1279
 Function 21, subfunction 12 - enable/disable low-level access to PCI.
114 mikedld 1280
======================================================================
1281
Parameters:
118 diamond 1282
  * eax = 21 - function number
1283
  * ebx = 12 - subfunction number
1284
  * ecx = 0/1 - disable/enable
114 mikedld 1285
Returned value:
1286
  * eax = 0
1287
Remarks:
118 diamond 1288
  * Is used in operations with PCI bus (function 62).
1289
  * The current implementation uses only low bit of ecx.
1290
  * To get current status use subfunction 12 of function 26.
114 mikedld 1291
 
1292
======================================================================
118 diamond 1293
================= Function 22 - set system date/time. ================
114 mikedld 1294
======================================================================
1295
Parameters:
118 diamond 1296
  * eax = 22 - function number
1297
  * ebx = 0 - set time
1298
    * ecx = 0x00SSMMHH - time in the binary-decimal code (BCD):
114 mikedld 1299
    * HH=hour 00..23
1300
    * MM=minute 00..59
1301
    * SS=second 00..59
118 diamond 1302
  * ebx = 1 - set date
1303
    * ecx = 0x00DDMMYY - date in the binary-decimal code (BCD):
114 mikedld 1304
    * DD=day 01..31
1305
    * MM=month 01..12
1306
    * YY=year 00..99
118 diamond 1307
  * ebx = 2 - set day of week
114 mikedld 1308
    * ecx = 1 for Sunday, ..., 7 for Saturday
118 diamond 1309
  * ebx = 3 - set alarm clock
114 mikedld 1310
    * ecx = 0x00SSMMHH
1311
Returned value:
118 diamond 1312
  * eax = 0 - success
1313
  * eax = 1 - incorrect parameter
114 mikedld 1314
  * eax = 2 - CMOS-battery was unloaded
1315
Remarks:
118 diamond 1316
  * Value of installation of day of week seems to be doubtful,
1317
    as it a little where is used
1318
    (day of week can be calculated by date).
1319
  * Alarm clock can be set on operation in the given time every day.
1320
    But there is no existing system function to disable it.
1321
  * Operation of alarm clock consists in generation IRQ8.
1322
  * Generally CMOS supports for alarm clock set of value 0xFF
1323
    as one of parameters and it means that the appropriate parameter
1324
    is ignored. But current implementation does not allow this
1325
    (will return 1).
1326
  * Alarm clock is a global system resource; the set of
1327
    an alarm clock cancels automatically the previous set.
1328
    However, at moment no program uses it.
114 mikedld 1329
 
1330
======================================================================
118 diamond 1331
============= Function 23 - wait for event with timeout. =============
114 mikedld 1332
======================================================================
118 diamond 1333
If the message queue is empty, waits for new message in the queue,
1334
but no more than given time. Then reads out a message from the queue.
114 mikedld 1335
 
1336
Parameters:
118 diamond 1337
  * eax = 23 - function number
114 mikedld 1338
  * ebx = timeout (in 1/100 of second)
1339
Returned value:
118 diamond 1340
  * eax = 0 - the message queue is empty
1341
  * otherwise eax = event (see the list of events)
114 mikedld 1342
Remarks:
118 diamond 1343
  * Only those events are taken into account, which enter into
1344
    the mask set by function 40. By default it is
1345
    redraw, key and button events.
1346
  * To check for presence of a message in the queue use function 11.
1347
    To wait without timeout use function 10.
1348
  * Transmission ebx=0 results in immediate returning eax=0.
1349
  * Current implementation returns immediately with eax=0,
1350
    if the addition of ebx with the current value of time counter
1351
    makes 32-bit overflow.
114 mikedld 1352
 
1353
======================================================================
641 diamond 1354
======= Function 24, subfunction 4 - eject tray of disk drive. =======
588 diamond 1355
======================================================================
1356
Parameters:
1357
  * eax = 24 - function number
1358
  * ebx = 4 - subfunction number
641 diamond 1359
  * ecx = position of CD/DVD-drive
4711 mario79 1360
    from 0=Primary Master to 3=Secondary Slave for first IDE contr.
1361
    from 4=Primary Master to 7=Secondary Slave for second IDE contr.
1362
    from 8=Primary Master to 11=Secondary Slave for third IDE contr.
588 diamond 1363
Returned value:
641 diamond 1364
  * function does not return value
588 diamond 1365
Remarks:
1366
  * The function is supported only for ATAPI devices (CD and DVD).
641 diamond 1367
  * When the tray is being ejected,
1368
    manual control of tray is unlocked.
1369
  * When the tray is being ejected, the code clears the cache for
1370
    corresponding device.
588 diamond 1371
  * An example of usage of the function is the application CD_tray.
1372
 
1373
======================================================================
641 diamond 1374
======== Function 24, subfunction 5 - load tray of disk drive. =======
588 diamond 1375
======================================================================
1376
Parameters:
1377
  * eax = 24 - function number
1378
  * ebx = 5 - subfunction number
641 diamond 1379
  * ecx = position of CD/DVD-drive
4711 mario79 1380
    from 0=Primary Master to 3=Secondary Slave for first IDE contr.
1381
    from 4=Primary Master to 7=Secondary Slave for second IDE contr.
1382
    from 8=Primary Master to 11=Secondary Slave for third IDE contr.
588 diamond 1383
Returned value:
641 diamond 1384
  * function does not return value
588 diamond 1385
Remarks:
1386
  * The function is supported only for ATAPI devices (CD and DVD).
1387
  * An example of usage of the function is the application CD_tray.
1388
 
1389
======================================================================
4066 shikhin 1390
======= Function 25 - put image area on the background layer. ========
1391
======================================================================
1392
Paramters:
1393
  * eax = 25 - function number
1394
  * ebx = pointer to the previously allocated memory area,
1395
        where placed the source images in a format BBGGRRTTBBGGRRTT...
1396
  * ecx = [size on axis x]*65536 + [size on axis y]
1397
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
1398
Returned value:
1399
  * function does not return value
1400
Remarks:
1401
  * Coordinates of the image are coordinates of the upper left corner
1402
    of the image relative to the screen.
1403
  * Size of the image in bytes is 4*xsize*ysize
1404
  * TT - byte pointer of transparency, at current version:
1405
         1 to FF - opaque, 0 - transparent.
1406
  * The function places the image directly to LFB. It is not for
1407
    background image f.15. Options f.15 to f.25 does not make sense.
1408
 
1409
======================================================================
118 diamond 1410
======== Function 26, subfunction 1 - get MPU MIDI base port. ========
114 mikedld 1411
======================================================================
1412
Parameters:
118 diamond 1413
  * eax = 26 - function number
1414
  * ebx = 1 - subfunction number
114 mikedld 1415
Returned value:
118 diamond 1416
  * eax = port number
1417
Parameters:
1418
  * To set base port use subfunction 1 of function 21.
114 mikedld 1419
 
1420
======================================================================
1421
========== Function 26, subfunction 2 - get keyboard layout. =========
1422
======================================================================
118 diamond 1423
The keyboard layout is used to convert keyboard scancodes to
1424
ASCII-codes for function 2.
114 mikedld 1425
Parameters:
118 diamond 1426
  * eax = 26 - function number
1427
  * ebx = 2 - subfunction number
114 mikedld 1428
  * ecx = what layout to get:
1429
    * 1 = normal layout
118 diamond 1430
    * 2 = layout with pressed Shift
1431
    * 3 = layout with pressed Alt
1432
  * edx = pointer to the 128-bytes buffer, where the layout will be
1433
    copied
114 mikedld 1434
Returned value:
1435
  * function does not return value
118 diamond 1436
Or:
1437
  * eax = 26 - function number
1438
  * ebx = 2 - subfunction number
114 mikedld 1439
  * ecx = 9
1440
Returned value:
118 diamond 1441
  * eax = country identifier (1=eng, 2=fi, 3=ger, 4=rus)
114 mikedld 1442
Remarks:
118 diamond 1443
  * If Alt is pressed, the layout with Alt is used;
1444
    if Alt is not pressed, but Shift is pressed,
1445
    the layout with Shift is used;
1446
    if Alt and Shift are not pressed, but Ctrl is pressed, the normal
1447
    layout is used and then from the code is subtracted 0x60;
1448
    if no control key is pressed, the normal layout is used.
2409 Serge 1449
  * To set layout and country identifier use
118 diamond 1450
    subfunction 2 of function 21.
1451
  * Country identifier is global system variable, which is not used
5452 leency 1452
    by the kernel itself; however the application '@taskbar' displays
118 diamond 1453
    the corresponding icon (using this function).
5452 leency 1454
  * The application @taskbar switches layouts on user request.
114 mikedld 1455
 
1456
======================================================================
118 diamond 1457
========== Function 26, subfunction 5 - get system language. =========
114 mikedld 1458
======================================================================
1459
Parameters:
118 diamond 1460
  * eax = 26 - function number
1461
  * ebx = 5 - subfunction number
114 mikedld 1462
Returned value:
118 diamond 1463
  * eax = system language (1=eng, 2=fi, 3=ger, 4=rus)
114 mikedld 1464
Remarks:
118 diamond 1465
  * System language is global system variable and is not used
5452 leency 1466
    by the kernel itself, however application @taskbar draws the
118 diamond 1467
    appropriate icon (using this function).
1468
  * To set system language use subfunction 5 of function 21.
114 mikedld 1469
 
1470
======================================================================
118 diamond 1471
=== Function 26, subfunction 9 - get the value of the time counter. ==
114 mikedld 1472
======================================================================
1473
Parameters:
118 diamond 1474
  * eax = 26 - function number
1475
  * ebx = 9 - subfunction number
114 mikedld 1476
Returned value:
118 diamond 1477
  * eax = number of 1/100s of second, past from the system boot time
114 mikedld 1478
Remarks:
118 diamond 1479
  * Counter takes modulo 2^32, that correspond to a little more
1480
    than 497 days.
5810 hidnplayr 1481
  * To get system time use function 3.
1482
 
1483
======================================================================
1484
===================== Function 26, subfunction 10 ====================
1485
========== Get the value of the high precision time counter. =========
1486
======================================================================
1487
Parameters:
1488
  * eax = 26 - function number
1489
  * ebx = 10 - subfunction number
1490
Returned value:
1491
  * eax = number of nanoseconds since system boot time (lower DWORD)
1492
  * edx = number of nanoseconds since system boot time (high DWORD)
1493
Remarks:
1494
  * The counter is based on HPET, if HPET is not available, resolution
1495
    will be reduced to 10 000 000 nanoseconds.
114 mikedld 1496
 
1497
======================================================================
118 diamond 1498
===================== Function 26, subfunction 11 ====================
1499
========== Find out whether low-level HD access is enabled. ==========
114 mikedld 1500
======================================================================
1501
Parameters:
118 diamond 1502
  * eax = 26 - function number
1503
  * ebx = 11 - subfunction number
114 mikedld 1504
Returned value:
118 diamond 1505
  * eax = 0/1 - disabled/enabled
114 mikedld 1506
Remarks:
118 diamond 1507
  * Is used in LBA read (subfunction 8 of function 58).
1508
  * To set current state use subfunction 11 of function 21.
114 mikedld 1509
 
1510
======================================================================
118 diamond 1511
===================== Function 26, subfunction 12 ====================
1512
========== Find out whether low-level PCI access is enabled. =========
114 mikedld 1513
======================================================================
1514
Parameters:
118 diamond 1515
  * eax = 26 - function number
1516
  * ebx = 12 - subfunction number
114 mikedld 1517
Returned value:
118 diamond 1518
  * eax = 0/1 - disabled/enabled
114 mikedld 1519
Remarks:
118 diamond 1520
  * Is used by operations with PCI bus (function 62).
1521
  * The current implementation uses only low bit of ecx.
1522
  * To set the current state use subfunction 12 of function 21.
114 mikedld 1523
 
1524
======================================================================
118 diamond 1525
=================== Function 29 - get system date. ===================
114 mikedld 1526
======================================================================
1527
Parameters:
118 diamond 1528
  * eax = 29 - function number
114 mikedld 1529
Returned value:
1530
  * eax = 0x00DDMMYY, where
118 diamond 1531
    (binary-decimal coding, BCD, is used)
1532
  * YY = two low digits of year (00..99)
1533
  * MM = month (01..12)
1534
  * DD = day (01..31)
114 mikedld 1535
Remarks:
118 diamond 1536
  * To set system date use function 22.
114 mikedld 1537
 
1538
======================================================================
521 diamond 1539
============= Function 30 - work with the current folder. ============
1540
======================================================================
1541
 
1542
--------- Subfunction 1 - set current folder for the thread. ---------
1543
Parameters:
1544
  * eax = 30 - function number
1545
  * ebx = 1 - subfunction number
1546
  * ecx = pointer to ASCIIZ-string with the path to new current folder
1547
Returned value:
1548
  * function does not return value
1549
 
1550
--------- Subfunction 2 - get current folder for the thread. ---------
1551
Parameters:
1552
  * eax = 30 - function number
1553
  * ebx = 2 - subfunction number
1554
  * ecx = pointer to buffer
1555
  * edx = size of buffer
1556
Returned value:
1557
  * eax = size of the current folder's name (including terminating 0)
1558
Remarks:
1559
  * If the buffer is too small to hold all data, only first (edx-1)
1560
    bytes are copied and than terminating 0 is inserted.
1662 Nasarus 1561
  * By default, current folder for the thread is "/rd/1".
2409 Serge 1562
  * At process/thread creation the current folder will be inherited
1662 Nasarus 1563
    from the parent.
521 diamond 1564
 
3663 mario79 1565
--- Subfunction 3 - install the add.system directory for the kernel --
1566
Parameters:
1567
  * eax = 30 - function number
1568
  * ebx = 3 - subfunction number
1569
  * ecx = pointer to a block of data:
1570
          sysdir_name     rb 64
1571
          sysdir_path     rb 64
3780 Serge 1572
For example:
1573
dir_name1       db 'KolibriOS',0
3912 mario79 1574
                rb 64-10
3663 mario79 1575
dir_path1       db 'HD0/1',0
1576
                rb 64-6
1577
Returned value:
1578
  * function does not return value
1579
Remarks:
1580
  * The function can be called only 1 time for 1 session of the OS.
1581
 
521 diamond 1582
======================================================================
2511 mario79 1583
========= Function 34 - who owner the pixel on the screen. ===========
1584
======================================================================
1585
Parameters:
1586
  * eax = 34 - function number
1587
  * ebx = x-coordinate (relative to the display)
1588
  * ecx = y-coordinate (relative to the display)
1589
 
1590
Returned value:
1591
  * eax = 0x000000XX - owner of pixel the slot window N
1592
    If incorrect values ebx and ecx then function returns 0
1593
  * The function takes the value from the area [_WinMapAddress]
3780 Serge 1594
 
2511 mario79 1595
======================================================================
118 diamond 1596
======= Function 35 - read the color of a pixel on the screen. =======
114 mikedld 1597
======================================================================
1598
Parameters:
1599
  * eax = 35
1600
  * ebx = y*xsize+x, where
118 diamond 1601
  * (x,y) = coordinates of a pixel (beginning from 0)
1602
  * xsize = horizontal screen size
114 mikedld 1603
Returned value:
118 diamond 1604
  * eax = color 0x00RRGGBB
114 mikedld 1605
Remarks:
118 diamond 1606
  * To get screen sizes use function 14. Pay attention,
1607
    that it subtracts 1 from both sizes.
1608
  * There is also direct access (without any system calls)
1609
    to videomemory through the selector gs. To get parameters of
1610
    the current videomode, use function 61.
114 mikedld 1611
 
1612
======================================================================
1018 diamond 1613
=================== Function 36 - read screen area. ==================
921 mario79 1614
======================================================================
1615
Paramters:
1616
  * eax = 36 - function number
1018 diamond 1617
  * ebx = pointer to the previously allocated memory area,
1618
        where will be placed the image in the format BBGGRRBBGGRR...
921 mario79 1619
  * ecx = [size on axis x]*65536 + [size on axis y]
1620
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
1621
Returned value:
1622
  * function does not return value
1623
Remarks:
1624
  * Coordinates of the image are coordinates of the upper left corner
923 mario79 1625
    of the image relative to the screen.
921 mario79 1626
  * Size of the image in bytes is 3*xsize*ysize.
1627
 
1628
======================================================================
277 diamond 1629
=================== Function 37 - work with mouse. ===================
114 mikedld 1630
======================================================================
1631
 
118 diamond 1632
---------- Subfunction 0 - screen coordinates of the mouse -----------
114 mikedld 1633
Parameters:
118 diamond 1634
  * eax = 37 - function number
1635
  * ebx = 0 - subfunction number
114 mikedld 1636
Returned value:
118 diamond 1637
  * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer
1638
    (beginning from 0)
114 mikedld 1639
 
118 diamond 1640
-- Subfunction 1 - coordinates of the mouse relative to the window ---
114 mikedld 1641
Parameters:
118 diamond 1642
  * eax = 37 - function number
1643
  * ebx = 1 - subfunction number
114 mikedld 1644
Returned value:
118 diamond 1645
  * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer
1646
    relative to the application window (beginning from 0)
114 mikedld 1647
Remarks:
118 diamond 1648
  * The value is calculated by formula (x-xwnd)*65536 + (y-ywnd).
1649
    If y>=ywnd, the low word is non-negative and contains
1650
    relative y-coordinate, and the high word - relative x-coordinate
1651
    (with correct sign). Otherwise the low word is negative and still
1652
    contains relative y-coordinate, and to the high word
1653
    1 should be added.
114 mikedld 1654
 
118 diamond 1655
------------ Subfunction 2 - pressed buttons of the mouse ------------
114 mikedld 1656
Parameters:
118 diamond 1657
  * eax = 37 - function number
1658
  * ebx = 2 - subfunction number
114 mikedld 1659
Returned value:
118 diamond 1660
  * eax contains information on the pressed mouse buttons:
1661
  * bit 0 is set = left button is pressed
1662
  * bit 1 is set = right button is pressed
486 kastigar 1663
  * bit 2 is set = middle button is pressed
1664
  * bit 3 is set = 4th button is pressed
1665
  * bit 4 is set = 5th button is pressed
118 diamond 1666
  * other bits are cleared
114 mikedld 1667
 
277 diamond 1668
-------------------- Subfunction 4 - load cursor ---------------------
1669
Parameters:
1670
  * eax = 37 - function number
1671
  * ebx = 4 - subfunction number
1672
  * dx = data source:
1673
  * dx = LOAD_FROM_FILE = 0 - data in a file
1674
    * ecx = pointer to full path to the cursor file
1675
    * the file must be in the format .cur, which is standard for
1676
      MS Windows, at that of the size 32*32 pixels
1677
  * dx = LOAD_FROM_MEM = 1 - data of file are already loaded in memory
1678
    * ecx = pointer to data of the cursor file
1679
    * the data format is the same as in the previous case
1680
  * dx = LOAD_INDIRECT = 2 - data in memory
1681
    * ecx = pointer to cursor image in the format ARGB 32*32 pixels
1682
    * edx = 0xXXYY0002, where
1683
      * XX = x-coordinate of cursor hotspot
1684
      * YY = y-coordinate
1685
      * 0 <= XX, YY <= 31
1686
Returned value:
1687
  * eax = 0 - failed
1688
  * otherwise eax = cursor handle
1689
 
1690
--------------------- Subfunction 5 - set cursor ---------------------
1691
Sets new cursor for the window of the current thread.
1692
Parameters:
1693
  * eax = 37 - function number
1694
  * ebx = 5 - subfunction number
1695
  * ecx = cursor handle
1696
Returned value:
1697
  * eax = handle of previous cursor
1698
Remarks:
1699
  * If the handle is incorrect, the function restores the default
1700
    cursor (standard arrow). In particular, ecx=0 restores it.
1701
 
1702
------------------- Subfunction 6 - delete cursor --------------------
1703
Parameters:
1704
  * eax = 37 - function number
1705
  * ebx = 6 - subfunction number
1706
  * ecx = cursor handle
1707
Returned value:
1708
  * eax destroyed
1709
Remarks:
1710
  * The cursor must be loaded previously by the current thread
1711
    (with the call to subfunction 4). The function does not delete
1712
    system cursors and cursors, loaded by another applications.
1713
  * If the active cursor (set by subfunction 5) is deleted,
1714
    the system restores the default cursor (standard arrow).
1715
 
499 diamond 1716
------------------ Subfunction 7 - get scroll data -------------------
486 kastigar 1717
Parameters:
1718
  * eax = 37 - function number
1719
  * ebx = 7 - subfunction number
1720
Returned value:
499 diamond 1721
  * eax = [horizontal offset]*65536 + [vertical offset]
486 kastigar 1722
Remarks:
499 diamond 1723
  * Scroll data is available for active window only.
1724
  * Values are zeroed after reading.
1725
  * Values are signed.
486 kastigar 1726
 
114 mikedld 1727
======================================================================
1728
====================== Function 38 - draw line. ======================
1729
======================================================================
1730
Parameters:
118 diamond 1731
  * eax = 38 - function number
1732
  * ebx = [start coordinate on axis x]*65536 +
1733
              [end coordinate on axis x]
1734
  * ecx = [start coordinate on axis y]*65536 +
1735
              [end coordinate on axis y]
1736
  * edx = 0x00RRGGBB - color
133 diamond 1737
    edx = 0x01xxxxxx - draw inversed line
1738
          (low 24 bits are ignored)
114 mikedld 1739
Returned value:
1740
  * function does not return value
1741
Remarks:
118 diamond 1742
  * Coordinates are relative to the window.
1743
  * End point is also drawn.
114 mikedld 1744
 
1745
======================================================================
118 diamond 1746
== Function 39, subfunction 1 - get a size of the background image. ==
114 mikedld 1747
======================================================================
1748
Parameters:
118 diamond 1749
  * eax = 39 - function number
1750
  * ebx = 1 - subfunction number
114 mikedld 1751
Returned value:
1752
  * eax = [width]*65536 + [height]
1753
Remarks:
118 diamond 1754
  * There is a pair function to set sizes of background image -
1755
    subfunction 1 of function 15. After which it is necessary,
1756
    of course, anew to define image.
114 mikedld 1757
 
1758
======================================================================
118 diamond 1759
== Function 39, subfunction 2 - get pixel from the background image. =
114 mikedld 1760
======================================================================
1761
Parameters:
118 diamond 1762
  * eax = 39 - function number
1763
  * ebx = 2 - subfunction number
114 mikedld 1764
  * ecx = offset
1765
Returned value:
118 diamond 1766
  * eax = 0x00RRGGBB - pixel color, if offset is valid
1767
    (less than 0x160000-16)
1768
  * eax = 2 otherwise
114 mikedld 1769
Remarks:
118 diamond 1770
  * Do not rely on returned value for invalid offsets, it may be
1771
    changed in future kernel versions.
1772
  * Offset for pixel with coordinates (x,y)
1773
    is calculated as (x+y*xsize)*3.
2409 Serge 1774
  * There is a pair function to set pixel on the background image -
118 diamond 1775
    subfunction 2 of function 15.
114 mikedld 1776
 
1777
======================================================================
118 diamond 1778
== Function 39, subfunction 4 - get drawing mode for the background. =
114 mikedld 1779
======================================================================
1780
Parameters:
118 diamond 1781
  * eax = 39 - function number
1782
  * ebx = 4 - subfunction number
114 mikedld 1783
Returned value:
118 diamond 1784
  * eax = 1 - tile
1785
  * eax = 2 - stretch
114 mikedld 1786
Remarks:
2409 Serge 1787
  * There is a pair function to set drawing mode -
118 diamond 1788
    subfunction 4 of function 15.
114 mikedld 1789
 
1790
======================================================================
118 diamond 1791
=========== Function 40 - set the mask for expected events. ==========
114 mikedld 1792
======================================================================
118 diamond 1793
The mask for expected events affects function working with events
1794
10, 11, 23 - they notify only about events allowed by this mask.
114 mikedld 1795
Parameters:
118 diamond 1796
  * eax = 40 - function number
114 mikedld 1797
  * ebx = mask: bit i corresponds to event i+1 (see list of events)
118 diamond 1798
    (set bit permits notice on event)
3940 mario79 1799
    bit 31: mouse active/inactive filter
2414 Serge 1800
    bit 31 = 0 - inactive window receive mouse events
1801
    bit 31 = 1 - inactive window does not receive mouse events
1802
    bit 30: cursor position filter
1803
    bit 30 = 0 = the window receive mouse events if cursor
1804
                 outside window
1805
    bit 30 = 1 - the window does not receive mouse events if cursor
1806
                 outside window
114 mikedld 1807
Returned value:
1153 clevermous 1808
  * eax = previous value of mask
114 mikedld 1809
Remarks:
118 diamond 1810
  * Default mask (7=111b) enables nofices about redraw,
1811
    keys and buttons. This is enough for many applications.
1812
  * Events prohibited in the mask are saved anyway, when come;
1813
    they are simply not informed with event functions.
1814
  * Event functions take into account the mask on moment of
1815
    function call, not on moment of event arrival.
114 mikedld 1816
 
1817
 
1818
======================================================================
118 diamond 1819
================ Function 43 - input/output to a port. ===============
114 mikedld 1820
======================================================================
1821
 
118 diamond 1822
------------------------ Output data to port -------------------------
114 mikedld 1823
Parameters:
118 diamond 1824
  * eax = 43 - function number
114 mikedld 1825
  * bl = byte for output
118 diamond 1826
  * ecx = port number 0xnnnn (from 0 to 0xFFFF)
114 mikedld 1827
Returned value:
118 diamond 1828
  * eax = 0 - success
1829
  * eax = 1 - the thread has not reserved the selected port
114 mikedld 1830
 
118 diamond 1831
------------------------ Input data from port ------------------------
114 mikedld 1832
Parameters:
118 diamond 1833
  * eax = 43 - function number
1834
  * ebx is ignored
1835
  * ecx = 0x8000nnnn, where nnnn = port number (from 0 to 0xFFFF)
114 mikedld 1836
Returned value:
118 diamond 1837
  * eax = 0 - success, thus ebx = entered byte
1838
  * eax = 1 - the thread has not reserved the selected port
114 mikedld 1839
Remarks:
118 diamond 1840
  * Previously the thread must reserve the selected port
1841
    for itself by function 46.
1842
  * Instead of call to this function it is better to use
1843
    processor instructions in/out - this is much
1844
    faster and a bit shorter and easier.
114 mikedld 1845
 
1846
 
1847
======================================================================
118 diamond 1848
====== Function 46 - reserve/free a group of input/output ports. =====
114 mikedld 1849
======================================================================
118 diamond 1850
To work with reserved ports an application can access directly by
1851
commands in/out (recommended way) and can use function 43
1852
(not recommended way).
114 mikedld 1853
Parameters:
118 diamond 1854
  * eax = 46 - function number
114 mikedld 1855
  * ebx = 0 - reserve, 1 - free
118 diamond 1856
  * ecx = start port number
1857
  * edx = end port number (inclusive)
114 mikedld 1858
Returned value:
118 diamond 1859
  * eax = 0 - success
114 mikedld 1860
  * eax = 1 - error
1861
Remarks:
118 diamond 1862
  * For ports reservation: an error occurs if and only if
1863
    one from the following condition satisfies:
1864
    * start port is more than end port;
1865
    * the selected range contains incorrect port number
1866
      (correct are from 0 to 0xFFFF);
1867
    * limit for the total number of reserved areas is exceeded
1868
      (maximum 255 are allowed);
1869
    * the selected range intersects with any of earlier reserved
1870
  * For ports free: an error is an attempt to free range,
1871
    that was not earlier reserved by this function
1872
    (with same ecx,edx).
1873
  * If an error occurs (for both cases) function performs no action.
277 diamond 1874
  * At booting the system reserves for itself ports
1875
    0..0x2d, 0x30..0x4d, 0x50..0xdf, 0xe5..0xff (inclusively).
118 diamond 1876
  * When a thread terminates, all reserved by it ports
1877
    are freed automatically.
114 mikedld 1878
 
1879
======================================================================
118 diamond 1880
============= Function 47 - draw a number in the window. =============
114 mikedld 1881
======================================================================
1882
Parameters:
118 diamond 1883
  * eax = 47 - function number
1884
  * ebx = parameters of conversion number to text:
114 mikedld 1885
    * bl = 0 - ecx contains number
665 diamond 1886
    * bl = 1 - ecx contains pointer to dword/qword-number
118 diamond 1887
    * bh = 0 - display in decimal number system
1888
    * bh = 1 - display in hexadecimal system
1889
    * bh = 2 - display in binary system
499 diamond 1890
    * bits 16-21 = how many digits to display
655 mario79 1891
    * bits 22-29 reserved and must be set to 0
665 diamond 1892
    * bit 30 set = display qword (64-bit) number (must be bl=1)
1893
    * bit 31 set = do not display leading zeroes of the number
118 diamond 1894
  * ecx = number (if bl=0) or pointer (if bl=1)
114 mikedld 1895
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
139 diamond 1896
  * esi = 0xX0RRGGBB:
1897
    * RR, GG, BB specify the color
1898
    * X = ABnn (bits)
1899
    * nn = font (0/1)
1900
    * A is ignored
1901
    * B=1 - fill background with the color edi
114 mikedld 1902
Returned value:
1903
  * function does not return value
1904
Remarks:
118 diamond 1905
  * The given length must not exceed 60.
1906
  * The exactly given amount of digits is output. If number is small
1907
    and can be written by smaller amount of digits, it is supplemented
1908
    by leading zeroes; if the number is big and can not be written by
1909
    given amount of digits, extra digits are not drawn.
1910
  * Parameters of fonts are shown in the description of function 4
1911
    (text output).
114 mikedld 1912
 
1913
======================================================================
118 diamond 1914
========= Function 48, subfunction 0 - apply screen settings. ========
114 mikedld 1915
======================================================================
1916
Parameters:
118 diamond 1917
  * eax = 48 - function number
1918
  * ebx = 0 - subfunction number
114 mikedld 1919
  * ecx = 0 - reserved
1920
Returned value:
1921
  * function does not return value
1922
Remarks:
118 diamond 1923
  * Function redraws the screen after parameters change by
114 mikedld 1924
    subfunctions 1 and 2.
118 diamond 1925
  * Function call without prior call to one of indicated subfunctions
1926
    is ignored.
1927
  * Function call with nonzero ecx is ignored.
114 mikedld 1928
 
1929
======================================================================
118 diamond 1930
=========== Function 48, subfunction 1 - set button style. ===========
114 mikedld 1931
======================================================================
1932
Parameters:
118 diamond 1933
  * eax = 48 - function number
1934
  * ebx = 1 - subfunction number
1935
  * ecx = button style:
1936
    * 0 = flat
1937
    * 1 = 3d
114 mikedld 1938
Returned value:
1939
  * function does not return value
1940
Remarks:
118 diamond 1941
  * After call to this function one should redraw the screen by
1942
    subfunction 0.
1943
  * Button style influences only to their draw of function 8.
114 mikedld 1944
 
118 diamond 1945
======================================================================
1946
====== Function 48, subfunction 2 - set standard window colors. ======
1947
======================================================================
114 mikedld 1948
Parameters:
118 diamond 1949
  * eax = 48 - function number
1950
  * ebx = 2 - subfunction number
1951
  * ecx = pointer to the color table
114 mikedld 1952
  * edx = size of the color table
118 diamond 1953
    (must be 40 bytes for future compatibility)
1954
Format of the color table is shown in description of subfunction 3.
114 mikedld 1955
Returned value:
1956
  * function does not return value
1957
Remarks:
118 diamond 1958
  * After call to this function one should redraw the screen by
1959
    subfunction 0.
1960
  * Table of standard colors influences only to applications,
1961
    which receive this table obviously (by subfunction 3)
1962
    and use it (specifying colors from it to drawing functions).
1963
  * Table of standard colors is included in skin and is installed
1964
    anew with skin installation (by subfunction 8).
1965
  * Color table can be viewed/changed interactively with
1966
    the application 'desktop'.
114 mikedld 1967
 
1968
======================================================================
118 diamond 1969
====== Function 48, subfunction 3 - get standard window colors. ======
114 mikedld 1970
======================================================================
1971
Parameters:
118 diamond 1972
  * eax = 48 - function number
1973
  * ebx = 3 - subfunction number
1974
  * ecx = pointer to the buffer with size edx bytes,
1975
    where table will be written
1976
  * edx = size of color table
1977
    (must be 40 bytes for future compatibility)
114 mikedld 1978
Returned value:
1979
  * function does not return value
118 diamond 1980
Format of the color table:
1981
each item is dword-value for color 0x00RRGGBB
1982
  * +0: dword: frames - color of frame
1983
  * +4: dword: grab - color of header
1984
  * +8: dword: grab_button - color of button on header bar
1985
  * +12 = +0xC: dword: grab_button_text - color of text on button
1986
    on header bar
1987
  * +16 = +0x10: dword: grab_text - color of text on header
1988
  * +20 = +0x14: dword: work - color of working area
1989
  * +24 = +0x18: dword: work_button - color of button in working area
1990
  * +28 = +0x1C: dword: work_button_text - color of text on button
1991
    in working area
1992
  * +32 = +0x20: dword: work_text - color of text in working area
1993
  * +36 = +0x24: dword: work_graph - color of graphics in working area
114 mikedld 1994
Remarks:
118 diamond 1995
  * Structure of the color table is described in the standard
1996
    include file 'macros.inc' as 'system_colors'; for example,
1997
    it is possible to write:
1662 Nasarus 1998
    	sc	system_colors		; variable declaration
1999
    	...				; somewhere one must call
2000
    					; this function with ecx=sc
2001
    	mov	ecx, [sc.work_button_text]	; read text color on
2002
    					; buttin in working area
118 diamond 2003
  * A program itself desides to use or not to use color table.
2004
    For usage program must simply at calls to drawing functions select
2005
    color taken from the table.
2006
  * At change of the table of standard colors (by subfunction 2 with
2007
    the subsequent application of changes by subfunction 0 or
2008
    at skin set by subfunction 8) the system sends to all windows
2009
    redraw message (the event with code 1).
2010
  * Color table can be viewed/changed interactively with
2011
    the application 'desktop'.
114 mikedld 2012
 
2013
======================================================================
118 diamond 2014
============ Function 48, subfunction 4 - get skin height. ===========
114 mikedld 2015
======================================================================
2016
Parameters:
118 diamond 2017
  * eax = 48 - function number
2018
  * ebx = 4 - subfunction number
114 mikedld 2019
Returned value:
118 diamond 2020
  * eax = skin height
114 mikedld 2021
Remarks:
118 diamond 2022
  * Skin height is defined as the height of a header
2023
    of skinned windows.
2024
  * See also general structure of window in the description
2025
    of function 0.
114 mikedld 2026
 
2027
======================================================================
118 diamond 2028
======== Function 48, subfunction 5 - get screen working area. =======
114 mikedld 2029
======================================================================
2030
Parameters:
118 diamond 2031
  * eax = 48 - function number
2032
  * ebx = 5 - subfunction number
114 mikedld 2033
Returned value:
2034
  * eax = [left]*65536 + [right]
2035
  * ebx = [top]*65536 + [bottom]
2036
Remarks:
118 diamond 2037
  * The screen working area defines position and coordinates of
2038
    a maximized window.
2039
  * The screen working area in view of normal work is all screen
5452 leency 2040
    without taskbar ('@taskbar' application).
118 diamond 2041
  * (left,top) are coordinates of the left upper corner,
2042
    (right,bottom) are coordinates of the right lower one.
2043
    Thus the size of working area on x axis can be calculated by
2044
    formula right-left+1, on y axis - by formula bottom-right+1.
2045
  * See also function 14,
2046
    to get sizes of all screen.
2047
  * There is a pair function to set working area - subfunction 6.
114 mikedld 2048
 
2049
======================================================================
118 diamond 2050
======== Function 48, subfunction 6 - set screen working area. =======
114 mikedld 2051
======================================================================
2052
Parameters:
118 diamond 2053
  * eax = 48 - function number
2054
  * ebx = 6 - subfunction number
114 mikedld 2055
  * ecx = [left]*65536 + [right]
2056
  * edx = [top]*65536 + [bottom]
2057
Returned value:
2058
  * function does not return value
2059
Remarks:
118 diamond 2060
  * The screen working area defines position and coordinates of
2061
    a maximized window.
5452 leency 2062
  * This function is used only by the application '@taskbar',
2063
    which set working area to all screen without taskbar.
118 diamond 2064
  * (left,top) are coordinates of the left upper corner,
2065
    (right,bottom) are coordinates of the right lower one.
2066
    Thus the size of working area on x axis can be calculated by
2067
    formula right-left+1, on y axis - by formula bottom-right+1.
2068
  * If 'left'>='right', x-coordinate of working area is not changed.
2069
    If 'left'<0, 'left' will not be set. If 'right' is greater than or
2070
    equal to screen width, 'right' will not be set.
2071
    Similarly on y axis.
2072
  * See also function 14,
2073
    to get sizes of all screen.
2074
  * There is a pair function to get working area - subfunction 5.
2075
  * This function redraws the screen automatically,
2076
    updating coordinates and sizes of maximized windows.
2077
    The system sends to all windows redraw message (the event 1).
114 mikedld 2078
 
2079
======================================================================
118 diamond 2080
=========== Function 48, subfunction 7 - get skin margins. ===========
114 mikedld 2081
======================================================================
118 diamond 2082
Returns the area of a header of a skinned window, intended for
2083
a text of a header.
114 mikedld 2084
Parameters:
118 diamond 2085
  * eax = 48 - function number
2086
  * ebx = 7 - subfunction number
114 mikedld 2087
Returned value:
2088
  * eax = [left]*65536 + [right]
2089
  * ebx = [top]*65536 + [bottom]
2090
Remarks:
118 diamond 2091
  * An application decides itself to use or not to use this function.
2092
  * It is recommended to take into account returned value
2093
    of this function for choice of a place for drawing header text
2094
    (by function 4) or a substitute of header text
2095
    (at the discretion of an application).
114 mikedld 2096
 
2097
======================================================================
118 diamond 2098
============= Function 48, subfunction 8 - set used skin. ============
114 mikedld 2099
======================================================================
2100
Parameters:
118 diamond 2101
  * eax = 48 - function number
2102
  * ebx = 8 - subfunction number
4573 clevermous 2103
  * ecx = pointer to filename of the skin
114 mikedld 2104
Returned value:
118 diamond 2105
  * eax = 0 - success
2106
  * otherwise eax = file system error code; if file does not
2107
    contain valid skin, function returns error 3
2108
    (unknown file system).
114 mikedld 2109
Remarks:
118 diamond 2110
  * After successful skin loading the system sends to all windows
2111
    redraw message (the event 1).
2112
  * At booting the system reads skin from file 'default.skn'
2113
    on ramdisk.
2114
  * User can change the skin statically by creating hisself
2115
    'default.skn' or dynamically with the application 'desktop'.
114 mikedld 2116
 
2117
======================================================================
5682 leency 2118
======== Function 48, subfunction 9 - font smoothing setting. ========
2119
======================================================================
2120
Parameters:
2121
  * eax = 48 - function number
2122
  * ebx = 9 - subfunction number
2123
  * cl=0 - turn off font smoothing, else - turn on
2124
 
2125
======================================================================
118 diamond 2126
=========== Function 49 - Advanced Power Management (APM). ===========
114 mikedld 2127
======================================================================
2128
Parameters:
118 diamond 2129
  * eax = 49 - function number
2130
  * dx = number of the APM function
2131
    (analogue of ax in APM specification)
2132
  * bx, cx = parameters of the APM function
114 mikedld 2133
Returned value:
118 diamond 2134
  * 16-bit registers ax, bx, cx, dx, si, di and carry flag CF
2135
    are set according to the APM specification
2136
  * high halves of 32-bit registers eax, ebx, ecx,
2137
    edx, esi, edi are destroyed
114 mikedld 2138
Remarks:
118 diamond 2139
  * APM 1.2 specification is described in the document
2140
    "Advanced Power Management (APM) BIOS Specification"
2141
    (Revision 1.2), available at
114 mikedld 2142
    http://www.microsoft.com/whdc/archive/amp_12.mspx;
118 diamond 2143
    besides it is included in famous Interrupt List by Ralf Brown
114 mikedld 2144
    (http://www.pobox.com/~ralf/files.html,
2145
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/).
2146
 
2147
======================================================================
118 diamond 2148
=================== Function 50 - set window shape. ==================
114 mikedld 2149
======================================================================
118 diamond 2150
Normal windows have rectangular shape. This function can give to
2151
a window any shape. The shape is given by a set of points inside
2152
the base rectangle belonging to a window. Position and coordinates
2153
of the base rectangle are set by function 0
2154
and changed by function 67.
114 mikedld 2155
 
118 diamond 2156
--------------------------- Set shape data ---------------------------
114 mikedld 2157
Parameters:
118 diamond 2158
  * eax = 50 - function number
2159
  * ebx = 0 - subfunction number
2160
  * ecx = pointer to shape data (array of bytes 0/1)
114 mikedld 2161
Returned value:
2162
  * function does not return value
2163
 
118 diamond 2164
-------------------------- Set shape scale ---------------------------
114 mikedld 2165
Parameters:
118 diamond 2166
  * eax = 50 - function number
2167
  * ebx = 1 - subfunction number
2168
  * ecx sets a scale: each byte of data defines
2169
    (2^scale)*(2^scale) pixels
114 mikedld 2170
Returned value:
2171
  * function does not return value
2172
Remarks:
118 diamond 2173
  * Default scale is 0 (scale factor is 1). If in the shape data
2174
    one byte corresponds to one pixel, there is no necessity
2175
    to set scale.
2176
  * Let's designate xsize = window width (in pixels), ysize = height;
2177
    pay attention, that they are one pixel more than defined by
114 mikedld 2178
    functions 0, 67.
118 diamond 2179
  * On definition of scale xsize and ysize must be divisible
2180
    on 2^scale.
2181
  * Byte of data on offset 'a' must be 0/1 and defines belonging
2182
    to a window of square with the side 2^scale (if scale=0,
2183
    this is one pixel) and coordinates of the left upper corner
114 mikedld 2184
    (a mod (xsize shr scale), a div (xsize shr scale))
118 diamond 2185
  * Data size: (xsize shr scale)*(ysize shr scale).
2186
  * Data must be presented in the memory and not change
2187
    after set of shape.
2188
  * The system views the shape data at every window redraw by
2189
    function 0.
2190
  * The call of subfunction 0 with NULL pointer results in return
2191
    to the rectangular shape.
114 mikedld 2192
 
2193
======================================================================
2194
==================== Function 51 - create thread. ====================
2195
======================================================================
2196
Parameters:
118 diamond 2197
  * eax = 51 - function number
2198
  * ebx = 1 - unique subfunction
2199
  * ecx = address of thread entry point (starting eip)
2200
  * edx = pointer to thread stack (starting esp)
114 mikedld 2201
Returned value:
118 diamond 2202
  * eax = -1 - error (there is too many threads)
2203
  * otherwise eax = TID - thread identifier
2409 Serge 2204
    
114 mikedld 2205
 
2206
======================================================================
4199 mario79 2207
==================== Function 54, subfunction 0 ======================
2208
============== Get the number of slots in the clipboard. =============
2209
======================================================================
2210
Parameters:
2211
  * eax = 54 - function number
2212
  * ebx = 0 - subfunction number
2213
Returned value:
2214
  * eax = slots in the clipboard
2215
  * eax = -1 - main list area not found
2216
 
2217
======================================================================
2218
==================== Function 54, subfunction 1 ======================
2219
================= Read the data from the clipboard. ==================
2220
======================================================================
2221
Parameters:
2222
  * eax = 54 - function number
2223
  * ebx = 1 - subfunction number
2224
  * eсx = slot number
2225
Returned value:
2226
  * eax = if successful - pointer to a memory with data
2227
  * eax = 1 - error
2228
  * eax = -1 - main list area not found
2229
 
2230
======================================================================
2231
==================== Function 54, subfunction 2 ======================
2232
================= Write the data to the clipboard. ===================
2233
======================================================================
2234
Parameters:
2235
  * eax = 54 - function number
2236
  * ebx = 2 - subfunction number
2237
  * eсx = the number of bytes to be copied
2238
  * edx = a pointer to a buffer for data to be copied
2239
Returned value:
2240
  * eax = 0 - success
2241
  * eax = 1 - error
2242
  * eax = -1 - main list area not found
2243
 
2244
======================================================================
2245
===================== Function 54, subfunction 3 =====================
2246
================ Delete the last slot in the clipboard ===============
2247
======================================================================
2248
Parameters:
2249
  * eax = 54 - function number
2250
  * ebx = 3 - subfunction number
2251
Returned value:
2252
  * eax = 0 - success
2253
  * eax = 1 - error
2254
  * eax = -1 - main list area not found
2255
 
2256
======================================================================
2257
===================== Function 54, subfunction 4 =====================
2258
===================== Alarm reset the lock buffer ====================
2259
======================================================================
2260
Parameters:
2261
  * eax = 54 - function number
2262
  * ebx = 4 - subfunction number
2263
Returned value:
2264
  * eax = 0 - success
2265
  * eax = -1 - main list area not found or no blocking
2266
Remarks:
2267
  * Used in exceptional cases, where no responsible or killed
2268
    application blocked the clipboard operations.
2269
 
2270
======================================================================
2409 Serge 2271
 Function 55, subfunction 55 - begin to play data on built-in speaker.
114 mikedld 2272
======================================================================
2273
Parameters:
118 diamond 2274
  * eax = 55 - function number
2275
  * ebx = 55 - subfunction number
2276
  * esi = pointer to data
114 mikedld 2277
Returned value:
118 diamond 2278
  * eax = 0 - success
2279
  * eax = 55 - error (speaker is off or busy)
2280
Data is an array of items with variable length.
2281
Format of each item is defined by first byte:
114 mikedld 2282
  * 0 = end of data
118 diamond 2283
  * 1..0x80 = sets sound duration on 1/100 of second; sound note
2284
    is defined by immediate value of frequency
2285
    * following word (2 bytes) contains frequency divider;
2286
      frequency is defined as 1193180/divider
114 mikedld 2287
  * 0x81 = invalid
118 diamond 2288
  * 0x82..0xFF = note is defined by octave and number:
2289
    * duration in 1/100 of second = (first byte)-0x81
114 mikedld 2290
    * there is one more byte;
118 diamond 2291
    * (second byte)=0xFF - delay
2292
    * otherwise it looks like a*0x10+b, where b=number of the note in
2293
      an octave from 1 to 12, a=number of octave (beginning from 0)
114 mikedld 2294
Remarks:
118 diamond 2295
  * Speaker play can be disabled/enabled by
2296
    subfunction 8 of function 18.
2297
  * Function returns control, having informed the system
2298
    an information on request. Play itself goes independently from
2299
    the program.
2300
  * The data must be kept in the memory at least up to the end
2301
    of play.
114 mikedld 2302
 
2303
======================================================================
641 diamond 2304
======================= Function 57 - PCI BIOS. ======================
2305
======================================================================
2306
Parameters:
2307
  * eax = 57 - function number
2308
  * ebp corresponds to al in PCI BIOS specification
2309
  * other registers are set according to PCI BIOS specification
2310
Returned value:
2311
  * CF is undefined
2312
  * other registers are set according to PCI BIOS specification
2313
Remarks:
2314
  * Many effects of this function can be also achieved with
2315
    corresponding subfunctions of function 62.
2316
  * The function calls PCI32 BIOS extension, documented e.g. in
2317
    http://alpha1.dyns.net/files/PCI/bios21.pdf.
2318
  * If BIOS does not support this extension, its behavior is emulated
2319
    (through kernel-mode analogues of subfunctions of function 62).
2320
 
2321
======================================================================
118 diamond 2322
========== Function 60 - Inter Process Communication (IPC). ==========
114 mikedld 2323
======================================================================
118 diamond 2324
IPC is used for message dispatching from one process/thread to
2325
another. Previously it is necessary to agree how to interpret
114 mikedld 2326
the concrete message.
2327
 
118 diamond 2328
----------- Subfunction 1 - set the area for IPC receiving -----------
2329
Is called by process-receiver.
114 mikedld 2330
Parameters:
118 diamond 2331
  * eax = 60 - function number
2332
  * ebx = 1 - subfunction number
2333
  * ecx = pointer to the buffer
2334
  * edx = size of the buffer
114 mikedld 2335
Returned value:
118 diamond 2336
  * eax = 0 - always success
2337
Format of IPC-buffer:
2338
  * +0: dword: if nonzero, buffer is considered locked;
2339
    lock/unlock the buffer, when you work with it and need that
2340
    buffer data are not changed from outside (no new messages)
114 mikedld 2341
  * +4: dword: occupied place in the buffer (in bytes)
2342
  * +8: first message
2343
  * +8+n: second message
2344
  * ...
118 diamond 2345
Format of a message:
2346
  * +0: dword: PID of sender
2347
  * +4: dword: message length (not including this header)
2348
  * +8: n*byte: message data
114 mikedld 2349
 
118 diamond 2350
------------------ Subfunction 2 - send IPC message ------------------
2351
Is called by process-sender.
114 mikedld 2352
Parameters:
118 diamond 2353
  * eax = 60 - function number
2354
  * ebx = 2 - subfunction number
114 mikedld 2355
  * ecx = PID of receiver
118 diamond 2356
  * edx = pointer to the message data
2357
  * esi = message length (in bytes)
114 mikedld 2358
Returned value:
118 diamond 2359
  * eax = 0 - success
2360
  * eax = 1 - the receiver has not defined buffer for IPC messages
2361
    (can be, still have no time,
2362
    and can be, this is not right process)
2363
  * eax = 2 - the receiver has blocked IPC-buffer; try to wait a bit
2364
  * eax = 3 - overflow of IPC-buffer of the receiver
114 mikedld 2365
  * eax = 4 - process/thread with such PID does not exist
2366
Remarks:
118 diamond 2367
  * Immediately after writing of IPC-message to the buffer the system
2368
    sends to the receiver the event with code 7 (see event codes).
114 mikedld 2369
 
2370
======================================================================
118 diamond 2371
==== Function 61 - get parameters for the direct graphics access. ====
114 mikedld 2372
======================================================================
118 diamond 2373
The data of the graphics screen (the memory area which displays
2374
screen contents) are accessible to a program directly, without
2375
any system calls, through the selector gs:
1662 Nasarus 2376
	mov	eax, [gs:0]
118 diamond 2377
places in eax the first dword of the buffer, which contains
2378
information on color of the left upper point (and, possibly, colors
2379
of several following).
1662 Nasarus 2380
	mov	[gs:0], eax
118 diamond 2381
by work in VESA modes with LFB sets color of the left upper point
2382
(and, possibly, colors of several following).
2383
To interpret the data of graphics screen program needs to know
2384
some parameters, returning by this function.
114 mikedld 2385
Remarks:
118 diamond 2386
  * Graphics parameters changes very seldom at work,
2387
    namely, only in cases, when user works with the application VRR.
2388
  * At videomode change the system redraws all windows (event
2389
    with code 1) and redraws the background (event 5).
2390
    Same events occur in other cases too, which meet much more often,
2391
    than videomode change.
2392
  * By operation in videomodes with LFB the selector gs points to
2393
    LFB itself, so reading/writing on gs result directly in
2394
    change of screen contents. By operation in videomodes without
2395
    LFB gs points to some data area in the kernel, and all functions
2396
    of screen output fulfil honesty double operation on writing
2397
    directly to the screen and writing to this buffer. In result
2398
    at reading contents of this buffer the results correspond to
2399
    screen contents (with, generally speaking, large color
2400
    resolution), and writing is ignored.
2401
    One exception is the mode 320*200, for which main loop of the
2402
    system thread updates the screen according to mouse movements.
114 mikedld 2403
 
2404
------------------------- Screen resolution --------------------------
2405
Parameters:
118 diamond 2406
  * eax = 61 - function number
2407
  * ebx = 1 - subfunction number
114 mikedld 2408
Returned value:
118 diamond 2409
  * eax = [resolution on x axis]*65536 + [resolution on y axis]
114 mikedld 2410
Remarks:
118 diamond 2411
  * One can use function 14 paying attention that
2412
    it returns sizes on 1 pixel less. It is fully equivalent way.
114 mikedld 2413
 
118 diamond 2414
---------------------- Number of bits per pixel ----------------------
114 mikedld 2415
Parameters:
118 diamond 2416
  * eax = 61 - function number
2417
  * ebx = 2 - subfunction number
114 mikedld 2418
Returned value:
118 diamond 2419
  * eax = number of bits per pixel (24 or 32)
114 mikedld 2420
 
118 diamond 2421
-------------------- Number of bytes per scanline --------------------
114 mikedld 2422
Parameters:
118 diamond 2423
  * eax = 61 - function number
2424
  * ebx = 3 - subfunction number
114 mikedld 2425
Returned value:
118 diamond 2426
  * eax = number of bytes occupied by one scanline
114 mikedld 2427
    (horizontal line on the screen)
2428
 
2429
======================================================================
118 diamond 2430
===== Function 62, subfunction 0 - get version of PCI-interface. =====
114 mikedld 2431
======================================================================
2432
Parameters:
118 diamond 2433
  * eax = 62 - function number
2434
  * bl = 0 - subfunction number
114 mikedld 2435
Returned value:
118 diamond 2436
  * eax = -1 - PCI access is disabled; otherwise
2437
  * ah.al = version of PCI-interface (ah=version, al=subversion)
2438
  * high word of eax is zeroed
114 mikedld 2439
Remarks:
118 diamond 2440
  * Previously low-level access to PCI for applications must be
2441
    enabled by subfunction 12 of function 21.
2442
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 2443
 
2444
======================================================================
118 diamond 2445
==== Function 62, subfunction 1 - get number of the last PCI-bus. ====
114 mikedld 2446
======================================================================
2447
Parameters:
118 diamond 2448
  * eax = 62 - function number
2449
  * bl = 1 - subfunction number
114 mikedld 2450
Returned value:
118 diamond 2451
  * eax = -1 - access to PCI is disabled; otherwise
2452
  * al = number of the last PCI-bus; other bytes of eax are destroyed
114 mikedld 2453
Remarks:
118 diamond 2454
  * Previously low-level access to PCI for applications must be
2455
    enabled by subfunction 12 of function 21.
2456
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 2457
 
2458
======================================================================
118 diamond 2459
===================== Function 62, subfunction 2 =====================
2460
===== Get mechanism of addressing to the PCI configuration space. ====
114 mikedld 2461
======================================================================
2462
Parameters:
118 diamond 2463
  * eax = 62 - function number
2464
  * bl = 2 - subfunction number
114 mikedld 2465
Returned value:
118 diamond 2466
  * eax = -1 - access to PCI is disabled; otherwise
2467
  * al = mechanism (1 or 2); other bytes of eax are destroyed
114 mikedld 2468
Remarks:
118 diamond 2469
  * Previously low-level access to PCI for applications must be
2470
    enabled by subfunction 12 of function 21.
2471
  * Addressing mechanism is selected depending on
2472
    equipment characteristics.
2473
  * Subfunctions of read and write work automatically
2474
    with the selected mechanism.
114 mikedld 2475
 
2476
======================================================================
118 diamond 2477
======== Function 62, subfunctions 4,5,6 - read PCI-register. ========
114 mikedld 2478
======================================================================
2479
Parameters:
118 diamond 2480
  * eax = 62 - function number
2481
  * bl = 4 - read byte
2482
  * bl = 5 - read word
2483
  * bl = 6 - read dword
114 mikedld 2484
  * bh = number of PCI-bus
118 diamond 2485
  * ch = dddddfff, where ddddd = number of the device on the bus,
2486
    fff = function number of device
2487
  * cl = number of register (must be even for bl=5,
2488
    divisible by 4 for bl=6)
114 mikedld 2489
Returned value:
118 diamond 2490
  * eax = -1 - error (access to PCI is disabled or parameters
2491
    are not supported); otherwise
2492
  * al/ax/eax (depending on requested size) contains the data;
2493
    the other part of register eax is destroyed
114 mikedld 2494
Remarks:
118 diamond 2495
  * Previously low-level access to PCI for applications must be
2496
    enabled by subfunction 12 of function 21.
2497
  * Access mechanism 2 supports only 16 devices on a bus and ignores
2498
    function number. To get access mechanism use subfunction 2.
2499
  * Some registers are standard and exist for all devices, some are
2500
    defined by the concrete device. The list of registers of the
2501
    first type can be found e.g. in famous
114 mikedld 2502
    Interrupt List by Ralf Brown
2503
    (http://www.pobox.com/~ralf/files.html,
2504
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/);
118 diamond 2505
    registers of the second type must be listed
2506
    in the device documentation.
114 mikedld 2507
 
2508
======================================================================
118 diamond 2509
====== Function 62, subfunctions 8,9,10 - write to PCI-register. =====
114 mikedld 2510
======================================================================
2511
Parameters:
118 diamond 2512
  * eax = 62 - function number
2513
  * bl = 8 - write byte
2514
  * bl = 9 - write word
2515
  * bl = 10 - write dword
114 mikedld 2516
  * bh = number of PCI-bus
118 diamond 2517
  * ch = dddddfff, where ddddd = number of the device on the bus,
2518
    fff = function number of device
2519
  * cl = number of register (must be even for bl=9,
2520
    divisible by 4 for bl=10)
2521
  * dl/dx/edx (depending on requested size) contatins
2522
    the data to write
114 mikedld 2523
Returned value:
118 diamond 2524
  * eax = -1 - error (access to PCI is disabled or parameters
2525
    are not supported)
2526
  * eax = 0 - success
114 mikedld 2527
Remarks:
118 diamond 2528
  * Previously low-level access to PCI for applications must be
2529
    enabled by subfunction 12 of function 21.
2530
  * Access mechanism 2 supports only 16 devices on a bus and ignores
2531
    function number. To get access mechanism use subfunction 2.
2532
  * Some registers are standard and exist for all devices, some are
2533
    defined by the concrete device. The list of registers of the
2534
    first type can be found e.g. in famous Interrupt List by
2535
    Ralf Brown; registers of the second type must be listed
2536
    in the device documentation.
114 mikedld 2537
 
2538
======================================================================
118 diamond 2539
============== Function 63 - work with the debug board. ==============
114 mikedld 2540
======================================================================
118 diamond 2541
The debug board is the global system buffer (with the size
499 diamond 2542
1024 bytes), to which any program can write (generally speaking,
118 diamond 2543
arbitrary) data and from which other program can read these data.
2544
By the agreement written data are text strings interpreted as
2545
debug messages on a course of program execution. The kernel in
2546
some situations also writes to the debug board information on
2547
execution of some functions; by the agreement kernel messages
2548
begins from the prefix "K : ".
2549
For view of the debug board the application 'board' was created,
2550
which reads data from the buffer and displays them in its window.
2551
'board' interpretes the sequence of codes 13,10 as newline.
2552
A character with null code in an end of line is not necessary,
114 mikedld 2553
but also does not prevent.
118 diamond 2554
Because debugger has been written, the value of the debug board
2555
has decreased, as debugger allows to inspect completely a course of
2556
program execution without any efforts from the direction of program
2557
itself. Nevertheless in some cases the debug board is still useful.
114 mikedld 2558
 
118 diamond 2559
----------------------------- Write byte -----------------------------
114 mikedld 2560
Parameters:
118 diamond 2561
  * eax = 63 - function number
2562
  * ebx = 1 - subfunction number
2563
  * cl = data byte
114 mikedld 2564
Returned value:
2565
  * function does not return value
2566
Remarks:
118 diamond 2567
  * Byte is written to the buffer. Buffer size is 512 bytes.
2568
    At buffer overflow all obtained data are lost.
2569
  * For output to the debug board of more complicated objects
2570
    (strings, numbers) it is enough to call this function in cycle.
2571
    It is possible not to write the appropriate code manually and use
2572
    file 'debug.inc', which is included into the distributive.
114 mikedld 2573
 
118 diamond 2574
----------------------------- Read byte ------------------------------
2575
Takes away byte from the buffer.
114 mikedld 2576
Parameters:
118 diamond 2577
  * eax = 63 - function number
2578
  * ebx = 2 - subfunction number
114 mikedld 2579
Returned value:
118 diamond 2580
  * eax = ebx = 0 - the buffer is empty
2581
  * eax = byte, ebx = 1 - byte was successfully read
114 mikedld 2582
 
2583
======================================================================
118 diamond 2584
============== Function 64 - resize application memory. ==============
114 mikedld 2585
======================================================================
2586
Parameters:
118 diamond 2587
  * eax = 64 - function number
2588
  * ebx = 1 - unique subfunction
2589
  * ecx = new memory size
114 mikedld 2590
Returned value:
118 diamond 2591
  * eax = 0 - success
2592
  * eax = 1 - not enough memory
114 mikedld 2593
Remarks:
193 diamond 2594
  * There is another way to dynamically allocate/free memory -
2595
    subfunctions 11, 12, 13 of function 68.
2596
  * The function cannot be used together with 68.11, 68.12, 68.13.
2597
    The function call will be ignored after creation of process heap
2598
    with function 68.11.
114 mikedld 2599
 
2600
======================================================================
283 diamond 2601
======== Function 65 - draw image with palette in the window. ========
2602
======================================================================
2603
Parameters:
2604
  * eax = 65 - function number
2605
  * ebx = pointer to the image
2606
  * ecx = [size on axis x]*65536 + [size on axis y]
2607
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
2730 dunkaist 2608
  * esi = number of bits per pixel, must be 1,2,4,8,9,15,16,24 or 32;
1018 diamond 2609
  * edi = pointer to palette (2 to the power esi colors 0x00RRGGBB);
2610
          ignored when esi > 8
314 diamond 2611
  * ebp = offset of next row data relative to previous row data
283 diamond 2612
Returned value:
2613
  * function does not return value
2614
Remarks:
2615
  * Coordinates of the image are coordinates of the upper left corner
2616
    of the image relative to the window.
1018 diamond 2617
  * Format of image with 1 bit per pixel: each byte of image
2618
    (possibly excluding last bytes in rows), contains information on
2619
    the color of 8 pixels, MSB corresponds to first pixel.
2620
  * Format of image with 2 bits per pixel: each byte of image
2621
    (possibly excluding last bytes in rows), contains information on
2622
    the color of 4 pixels, two MSBs correspond to first pixel.
2623
  * Format of image with 4 bits per pixel: each byte of image
2624
    excluding last bytes in rows (if width is odd) contains
2625
    information on the color of 2 pixels, high-order tetrad
2626
    corresponds to first pixel.
2627
  * Format of image with 8 bits per pixel: each byte of image is
2628
    index in the palette.
2730 dunkaist 2629
  * Format of image with 9 bits per pixel: array of one byte values;
2630
    each byte (8 bit) represents the intensity of gray for one pixel;
2631
    this format is equal to 8bpp without palette.
1018 diamond 2632
  * Format of image with 15 bits per pixel: the color of each pixel
2633
    is coded as (bit representation) 0RRRRRGGGGGBBBBB - 5 bits per
2634
    each color.
2635
  * Format of image with 16 bits per pixel: the color of each pixel
2636
    is coded as RRRRRGGGGGGBBBBB (5+6+5).
2637
  * Format of image with 24 bits per pixel: the color of each pixel
2638
    is coded as 3 bytes - sequentially blue, green, red components.
2639
  * Format of image with 32 bits per pixel: similar to 24, but
2640
    one additional ignored byte is present.
314 diamond 2641
  * The call to function 7 is equivalent to call to this function
2642
    with esi=24, ebp=0.
283 diamond 2643
 
2644
======================================================================
118 diamond 2645
================== Function 66 - work with keyboard. =================
114 mikedld 2646
======================================================================
118 diamond 2647
The input mode influences results of reading keys by function 2.
2648
When a program loads, ASCII input mode is set for it.
114 mikedld 2649
 
118 diamond 2650
-------------- Subfunction 1 - set keyboard input mode. --------------
114 mikedld 2651
Parameters:
118 diamond 2652
  * eax = 66 - function number
2653
  * ebx = 1 - subfunction number
114 mikedld 2654
  * ecx = mode:
2655
    * 0 = normal (ASCII-characters)
2656
    * 1 = scancodes
2657
Returned value:
2658
  * function does not return value
2659
 
118 diamond 2660
-------------- Subfunction 2 - get keyboard input mode. --------------
114 mikedld 2661
Parameters:
118 diamond 2662
  * eax = 66 - function number
2663
  * ebx = 2 - subfunction number
114 mikedld 2664
Returned value:
2665
  * eax = current mode
2666
 
118 diamond 2667
------------ Subfunction 3 - get status of control keys. -------------
114 mikedld 2668
Parameters:
118 diamond 2669
  * eax = 66 - function number
2670
  * ebx = 3 - subfunction number
114 mikedld 2671
Returned value:
2672
  * eax = bit mask:
3355 mario79 2673
  * bit 0  (mask 1): left Shift is pressed
2674
  * bit 1  (mask 2): right Shift is pressed
2675
  * bit 2  (mask 4): left Ctrl is pressed
2676
  * bit 3  (mask 8): right Ctrl is pressed
2677
  * bit 4  (mask 0x10): left Alt is pressed
2678
  * bit 5  (mask 0x20): right Alt is pressed
2679
  * bit 6  (mask 0x40): CapsLock is on
2680
  * bit 7  (mask 0x80): NumLock is on
2681
  * bit 8  (mask 0x100): ScrollLock is on
2682
  * bit 9  (mask 0x200): left Win is pressed
2683
  * bit 10 (mask 0x400): right Win is pressed
118 diamond 2684
  * other bits are cleared
114 mikedld 2685
 
118 diamond 2686
-------------- Subfunction 4 - set system-wide hotkey. ---------------
2687
When hotkey is pressed, the system notifies only those applications,
2688
which have installed it; the active application (which receives
2689
all normal input) does not receive such keys.
2690
The notification consists in sending event with the code 2.
2691
Reading hotkey is the same as reading normal key - by function 2.
114 mikedld 2692
Parameters:
118 diamond 2693
  * eax = 66 - function number
2694
  * ebx = 4 - subfunction number
2695
  * cl determines key scancode;
2696
    use cl=0 to give combinations such as Ctrl+Shift
2697
  * edx = 0xXYZ determines possible states of control keys:
2698
    * Z (low 4 bits) determines state of LShift and RShift:
2699
      * 0 = no key must be pressed;
2700
      * 1 = exactly one key must be pressed;
2701
      * 2 = both keys must be pressed;
2702
      * 3 = must be pressed LShift, but not RShift;
2703
      * 4 = must be pressed RShift, but not LShift
2704
    * Y - similar for LCtrl and RCtrl;
2705
    * X - similar for LAlt and RAlt
114 mikedld 2706
Returned value:
118 diamond 2707
  * eax=0 - success
2708
  * eax=1 - too mant hotkeys (maximum 256 are allowed)
114 mikedld 2709
Remarks:
118 diamond 2710
  * Hotkey can work either at pressing or at release. Release
2711
    scancode of a key is more on 128 than pressing scancode
2712
    (i.e. high bit is set).
2713
  * Several applications can set the same combination;
2714
    all such applications will be informed on pressing
2715
    such combination.
114 mikedld 2716
 
118 diamond 2717
-------------- Subfunction 5 - delete installed hotkey. --------------
114 mikedld 2718
Parameters:
118 diamond 2719
  * eax = 66 - function number
2720
  * ebx = 5 - subfunction number
2721
  * cl = scancode of key and edx = 0xXYZ the same as in subfunction 4
114 mikedld 2722
Returned value:
118 diamond 2723
  * eax = 0 - success
114 mikedld 2724
  * eax = 1 - there is no such hotkey
2725
Remarks:
118 diamond 2726
  * When a process/thread terminates, all hotkey installed by it are
2727
    deleted.
2728
  * The call to this subfunction does not affect other applications.
2729
    If other application has defined the same combination, it will
2730
    still receive notices.
114 mikedld 2731
 
2709 mario79 2732
--------------- Subfunction 6 - block the normal input. --------------
2733
Parameters:
2734
  * eax = 66 - function number
2735
  * ebx = 6 - subfunction number
2736
Returned value:
2737
  * function does not return value
2738
Remarks:
2739
  * Blocking the normal keyboard input for installed hotkeys
2740
  * To emulate a mouse via the keyboard, the application MOUSEMUL
2741
 
2742
------------ Subfunction 7 - unlock the normal input. ----------------
2743
Parameters:
2744
  * eax = 66 - function number
2745
  * ebx = 7 - subfunction number
2746
Returned value:
2747
  * function does not return value
2748
Remarks:
2749
  * Unlocking the results of the f. 66.6
2750
  * To emulate a mouse via the keyboard, the application MOUSEMUL
2751
 
114 mikedld 2752
======================================================================
118 diamond 2753
========= Function 67 - change position/sizes of the window. =========
114 mikedld 2754
======================================================================
2755
Parameters:
118 diamond 2756
  * eax = 67 - function number
114 mikedld 2757
  * ebx = new x-coordinate of the window
2758
  * ecx = new y-coordinate of the window
2759
  * edx = new x-size of the window
2760
  * esi = new y-size of the window
2761
Returned value:
2762
  * function does not return value
2763
Remarks:
118 diamond 2764
  * The value -1 for a parameter means "do not change"; e.g. to move
2765
    the window without resizing it is possible to specify edx=esi=-1.
2766
  * Previously the window must be defined by function 0.
114 mikedld 2767
    It sets initial coordinates and sizes of the window.
118 diamond 2768
  * Sizes of the window are understood in sense of function 0,
2769
    that is one pixel less than real sizes.
2770
  * The function call for maximized windows is simply ignored.
2771
  * For windows of appropriate styles position and/or sizes can be
2772
    changed by user; current position and sizes can be obtained by
2773
    call to function 9.
2774
  * The function sends to the window redraw event (with the code 1).
114 mikedld 2775
 
2776
======================================================================
118 diamond 2777
====== Function 68, subfunction 0 - get the task switch counter. =====
114 mikedld 2778
======================================================================
2779
Parameters:
118 diamond 2780
  * eax = 68 - function number
2781
  * ebx = 0 - subfunction number
114 mikedld 2782
Returned value:
118 diamond 2783
  * eax = number of task switches from the system booting
2784
    (modulo 2^32)
114 mikedld 2785
 
2786
======================================================================
118 diamond 2787
======= Function 68, subfunction 1 - switch to the next thread. ======
114 mikedld 2788
======================================================================
118 diamond 2789
The function completes the current time slice allocated to the
2790
thread and switches to the next. (Which thread in which process
2791
will be next, is unpredictable). Later, when execution queue
2792
will reach the current thread, execution will be continued.
114 mikedld 2793
Parameters:
118 diamond 2794
  * eax = 68 - function number
2795
  * ebx = 1 - subfunction number
114 mikedld 2796
Returned value:
2797
  * function does not return value
2798
 
2799
======================================================================
118 diamond 2800
============= Function 68, subfunction 2 - cache + rdpmc. ============
114 mikedld 2801
======================================================================
2802
Parameters:
118 diamond 2803
  * eax = 68 - function number
2804
  * ebx = 2 - subfunction number
2805
  * ecx = required action:
2806
    * ecx = 0 - enable instruction 'rdpmc'
2807
      (ReaD Performance-Monitoring Counters) for applications
2808
    * ecx = 1 - find out whether cache is disabled/enabled
2809
    * ecx = 2 - enable cache
2810
    * ecx = 3 - disable cache
114 mikedld 2811
Returned value:
2812
  * for ecx=0:
118 diamond 2813
    * eax = the value of cr4
114 mikedld 2814
  * for ecx=1:
2815
    * eax = (cr0 and 0x60000000):
118 diamond 2816
    * eax = 0 - cache is on
2817
    * eax <> 0 - cache is off
114 mikedld 2818
  * for ecx=2 and ecx=3:
2819
    * function does not return value
2820
 
2821
======================================================================
2822
=========== Function 68, subfunction 3 - read MSR-register. ==========
2823
======================================================================
118 diamond 2824
MSR = Model Specific Register; the complete list of MSR-registers
2825
of a processor is included to the documentation on it (for example,
2826
IA-32 Intel Architecture Software Developer's Manual,
2827
Volume 3, Appendix B); each processor family has its own subset
2828
of the MSR-registers.
114 mikedld 2829
Parameters:
118 diamond 2830
  * eax = 68 - function number
2831
  * ebx = 3 - subfunction number
2832
  * ecx is ignored
2833
  * edx = MSR address
114 mikedld 2834
Returned value:
118 diamond 2835
  * ebx:eax = high:low dword of the result
114 mikedld 2836
Remarks:
118 diamond 2837
  * If ecx contains nonexistent or not implemented for this processor
2838
    MSR, processor will generate an exception in the kernel, which
2839
    will kill the thread.
2840
  * Previously it is necessary to check, whether MSRs are supported
2841
    as a whole, with the instruction 'cpuid'. Otherwise processor
2842
    will generate other exception in the kernel, which will anyway
2843
    kill the thread.
114 mikedld 2844
 
2845
======================================================================
118 diamond 2846
========= Function 68, subfunction 4 - write to MSR-register. ========
114 mikedld 2847
======================================================================
118 diamond 2848
MSR = Model Specific Register; the complete list of MSR-registers
2849
of a processor is included to the documentation on it (for example,
2850
IA-32 Intel Architecture Software Developer's Manual,
2851
Volume 3, Appendix B); each processor family has its own subset
2852
of the MSR-registers.
114 mikedld 2853
Parameters:
118 diamond 2854
  * eax = 68 - function number
2855
  * ebx = 4 - subfunction number
2856
  * ecx is ignored
2857
  * edx = MSR address
2858
  * esi:edi = high:low dword
114 mikedld 2859
Returned value:
499 diamond 2860
  * function does not return value
2861
Remarks:
118 diamond 2862
  * If ecx contains nonexistent or not implemented for this processor
2863
    MSR, processor will generate an exception in the kernel, which
2864
    will kill the thread.
2865
  * Previously it is necessary to check, whether MSRs are supported
2866
    as a whole, with the instruction 'cpuid'. Otherwise processor
2867
    will generate other exception in the kernel, which will anyway
2868
    kill the thread.
114 mikedld 2869
 
2870
======================================================================
193 diamond 2871
======= Function 68, subfunction 11 - initialize process heap. =======
114 mikedld 2872
======================================================================
2873
Parameters:
118 diamond 2874
  * eax = 68 - function number
193 diamond 2875
  * ebx = 11 - subfunction number
114 mikedld 2876
Returned value:
193 diamond 2877
  * eax = 0 - failed
2878
  * otherwise size of created heap
114 mikedld 2879
Remarks:
193 diamond 2880
  * The function call initializes heap, from which one can in future
2881
    allocate and free memory blocks with subfunctions 12 and 13.
2882
    Heap size is equal to total amount of free application memory.
2883
  * The second function call from the same process results in
2884
    returning the size of the existing heap.
2885
  * After creation of the heap calls to function 64 will be ignored.
114 mikedld 2886
 
2887
======================================================================
193 diamond 2888
======== Function 68, subfunction 12 - allocate memory block. ========
114 mikedld 2889
======================================================================
2890
Parameters:
118 diamond 2891
  * eax = 68 - function number
193 diamond 2892
  * ebx = 12 - subfunction number
2893
  * ecx = required size in bytes
114 mikedld 2894
Returned value:
193 diamond 2895
  * eax = pointer to the allocated block
114 mikedld 2896
Remarks:
193 diamond 2897
  * Before this call one must initialize process heap by call to
2898
    subfunction 11.
2899
  * The function allocates an integer number of pages (4 Kb) in such
2900
    way that the real size of allocated block is more than or equal to
2901
    requested size.
114 mikedld 2902
 
2903
======================================================================
193 diamond 2904
========== Function 68, subfunction 13 - free memory block. ==========
114 mikedld 2905
======================================================================
2906
Parameters:
118 diamond 2907
  * eax = 68 - function number
193 diamond 2908
  * ebx = 13 - subfunction number
2909
  * ecx = pointer to the memory block
114 mikedld 2910
Returned value:
193 diamond 2911
  * eax = 1 - success
2912
  * eax = 0 - failed
114 mikedld 2913
Remarks:
448 diamond 2914
  * The memory block must have been allocated by subfunction 12
2915
    or subfunction 20.
114 mikedld 2916
 
2917
======================================================================
1074 Galkov 2918
===================== Function 68, subfunction 14 ====================
1662 Nasarus 2919
============ Wait for signal from another program/driver. ============
114 mikedld 2920
======================================================================
2921
Parameters:
118 diamond 2922
  * eax = 68 - function number
193 diamond 2923
  * ebx = 14 - subfunction number
1074 Galkov 2924
  * ecx = pointer to the buffer for information (24 bytes)
114 mikedld 2925
Returned value:
193 diamond 2926
  * buffer pointed to by ecx contains the following information:
1662 Nasarus 2927
    * +0: dword: identifier for following data of signal
2928
    * +4: dword: data of signal (20 bytes), format of which is defined
2929
          by the first dword
114 mikedld 2930
 
2931
======================================================================
193 diamond 2932
============= Function 68, subfunction 16 - load driver. =============
2933
======================================================================
2934
Parameters:
2935
  * eax = 68 - function number
2936
  * ebx = 16 - subfunction number
2937
  * ecx = pointer to ASCIIZ-string with driver name
2938
Returned value:
2939
  * eax = 0 - failed
2940
  * otherwise eax = driver handle
2941
Remarks:
2942
  * If the driver was not loaded yet, it is loaded;
2943
    if the driver was loaded yet, nothing happens.
2944
  * Driver name is case-sensitive.
2945
    Maximum length of the name is 16 characters, including
2946
    terminating null character, the rest is ignored.
346 diamond 2947
  * Driver ABC is loaded from file /rd/1/drivers/ABC.obj.
193 diamond 2948
 
2949
======================================================================
2950
============ Function 68, subfunction 17 - driver control. ===========
2951
======================================================================
2952
Parameters:
2953
  * eax = 68 - function number
2954
  * ebx = 17 - subfunction number
2955
  * ecx = pointer to the control structure:
2956
    * +0: dword: handle of driver
2957
    * +4: dword: code of driver function
2958
    * +8: dword: pointer to input data
2959
    * +12 = +0xC: dword: size of input data
2960
    * +16 = +0x10: dword: pointer to output data
2961
    * +20 = +0x14: dword: size of output data
2962
Returned value:
1662 Nasarus 2963
  * eax = determined by driver
193 diamond 2964
Remarks:
2965
  * Function codes and the structure of input/output data
2966
    are defined by driver.
2967
  * Previously one must obtain driver handle by subfunction 16.
2968
 
2969
======================================================================
277 diamond 2970
=============== Function 68, subfunction 19 - load DLL. ==============
2971
======================================================================
2972
Parameters:
2973
  * eax = 68 - function number
2974
  * ebx = 19 - subfunction number
2975
  * ecx = pointer to ASCIIZ-string with the full path to DLL
2976
Returned value:
2977
  * eax = 0 - failed
2978
  * otherwise eax = pointer to DLL export table
2979
Remarks:
2980
  * Export table is an array of structures of 2 dword's, terminated
2981
    by zero. The first dword in structure points to function name,
2982
    the second dword contains address of function.
2983
 
2984
======================================================================
448 diamond 2985
======= Function 68, subfunction 20 - reallocate memory block. =======
2986
======================================================================
2987
Parameters:
2988
  * eax = 68 - function number
2989
  * ebx = 20 - subfunction number
2990
  * ecx = new size in bytes
2991
  * edx = pointer to already allocated block
2992
Returned value:
2993
  * eax = pointer to the reallocated block, 0 = error
2994
Remarks:
2995
  * Before this call one must initialize process heap by call to
2996
    subfunction 11.
2997
  * The function allocates an integer number of pages (4 Kb) in such
2998
    way that the real size of allocated block is more than or equal to
2999
    requested size.
3000
  * If edx=0, the function call is equivalent to memory allocation
3001
    with subfunction 12. Otherwise the block at edx
3002
    must be allocated earlier with subfunction 12 or this subfunction.
3003
  * If ecx=0, the function frees memory block at edx and returns 0.
3004
  * The contents of the block are unchanged up to the shorter of
3005
    the new and old sizes.
3006
 
3007
======================================================================
2646 mario79 3008
=========== Function 68, subfunction 21 - load driver PE. ============
3009
======================================================================
3010
Parameters:
3011
  * eax = 68 - function number
3012
  * ebx = 21 - subfunction number
3013
  * ecx = pointer to ASCIIZ-string with driver name
2647 mario79 3014
  * edx = pointer to command line
2646 mario79 3015
Returned value:
3016
  * eax = 0 - failed
3017
  * otherwise eax = driver handle
3018
Remarks:
3019
  * If the driver was not loaded yet, it is loaded;
3020
    if the driver was loaded yet, nothing happens.
3021
 
3022
======================================================================
1662 Nasarus 3023
======== Function 68, subfunction 22 - open named memory area. =======
1077 Galkov 3024
======================================================================
3025
Parameters:
3026
  * eax = 68 - function number
1662 Nasarus 3027
  * ebx = 22 - subfunction number
3028
  * ecx = area name. Maximum of 31 characters with terminating zero
3029
  * edx = area size in bytes for SHM_CREATE and SHM_OPEN_ALWAYS
3030
  * esi = flags for open and access:
3031
    * SHM_OPEN        = 0x00 - open existing memory area. If an area
3032
                          with such name does not exist, the function
3033
                          will return error code 5.
3034
    * SHM_OPEN_ALWAYS = 0x04 - open existing or create new
3035
                          memory area.
3036
    * SHM_CREATE      = 0x08 - create new memory area. If an area
3037
                          with such name already exists, the function
3038
                          will return error code 10.
3039
    * SHM_READ        = 0x00 - only read access
3040
    * SHM_WRITE       = 0x01 - read and write access
3041
Returned value:
3042
  * eax = pointer to memory area, 0 if error has occured
3043
  * if new area is created (SHM_CREATE or SHM_OPEN_ALWAYS):
3044
    edx = 0 - success, otherwise - error code
3045
  * if existing area is opened (SHM_OPEN or SHM_OPEN_ALWAYS):
3046
    edx = error code (if eax=0) or area size in bytes
3047
Error codes:
3048
  * E_NOTFOUND = 5
3049
  * E_ACCESS = 10
3050
  * E_NOMEM = 30
3051
  * E_PARAM = 33
3052
Remarks:
3053
  * Before this call one must initialize process heap by call to
3054
    subfunction 11.
3055
  * If a new area is created, access flags set maximal rights
3056
    for other processes. An attempt from other process to open
3057
    with denied rights will fail with error code E_ACCESS.
3058
  * The process which has created an area always has write access.
3059
 
3060
======================================================================
3061
======= Function 68, subfunction 23 - close named memory area. =======
3062
======================================================================
3063
Parameters:
3064
  * eax = 68 - function number
3065
  * ebx = 23 - subfunction number
3066
  * ecx = area name. Maximum of 31 characters with terminating zero
3067
Returned value:
3068
  * eax destroyed
3069
Remarks:
3070
  * A memory area is physically freed (with deleting all data and
3071
    freeing physical memory), when all threads which have opened
3072
    this area will close it.
3073
  * When thread is terminating, all opened by it areas are closed.
3074
 
3075
======================================================================
3076
======== Function 68, subfunction 24 - set exception handler. ========
3077
======================================================================
3078
Parameters:
3079
  * eax = 68 - function number
1077 Galkov 3080
  * ebx = 24 - subfunction number
3081
  * ecx = address of the new exception handler
1662 Nasarus 3082
  * edx = the mask of handled exceptions
1077 Galkov 3083
Returned value:
3084
  * eax = address of the old exception handler (0, if it was not set)
1662 Nasarus 3085
  * ebx = the old mask of handled exceptions
1077 Galkov 3086
Remarks:
1662 Nasarus 3087
  * Bit number in mask of exceptions corresponds to exception number
3088
    in CPU-specification (Intel-PC). For example, FPU exceptions have
3089
    number 16 (#MF), and SSE exceptions - 19 (#XF).
3090
  * The current implementation ignores the inquiry for hook of 7
3091
    exception - the system handles #NM by its own.
3092
  * The exception handler is called with exception number as first
3093
    (and only) stack parameter. So, correct exit from the handler is
3094
    RET 4. It returns to the instruction, that caused the exception,
3095
    for faults, and to the next instruction for traps (see
3096
    classification of exceptions in CPU specification).
3097
  * When user handler receives control, the corresponding bit in
3098
    the exception mask is cleared. Raising this exception
3099
    in consequence leads to default handling, that is,
3100
    terminating the application in absence of debugger or
3101
    suspend with notification of debugger otherwise.
3102
  * After user handler completes critical operations, it can set
3103
    the corresponding bit in the exception mask with subfunction 25.
3104
    Also user handler is responsible for clearing exceptions flags in
3105
    FPU and/or SSE.
1077 Galkov 3106
 
3107
======================================================================
1662 Nasarus 3108
====== Function 68, subfunction 25 - set FPU exception handler. ======
1077 Galkov 3109
======================================================================
3110
Parameters:
3111
  * eax = 68 - function number
3112
  * ebx = 25 - subfunction number
3113
  * ecx = signal number
3114
  * edx = value of activity (0/1)
3115
Returned value:
1662 Nasarus 3116
  * eax = -1 - invalid signal number
3117
  * otherwise eax = old value of activity for this signal (0/1)
1077 Galkov 3118
Remarks:
1662 Nasarus 3119
  * In current implementation only mask for user excepton handler,
3120
    which has been previously set by subfunction 24,
3121
    is changed. Signal number corresponds to exception number.
1077 Galkov 3122
 
3123
======================================================================
3787 Serge 3124
====== Function 68, subfunction 26 - release memory pages ============
3125
======================================================================
3126
Parameters:
3127
  * eax = 68 - function number
3128
  * ebx = 26 - subfunction number
3129
  * ecx = pointer to the memory block, allocated by subfunction 12
3130
  * edx = offset from the block beginnings
3131
  * esi = the size of the region of memory to release, in bytes
3132
Remarks:
3133
  * function release range of pages from ecx+edx to ecx+edx+esi
3134
    and set virtual memory into reserved state.
3135
 
3136
======================================================================
3137
========== Function 68, subfunction 27 - load file ===================
3138
======================================================================
3139
Parameters:
3140
  * eax = 68 - function number
3141
  * ebx = 27 - subfunction number
3142
  * ecx = pointer to ASCIIZ-string with the filename
3143
Returned value:
3144
  * eax = pointer to the loaded file, or zero
3145
  * edx = size of the loaded file, or zero
3146
Remarks:
3147
  * function loads file and unpacks, if necessary
3148
 
3149
======================================================================
1662 Nasarus 3150
====================== Function 69 - debugging. ======================
114 mikedld 3151
======================================================================
118 diamond 3152
A process can load other process as debugged by set of corresponding
193 diamond 3153
bit by call to subfunction 7 of function 70.
118 diamond 3154
A process can have only one debugger; one process can debug some
3155
others. The system notifies debugger on events occuring with
3156
debugged process. Messages are written to the buffer defined by
114 mikedld 3157
subfunction 0.
118 diamond 3158
Format of a message:
3159
  * +0: dword: message code
3160
  * +4: dword: PID of debugged process
3161
  * +8: there can be additional data depending on message code
3162
Message codes:
114 mikedld 3163
  * 1 = exception
118 diamond 3164
    * in addition dword-number of the exception is given
3165
    * process is suspended
3166
  * 2 = process has terminated
3167
    * comes at any termination: both through the system function -1,
3168
      and at "murder" by any other process (including debugger itself)
114 mikedld 3169
  * 3 = debug exception int 1 = #DB
118 diamond 3170
    * in addition dword-image of the register DR6 is given:
3171
      * bits 0-3: condition of the corresponding breakpoint (set by
3172
        subfunction 9) is satisfied
3539 clevermous 3173
      * bit 14: exception has occured because of the trace mode
118 diamond 3174
        (flag TF is set TF)
3175
    * process is suspended
3176
When debugger terminates, all debugged processes are killed.
3177
If debugger does not want this, it must previously detach by
114 mikedld 3178
subfunction 3.
3179
 
1018 diamond 3180
All subfunctions are applicable only to processes/threads started
3181
from the current by function 70 with set debugging flag.
118 diamond 3182
Debugging of multithreaded programs is not supported yet.
3183
The full list of subfunctions:
3184
  * subfunction 0 - define data area for debug messages
3185
  * subfunction 1 - get contents of registers of debugged thread
3186
  * subfunction 2 - set contents of registers of debugged thread
3187
  * subfunction 3 - detach from debugged process
3188
  * subfunction 4 - suspend debugged thread
3189
  * subfunction 5 - resume debugged thread
3190
  * subfunction 6 - read from the memory of debugged process
3191
  * subfunction 7 - write to the memory of debugged process
3192
  * subfunction 8 - terminate debugged thread
3193
  * subfunction 9 - set/clear hardware breakpoint
114 mikedld 3194
 
3195
======================================================================
118 diamond 3196
= Function 69, subfunction 0 - define data area fror debug messages. =
114 mikedld 3197
======================================================================
3198
Parameters:
118 diamond 3199
  * eax = 69 - function number
3200
  * ebx = 0 - subfunction number
114 mikedld 3201
  * ecx = pointer
3202
Format of data area:
118 diamond 3203
  * +0: dword: N = buffer size (not including this header)
3204
  * +4: dword: occupied place
114 mikedld 3205
  * +8: N*byte: buffer
3206
Returned value:
3207
  * function does not return value
3208
Remarks:
118 diamond 3209
  * If the size field is negative, the buffer is considered locked
3210
    and at arrival of new message the system will wait.
3211
    For synchronization frame all work with the buffer by operations
3212
    lock/unlock
1662 Nasarus 3213
    	neg	[bufsize]
118 diamond 3214
  * Data in the buffer are considered as array of items with variable
3215
    length - messages. Format of a message is explained in
3216
    general description.
114 mikedld 3217
 
3218
======================================================================
118 diamond 3219
===================== Function 69, subfunction 1 =====================
3220
============ Get contents of registers of debugged thread. ===========
114 mikedld 3221
======================================================================
3222
Parameters:
118 diamond 3223
  * eax = 69 - function number
3224
  * ebx = 1 - subfunction number
114 mikedld 3225
  * ecx = thread identifier
118 diamond 3226
  * edx = size of context structure, must be 0x28=40 bytes
3227
  * esi = pointer to context structure
114 mikedld 3228
Returned value:
3229
  * function does not return value
118 diamond 3230
Format of context structure: (FPU is not supported yet)
114 mikedld 3231
  * +0: dword: eip
3232
  * +4: dword: eflags
3233
  * +8: dword: eax
3234
  * +12 = +0xC: dword: ecx
3235
  * +16 = +0x10: dword: edx
3236
  * +20 = +0x14: dword: ebx
3237
  * +24 = +0x18: dword: esp
3238
  * +28 = +0x1C: dword: ebp
3239
  * +32 = +0x20: dword: esi
3240
  * +36 = +0x24: dword: edi
3241
Remarks:
118 diamond 3242
  * If the thread executes code of ring-0, the function returns
3243
    contents of registers of ring-3.
3244
  * Process must be loaded for debugging (as is shown in
3245
    general description).
114 mikedld 3246
 
3247
======================================================================
118 diamond 3248
===================== Function 69, subfunction 2 =====================
3249
============ Set contents of registers of debugged thread. ===========
114 mikedld 3250
======================================================================
3251
Parameters:
118 diamond 3252
  * eax = 69 - function number
3253
  * ebx = 2 - subfunction number
114 mikedld 3254
  * ecx = thread identifier
118 diamond 3255
  * edx = size of context structure, must be 0x28=40 bytes
114 mikedld 3256
Returned value:
3257
  * function does not return value
118 diamond 3258
Format of context structure is shown in the description of
3259
subfunction 1.
114 mikedld 3260
Remarks:
118 diamond 3261
  * If the thread executes code of ring-0, the function returns
3262
    contents of registers of ring-3.
3263
  * Process must be loaded for debugging (as is shown in
3264
    general description).
114 mikedld 3265
 
3266
======================================================================
118 diamond 3267
===== Function 69, subfunction 3 - detach from debugged process. =====
114 mikedld 3268
======================================================================
3269
Parameters:
118 diamond 3270
  * eax = 69 - function number
3271
  * ebx = 3 - subfunction number
114 mikedld 3272
  * ecx = identifier
3273
Returned value:
3274
  * function does not return value
3275
Remarks:
118 diamond 3276
  * If the process was suspended, it resumes execution.
114 mikedld 3277
 
3278
======================================================================
1018 diamond 3279
======== Function 69, subfunction 4 - suspend debugged thread. =======
114 mikedld 3280
======================================================================
3281
Parameters:
118 diamond 3282
  * eax = 69 - function number
3283
  * ebx = 4 - subfunction number
3284
  * ecx = thread identifier
114 mikedld 3285
Returned value:
3286
  * function does not return value
1018 diamond 3287
Remarks:
3288
  * Process must be loaded for debugging (as is shown in
3289
    general description).
114 mikedld 3290
 
3291
======================================================================
1018 diamond 3292
======== Function 69, subfunction 5 - resume debugged thread. ========
114 mikedld 3293
======================================================================
3294
Parameters:
118 diamond 3295
  * eax = 69 - function number
3296
  * ebx = 5 - subfunction number
3297
  * ecx = thread identifier
114 mikedld 3298
Returned value:
3299
  * function does not return value
1018 diamond 3300
Remarks:
3301
  * Process must be loaded for debugging (as is shown in
3302
    general description).
114 mikedld 3303
 
3304
======================================================================
118 diamond 3305
= Fucntion 69, subfunction 6 - read from memory of debugged process. =
114 mikedld 3306
======================================================================
3307
Parameters:
118 diamond 3308
  * eax = 69 - function number
3309
  * ebx = 6 - subfunction number
114 mikedld 3310
  * ecx = identifier
118 diamond 3311
  * edx = number of bytes to read
3312
  * esi = address in the memory of debugged process
3313
  * edi = pointer to buffer for data
114 mikedld 3314
Returned value:
118 diamond 3315
  * eax = -1 at an error (invalid PID or buffer)
3316
  * otherwise eax = number of read bytes (possibly, 0,
3317
    if esi is too large)
114 mikedld 3318
Remarks:
118 diamond 3319
  * Process must be loaded for debugging (as is shown in
3320
    general description).
114 mikedld 3321
 
3322
======================================================================
118 diamond 3323
== Function 69, subfunction 7 - write to memory of debugged process. =
114 mikedld 3324
======================================================================
3325
Parameters:
118 diamond 3326
  * eax = 69 - function number
3327
  * ebx = 7 - subfunction number
114 mikedld 3328
  * ecx = identifier
118 diamond 3329
  * edx = number of bytes to write
3330
  * esi = address of memory in debugged process
3331
  * edi = pointer to data
114 mikedld 3332
Returned value:
118 diamond 3333
  * eax = -1 at an error (invalid PID or buffer)
3334
  * otherwise eax = number of written bytes (possibly, 0,
3335
    if esi is too large)
114 mikedld 3336
Remarks:
118 diamond 3337
  * Process must be loaded for debugging (as is shown in
3338
    general description).
114 mikedld 3339
 
3340
======================================================================
118 diamond 3341
======= Function 69, subfunction 8 - terminate debugged thread. ======
114 mikedld 3342
======================================================================
3343
Parameters:
118 diamond 3344
  * eax = 69 - function number
3345
  * ebx = 8 - subfunction number
114 mikedld 3346
  * ecx = identifier
3347
Returned value:
3348
  * function does not return value
3349
Remarks:
118 diamond 3350
  * Process must be loaded for debugging (as is shown in
3351
    general description).
3352
  * The function is similar to subfunction 2 of function 18
3353
    with two differences: it requires first remark and
3354
    accepts PID rather than slot number.
114 mikedld 3355
 
3356
======================================================================
118 diamond 3357
===== Function 69, subfunction 9 - set/clear hardware breakpoint. ====
114 mikedld 3358
======================================================================
3359
Parameters:
118 diamond 3360
  * eax = 69 - function number
3361
  * ebx = 9 - subfunction number
114 mikedld 3362
  * ecx = thread identifier
118 diamond 3363
  * dl = index of breakpoint, from 0 to 3 inclusively
114 mikedld 3364
  * dh = flags:
118 diamond 3365
    * if high bit is cleared - set breakpoint:
114 mikedld 3366
      * bits 0-1 - condition:
3367
        * 00 = breakpoint on execution
118 diamond 3368
        * 01 = breakpoint on read
3369
        * 11 = breakpoint on read/write
3370
      * bits 2-3 - length; for breakpoints on exception it must be
3371
        00, otherwise one of
3372
        * 00 = byte
114 mikedld 3373
        * 01 = word
118 diamond 3374
        * 11 = dword
3375
      * esi = breakpoint address; must be aligned according to
3376
        the length (i.e. must be even for word breakpoints,
3377
        divisible by 4 for dword)
3378
    * if high bit is set - clear breakpoint
114 mikedld 3379
Returned value:
118 diamond 3380
  * eax = 0 - success
114 mikedld 3381
  * eax = 1 - error in the input data
118 diamond 3382
  * eax = 2 - (reserved, is never returned in the current
3383
    implementation) a global breakpoint with that index is already set
114 mikedld 3384
Remarks:
118 diamond 3385
  * Process must be loaded for debugging (as is shown in
3386
    general description).
3387
  * Hardware breakpoints are implemented through DRx-registers of
3388
    the processor, all limitations results from this.
3389
  * The function can reinstall the breakpoint, previously set
3390
    by it (and it does not inform on this).
3391
    Carry on the list of set breakpoints in the debugger.
3392
  * Breakpoints generate debug exception #DB, on which the system
3393
    notifies debugger.
3394
  * Breakpoints on write and read/write act after
3395
    execution of the caused it instruction.
114 mikedld 3396
 
3397
======================================================================
118 diamond 3398
==== Function 70 - work with file system with long names support. ====
114 mikedld 3399
======================================================================
3400
Parameters:
3401
  * eax = 70
118 diamond 3402
  * ebx = pointer to the information structure
114 mikedld 3403
Returned value:
118 diamond 3404
  * eax = 0 - success; otherwise file system error code
3405
  * some subfunctions return value in other registers too
3406
General format of the information structure:
3407
  * +0: dword: subfunction number
3408
  * +4: dword: file offset
3409
  * +8: dword: high dword of offset (must be 0) or flags field
114 mikedld 3410
  * +12 = +0xC: dword: size
118 diamond 3411
  * +16 = +0x10: dword: pointer to data
3412
  * +20 = +0x14: n db: ASCIIZ-string with the filename
114 mikedld 3413
    or
3414
  * +20 = +0x14: db 0
118 diamond 3415
  * +21 = +0x15: dd pointer to ASCIIZ-string with the filename
3416
Specifications - in documentation on the appropriate subfunction.
3417
Filename is case-insensitive. Russian letters must be written in
3418
the encoding cp866 (DOS).
3419
Format of filename:
114 mikedld 3420
/base/number/dir1/dir2/.../dirn/file,
118 diamond 3421
where /base/number identifies device, on which file is located:
114 mikedld 3422
one of
118 diamond 3423
  * /RD/1 = /RAMDISK/1 to access ramdisk
3424
  * /FD/1 = /FLOPPYDISK/1 to access first floppy drive,
3425
    /FD/2 = /FLOPPYDISK/2 to access second one
3426
  * /HD0/x, /HD1/x, /HD2/x, /HD3/x to access accordingly to devices
3427
    IDE0 (Primary Master), IDE1 (Primary Slave),
114 mikedld 3428
    IDE2 (Secondary Master), IDE3 (Secondary Slave);
118 diamond 3429
    x - partition number on the selected hard drive, varies from 1
3430
    to 255 (on each hard drive the indexing starts from 1)
3431
  * /CD0/1, /CD1/1, /CD2/1, /CD3/1 to access accordingly to
3432
    CD on IDE0 (Primary Master), IDE1 (Primary Slave),
3433
    IDE2 (Secondary Master), IDE3 (Secondary Slave)
546 diamond 3434
  * /SYS means system folder; with the usual boot (from floppy)
3435
    is equivalent to /RD/1
114 mikedld 3436
Examples:
3437
  * '/rd/1/kernel.asm',0
3438
  * '/HD0/1/kernel.asm',0
3439
  * '/hd0/2/menuet/pics/tanzania.bmp',0
3440
  * '/hd0/1/Program files/NameOfProgram/SomeFile.SomeExtension',0
546 diamond 3441
  * '/sys/MySuperApp.ini',0
3780 Serge 3442
Also function supports relative names.  If the path begins not
3443
with '/', it is considered relative to a current folder. To get or
1662 Nasarus 3444
set a current folder, use the function 30.
3445
 
118 diamond 3446
Available subfunctions:
114 mikedld 3447
  * subfunction 0 - read file
3448
  * subfunction 1 - read folder
3449
  * subfunction 2 - create/rewrite file
131 diamond 3450
  * subfunction 3 - write to existing file
133 diamond 3451
  * subfunction 4 - set file size
118 diamond 3452
  * subfunction 5 - get attributes of file/folder
3453
  * subfunction 6 - set attributes of file/folder
114 mikedld 3454
  * subfunction 7 - start application
193 diamond 3455
  * subfunction 8 - delete file/folder
321 diamond 3456
  * subfunction 9 - create folder
118 diamond 3457
For CD-drives due to hardware limitations only subfunctions
3458
0,1,5 and 7 are available, other subfunctions return error
3459
with code 2.
641 diamond 3460
At the first call of subfunctions 0,1,5,7 to ATAPI devices
3461
(CD and DVD) the manual control of tray is locked due to caching
3462
drive data. Unlocking is made when subfunction 4 of function 24
3463
is called for corresponding device.
114 mikedld 3464
 
3465
======================================================================
118 diamond 3466
=== Function 70, subfunction 0 - read file with long names support. ==
114 mikedld 3467
======================================================================
3468
Parameters:
118 diamond 3469
  * eax = 70 - function number
3470
  * ebx = pointer to the information structure
3471
Format of the information structure:
3472
  * +0: dword: 0 = subfunction number
3473
  * +4: dword: file offset (in bytes)
3474
  * +8: dword: 0 (reserved for high dword of offset)
3475
  * +12 = +0xC: dword: number of bytes to read
3476
  * +16 = +0x10: dword: pointer to buffer for data
3477
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3478
    given in the general description
114 mikedld 3479
    or
3480
  * +20 = +0x14: db 0
118 diamond 3481
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3482
Returned value:
118 diamond 3483
  * eax = 0 - success, otherwise file system error code
3484
  * ebx = number of read bytes or -1=0xffffffff if file was not found
114 mikedld 3485
Remarks:
118 diamond 3486
  * If file was ended before last requested block was read,
3487
    the function will read as many as it can, and after that return
3488
    eax=6 (EOF).
3489
  * The function does not allow to read folder (returns eax=10,
3490
    access denied).
114 mikedld 3491
 
118 diamond 3492
======================================================================
3493
== Function 70, subfunction 1 - read folder with long names support. =
3494
======================================================================
114 mikedld 3495
Parameters:
118 diamond 3496
  * eax = 70 - function number
3497
  * ebx = pointer to the information structure
3498
Format of the information structure:
3499
  * +0: dword: 1 = subfunction number
3500
  * +4: dword: index of starting block (beginning from 0)
3501
  * +8: dword: flags field:
114 mikedld 3502
    * bit 0 (mask 1): in what format to return names,
3503
      0=ANSI, 1=UNICODE
118 diamond 3504
    * other bits are reserved and must be set to 0 for the future
3505
      compatibility
3506
  * +12 = +0xC: dword: number of blocks to read
3507
  * +16 = +0x10: dword: pointer to buffer for data, buffer size
3508
    must be not less than 32 + [+12]*560 bytes
3509
  * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are
3510
    given in the general description
114 mikedld 3511
    or
3512
  * +20 = +0x14: db 0
118 diamond 3513
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3514
Returned value:
118 diamond 3515
  * eax = 0 - success, otherwise file system error code
3516
  * ebx = number of files, information on which was written to
3517
    the buffer, or -1=0xffffffff, if folder was not found
114 mikedld 3518
Structure of the buffer:
3519
  * +0: 32*byte: header
3520
  * +32 = +0x20: n1*byte: block with information on file 1
118 diamond 3521
  * +32+n1: n2*byte: block with information on file 2
114 mikedld 3522
  * ...
3523
Structure of header:
118 diamond 3524
  * +0: dword: version of structure (current is 1)
3525
  * +4: dword: number of placed blocks; is not greater than requested
3526
    in the field +12 of information structure; can be less, if
3527
    there are no more files in folder (the same as in ebx)
3528
  * +8: dword: total number of files in folder
3529
  * +12 = +0xC: 20*byte: reserved (zeroed)
3530
Structure of block of data for folder entry (BDFE):
3531
  * +0: dword: attributes of file:
3532
    * bit 0 (mask 1): file is read-only
3533
    * bit 1 (mask 2): file is hidden
3534
    * bit 2 (mask 4): file is system
3535
    * bit 3 (mask 8): this is not a file but volume label
3536
      (for one partition meets no more than once and
3537
      only in root folder)
3538
    * bit 4 (mask 0x10): this is a folder
3539
    * bit 5 (mask 0x20): file was not archived - many archivation
3540
      programs have an option to archive only files with this bit set,
3541
      and after archiving this bit is cleared - it can be useful
3542
      for automatically creating of backup-archives as at writing
3543
      this bit is usually set
3544
  * +4: byte: type of name data:
3545
    (coincides with bit 0 of flags in the information structure)
3546
    * 0 = ASCII = 1-byte representation of each character
3547
    * 1 = UNICODE = 2-byte representation of each character
114 mikedld 3548
  * +5: 3*byte: reserved (zero)
118 diamond 3549
  * +8: 4*byte: time of file creation
3550
  * +12 = +0xC: 4*byte: date of file creation
3551
  * +16 = +0x10: 4*byte: time of last access (read or write)
114 mikedld 3552
  * +20 = +0x14: 4*byte: date of last access
118 diamond 3553
  * +24 = +0x18: 4*byte: time of last modification
3554
  * +28 = +0x1C: 4*byte: date of last modification
3555
  * +32 = +0x20: qword: file size in bytes (up to 16777216 Tb)
114 mikedld 3556
  * +40 = +0x28: name
118 diamond 3557
    * for ASCII format: maximum length is 263 characters
3558
      (263 bytes), byte after the name has value 0
321 diamond 3559
    * for UNICODE format: maximum length is 259 characters
118 diamond 3560
      (518 bytes), 2 bytes after the name have value 0
3561
Time format:
114 mikedld 3562
  * +0: byte: seconds
3563
  * +1: byte: minutes
3564
  * +2: byte: hours
3565
  * +3: byte: reserved (0)
118 diamond 3566
  * for example, 23.59.59 is written as (in hex) 3B 3B 17 00
3567
Date format:
3568
  * +0: byte: day
3569
  * +1: byte: month
3570
  * +2: word: year
3571
  * for example, 25.11.1979 is written as (in hex) 19 0B BB 07
114 mikedld 3572
Remarks:
118 diamond 3573
  * If BDFE contains ASCII name, the length of BDFE is 304 bytes,
3574
    if UNICODE name - 560 bytes. Value of length is aligned
3575
    on 16-byte bound (to accelerate processing in CPU cache).
3576
  * First character after a name is zero (ASCIIZ-string). The further
3577
    data contain garbage.
3578
  * If files in folder were ended before requested number was read,
3579
    the function will read as many as it can, and after that return
3580
    eax=6 (EOF).
114 mikedld 3581
  * Any folder on the disk, except for root, contains two special
118 diamond 3582
    entries "." and "..", identifying accordingly the folder itself
3583
    and the parent folder.
3584
  * The function allows also to read virtual folders "/", "/rd",
3585
    "/fd", "/hd[n]", thus attributes of subfolders are set to 0x10,
3586
    and times and dates are zeroed. An alternative way to get the
3587
    equipment information - subfunction 11 of function 18.
114 mikedld 3588
 
3589
======================================================================
118 diamond 3590
===================== Function 70, subfunction 2 =====================
3591
============ Create/rewrite file with long names support. ============
114 mikedld 3592
======================================================================
3593
Parameters:
118 diamond 3594
  * eax = 70 - function number
3595
  * ebx = pointer to the information structure
3596
Format of the information structure:
3597
  * +0: dword: 2 = subfunction number
114 mikedld 3598
  * +4: dword: 0 (reserved)
3599
  * +8: dword: 0 (reserved)
4066 shikhin 3600
  * +12 = +0xC: dword: number of bytes to write
118 diamond 3601
  * +16 = +0x10: dword: pointer to data
3602
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3603
    given in the general description
114 mikedld 3604
    or
3605
  * +20 = +0x14: db 0
118 diamond 3606
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3607
Returned value:
118 diamond 3608
  * eax = 0 - success, otherwise file system error code
3609
  * ebx = number of written bytes (possibly 0)
114 mikedld 3610
Remarks:
118 diamond 3611
  * If a file with given name did not exist, it is created;
3612
    if it existed, it is rewritten.
3613
  * If there is not enough free space on disk, the function will
3614
    write as many as can and then return error code 8.
3615
  * The function is not supported for CD (returns error code 2).
114 mikedld 3616
 
3617
======================================================================
131 diamond 3618
===================== Function 70, subfunction 3 =====================
3619
=========== Write to existing file with long names support. ==========
3620
======================================================================
3621
Parameters:
3622
  * eax = 70 - function number
3623
  * ebx = pointer to the information structure
3624
Format of the information structure:
3625
  * +0: dword: 3 = subfunction number
3626
  * +4: dword: file offset (in bytes)
3627
  * +8: dword: high dword of offset (must be 0 for FAT)
3628
  * +12 = +0xC: dword: number of bytes to write
3629
  * +16 = +0x10: dword: pointer to data
3630
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3631
    given in the general description
3632
    or
3633
  * +20 = +0x14: db 0
3634
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
3635
Returned value:
3636
  * eax = 0 - success, otherwise file system error code
3637
  * ebx = number of written bytes (possibly 0)
3638
Remarks:
3639
  * The file must already exist, otherwise function returns eax=5.
3640
  * The only result of write 0 bytes is update in the file attributes
3641
    date/time of modification and access to the current date/time.
3642
  * If beginning and/or ending position is greater than file size
3643
    (except for the previous case), the file is expanded to needed
3644
    size with zero characters.
133 diamond 3645
  * The function is not supported for CD (returns error code 2).
131 diamond 3646
 
3647
======================================================================
133 diamond 3648
============ Function 70, subfunction 4 - set end of file. ===========
3649
======================================================================
3650
Parameters:
3651
  * eax = 70 - function number
3652
  * ebx = pointer to the information structure
3653
Format of the information structure:
3654
  * +0: dword: 4 = subfunction number
3655
  * +4: dword: low dword of new file size
3656
  * +8: dword: high dword of new file size (must be 0 for FAT)
3657
  * +12 = +0xC: dword: 0 (reserved)
3658
  * +16 = +0x10: dword: 0 (reserved)
3659
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3660
    given in the general description
3661
    or
3662
  * +20 = +0x14: db 0
3663
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
3664
Returned value:
3665
  * eax = 0 - success, otherwise file system error code
3666
  * ebx destroyed
3667
Remarks:
3668
  * If the new file size is less than old one, file is truncated.
3669
    If the new size is greater than old one, file is expanded with
3670
    characters with code 0. If the new size is equal to old one,
3671
    the only result of call is set date/time of modification and
3672
    access to the current date/time.
3673
  * If there is not enough free space on disk for expansion, the
3674
    function will expand to maximum possible size and then return
3675
    error code 8.
3676
  * The function is not supported for CD (returns error code 2).
3677
 
3678
======================================================================
118 diamond 3679
==== Function 70, subfunction 5 - get information on file/folder. ====
114 mikedld 3680
======================================================================
3681
Parameters:
118 diamond 3682
  * eax = 70 - function number
3683
  * ebx = pointer to the information structure
3684
Format of the information structure:
3685
  * +0: dword: 5 = subfunction number
114 mikedld 3686
  * +4: dword: 0 (reserved)
3687
  * +8: dword: 0 (reserved)
3688
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 3689
  * +16 = +0x10: dword: pointer to buffer for data (40 bytes)
3690
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3691
    given in the general description
114 mikedld 3692
    or
3693
  * +20 = +0x14: db 0
118 diamond 3694
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3695
Returned value:
118 diamond 3696
  * eax = 0 - success, otherwise file system error code
3697
  * ebx destroyed
3698
Information on file is returned in the BDFE format (block of data
3699
for folder entry), explained in the description of
3700
subfunction 1, but without filename
3701
(i.e. only first 40 = 0x28 bytes).
114 mikedld 3702
Remarks:
118 diamond 3703
  * The function does not support virtual folders such as /, /rd and
3704
    root folders like /rd/1.
114 mikedld 3705
 
3706
======================================================================
118 diamond 3707
===== Function 70, subfunction 6 - set attributes of file/folder. ====
114 mikedld 3708
======================================================================
3709
Parameters:
118 diamond 3710
  * eax = 70 - function number
3711
  * ebx = pointer to the information structure
3712
Format of the information structure:
3713
  * +0: dword: 6 = subfunction number
114 mikedld 3714
  * +4: dword: 0 (reserved)
3715
  * +8: dword: 0 (reserved)
3716
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 3717
  * +16 = +0x10: dword: pointer to buffer with attributes (32 bytes)
3718
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3719
    given in the general description
114 mikedld 3720
    or
3721
  * +20 = +0x14: db 0
118 diamond 3722
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3723
Returned value:
118 diamond 3724
  * eax = 0 - success, otherwise file system error code
3725
  * ebx destroyed
3726
File attributes are first 32 bytes in BDFE (block of data
3727
for folder entry), explained in the description of subfunction 1
3728
(that is, without name and size of file). Attribute
3729
file/folder/volume label (bits 3,4 in dword +0) is not changed.
3730
Byte +4 (name format) is ignored.
114 mikedld 3731
Remarks:
118 diamond 3732
  * The function does not support virtual folders such as /, /rd and
3733
    root folders like /rd/1.
3734
  * The function is not supported for CD (returns error code 2).
114 mikedld 3735
 
3736
======================================================================
118 diamond 3737
=========== Function 70, subfunction 7 - start application. ==========
114 mikedld 3738
======================================================================
3739
Parameters:
118 diamond 3740
  * eax = 70 - function number
3741
  * ebx = pointer to the information structure
3742
Format of the information structure:
3743
  * +0: dword: 7 = subfunction number
3744
  * +4: dword: flags field:
3539 clevermous 3745
    * bit 0: start process as debugged
118 diamond 3746
    * other bits are reserved and must be set to 0
3747
  * +8: dword: 0 or pointer to ASCIIZ-string with parameters
114 mikedld 3748
  * +12 = +0xC: dword: 0 (reserved)
3749
  * +16 = +0x10: dword: 0 (reserved)
118 diamond 3750
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3751
    given in the general description
114 mikedld 3752
    or
3753
  * +20 = +0x14: db 0
118 diamond 3754
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld