Subversion Repositories Kolibri OS

Rev

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

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