Subversion Repositories Kolibri OS

Rev

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

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