Subversion Repositories Kolibri OS

Rev

Rev 667 | Rev 760 | 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 32 - delete file from ramdisk. ==============
114 mikedld 1755
======================================================================
1756
Parameters:
118 diamond 1757
  * eax = 32 - function number
1758
  * ebx = pointer to the filename
114 mikedld 1759
Returned value:
118 diamond 1760
  * eax = 0 - success; otherwise file system error code
114 mikedld 1761
Remarks:
118 diamond 1762
  * This function is obsolete; function 58 allows to fulfill
1763
    the same operations with the extended possibilities.
1764
  * The current implementation returns only values 0(success) and
1765
    5(file not found).
1766
  * The filename must be either in the format 8+3 characters
1767
    (first 8 characters - name itself, last 3 - extension,
1768
    the short names and extensions are supplemented with spaces),
1769
    or in the format 8.3 characters "FILE.EXT"/"FILE.EX "
1770
    (name no more than 8 characters, dot, extension 3 characters
1771
    supplemented if necessary by spaces).
1772
    The filename must be written with capital letters. The terminating
1773
    character with code 0 is not necessary (not ASCIIZ-string).
1774
  * This function does not support folders on the ramdisk.
114 mikedld 1775
 
1776
======================================================================
118 diamond 1777
================ Function 33 - write file to ramdisk. ================
114 mikedld 1778
======================================================================
1779
Parameters:
118 diamond 1780
  * eax = 33 - function number
1781
  * ebx = pointer to the filename
1782
  * ecx = pointer to data for writing
1783
  * edx = number of bytes for writing
1784
  * should be set esi=0
114 mikedld 1785
Returned value:
118 diamond 1786
  * eax = 0 - success, otherwise file system error code
114 mikedld 1787
Remarks:
118 diamond 1788
  * This function is obsolete; function 70 allows to fulfil
1789
    the same operations with extended possibilities.
1790
  * If esi contains non-zero value and selected file already exists,
1791
    one more file with the same name will be created.
1792
  * Otherwise file will be overwritten.
1793
  * The filename must be either in the format 8+3 characters
1794
    (first 8 characters - name itself, last 3 - extension,
1795
    the short names and extensions are supplemented with spaces),
1796
    or in the format 8.3 characters "FILE.EXT"/"FILE.EX "
1797
    (name no more than 8 characters, dot, extension 3 characters
1798
    supplemented if necessary by spaces).
1799
    The filename must be written with capital letters. The terminating
1800
    character with code 0 is not necessary (not ASCIIZ-string).
1801
  * This function does not support folders on the ramdisk.
114 mikedld 1802
 
1803
======================================================================
118 diamond 1804
======= Function 35 - read the color of a pixel on the screen. =======
114 mikedld 1805
======================================================================
1806
Parameters:
1807
  * eax = 35
1808
  * ebx = y*xsize+x, where
118 diamond 1809
  * (x,y) = coordinates of a pixel (beginning from 0)
1810
  * xsize = horizontal screen size
114 mikedld 1811
Returned value:
118 diamond 1812
  * eax = color 0x00RRGGBB
114 mikedld 1813
Remarks:
118 diamond 1814
  * To get screen sizes use function 14. Pay attention,
1815
    that it subtracts 1 from both sizes.
1816
  * There is also direct access (without any system calls)
1817
    to videomemory through the selector gs. To get parameters of
1818
    the current videomode, use function 61.
114 mikedld 1819
 
1820
======================================================================
277 diamond 1821
=================== Function 37 - work with mouse. ===================
114 mikedld 1822
======================================================================
1823
 
118 diamond 1824
---------- Subfunction 0 - screen coordinates of the mouse -----------
114 mikedld 1825
Parameters:
118 diamond 1826
  * eax = 37 - function number
1827
  * ebx = 0 - subfunction number
114 mikedld 1828
Returned value:
118 diamond 1829
  * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer
1830
    (beginning from 0)
114 mikedld 1831
 
118 diamond 1832
-- Subfunction 1 - coordinates of the mouse relative to the window ---
114 mikedld 1833
Parameters:
118 diamond 1834
  * eax = 37 - function number
1835
  * ebx = 1 - subfunction number
114 mikedld 1836
Returned value:
118 diamond 1837
  * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer
1838
    relative to the application window (beginning from 0)
114 mikedld 1839
Remarks:
118 diamond 1840
  * The value is calculated by formula (x-xwnd)*65536 + (y-ywnd).
1841
    If y>=ywnd, the low word is non-negative and contains
1842
    relative y-coordinate, and the high word - relative x-coordinate
1843
    (with correct sign). Otherwise the low word is negative and still
1844
    contains relative y-coordinate, and to the high word
1845
    1 should be added.
114 mikedld 1846
 
118 diamond 1847
------------ Subfunction 2 - pressed buttons of the mouse ------------
114 mikedld 1848
Parameters:
118 diamond 1849
  * eax = 37 - function number
1850
  * ebx = 2 - subfunction number
114 mikedld 1851
Returned value:
118 diamond 1852
  * eax contains information on the pressed mouse buttons:
1853
  * bit 0 is set = left button is pressed
1854
  * bit 1 is set = right button is pressed
486 kastigar 1855
  * bit 2 is set = middle button is pressed
1856
  * bit 3 is set = 4th button is pressed
1857
  * bit 4 is set = 5th button is pressed
118 diamond 1858
  * other bits are cleared
114 mikedld 1859
 
277 diamond 1860
-------------------- Subfunction 4 - load cursor ---------------------
1861
Parameters:
1862
  * eax = 37 - function number
1863
  * ebx = 4 - subfunction number
1864
  * dx = data source:
1865
  * dx = LOAD_FROM_FILE = 0 - data in a file
1866
    * ecx = pointer to full path to the cursor file
1867
    * the file must be in the format .cur, which is standard for
1868
      MS Windows, at that of the size 32*32 pixels
1869
  * dx = LOAD_FROM_MEM = 1 - data of file are already loaded in memory
1870
    * ecx = pointer to data of the cursor file
1871
    * the data format is the same as in the previous case
1872
  * dx = LOAD_INDIRECT = 2 - data in memory
1873
    * ecx = pointer to cursor image in the format ARGB 32*32 pixels
1874
    * edx = 0xXXYY0002, where
1875
      * XX = x-coordinate of cursor hotspot
1876
      * YY = y-coordinate
1877
      * 0 <= XX, YY <= 31
1878
Returned value:
1879
  * eax = 0 - failed
1880
  * otherwise eax = cursor handle
1881
 
1882
--------------------- Subfunction 5 - set cursor ---------------------
1883
Sets new cursor for the window of the current thread.
1884
Parameters:
1885
  * eax = 37 - function number
1886
  * ebx = 5 - subfunction number
1887
  * ecx = cursor handle
1888
Returned value:
1889
  * eax = handle of previous cursor
1890
Remarks:
1891
  * If the handle is incorrect, the function restores the default
1892
    cursor (standard arrow). In particular, ecx=0 restores it.
1893
 
1894
------------------- Subfunction 6 - delete cursor --------------------
1895
Parameters:
1896
  * eax = 37 - function number
1897
  * ebx = 6 - subfunction number
1898
  * ecx = cursor handle
1899
Returned value:
1900
  * eax destroyed
1901
Remarks:
1902
  * The cursor must be loaded previously by the current thread
1903
    (with the call to subfunction 4). The function does not delete
1904
    system cursors and cursors, loaded by another applications.
1905
  * If the active cursor (set by subfunction 5) is deleted,
1906
    the system restores the default cursor (standard arrow).
1907
 
499 diamond 1908
------------------ Subfunction 7 - get scroll data -------------------
486 kastigar 1909
Parameters:
1910
  * eax = 37 - function number
1911
  * ebx = 7 - subfunction number
1912
Returned value:
499 diamond 1913
  * eax = [horizontal offset]*65536 + [vertical offset]
486 kastigar 1914
Remarks:
499 diamond 1915
  * Scroll data is available for active window only.
1916
  * Values are zeroed after reading.
1917
  * Values are signed.
486 kastigar 1918
 
114 mikedld 1919
======================================================================
1920
====================== Function 38 - draw line. ======================
1921
======================================================================
1922
Parameters:
118 diamond 1923
  * eax = 38 - function number
1924
  * ebx = [start coordinate on axis x]*65536 +
1925
              [end coordinate on axis x]
1926
  * ecx = [start coordinate on axis y]*65536 +
1927
              [end coordinate on axis y]
1928
  * edx = 0x00RRGGBB - color
133 diamond 1929
    edx = 0x01xxxxxx - draw inversed line
1930
          (low 24 bits are ignored)
114 mikedld 1931
Returned value:
1932
  * function does not return value
1933
Remarks:
118 diamond 1934
  * Coordinates are relative to the window.
1935
  * End point is also drawn.
114 mikedld 1936
 
1937
======================================================================
118 diamond 1938
== Function 39, subfunction 1 - get a size of the background image. ==
114 mikedld 1939
======================================================================
1940
Parameters:
118 diamond 1941
  * eax = 39 - function number
1942
  * ebx = 1 - subfunction number
114 mikedld 1943
Returned value:
1944
  * eax = [width]*65536 + [height]
1945
Remarks:
118 diamond 1946
  * There is a pair function to set sizes of background image -
1947
    subfunction 1 of function 15. After which it is necessary,
1948
    of course, anew to define image.
114 mikedld 1949
 
1950
======================================================================
118 diamond 1951
== Function 39, subfunction 2 - get pixel from the background image. =
114 mikedld 1952
======================================================================
1953
Parameters:
118 diamond 1954
  * eax = 39 - function number
1955
  * ebx = 2 - subfunction number
114 mikedld 1956
  * ecx = offset
1957
Returned value:
118 diamond 1958
  * eax = 0x00RRGGBB - pixel color, if offset is valid
1959
    (less than 0x160000-16)
1960
  * eax = 2 otherwise
114 mikedld 1961
Remarks:
118 diamond 1962
  * Do not rely on returned value for invalid offsets, it may be
1963
    changed in future kernel versions.
1964
  * Offset for pixel with coordinates (x,y)
1965
    is calculated as (x+y*xsize)*3.
1966
  * There is a pair function to set pixel on the background image -
1967
    subfunction 2 of function 15.
114 mikedld 1968
 
1969
======================================================================
118 diamond 1970
== Function 39, subfunction 4 - get drawing mode for the background. =
114 mikedld 1971
======================================================================
1972
Parameters:
118 diamond 1973
  * eax = 39 - function number
1974
  * ebx = 4 - subfunction number
114 mikedld 1975
Returned value:
118 diamond 1976
  * eax = 1 - tile
1977
  * eax = 2 - stretch
114 mikedld 1978
Remarks:
118 diamond 1979
  * There is a pair function to set drawing mode -
1980
    subfunction 4 of function 15.
114 mikedld 1981
 
1982
======================================================================
118 diamond 1983
=========== Function 40 - set the mask for expected events. ==========
114 mikedld 1984
======================================================================
118 diamond 1985
The mask for expected events affects function working with events
1986
10, 11, 23 - they notify only about events allowed by this mask.
114 mikedld 1987
Parameters:
118 diamond 1988
  * eax = 40 - function number
114 mikedld 1989
  * ebx = mask: bit i corresponds to event i+1 (see list of events)
118 diamond 1990
    (set bit permits notice on event)
114 mikedld 1991
Returned value:
1992
  * function does not return value
1993
Remarks:
118 diamond 1994
  * Default mask (7=111b) enables nofices about redraw,
1995
    keys and buttons. This is enough for many applications.
1996
  * Events prohibited in the mask are saved anyway, when come;
1997
    they are simply not informed with event functions.
1998
  * Event functions take into account the mask on moment of
1999
    function call, not on moment of event arrival.
114 mikedld 2000
 
2001
======================================================================
118 diamond 2002
==================== Function 41 - get IRQ owner. ====================
114 mikedld 2003
======================================================================
2004
Parameters:
118 diamond 2005
  * eax = 41 - function number
2006
  * ebx = IRQ number, 0..15
114 mikedld 2007
Returned value:
118 diamond 2008
  * eax = owner PID
2009
  * eax = 0, if there is no owner
114 mikedld 2010
  * eax = -1 for incorrect ebx
2011
 
2012
======================================================================
118 diamond 2013
==================== Function 42 - read IRQ data. ====================
114 mikedld 2014
======================================================================
118 diamond 2015
When an IRQ occurs, the system reads data from ports indicated
2016
earlier by function 44 and writes this data to
2017
internal buffer. This function reads out data from that buffer
2018
bytewise.
114 mikedld 2019
Parameters:
118 diamond 2020
  * eax = 42 - function number
2021
  * ebx = IRQ number, 0..15
2022
Returned value: (use value of ecx to distinguish)
2023
  * if the thread is not IRQ owner (or IRQ number is incorrect):
114 mikedld 2024
    * ecx = 2
118 diamond 2025
  * if there is no data:
114 mikedld 2026
    * eax = 0
2027
    * ecx = 1
118 diamond 2028
    * ebx destroyed
2029
  * if all is ok:
2030
    * eax = byte size of data, not yet read from buffer
114 mikedld 2031
    * ecx = 0
2032
    * ebx = current byte
2033
Remarks:
118 diamond 2034
  * Previously the thread must reserve indicated IRQ for itself
2035
    by function 45.
2036
  * The size of data buffer is 4000 bytes, on overflow
2037
    "fresh" data cease to be written in the buffer.
114 mikedld 2038
 
2039
======================================================================
118 diamond 2040
================ Function 43 - input/output to a port. ===============
114 mikedld 2041
======================================================================
2042
 
118 diamond 2043
------------------------ Output data to port -------------------------
114 mikedld 2044
Parameters:
118 diamond 2045
  * eax = 43 - function number
114 mikedld 2046
  * bl = byte for output
118 diamond 2047
  * ecx = port number 0xnnnn (from 0 to 0xFFFF)
114 mikedld 2048
Returned value:
118 diamond 2049
  * eax = 0 - success
2050
  * eax = 1 - the thread has not reserved the selected port
114 mikedld 2051
 
118 diamond 2052
------------------------ Input data from port ------------------------
114 mikedld 2053
Parameters:
118 diamond 2054
  * eax = 43 - function number
2055
  * ebx is ignored
2056
  * ecx = 0x8000nnnn, where nnnn = port number (from 0 to 0xFFFF)
114 mikedld 2057
Returned value:
118 diamond 2058
  * eax = 0 - success, thus ebx = entered byte
2059
  * eax = 1 - the thread has not reserved the selected port
114 mikedld 2060
Remarks:
118 diamond 2061
  * Previously the thread must reserve the selected port
2062
    for itself by function 46.
2063
  * Instead of call to this function it is better to use
2064
    processor instructions in/out - this is much
2065
    faster and a bit shorter and easier.
114 mikedld 2066
 
2067
======================================================================
118 diamond 2068
=========== Function 44 - define operations at IRQ arrival. ==========
114 mikedld 2069
======================================================================
118 diamond 2070
At IRQ arrival the system can read the data from ports defined
2071
by this function and write these data to internal buffer, whence
2072
they can be read by функцией 42.
114 mikedld 2073
Parameters:
118 diamond 2074
  * eax = 44 - function number
2075
  * ebx = pointer to the array of structures each describing one port:
2076
    * +0: word: 0 means end of array, otherwise port number
114 mikedld 2077
    * +2: byte: reserved (ignored)
118 diamond 2078
    * +3: byte: 1=read byte from this port, 2=read word
2079
  * ecx = IRQ number, 0..15
114 mikedld 2080
Returned value:
118 diamond 2081
  * eax = 0 - success
2082
  * eax = 1 - the thread is not owner of selected IRQ
114 mikedld 2083
Remarks:
118 diamond 2084
  * Previously the thread must reserve for itself selected IRQ
2085
    by function 45.
114 mikedld 2086
  * First 16 ports are considered only.
118 diamond 2087
  * The current implementation considers incorrect value of field +3
2088
    as a signal to terminate IRQ processing.
114 mikedld 2089
 
2090
======================================================================
118 diamond 2091
=================== Function 45 - reserve/free IRQ. ==================
114 mikedld 2092
======================================================================
2093
Parameters:
118 diamond 2094
  * eax = 45 - function number
114 mikedld 2095
  * ebx = 0 - reserve, 1 = free
118 diamond 2096
  * ecx = IRQ number, 0..15
114 mikedld 2097
Returned value:
118 diamond 2098
  * eax = 0 - success
2099
  * eax = 1 - error (invalid IRQ number
2100
    or attempt to reserve not free IRQ
2101
    or to free IRQ, not reserved by this thread)
114 mikedld 2102
Remarks:
118 diamond 2103
  * IRQ reservation is required for functions 42 and 44.
2104
  * Only one thread can reserve the specific IRQ.
2105
  * IRQs, handled by the system itself, are reserved by the system
2106
    (thread 1) at booting.
2107
  * When a thread terminates, all reserved by it IRQs
2108
    are freed automatically.
114 mikedld 2109
 
2110
======================================================================
118 diamond 2111
====== Function 46 - reserve/free a group of input/output ports. =====
114 mikedld 2112
======================================================================
118 diamond 2113
To work with reserved ports an application can access directly by
2114
commands in/out (recommended way) and can use function 43
2115
(not recommended way).
114 mikedld 2116
Parameters:
118 diamond 2117
  * eax = 46 - function number
114 mikedld 2118
  * ebx = 0 - reserve, 1 - free
118 diamond 2119
  * ecx = start port number
2120
  * edx = end port number (inclusive)
114 mikedld 2121
Returned value:
118 diamond 2122
  * eax = 0 - success
114 mikedld 2123
  * eax = 1 - error
2124
Remarks:
118 diamond 2125
  * For ports reservation: an error occurs if and only if
2126
    one from the following condition satisfies:
2127
    * start port is more than end port;
2128
    * the selected range contains incorrect port number
2129
      (correct are from 0 to 0xFFFF);
2130
    * limit for the total number of reserved areas is exceeded
2131
      (maximum 255 are allowed);
2132
    * the selected range intersects with any of earlier reserved
2133
  * For ports free: an error is an attempt to free range,
2134
    that was not earlier reserved by this function
2135
    (with same ecx,edx).
2136
  * If an error occurs (for both cases) function performs no action.
277 diamond 2137
  * At booting the system reserves for itself ports
2138
    0..0x2d, 0x30..0x4d, 0x50..0xdf, 0xe5..0xff (inclusively).
118 diamond 2139
  * When a thread terminates, all reserved by it ports
2140
    are freed automatically.
114 mikedld 2141
 
2142
======================================================================
118 diamond 2143
============= Function 47 - draw a number in the window. =============
114 mikedld 2144
======================================================================
2145
Parameters:
118 diamond 2146
  * eax = 47 - function number
2147
  * ebx = parameters of conversion number to text:
114 mikedld 2148
    * bl = 0 - ecx contains number
665 diamond 2149
    * bl = 1 - ecx contains pointer to dword/qword-number
118 diamond 2150
    * bh = 0 - display in decimal number system
2151
    * bh = 1 - display in hexadecimal system
2152
    * bh = 2 - display in binary system
499 diamond 2153
    * bits 16-21 = how many digits to display
655 mario79 2154
    * bits 22-29 reserved and must be set to 0
665 diamond 2155
    * bit 30 set = display qword (64-bit) number (must be bl=1)
2156
    * bit 31 set = do not display leading zeroes of the number
118 diamond 2157
  * ecx = number (if bl=0) or pointer (if bl=1)
114 mikedld 2158
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
139 diamond 2159
  * esi = 0xX0RRGGBB:
2160
    * RR, GG, BB specify the color
2161
    * X = ABnn (bits)
2162
    * nn = font (0/1)
2163
    * A is ignored
2164
    * B=1 - fill background with the color edi
114 mikedld 2165
Returned value:
2166
  * function does not return value
2167
Remarks:
118 diamond 2168
  * The given length must not exceed 60.
2169
  * The exactly given amount of digits is output. If number is small
2170
    and can be written by smaller amount of digits, it is supplemented
2171
    by leading zeroes; if the number is big and can not be written by
2172
    given amount of digits, extra digits are not drawn.
2173
  * Parameters of fonts are shown in the description of function 4
2174
    (text output).
114 mikedld 2175
 
2176
======================================================================
118 diamond 2177
========= Function 48, subfunction 0 - apply screen settings. ========
114 mikedld 2178
======================================================================
2179
Parameters:
118 diamond 2180
  * eax = 48 - function number
2181
  * ebx = 0 - subfunction number
114 mikedld 2182
  * ecx = 0 - reserved
2183
Returned value:
2184
  * function does not return value
2185
Remarks:
118 diamond 2186
  * Function redraws the screen after parameters change by
114 mikedld 2187
    subfunctions 1 and 2.
118 diamond 2188
  * Function call without prior call to one of indicated subfunctions
2189
    is ignored.
2190
  * Function call with nonzero ecx is ignored.
114 mikedld 2191
 
2192
======================================================================
118 diamond 2193
=========== Function 48, subfunction 1 - set button style. ===========
114 mikedld 2194
======================================================================
2195
Parameters:
118 diamond 2196
  * eax = 48 - function number
2197
  * ebx = 1 - subfunction number
2198
  * ecx = button style:
2199
    * 0 = flat
2200
    * 1 = 3d
114 mikedld 2201
Returned value:
2202
  * function does not return value
2203
Remarks:
118 diamond 2204
  * After call to this function one should redraw the screen by
2205
    subfunction 0.
2206
  * Button style influences only to their draw of function 8.
114 mikedld 2207
 
118 diamond 2208
======================================================================
2209
====== Function 48, subfunction 2 - set standard window colors. ======
2210
======================================================================
114 mikedld 2211
Parameters:
118 diamond 2212
  * eax = 48 - function number
2213
  * ebx = 2 - subfunction number
2214
  * ecx = pointer to the color table
114 mikedld 2215
  * edx = size of the color table
118 diamond 2216
    (must be 40 bytes for future compatibility)
2217
Format of the color table is shown in description of subfunction 3.
114 mikedld 2218
Returned value:
2219
  * function does not return value
2220
Remarks:
118 diamond 2221
  * After call to this function one should redraw the screen by
2222
    subfunction 0.
2223
  * Table of standard colors influences only to applications,
2224
    which receive this table obviously (by subfunction 3)
2225
    and use it (specifying colors from it to drawing functions).
2226
  * Table of standard colors is included in skin and is installed
2227
    anew with skin installation (by subfunction 8).
2228
  * Color table can be viewed/changed interactively with
2229
    the application 'desktop'.
114 mikedld 2230
 
2231
======================================================================
118 diamond 2232
====== Function 48, subfunction 3 - get standard window colors. ======
114 mikedld 2233
======================================================================
2234
Parameters:
118 diamond 2235
  * eax = 48 - function number
2236
  * ebx = 3 - subfunction number
2237
  * ecx = pointer to the buffer with size edx bytes,
2238
    where table will be written
2239
  * edx = size of color table
2240
    (must be 40 bytes for future compatibility)
114 mikedld 2241
Returned value:
2242
  * function does not return value
118 diamond 2243
Format of the color table:
2244
each item is dword-value for color 0x00RRGGBB
2245
  * +0: dword: frames - color of frame
2246
  * +4: dword: grab - color of header
2247
  * +8: dword: grab_button - color of button on header bar
2248
  * +12 = +0xC: dword: grab_button_text - color of text on button
2249
    on header bar
2250
  * +16 = +0x10: dword: grab_text - color of text on header
2251
  * +20 = +0x14: dword: work - color of working area
2252
  * +24 = +0x18: dword: work_button - color of button in working area
2253
  * +28 = +0x1C: dword: work_button_text - color of text on button
2254
    in working area
2255
  * +32 = +0x20: dword: work_text - color of text in working area
2256
  * +36 = +0x24: dword: work_graph - color of graphics in working area
114 mikedld 2257
Remarks:
118 diamond 2258
  * Structure of the color table is described in the standard
2259
    include file 'macros.inc' as 'system_colors'; for example,
2260
    it is possible to write:
131 diamond 2261
    	sc	system_colors		; variable declaration
2262
    	...				; somewhere one must call
2263
    					; this function with ecx=sc
2264
    	mov	ecx, [sc.work_button_text]	; read text color on
2265
    					; buttin in working area
118 diamond 2266
  * A program itself desides to use or not to use color table.
2267
    For usage program must simply at calls to drawing functions select
2268
    color taken from the table.
2269
  * At change of the table of standard colors (by subfunction 2 with
2270
    the subsequent application of changes by subfunction 0 or
2271
    at skin set by subfunction 8) the system sends to all windows
2272
    redraw message (the event with code 1).
2273
  * Color table can be viewed/changed interactively with
2274
    the application 'desktop'.
114 mikedld 2275
 
2276
======================================================================
118 diamond 2277
============ Function 48, subfunction 4 - get skin height. ===========
114 mikedld 2278
======================================================================
2279
Parameters:
118 diamond 2280
  * eax = 48 - function number
2281
  * ebx = 4 - subfunction number
114 mikedld 2282
Returned value:
118 diamond 2283
  * eax = skin height
114 mikedld 2284
Remarks:
118 diamond 2285
  * Skin height is defined as the height of a header
2286
    of skinned windows.
2287
  * See also general structure of window in the description
2288
    of function 0.
114 mikedld 2289
 
2290
======================================================================
118 diamond 2291
======== Function 48, subfunction 5 - get screen working area. =======
114 mikedld 2292
======================================================================
2293
Parameters:
118 diamond 2294
  * eax = 48 - function number
2295
  * ebx = 5 - subfunction number
114 mikedld 2296
Returned value:
2297
  * eax = [left]*65536 + [right]
2298
  * ebx = [top]*65536 + [bottom]
2299
Remarks:
118 diamond 2300
  * The screen working area defines position and coordinates of
2301
    a maximized window.
2302
  * The screen working area in view of normal work is all screen
2303
    without system panel (the application '@panel').
2304
  * (left,top) are coordinates of the left upper corner,
2305
    (right,bottom) are coordinates of the right lower one.
2306
    Thus the size of working area on x axis can be calculated by
2307
    formula right-left+1, on y axis - by formula bottom-right+1.
2308
  * See also function 14,
2309
    to get sizes of all screen.
2310
  * There is a pair function to set working area - subfunction 6.
114 mikedld 2311
 
2312
======================================================================
118 diamond 2313
======== Function 48, subfunction 6 - set screen working area. =======
114 mikedld 2314
======================================================================
2315
Parameters:
118 diamond 2316
  * eax = 48 - function number
2317
  * ebx = 6 - subfunction number
114 mikedld 2318
  * ecx = [left]*65536 + [right]
2319
  * edx = [top]*65536 + [bottom]
2320
Returned value:
2321
  * function does not return value
2322
Remarks:
118 diamond 2323
  * The screen working area defines position and coordinates of
2324
    a maximized window.
2325
  * This function is used only by the application '@panel',
2326
    which set working area to all screen without system panel.
2327
  * (left,top) are coordinates of the left upper corner,
2328
    (right,bottom) are coordinates of the right lower one.
2329
    Thus the size of working area on x axis can be calculated by
2330
    formula right-left+1, on y axis - by formula bottom-right+1.
2331
  * If 'left'>='right', x-coordinate of working area is not changed.
2332
    If 'left'<0, 'left' will not be set. If 'right' is greater than or
2333
    equal to screen width, 'right' will not be set.
2334
    Similarly on y axis.
2335
  * See also function 14,
2336
    to get sizes of all screen.
2337
  * There is a pair function to get working area - subfunction 5.
2338
  * This function redraws the screen automatically,
2339
    updating coordinates and sizes of maximized windows.
2340
    The system sends to all windows redraw message (the event 1).
114 mikedld 2341
 
2342
======================================================================
118 diamond 2343
=========== Function 48, subfunction 7 - get skin margins. ===========
114 mikedld 2344
======================================================================
118 diamond 2345
Returns the area of a header of a skinned window, intended for
2346
a text of a header.
114 mikedld 2347
Parameters:
118 diamond 2348
  * eax = 48 - function number
2349
  * ebx = 7 - subfunction number
114 mikedld 2350
Returned value:
2351
  * eax = [left]*65536 + [right]
2352
  * ebx = [top]*65536 + [bottom]
2353
Remarks:
118 diamond 2354
  * An application decides itself to use or not to use this function.
2355
  * It is recommended to take into account returned value
2356
    of this function for choice of a place for drawing header text
2357
    (by function 4) or a substitute of header text
2358
    (at the discretion of an application).
114 mikedld 2359
 
2360
======================================================================
118 diamond 2361
============= Function 48, subfunction 8 - set used skin. ============
114 mikedld 2362
======================================================================
2363
Parameters:
118 diamond 2364
  * eax = 48 - function number
2365
  * ebx = 8 - subfunction number
2366
  * ecx = pointer to a block for function 58, in
2367
    which the fields of intermediate buffer and file name are filled
114 mikedld 2368
Returned value:
118 diamond 2369
  * eax = 0 - success
2370
  * otherwise eax = file system error code; if file does not
2371
    contain valid skin, function returns error 3
2372
    (unknown file system).
114 mikedld 2373
Remarks:
118 diamond 2374
  * After successful skin loading the system sends to all windows
2375
    redraw message (the event 1).
2376
  * At booting the system reads skin from file 'default.skn'
2377
    on ramdisk.
2378
  * User can change the skin statically by creating hisself
2379
    'default.skn' or dynamically with the application 'desktop'.
114 mikedld 2380
 
2381
======================================================================
118 diamond 2382
=========== Function 49 - Advanced Power Management (APM). ===========
114 mikedld 2383
======================================================================
2384
Parameters:
118 diamond 2385
  * eax = 49 - function number
2386
  * dx = number of the APM function
2387
    (analogue of ax in APM specification)
2388
  * bx, cx = parameters of the APM function
114 mikedld 2389
Returned value:
118 diamond 2390
  * 16-bit registers ax, bx, cx, dx, si, di and carry flag CF
2391
    are set according to the APM specification
2392
  * high halves of 32-bit registers eax, ebx, ecx,
2393
    edx, esi, edi are destroyed
114 mikedld 2394
Remarks:
118 diamond 2395
  * APM 1.2 specification is described in the document
2396
    "Advanced Power Management (APM) BIOS Specification"
2397
    (Revision 1.2), available at
114 mikedld 2398
    http://www.microsoft.com/whdc/archive/amp_12.mspx;
118 diamond 2399
    besides it is included in famous Interrupt List by Ralf Brown
114 mikedld 2400
    (http://www.pobox.com/~ralf/files.html,
2401
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/).
2402
 
2403
======================================================================
118 diamond 2404
=================== Function 50 - set window shape. ==================
114 mikedld 2405
======================================================================
118 diamond 2406
Normal windows have rectangular shape. This function can give to
2407
a window any shape. The shape is given by a set of points inside
2408
the base rectangle belonging to a window. Position and coordinates
2409
of the base rectangle are set by function 0
2410
and changed by function 67.
114 mikedld 2411
 
118 diamond 2412
--------------------------- Set shape data ---------------------------
114 mikedld 2413
Parameters:
118 diamond 2414
  * eax = 50 - function number
2415
  * ebx = 0 - subfunction number
2416
  * ecx = pointer to shape data (array of bytes 0/1)
114 mikedld 2417
Returned value:
2418
  * function does not return value
2419
 
118 diamond 2420
-------------------------- Set shape scale ---------------------------
114 mikedld 2421
Parameters:
118 diamond 2422
  * eax = 50 - function number
2423
  * ebx = 1 - subfunction number
2424
  * ecx sets a scale: each byte of data defines
2425
    (2^scale)*(2^scale) pixels
114 mikedld 2426
Returned value:
2427
  * function does not return value
2428
Remarks:
118 diamond 2429
  * Default scale is 0 (scale factor is 1). If in the shape data
2430
    one byte corresponds to one pixel, there is no necessity
2431
    to set scale.
2432
  * Let's designate xsize = window width (in pixels), ysize = height;
2433
    pay attention, that they are one pixel more than defined by
114 mikedld 2434
    functions 0, 67.
118 diamond 2435
  * On definition of scale xsize and ysize must be divisible
2436
    on 2^scale.
2437
  * Byte of data on offset 'a' must be 0/1 and defines belonging
2438
    to a window of square with the side 2^scale (if scale=0,
2439
    this is one pixel) and coordinates of the left upper corner
114 mikedld 2440
    (a mod (xsize shr scale), a div (xsize shr scale))
118 diamond 2441
  * Data size: (xsize shr scale)*(ysize shr scale).
2442
  * Data must be presented in the memory and not change
2443
    after set of shape.
2444
  * The system views the shape data at every window redraw by
2445
    function 0.
2446
  * The call of subfunction 0 with NULL pointer results in return
2447
    to the rectangular shape.
114 mikedld 2448
 
2449
======================================================================
2450
==================== Function 51 - create thread. ====================
2451
======================================================================
2452
Parameters:
118 diamond 2453
  * eax = 51 - function number
2454
  * ebx = 1 - unique subfunction
2455
  * ecx = address of thread entry point (starting eip)
2456
  * edx = pointer to thread stack (starting esp)
114 mikedld 2457
Returned value:
118 diamond 2458
  * eax = -1 - error (there is too many threads)
2459
  * otherwise eax = TID - thread identifier
2460
    
114 mikedld 2461
 
2462
======================================================================
118 diamond 2463
=== Function 52, subfunction 0 - get network driver configuration. ===
114 mikedld 2464
======================================================================
2465
Parameters:
118 diamond 2466
  * eax = 52 - function number
2467
  * ebx = 0 - subfunction number
114 mikedld 2468
Returned value:
118 diamond 2469
  * eax = configuration dword
114 mikedld 2470
Remarks:
118 diamond 2471
  * Configuration dword can be set by subfunction 2.
2472
  * The kernel does not use this variable. The value of this
2473
    variable and working with it subfunctions 0 and 2 is represented
2474
    doubtful.
114 mikedld 2475
 
2476
======================================================================
118 diamond 2477
========= Function 52, subfunction 1 - get local IP-address. =========
114 mikedld 2478
======================================================================
2479
Parameters:
118 diamond 2480
  * eax = 52 - function number
2481
  * ebx = 1 - subfunction number
114 mikedld 2482
Returned value:
2483
  * eax = IP-address (4 bytes)
2484
Remarks:
118 diamond 2485
  * Local IP-address is set by subfunction 3.
114 mikedld 2486
 
2487
======================================================================
118 diamond 2488
=== Function 52, subfunction 2 - set network driver configuration. ===
114 mikedld 2489
======================================================================
2490
Parameters:
118 diamond 2491
  * eax = 52 - function number
2492
  * ebx = 2 - subfunction number
2493
  * ecx = configuration dword; if low 7 bits derivate the number 3,
2494
    function [re-]initializes Ethernet-card, otherwise
2495
    Ethernet turns off
114 mikedld 2496
Returned value:
118 diamond 2497
  * if Ethernet-interface is not requested, function returns eax=2,
2498
    but this can be changed in future kernel versions
2499
  * if Ethernet-interface is requested, eax=0 means error
2500
    (absence of Ethernet-card), and nonzero value - success
114 mikedld 2501
Remarks:
118 diamond 2502
  * Configuration dword can be read by subfunction 0.
2503
  * The kernel does not use this variable. The value of this
2504
    variable, subfunction 0 and part of subfunction 2, which set it,
114 mikedld 2505
    is represented doubtful.
2506
 
2507
======================================================================
2508
========= Function 52, subfunction 3 - set local IP-address. =========
2509
======================================================================
2510
Parameters:
118 diamond 2511
  * eax = 52 - function number
2512
  * ebx = 3 - subfunction number
114 mikedld 2513
  * ecx = IP-address (4 bytes)
2514
Returned value:
118 diamond 2515
  * the current implementation returns eax=3, but this can be changed
2516
    in future versions
114 mikedld 2517
Remarks:
118 diamond 2518
  * Local IP-address can be get by subfunction 1.
114 mikedld 2519
 
2520
======================================================================
118 diamond 2521
= Function 52, subfunction 6 - add data to the stack of input queue. =
114 mikedld 2522
======================================================================
2523
Parameters:
118 diamond 2524
  * eax = 52 - function number
2525
  * ebx = 6 - subfunction number
2526
  * edx = data size
2527
  * esi = data pointer
114 mikedld 2528
Returned value:
2529
  * eax = -1 - error
118 diamond 2530
  * eax = 0 - success
114 mikedld 2531
Remarks:
118 diamond 2532
  * This function is intended only for slow network drivers
2533
    (PPP, SLIP).
2534
  * Data size must not exceed 1500 bytes, though function
2535
    performs no checks on correctness.
114 mikedld 2536
 
2537
======================================================================
118 diamond 2538
 Function 52, subfunction 8 - read data from the network output queue.
114 mikedld 2539
======================================================================
2540
Parameters:
118 diamond 2541
  * eax = 52 - function number
2542
  * ebx = 8 - subfunction number
2543
  * esi = pointer to 1500-byte buffer
114 mikedld 2544
Returned value:
118 diamond 2545
  * eax = number of read bytes (in the current implementation
2546
    either 0 = no data or 1500)
2547
  * data was copied in buffer
114 mikedld 2548
Remarks:
118 diamond 2549
  * This function is intended only for slow network drivers
2550
    (PPP, SLIP).
114 mikedld 2551
 
2552
======================================================================
118 diamond 2553
============ Function 52, subfunction 9 - get gateway IP. ============
114 mikedld 2554
======================================================================
2555
Parameters:
118 diamond 2556
  * eax = 52 - function number
2557
  * ebx = 9 - subfunction number
114 mikedld 2558
Returned value:
2559
  * eax = gateway IP (4 bytes)
2560
 
2561
======================================================================
118 diamond 2562
=========== Function 52, subfunction 10 - get subnet mask. ===========
114 mikedld 2563
======================================================================
2564
Parameters:
118 diamond 2565
  * eax = 52 - function number
2566
  * ebx = 10 - subfunction number
114 mikedld 2567
Returned value:
118 diamond 2568
  * eax = subnet mask
114 mikedld 2569
 
2570
======================================================================
118 diamond 2571
============ Function 52, subfunction 11 - set gateway IP. ===========
114 mikedld 2572
======================================================================
2573
Parameters:
118 diamond 2574
  * eax = 52 - function number
2575
  * ebx = 11 - subfunction number
114 mikedld 2576
  * ecx = gateway IP (4 bytes)
2577
Returned value:
118 diamond 2578
  * the current implementation returns eax=11, but this can be changed
2579
    in future versions
114 mikedld 2580
 
2581
======================================================================
118 diamond 2582
=========== Function 52, subfunction 12 - set subnet mask. ===========
114 mikedld 2583
======================================================================
2584
Parameters:
118 diamond 2585
  * eax = 52 - function number
2586
  * ebx = 12 - subfunction number
2587
  * ecx = subnet mask
114 mikedld 2588
Returned value:
118 diamond 2589
  * the current implementation returns eax=12, but this can be changed
2590
    in future versions
114 mikedld 2591
 
2592
======================================================================
118 diamond 2593
============== Function 52, subfunction 13 - get DNS IP. =============
114 mikedld 2594
======================================================================
2595
Parameters:
118 diamond 2596
  * eax = 52 - function number
2597
  * ebx = 13 - subfunction number
114 mikedld 2598
Returned value:
2599
  * eax = DNS IP (4 bytes)
2600
 
2601
======================================================================
118 diamond 2602
============== Function 52, subfunction 14 - set DNS IP. =============
114 mikedld 2603
======================================================================
2604
Parameters:
118 diamond 2605
  * eax = 52 - function number
2606
  * ebx = 14 - subfunction number
114 mikedld 2607
  * ecx = DNS IP (4 bytes)
2608
Returned value:
118 diamond 2609
  * the current implementation returns eax=14, but this can be changed
2610
    in future versions
114 mikedld 2611
 
2612
======================================================================
277 diamond 2613
======== Function 52, subfunction 15 - get local MAC address. ========
2614
======================================================================
2615
Parameters:
2616
  * eax = 52 - function number
2617
  * ebx = 15 - subfunction number
2618
  * ecx = 0 - read first 4 bytes,
2619
    ecx = 4 - read last 2 bytes
2620
Returned value:
2621
  * for ecx=0: eax = first 4 bytes of MAC address
2622
  * for ecx=4: ax = last 2 bytes of MAC address,
2623
               high half of eax is destroyed
2624
  * for other ecx: eax = -1 indicates an error
2625
 
2626
======================================================================
118 diamond 2627
============ Function 53, subfunction 0 - open UDP-socket. ===========
114 mikedld 2628
======================================================================
2629
Parameters:
118 diamond 2630
  * eax = 53 - function number
2631
  * ebx = 0 - subfunction number
2632
  * ecx = local port (only low word is taken into account)
2633
  * edx = remote port (only low word is taken into account)
114 mikedld 2634
  * esi = remote IP
2635
Returned value:
118 diamond 2636
  * eax = -1 = 0xFFFFFFFF - error; ebx destroyed
2637
  * eax = socket handle (some number which unambiguously identifies
2638
    socket and have sense only for the system) - success;
2639
    ebx destroyed
114 mikedld 2640
 
2641
======================================================================
118 diamond 2642
=========== Function 53, subfunction 1 - close UDP-socket. ===========
114 mikedld 2643
======================================================================
2644
Parameters:
118 diamond 2645
  * eax = 53 - function number
2646
  * ebx = 1 - subfunction number
2647
  * ecx = socket handle
114 mikedld 2648
Returned value:
118 diamond 2649
  * eax = -1 - incorrect handle
2650
  * eax = 0 - success
2651
  * ebx destroyed
114 mikedld 2652
Remarks:
118 diamond 2653
  * The current implementation does not close automatically all
2654
    sockets of a thread at termination. In particular, one should not
2655
    kill a thread with many opened sockets - there will be an outflow
2656
    of resources.
2657
  * The current implementation does no checks on correctness
2658
    (function returns error only if thread tries to close not opened
2659
    socket with correct handle).
114 mikedld 2660
 
2661
======================================================================
2662
============== Function 53, subfunction 2 - poll socket. =============
2663
======================================================================
2664
Parameters:
118 diamond 2665
  * eax = 53 - function number
2666
  * ebx = 2 - subfunction number
2667
  * ecx = socket handle
114 mikedld 2668
Returned value:
118 diamond 2669
  * eax = number of read bytes
2670
  * ebx destroyed
114 mikedld 2671
Remarks:
118 diamond 2672
  * There is no checks for correctness.
114 mikedld 2673
 
2674
======================================================================
118 diamond 2675
========= Function 53, subfunction 3 - read byte from socket. ========
114 mikedld 2676
======================================================================
2677
Parameters:
118 diamond 2678
  * eax = 53 - function number
2679
  * ebx = 3 - subfunction number
2680
  * ecx = socket handle
114 mikedld 2681
Returned value:
118 diamond 2682
  * if there is no read data: eax=0, bl=0,
2683
    other bytes of ebx are destroyed
2684
  * if there are read data: eax=number of rest bytes
2685
    (possibly 0), bl=read byte, other bytes of ebx are destroyed
114 mikedld 2686
Remarks:
118 diamond 2687
  * There is no checks for correctness.
114 mikedld 2688
 
2689
======================================================================
118 diamond 2690
========== Function 53, subfunction 4 - write to UDP-socket. =========
114 mikedld 2691
======================================================================
2692
Parameters:
118 diamond 2693
  * eax = 53 - function number
2694
  * ebx = 4 - subfunction number
2695
  * ecx = socket handle
2696
  * edx = number of bytes to write
2697
  * esi = pointer to data to write
114 mikedld 2698
Returned value:
118 diamond 2699
  * eax = 0xffffffff - invalid handle
2700
  * eax = 0xffff - not enough memory
2701
  * eax = 0 - success
2702
  * ebx destroyed
114 mikedld 2703
Remarks:
118 diamond 2704
  * Check on validity of handle is minimal - only not very incorrect
2705
    not opened handles are eliminated.
2706
  * Number of bytes to write must not exceed 1500-28, though
2707
    the appropriate check is not made.
114 mikedld 2708
 
2709
======================================================================
2710
============ Function 53, subfunction 5 - open TCP-socket. ===========
2711
======================================================================
2712
Parameters:
118 diamond 2713
  * eax = 53 - function number
2714
  * ebx = 5 - subfunction number
2715
  * ecx = local port (only low word is taken into account)
2716
  * edx = remote port (only low word is taken into account)
114 mikedld 2717
  * esi = remote IP
118 diamond 2718
  * edi = open mode: SOCKET_PASSIVE=0 or SOCKET_ACTIVE=1
114 mikedld 2719
Returned value:
118 diamond 2720
  * eax = -1 = 0xFFFFFFFF - error; ebx destroys
2721
  * eax = socket handle (some number which unambiguously identifies
2722
    socket and have sense only for the system) - success;
2723
    ebx destroyed
114 mikedld 2724
 
2725
======================================================================
118 diamond 2726
========= Function 53, subfunction 6 - get TCP-socket status. ========
114 mikedld 2727
======================================================================
2728
Parameters:
118 diamond 2729
  * eax = 53 - function number
2730
  * ebx = 6 - subfunction number
2731
  * ecx = socket handle
114 mikedld 2732
Returned value:
118 diamond 2733
  * eax = socket status: one of
114 mikedld 2734
  * TCB_LISTEN = 1
2735
  * TCB_SYN_SENT = 2
2736
  * TCB_SYN_RECEIVED = 3
2737
  * TCB_ESTABLISHED = 4
2738
  * TCB_FIN_WAIT_1 = 5
2739
  * TCB_FIN_WAIT_2 = 6
2740
  * TCB_CLOSE_WAIT = 7
2741
  * TCB_CLOSING = 8
2742
  * TCB_LAST_ASK = 9
2743
  * TCB_TIME_WAIT = 10
2744
  * TCB_CLOSED = 11
118 diamond 2745
  * ebx destroys
114 mikedld 2746
Remarks:
118 diamond 2747
  * There is no checks for correctness.
114 mikedld 2748
 
2749
======================================================================
118 diamond 2750
========== Function 53, subfunction 7 - write to TCP-socket. =========
114 mikedld 2751
======================================================================
2752
Parameters:
118 diamond 2753
  * eax = 53 - function number
2754
  * ebx = 7 - subfunction number
2755
  * ecx = socket handle
2756
  * edx = number of bytes to write
2757
  * esi = pointer to data to write
114 mikedld 2758
Returned value:
2759
  * eax = 0xffffffff - error
118 diamond 2760
  * eax = 0xffff - not enough memory
2761
  * eax = 0 - success
2762
  * ebx destroyed
114 mikedld 2763
Remarks:
118 diamond 2764
  * Check on validity of handle is minimal - only not very incorrect
2765
    not opened handles are eliminated.
2766
  * Number of bytes to write must not exceed 1500-40, though
2767
    the appropriate check is not made.
114 mikedld 2768
 
2769
======================================================================
118 diamond 2770
=========== Function 53, subfunction 8 - close TCP-socket. ===========
114 mikedld 2771
======================================================================
2772
Parameters:
118 diamond 2773
  * eax = 53 - function number
2774
  * ebx = 8 - subfunction number
2775
  * ecx = socket handle
114 mikedld 2776
Returned value:
118 diamond 2777
  * eax = -1 - invalid handle
2778
  * eax = 0xffff - not enough memory for socket close packet
2779
  * eax = 0 - success
2780
  * in many cases eax is destroyed (the result of function 'queue'
2781
    is returned) - probably this is bug, which will be corrected
2782
  * ebx destroyed
114 mikedld 2783
Remarks:
118 diamond 2784
  * The current implementation does not close automatically all
2785
    sockets of a thread at termination. In particular, one should not
2786
    kill a thread with many opened sockets - there will be an outflow
2787
    of resources.
2788
  * The current implementation does no checks on correctness
2789
    (function returns error only if thread tries to close not opened
2790
    socket with correct handle).
114 mikedld 2791
 
2792
======================================================================
118 diamond 2793
=== Function 53, subfunction 9 - check whether local port is free. ===
114 mikedld 2794
======================================================================
2795
Parameters:
118 diamond 2796
  * eax = 53 - function number
2797
  * ebx = 9 - subfunction number
2798
  * ecx = local port number (low 16 bits are used only)
114 mikedld 2799
Returned value:
2800
  * eax = 0 - port is used
2801
  * eax = 1 - port is free
118 diamond 2802
  * ebx destroyed
114 mikedld 2803
 
2804
======================================================================
314 diamond 2805
===== Function 53, subfunction 10 - query Ethernet cable status. =====
2806
======================================================================
2807
Parameters:
2808
  * eax = 53 - function number
2809
  * ebx = 10 - subfunction number
2810
Returned value:
2811
  * al = -1 - a network driver is not loaded or
2812
              does not support this function
2813
  * al = 0 - Ethernet cable is unplugged
2814
  * al = 1 - Ethernet cable is plugged
346 diamond 2815
  * ebx destroyed
314 diamond 2816
Remarks:
2817
  * The current kernel implementation supports this function
2818
    only for RTL8139 network cards.
2819
 
2820
======================================================================
346 diamond 2821
======= Function 53, subfunction 11 - read network stack data. =======
340 heavyiron 2822
======================================================================
346 diamond 2823
Paramters:
2824
  * eax = 53 - function number
2825
  * ebx = 11 - subfunction number
2826
  * ecx = socket handle
2827
  * edx = pointer to buffer
2828
  * esi = number of bytes to read;
2829
  * esi = 0 - read all data (maximum 4096 bytes)
2830
Returned value:
2831
  * eax = number of bytes read
2832
  * ebx destroyed
2833
Remakrs:
2834
  * There is no check on handle correctness.
340 heavyiron 2835
 
2836
======================================================================
118 diamond 2837
= Function 53, subfunction 255 - debug information of network driver.
114 mikedld 2838
======================================================================
2839
Parameters:
118 diamond 2840
  * eax = 53 - function number
2841
  * ebx = 255 - subfunction number
114 mikedld 2842
  * ecx = type of requested information (see below)
2843
Returned value:
2844
  * eax = requested information
118 diamond 2845
  * ebx destroyed
2846
Possible values for ecx:
114 mikedld 2847
  * 100: length of queue 0 (empty queue)
2848
  * 101: length of queue 1 (ip-out queue)
2849
  * 102: length of queue 2 (ip-in queue)
2850
  * 103: length of queue 3 (net1out queue)
118 diamond 2851
  * 200: number of items in the ARP table
2852
  * 201: size of the ARP table (in items) (20 for current version)
2853
  * 202: read item at edx of the ARP table to the temporary buffer,
2854
    whence 5 following types take information;
114 mikedld 2855
    in this case eax is not defined
118 diamond 2856
  * 203: IP-address saved by type 202
2857
  * 204: high dword of MAC-address saved by type 202
2858
  * 205: low word of MAC-address saved by type 202
2859
  * 206: status word saved by type 202
2860
  * 207: ttl word saved by type 202
2861
  * 2: total number of received IP-packets
2862
  * 3: total number of transferred IP-packets
2863
  * 4: total number of dumped received packets
2864
  * 5: total number of received ARP-packets
2865
  * 6: status of packet driver, 0=inactive, nonzero=active
114 mikedld 2866
 
2867
======================================================================
2868
========== Function 55, subfunction 0 - load data for SB16. ==========
2869
======================================================================
2870
Parameters:
118 diamond 2871
  * eax = 55 - function number
2872
  * ebx = 0 - subfunction number
2873
  * ecx = pointer to data (is copied 64 kilobytes, is used as much as
2874
    set by subfunction 2)
114 mikedld 2875
Returned value:
2876
  * function does not return value
2877
Remarks:
118 diamond 2878
  * Format and size of data are set by subfunction 2.
114 mikedld 2879
 
2880
======================================================================
118 diamond 2881
======== Function 55, subfunction 1 - begin play data on SB16. =======
114 mikedld 2882
======================================================================
2883
Parameters:
118 diamond 2884
  * eax = 55 - function number
2885
  * ebx = 1 - subfunction number
114 mikedld 2886
Returned value:
2887
  * function does not return value
2888
Remarks:
118 diamond 2889
  * Previously data must be loaded by subfunction 0 and
2890
    their format must be defined by subfunction 2.
2891
  * Function returns control, when playing of data began; after that
2892
    play goes independently from application (and does not use
2893
    processor time at all).
2894
  * Previously must be defined SB16 base port
2895
    (by subfunction 4 of function 21) and DMA channel
2896
    (by subfunction 10 of function 21).
114 mikedld 2897
 
2898
======================================================================
118 diamond 2899
======== Function 55, subfunction 2 - set format of SB16 data. =======
114 mikedld 2900
======================================================================
2901
Parameters:
118 diamond 2902
  * eax = 55 - function number
2903
  * ebx = 2 - subfunction number
2904
  * ecx = 0 - set digit capacity
2905
    * edx = 1 - 8bit mono
2906
    * edx = 2 - 8bit stereo
2907
  * ecx = 1 - set data size
114 mikedld 2908
    * edx = size in bytes
118 diamond 2909
  * ecx = 2 - set play frequency
114 mikedld 2910
    * edx = frequency
2911
Returned value:
2912
  * function does not return value
2913
Remarks:
118 diamond 2914
  * When the system boots, it sets following default parameters:
2915
    digit capacity - 8bit mono, size - 64 Kb, frequency - 44100 Hz.
2916
    Nevertheless it is recommended to set necessary values obviously
2917
    as they could be reset by some application.
114 mikedld 2918
 
2919
======================================================================
118 diamond 2920
 Function 55, subfunction 55 - begin to play data on built-in speaker.
114 mikedld 2921
======================================================================
2922
Parameters:
118 diamond 2923
  * eax = 55 - function number
2924
  * ebx = 55 - subfunction number
2925
  * esi = pointer to data
114 mikedld 2926
Returned value:
118 diamond 2927
  * eax = 0 - success
2928
  * eax = 55 - error (speaker is off or busy)
2929
Data is an array of items with variable length.
2930
Format of each item is defined by first byte:
114 mikedld 2931
  * 0 = end of data
118 diamond 2932
  * 1..0x80 = sets sound duration on 1/100 of second; sound note
2933
    is defined by immediate value of frequency
2934
    * following word (2 bytes) contains frequency divider;
2935
      frequency is defined as 1193180/divider
114 mikedld 2936
  * 0x81 = invalid
118 diamond 2937
  * 0x82..0xFF = note is defined by octave and number:
2938
    * duration in 1/100 of second = (first byte)-0x81
114 mikedld 2939
    * there is one more byte;
118 diamond 2940
    * (second byte)=0xFF - delay
2941
    * otherwise it looks like a*0x10+b, where b=number of the note in
2942
      an octave from 1 to 12, a=number of octave (beginning from 0)
114 mikedld 2943
Remarks:
118 diamond 2944
  * Speaker play can be disabled/enabled by
2945
    subfunction 8 of function 18.
2946
  * Function returns control, having informed the system
2947
    an information on request. Play itself goes independently from
2948
    the program.
2949
  * The data must be kept in the memory at least up to the end
2950
    of play.
114 mikedld 2951
 
2952
======================================================================
641 diamond 2953
======================= Function 57 - PCI BIOS. ======================
2954
======================================================================
2955
Parameters:
2956
  * eax = 57 - function number
2957
  * ebp corresponds to al in PCI BIOS specification
2958
  * other registers are set according to PCI BIOS specification
2959
Returned value:
2960
  * CF is undefined
2961
  * other registers are set according to PCI BIOS specification
2962
Remarks:
2963
  * Many effects of this function can be also achieved with
2964
    corresponding subfunctions of function 62.
2965
  * The function calls PCI32 BIOS extension, documented e.g. in
2966
    http://alpha1.dyns.net/files/PCI/bios21.pdf.
2967
  * If BIOS does not support this extension, its behavior is emulated
2968
    (through kernel-mode analogues of subfunctions of function 62).
2969
 
2970
======================================================================
118 diamond 2971
================ Function 58 - work with file system. ================
114 mikedld 2972
======================================================================
2973
Parameters:
2974
  * eax = 58
118 diamond 2975
  * ebx = pointer to the information structure
114 mikedld 2976
Returned value:
118 diamond 2977
  * eax = 0 - success; otherwise file system error code
2978
  * some subfunctions return value in other registers too
2979
General format of the information structure:
2980
  * +0: dword: subfunction number
114 mikedld 2981
  * +4: dword: number of block
2982
  * +8: dword: size
118 diamond 2983
  * +12 = +0xC: dword: pointer to data
2984
  * +16 = +0x10: dword: pointer to a memory for system operations
114 mikedld 2985
    (4096 bytes)
118 diamond 2986
  * +20 = +0x14: n db: ASCIIZ-string with the file name
2987
Specifications - in documentation on the appropriate subfunction.
2988
Filename is case-insensitive for latin letters, russian letters
2989
must be capital.
2990
Format of filename:
114 mikedld 2991
/base/number/dir1/dir2/.../dirn/file,
118 diamond 2992
where /base/number identifies device, on which file is located:
114 mikedld 2993
one of
118 diamond 2994
  * /RD/1 = /RAMDISK/1 to access ramdisk
2995
  * /FD/1 = /FLOPPYDISK/1 to access first floppy drive,
2996
    /FD/2 = /FLOPPYDISK/2 to access second one
2997
  * /HD/x = /HARDDISK/x - obsolete variant of access to hard disk
2998
    (in this case base is defined by subfunction 7 of function 21),
2999
    x - partition number (beginning from 1)
3000
  * /HD0/x, /HD1/x, /HD2/x, /HD3/x to access accordingly to devices
3001
    IDE0 (Primary Master), IDE1 (Primary Slave),
114 mikedld 3002
    IDE2 (Secondary Master), IDE3 (Secondary Slave);
118 diamond 3003
    x - partition number on the selected hard drive, varies from 1
3004
    to 255 (on each hard drive the indexing starts from 1)
114 mikedld 3005
Remarks:
118 diamond 3006
  * In the first two cases it is also possible to use FIRST
3007
    instead of 1, SECOND instead of 2, but it is not recommended
3008
    for convenience of transition to the future extensions.
3009
  * Limitation n<=39 is imposed.
3010
  * Names of folders and file dir1,...,dirn,file must have the
3011
    format 8.3: name no more than 8 characters, dot, extension no
3012
    more than 3 characters. Trailing spaces are ignored, no other
3013
    spaces is allowed. If name occupies equally 8 characters,
3014
    dot may be omitted (though it is not recommended to use this
3015
    feature for convenience of transition to the future extensions).
3016
  * This function does not support folders on ramdisk.
114 mikedld 3017
Examples:
3018
  * '/RAMDISK/FIRST/KERNEL.ASM',0
3019
    '/rd/1/kernel.asm',0
3020
  * '/HD0/1/kernel.asm',0
3021
  * '/hd0/1/menuet/pics/tanzania.bmp',0
118 diamond 3022
Existing subfunctions:
3023
  * subfunction 0 - read file/folder
3024
  * subfunction 8 - LBA-read from device
3025
  * subfunction 15 - get file system information
114 mikedld 3026
 
3027
======================================================================
118 diamond 3028
=========== Function 58, subfunction 0 - read file/folder. ===========
114 mikedld 3029
======================================================================
3030
Parameters:
3031
  * eax = 58
118 diamond 3032
  * ebx = pointer to the information structure
3033
Format of the information structure:
3034
  * +0: dword: 0 = subfunction number
3035
  * +4: dword: first block to read (beginning from 0)
3036
  * +8: dword: amount of blocks to read
3037
  * +12 = +0xC: dword: pointer to buffer for data
3038
  * +16 = +0x10: dword: pointer to buffer for system operations
114 mikedld 3039
    (4096 bytes)
118 diamond 3040
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3041
    given in the general description
114 mikedld 3042
Returned value:
118 diamond 3043
  * eax = 0 - success, otherwise file system error code
3044
  * ebx = file size (in bytes) or -1=0xffffffff, if file was not found
114 mikedld 3045
Remarks:
118 diamond 3046
  * Block size is 512 bytes.
114 mikedld 3047
  * This function is obsolete, for reading files use subfunction 0
118 diamond 3048
    of function 70, for reading folders - subfunction 1 of
3049
    function 70.
3050
  * Function can read contents of a folder. Only FAT file system is
3051
    supported. The format of FAT-folder is described
3052
    in any FAT documentation.
3053
  * Size of a folder is determined by size of FAT clusters chain.
3054
  * If file was ended before last requested block was read,
3055
    the function will read as many as it can, and after that return
3056
    eax=6 (EOF).
3057
  * Function can read root folders /rd/1,/fd/x,/hd[n]/x, but
3058
    in the first two cases the current implementation does not follow
3059
    to the declared rules:
114 mikedld 3060
    for /rd/1:
118 diamond 3061
    * if one want to read 0 blocks, function considers,
3062
      that he requested 1;
3063
    * if one requests more than 14 blocks or starting block is
3064
      not less than 14, function returns eax=5 (not found) и ebx=-1;
3065
    * size of ramdisk root folder is 14 blocks,
3066
      0x1C00=7168 байт; but function returns ebx=0
3067
      (except of the case of previous item);
3068
    * strangely enough, it is possible to read 14th block (which
3069
      generally contains a garbage - I remind, the indexing begins
3070
      from 0);
3071
    * if some block with the number not less than 14 was requested,
3072
      function returns eax=6(EOF); otherwise eax=0.
3073
    For /fd/x:
3074
    * if the start block is not less than 14, function returns
3075
      eax=5 (not found) and ebx=0;
3076
    * note that format of FAT12 allows floppies with the root size
3077
      more or less than 14 blocks;
3078
    * check for length is not performed;
3079
    * if data was successful read, function returns
3080
      eax=0,ebx=0; otherwise eax=10 (access denied), ebx=-1.
3081
  * The function handles reading of special folders /,/rd,/fd,/hd[n];
3082
    but the result does not correspond to expected (on operations with
3083
    normal files/folders), does not follow the declared rules,
3084
    may be changed in future versions of the kernel and consequently
3085
    is not described. To obtain the information about the equipment
3086
    use subfunction 11 of function 18 or
3087
    read corresponding folder with subfunction 1 of function 70.
114 mikedld 3088
 
3089
======================================================================
118 diamond 3090
========= Function 58, subfunction 8 - LBA-read from device. =========
114 mikedld 3091
======================================================================
3092
Parameters:
118 diamond 3093
  * eax = 58 - function number
3094
  * ebx = pointer to the information structure
3095
Format of the information structure:
3096
  * +0: dword: 8 = subfunction number
3097
  * +4: dword: number of block to read (beginning from 0)
3098
  * +8: dword: ignored (set to 1)
3099
  * +12 = +0xC: dword: pointer to buffer for data (512 bytes)
3100
  * +16 = +0x10: dword: pointer to buffer for system operations
114 mikedld 3101
    (4096 bytes)
118 diamond 3102
  * +20 = +0x14: ASCIIZ-name of device: case-insensitive, one of
3103
    /rd/1 = /RamDisk/1, /hd/n = /HardDisk/n,
114 mikedld 3104
    1<=n<=4 - number of device: 1=IDE0, ..., 4=IDE3.
118 diamond 3105
    Instead of digits it is allowed, though not recommended for
3106
    convenience of transition to future extensions, to use
3107
    'first','second','third','fourth'.
114 mikedld 3108
Returned value:
118 diamond 3109
  * for device name /hd/xxx, where xxx is not in the list above:
114 mikedld 3110
    * eax = ebx = 1
118 diamond 3111
  * for invalid device name (except for the previous case):
114 mikedld 3112
    * eax = 5
118 diamond 3113
    * ebx does not change
3114
  * if LBA-access is disabled by subfunction 11 of function 21:
114 mikedld 3115
    * eax = 2
118 diamond 3116
    * ebx destroyed
3117
  * for ramdisk: attempt to read block outside ramdisk
3118
    (18*2*80 blocks) results in
114 mikedld 3119
    * eax = 3
3120
    * ebx = 0
118 diamond 3121
  * for successful read:
114 mikedld 3122
    * eax = ebx = 0
3123
Remarks:
118 diamond 3124
  * Block size is 512 bytes; function reads one block.
3125
  * Do not depend on returned value, it can be changed
3126
    in future versions.
3127
  * Function requires that LBA-access to devices is enabled by
3128
    subfunction 11 of function 21. To check this one can use
3129
    subfunction 11 of function 26.
3130
  * LBA-read of floppy is not supported.
3131
  * Function reads data on physical hard drive; if for any reason
3132
    data of the concrete partition are required, application must
3133
    define starting sector of this partition (either directly
3134
    through MBR, or from the full structure returned by
3135
    подфункцией 11 функции 18).
3136
  * Function does not check error code of hard disk, so request of
3137
    nonexisting sector reads something (most probably it will be
3138
    zeroes, but this is defined by device) and this is considered
3139
    as success (eax=0).
114 mikedld 3140
 
118 diamond 3141
======================================================================
3142
==== Function 58, subfunction 15 - get information on file system. ===
3143
======================================================================
114 mikedld 3144
Parameters:
118 diamond 3145
  * eax = 58 - function number
3146
  * ebx = pointer to the information structure
3147
Format of the information structure:
3148
  * +0: dword: 15 = subfunction number
114 mikedld 3149
  * +4: dword: ignored
3150
  * +8: dword: ignored
3151
  * +12 = +0xC: dword: ignored
3152
  * +16 = +0x10: dword: ignored
118 diamond 3153
  * +20 = +0x14: (only second character is checked)
114 mikedld 3154
    /rd=/RAMDISK or /hd=/HARDDISK
3155
Returned value:
118 diamond 3156
  * if the second character does not belong to set {'r','R','h','H'}:
114 mikedld 3157
    * eax = 3
3158
    * ebx = ecx = dword [fileinfo] = 0
3159
  * for ramdisk:
3160
    * eax = 0 (success)
3161
    * ebx = total number of clusters = 2847
3162
    * ecx = number of free clusters
3163
    * dword [fileinfo] = cluster size = 512
118 diamond 3164
  * for hard disk: base and partition are defined by subfunctions
3165
    7 and 8 of function 21:
114 mikedld 3166
    * eax = 0 (success)
3167
    * ebx = total number of clusters
3168
    * ecx = number of free clusters
3169
    * dword [fileinfo] = cluster size (in bytes)
3170
Remarks:
118 diamond 3171
  * Be not surprised to strange layout of 4th returned parameter
3172
    - when this code was writing, at system calls application got
3173
    only registers eax,ebx,ecx (from pushad-structure transmitted
3174
    as argument to the system function). Now it is corrected, so,
3175
    probably, it is meaningful to return cluster size in edx, while
3176
    this function is not used yet.
3177
  * There exists also subfunction 11 of function 18,
3178
    which returns information on file system. From the full table
3179
    of disk subsystem it is possible to deduce cluster size (there
3180
    it is stored in sectors) and total number of clusters
3181
    for hard disks.
114 mikedld 3182
 
3183
======================================================================
118 diamond 3184
========== Function 60 - Inter Process Communication (IPC). ==========
114 mikedld 3185
======================================================================
118 diamond 3186
IPC is used for message dispatching from one process/thread to
3187
another. Previously it is necessary to agree how to interpret
114 mikedld 3188
the concrete message.
3189
 
118 diamond 3190
----------- Subfunction 1 - set the area for IPC receiving -----------
3191
Is called by process-receiver.
114 mikedld 3192
Parameters:
118 diamond 3193
  * eax = 60 - function number
3194
  * ebx = 1 - subfunction number
3195
  * ecx = pointer to the buffer
3196
  * edx = size of the buffer
114 mikedld 3197
Returned value:
118 diamond 3198
  * eax = 0 - always success
3199
Format of IPC-buffer:
3200
  * +0: dword: if nonzero, buffer is considered locked;
3201
    lock/unlock the buffer, when you work with it and need that
3202
    buffer data are not changed from outside (no new messages)
114 mikedld 3203
  * +4: dword: occupied place in the buffer (in bytes)
3204
  * +8: first message
3205
  * +8+n: second message
3206
  * ...
118 diamond 3207
Format of a message:
3208
  * +0: dword: PID of sender
3209
  * +4: dword: message length (not including this header)
3210
  * +8: n*byte: message data
114 mikedld 3211
 
118 diamond 3212
------------------ Subfunction 2 - send IPC message ------------------
3213
Is called by process-sender.
114 mikedld 3214
Parameters:
118 diamond 3215
  * eax = 60 - function number
3216
  * ebx = 2 - subfunction number
114 mikedld 3217
  * ecx = PID of receiver
118 diamond 3218
  * edx = pointer to the message data
3219
  * esi = message length (in bytes)
114 mikedld 3220
Returned value:
118 diamond 3221
  * eax = 0 - success
3222
  * eax = 1 - the receiver has not defined buffer for IPC messages
3223
    (can be, still have no time,
3224
    and can be, this is not right process)
3225
  * eax = 2 - the receiver has blocked IPC-buffer; try to wait a bit
3226
  * eax = 3 - overflow of IPC-buffer of the receiver
114 mikedld 3227
  * eax = 4 - process/thread with such PID does not exist
3228
Remarks:
118 diamond 3229
  * Immediately after writing of IPC-message to the buffer the system
3230
    sends to the receiver the event with code 7 (see event codes).
114 mikedld 3231
 
3232
======================================================================
118 diamond 3233
==== Function 61 - get parameters for the direct graphics access. ====
114 mikedld 3234
======================================================================
118 diamond 3235
The data of the graphics screen (the memory area which displays
3236
screen contents) are accessible to a program directly, without
3237
any system calls, through the selector gs:
131 diamond 3238
	mov	eax, [gs:0]
118 diamond 3239
places in eax the first dword of the buffer, which contains
3240
information on color of the left upper point (and, possibly, colors
3241
of several following).
131 diamond 3242
	mov	[gs:0], eax
118 diamond 3243
by work in VESA modes with LFB sets color of the left upper point
3244
(and, possibly, colors of several following).
3245
To interpret the data of graphics screen program needs to know
3246
some parameters, returning by this function.
114 mikedld 3247
Remarks:
118 diamond 3248
  * Graphics parameters changes very seldom at work,
3249
    namely, only in cases, when user works with the application VRR.
3250
  * At videomode change the system redraws all windows (event
3251
    with code 1) and redraws the background (event 5).
3252
    Same events occur in other cases too, which meet much more often,
3253
    than videomode change.
3254
  * By operation in videomodes with LFB the selector gs points to
3255
    LFB itself, so reading/writing on gs result directly in
3256
    change of screen contents. By operation in videomodes without
3257
    LFB gs points to some data area in the kernel, and all functions
3258
    of screen output fulfil honesty double operation on writing
3259
    directly to the screen and writing to this buffer. In result
3260
    at reading contents of this buffer the results correspond to
3261
    screen contents (with, generally speaking, large color
3262
    resolution), and writing is ignored.
3263
    One exception is the mode 320*200, for which main loop of the
3264
    system thread updates the screen according to mouse movements.
114 mikedld 3265
 
3266
------------------------- Screen resolution --------------------------
3267
Parameters:
118 diamond 3268
  * eax = 61 - function number
3269
  * ebx = 1 - subfunction number
114 mikedld 3270
Returned value:
118 diamond 3271
  * eax = [resolution on x axis]*65536 + [resolution on y axis]
114 mikedld 3272
Remarks:
118 diamond 3273
  * One can use function 14 paying attention that
3274
    it returns sizes on 1 pixel less. It is fully equivalent way.
114 mikedld 3275
 
118 diamond 3276
---------------------- Number of bits per pixel ----------------------
114 mikedld 3277
Parameters:
118 diamond 3278
  * eax = 61 - function number
3279
  * ebx = 2 - subfunction number
114 mikedld 3280
Returned value:
118 diamond 3281
  * eax = number of bits per pixel (24 or 32)
114 mikedld 3282
 
118 diamond 3283
-------------------- Number of bytes per scanline --------------------
114 mikedld 3284
Parameters:
118 diamond 3285
  * eax = 61 - function number
3286
  * ebx = 3 - subfunction number
114 mikedld 3287
Returned value:
118 diamond 3288
  * eax = number of bytes occupied by one scanline
114 mikedld 3289
    (horizontal line on the screen)
3290
 
3291
======================================================================
118 diamond 3292
===== Function 62, subfunction 0 - get version of PCI-interface. =====
114 mikedld 3293
======================================================================
3294
Parameters:
118 diamond 3295
  * eax = 62 - function number
3296
  * bl = 0 - subfunction number
114 mikedld 3297
Returned value:
118 diamond 3298
  * eax = -1 - PCI access is disabled; otherwise
3299
  * ah.al = version of PCI-interface (ah=version, al=subversion)
3300
  * high word of eax is zeroed
114 mikedld 3301
Remarks:
118 diamond 3302
  * Previously low-level access to PCI for applications must be
3303
    enabled by subfunction 12 of function 21.
3304
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 3305
 
3306
======================================================================
118 diamond 3307
==== Function 62, subfunction 1 - get number of the last PCI-bus. ====
114 mikedld 3308
======================================================================
3309
Parameters:
118 diamond 3310
  * eax = 62 - function number
3311
  * bl = 1 - subfunction number
114 mikedld 3312
Returned value:
118 diamond 3313
  * eax = -1 - access to PCI is disabled; otherwise
3314
  * al = number of the last PCI-bus; other bytes of eax are destroyed
114 mikedld 3315
Remarks:
118 diamond 3316
  * Previously low-level access to PCI for applications must be
3317
    enabled by subfunction 12 of function 21.
3318
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 3319
 
3320
======================================================================
118 diamond 3321
===================== Function 62, subfunction 2 =====================
3322
===== Get mechanism of addressing to the PCI configuration space. ====
114 mikedld 3323
======================================================================
3324
Parameters:
118 diamond 3325
  * eax = 62 - function number
3326
  * bl = 2 - subfunction number
114 mikedld 3327
Returned value:
118 diamond 3328
  * eax = -1 - access to PCI is disabled; otherwise
3329
  * al = mechanism (1 or 2); other bytes of eax are destroyed
114 mikedld 3330
Remarks:
118 diamond 3331
  * Previously low-level access to PCI for applications must be
3332
    enabled by subfunction 12 of function 21.
3333
  * Addressing mechanism is selected depending on
3334
    equipment characteristics.
3335
  * Subfunctions of read and write work automatically
3336
    with the selected mechanism.
114 mikedld 3337
 
3338
======================================================================
118 diamond 3339
======== Function 62, subfunctions 4,5,6 - read PCI-register. ========
114 mikedld 3340
======================================================================
3341
Parameters:
118 diamond 3342
  * eax = 62 - function number
3343
  * bl = 4 - read byte
3344
  * bl = 5 - read word
3345
  * bl = 6 - read dword
114 mikedld 3346
  * bh = number of PCI-bus
118 diamond 3347
  * ch = dddddfff, where ddddd = number of the device on the bus,
3348
    fff = function number of device
3349
  * cl = number of register (must be even for bl=5,
3350
    divisible by 4 for bl=6)
114 mikedld 3351
Returned value:
118 diamond 3352
  * eax = -1 - error (access to PCI is disabled or parameters
3353
    are not supported); otherwise
3354
  * al/ax/eax (depending on requested size) contains the data;
3355
    the other part of register eax is destroyed
114 mikedld 3356
Remarks:
118 diamond 3357
  * Previously low-level access to PCI for applications must be
3358
    enabled by subfunction 12 of function 21.
3359
  * Access mechanism 2 supports only 16 devices on a bus and ignores
3360
    function number. To get access mechanism use subfunction 2.
3361
  * Some registers are standard and exist for all devices, some are
3362
    defined by the concrete device. The list of registers of the
3363
    first type can be found e.g. in famous
114 mikedld 3364
    Interrupt List by Ralf Brown
3365
    (http://www.pobox.com/~ralf/files.html,
3366
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/);
118 diamond 3367
    registers of the second type must be listed
3368
    in the device documentation.
114 mikedld 3369
 
3370
======================================================================
118 diamond 3371
====== Function 62, subfunctions 8,9,10 - write to PCI-register. =====
114 mikedld 3372
======================================================================
3373
Parameters:
118 diamond 3374
  * eax = 62 - function number
3375
  * bl = 8 - write byte
3376
  * bl = 9 - write word
3377
  * bl = 10 - write dword
114 mikedld 3378
  * bh = number of PCI-bus
118 diamond 3379
  * ch = dddddfff, where ddddd = number of the device on the bus,
3380
    fff = function number of device
3381
  * cl = number of register (must be even for bl=9,
3382
    divisible by 4 for bl=10)
3383
  * dl/dx/edx (depending on requested size) contatins
3384
    the data to write
114 mikedld 3385
Returned value:
118 diamond 3386
  * eax = -1 - error (access to PCI is disabled or parameters
3387
    are not supported)
3388
  * eax = 0 - success
114 mikedld 3389
Remarks:
118 diamond 3390
  * Previously low-level access to PCI for applications must be
3391
    enabled by subfunction 12 of function 21.
3392
  * Access mechanism 2 supports only 16 devices on a bus and ignores
3393
    function number. To get access mechanism use subfunction 2.
3394
  * Some registers are standard and exist for all devices, some are
3395
    defined by the concrete device. The list of registers of the
3396
    first type can be found e.g. in famous Interrupt List by
3397
    Ralf Brown; registers of the second type must be listed
3398
    in the device documentation.
114 mikedld 3399
 
3400
======================================================================
118 diamond 3401
============== Function 63 - work with the debug board. ==============
114 mikedld 3402
======================================================================
118 diamond 3403
The debug board is the global system buffer (with the size
499 diamond 3404
1024 bytes), to which any program can write (generally speaking,
118 diamond 3405
arbitrary) data and from which other program can read these data.
3406
By the agreement written data are text strings interpreted as
3407
debug messages on a course of program execution. The kernel in
3408
some situations also writes to the debug board information on
3409
execution of some functions; by the agreement kernel messages
3410
begins from the prefix "K : ".
3411
For view of the debug board the application 'board' was created,
3412
which reads data from the buffer and displays them in its window.
3413
'board' interpretes the sequence of codes 13,10 as newline.
3414
A character with null code in an end of line is not necessary,
114 mikedld 3415
but also does not prevent.
118 diamond 3416
Because debugger has been written, the value of the debug board
3417
has decreased, as debugger allows to inspect completely a course of
3418
program execution without any efforts from the direction of program
3419
itself. Nevertheless in some cases the debug board is still useful.
114 mikedld 3420
 
118 diamond 3421
----------------------------- Write byte -----------------------------
114 mikedld 3422
Parameters:
118 diamond 3423
  * eax = 63 - function number
3424
  * ebx = 1 - subfunction number
3425
  * cl = data byte
114 mikedld 3426
Returned value:
3427
  * function does not return value
3428
Remarks:
118 diamond 3429
  * Byte is written to the buffer. Buffer size is 512 bytes.
3430
    At buffer overflow all obtained data are lost.
3431
  * For output to the debug board of more complicated objects
3432
    (strings, numbers) it is enough to call this function in cycle.
3433
    It is possible not to write the appropriate code manually and use
3434
    file 'debug.inc', which is included into the distributive.
114 mikedld 3435
 
118 diamond 3436
----------------------------- Read byte ------------------------------
3437
Takes away byte from the buffer.
114 mikedld 3438
Parameters:
118 diamond 3439
  * eax = 63 - function number
3440
  * ebx = 2 - subfunction number
114 mikedld 3441
Returned value:
118 diamond 3442
  * eax = ebx = 0 - the buffer is empty
3443
  * eax = byte, ebx = 1 - byte was successfully read
114 mikedld 3444
 
3445
======================================================================
118 diamond 3446
============== Function 64 - resize application memory. ==============
114 mikedld 3447
======================================================================
3448
Parameters:
118 diamond 3449
  * eax = 64 - function number
3450
  * ebx = 1 - unique subfunction
3451
  * ecx = new memory size
114 mikedld 3452
Returned value:
118 diamond 3453
  * eax = 0 - success
3454
  * eax = 1 - not enough memory
114 mikedld 3455
Remarks:
193 diamond 3456
  * There is another way to dynamically allocate/free memory -
3457
    subfunctions 11, 12, 13 of function 68.
3458
  * The function cannot be used together with 68.11, 68.12, 68.13.
3459
    The function call will be ignored after creation of process heap
3460
    with function 68.11.
114 mikedld 3461
 
3462
======================================================================
283 diamond 3463
======== Function 65 - draw image with palette in the window. ========
3464
======================================================================
3465
Parameters:
3466
  * eax = 65 - function number
3467
  * ebx = pointer to the image
3468
  * ecx = [size on axis x]*65536 + [size on axis y]
3469
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
314 diamond 3470
  * esi = number of bits per pixel, must be 8, 24 or 32
3471
  * edi = pointer to palette (256 colors 0x00RRGGBB);
3472
          ignored when esi = 24 and 32
3473
  * ebp = offset of next row data relative to previous row data
283 diamond 3474
Returned value:
3475
  * function does not return value
3476
Remarks:
3477
  * Coordinates of the image are coordinates of the upper left corner
3478
    of the image relative to the window.
3479
  * Size of the image in bytes is xsize*ysize.
3480
  * Each byte of image is index in the palette.
3481
  * If the image uses less than 256 colors, palette size may be
3482
    less than 256 too.
314 diamond 3483
  * The call to function 7 is equivalent to call to this function
3484
    with esi=24, ebp=0.
283 diamond 3485
 
3486
======================================================================
118 diamond 3487
================== Function 66 - work with keyboard. =================
114 mikedld 3488
======================================================================
118 diamond 3489
The input mode influences results of reading keys by function 2.
3490
When a program loads, ASCII input mode is set for it.
114 mikedld 3491
 
118 diamond 3492
-------------- Subfunction 1 - set keyboard input mode. --------------
114 mikedld 3493
Parameters:
118 diamond 3494
  * eax = 66 - function number
3495
  * ebx = 1 - subfunction number
114 mikedld 3496
  * ecx = mode:
3497
    * 0 = normal (ASCII-characters)
3498
    * 1 = scancodes
3499
Returned value:
3500
  * function does not return value
3501
 
118 diamond 3502
-------------- Subfunction 2 - get keyboard input mode. --------------
114 mikedld 3503
Parameters:
118 diamond 3504
  * eax = 66 - function number
3505
  * ebx = 2 - subfunction number
114 mikedld 3506
Returned value:
3507
  * eax = current mode
3508
 
118 diamond 3509
------------ Subfunction 3 - get status of control keys. -------------
114 mikedld 3510
Parameters:
118 diamond 3511
  * eax = 66 - function number
3512
  * ebx = 3 - subfunction number
114 mikedld 3513
Returned value:
3514
  * eax = bit mask:
118 diamond 3515
  * bit 0 (mask 1): left Shift is pressed
3516
  * bit 1 (mask 2): right Shift is pressed
3517
  * bit 2 (mask 4): left Ctrl is pressed
3518
  * bit 3 (mask 8): right Ctrl is pressed
3519
  * bit 4 (mask 0x10): left Alt is pressed
3520
  * bit 5 (mask 0x20): right Alt is pressed
3521
  * bit 6 (mask 0x40): CapsLock is on
3522
  * bit 7 (mask 0x80): NumLock is on
3523
  * bit 8 (mask 0x100): ScrollLock is on
3524
  * other bits are cleared
114 mikedld 3525
 
118 diamond 3526
-------------- Subfunction 4 - set system-wide hotkey. ---------------
3527
When hotkey is pressed, the system notifies only those applications,
3528
which have installed it; the active application (which receives
3529
all normal input) does not receive such keys.
3530
The notification consists in sending event with the code 2.
3531
Reading hotkey is the same as reading normal key - by function 2.
114 mikedld 3532
Parameters:
118 diamond 3533
  * eax = 66 - function number
3534
  * ebx = 4 - subfunction number
3535
  * cl determines key scancode;
3536
    use cl=0 to give combinations such as Ctrl+Shift
3537
  * edx = 0xXYZ determines possible states of control keys:
3538
    * Z (low 4 bits) determines state of LShift and RShift:
3539
      * 0 = no key must be pressed;
3540
      * 1 = exactly one key must be pressed;
3541
      * 2 = both keys must be pressed;
3542
      * 3 = must be pressed LShift, but not RShift;
3543
      * 4 = must be pressed RShift, but not LShift
3544
    * Y - similar for LCtrl and RCtrl;
3545
    * X - similar for LAlt and RAlt
114 mikedld 3546
Returned value:
118 diamond 3547
  * eax=0 - success
3548
  * eax=1 - too mant hotkeys (maximum 256 are allowed)
114 mikedld 3549
Remarks:
118 diamond 3550
  * Hotkey can work either at pressing or at release. Release
3551
    scancode of a key is more on 128 than pressing scancode
3552
    (i.e. high bit is set).
3553
  * Several applications can set the same combination;
3554
    all such applications will be informed on pressing
3555
    such combination.
114 mikedld 3556
 
118 diamond 3557
-------------- Subfunction 5 - delete installed hotkey. --------------
114 mikedld 3558
Parameters:
118 diamond 3559
  * eax = 66 - function number
3560
  * ebx = 5 - subfunction number
3561
  * cl = scancode of key and edx = 0xXYZ the same as in subfunction 4
114 mikedld 3562
Returned value:
118 diamond 3563
  * eax = 0 - success
114 mikedld 3564
  * eax = 1 - there is no such hotkey
3565
Remarks:
118 diamond 3566
  * When a process/thread terminates, all hotkey installed by it are
3567
    deleted.
3568
  * The call to this subfunction does not affect other applications.
3569
    If other application has defined the same combination, it will
3570
    still receive notices.
114 mikedld 3571
 
3572
======================================================================
118 diamond 3573
========= Function 67 - change position/sizes of the window. =========
114 mikedld 3574
======================================================================
3575
Parameters:
118 diamond 3576
  * eax = 67 - function number
114 mikedld 3577
  * ebx = new x-coordinate of the window
3578
  * ecx = new y-coordinate of the window
3579
  * edx = new x-size of the window
3580
  * esi = new y-size of the window
3581
Returned value:
3582
  * function does not return value
3583
Remarks:
118 diamond 3584
  * The value -1 for a parameter means "do not change"; e.g. to move
3585
    the window without resizing it is possible to specify edx=esi=-1.
3586
  * Previously the window must be defined by function 0.
114 mikedld 3587
    It sets initial coordinates and sizes of the window.
118 diamond 3588
  * Sizes of the window are understood in sense of function 0,
3589
    that is one pixel less than real sizes.
3590
  * The function call for maximized windows is simply ignored.
3591
  * For windows of appropriate styles position and/or sizes can be
3592
    changed by user; current position and sizes can be obtained by
3593
    call to function 9.
3594
  * The function sends to the window redraw event (with the code 1).
114 mikedld 3595
 
3596
======================================================================
118 diamond 3597
====== Function 68, subfunction 0 - get the task switch counter. =====
114 mikedld 3598
======================================================================
3599
Parameters:
118 diamond 3600
  * eax = 68 - function number
3601
  * ebx = 0 - subfunction number
114 mikedld 3602
Returned value:
118 diamond 3603
  * eax = number of task switches from the system booting
3604
    (modulo 2^32)
114 mikedld 3605
 
3606
======================================================================
118 diamond 3607
======= Function 68, subfunction 1 - switch to the next thread. ======
114 mikedld 3608
======================================================================
118 diamond 3609
The function completes the current time slice allocated to the
3610
thread and switches to the next. (Which thread in which process
3611
will be next, is unpredictable). Later, when execution queue
3612
will reach the current thread, execution will be continued.
114 mikedld 3613
Parameters:
118 diamond 3614
  * eax = 68 - function number
3615
  * ebx = 1 - subfunction number
114 mikedld 3616
Returned value:
3617
  * function does not return value
3618
 
3619
======================================================================
118 diamond 3620
============= Function 68, subfunction 2 - cache + rdpmc. ============
114 mikedld 3621
======================================================================
3622
Parameters:
118 diamond 3623
  * eax = 68 - function number
3624
  * ebx = 2 - subfunction number
3625
  * ecx = required action:
3626
    * ecx = 0 - enable instruction 'rdpmc'
3627
      (ReaD Performance-Monitoring Counters) for applications
3628
    * ecx = 1 - find out whether cache is disabled/enabled
3629
    * ecx = 2 - enable cache
3630
    * ecx = 3 - disable cache
114 mikedld 3631
Returned value:
3632
  * for ecx=0:
118 diamond 3633
    * eax = the value of cr4
114 mikedld 3634
  * for ecx=1:
3635
    * eax = (cr0 and 0x60000000):
118 diamond 3636
    * eax = 0 - cache is on
3637
    * eax <> 0 - cache is off
114 mikedld 3638
  * for ecx=2 and ecx=3:
3639
    * function does not return value
3640
 
3641
======================================================================
3642
=========== Function 68, subfunction 3 - read MSR-register. ==========
3643
======================================================================
118 diamond 3644
MSR = Model Specific Register; the complete list of MSR-registers
3645
of a processor is included to the documentation on it (for example,
3646
IA-32 Intel Architecture Software Developer's Manual,
3647
Volume 3, Appendix B); each processor family has its own subset
3648
of the MSR-registers.
114 mikedld 3649
Parameters:
118 diamond 3650
  * eax = 68 - function number
3651
  * ebx = 3 - subfunction number
3652
  * ecx is ignored
3653
  * edx = MSR address
114 mikedld 3654
Returned value:
118 diamond 3655
  * ebx:eax = high:low dword of the result
114 mikedld 3656
Remarks:
118 diamond 3657
  * If ecx contains nonexistent or not implemented for this processor
3658
    MSR, processor will generate an exception in the kernel, which
3659
    will kill the thread.
3660
  * Previously it is necessary to check, whether MSRs are supported
3661
    as a whole, with the instruction 'cpuid'. Otherwise processor
3662
    will generate other exception in the kernel, which will anyway
3663
    kill the thread.
114 mikedld 3664
 
3665
======================================================================
118 diamond 3666
========= Function 68, subfunction 4 - write to MSR-register. ========
114 mikedld 3667
======================================================================
118 diamond 3668
MSR = Model Specific Register; the complete list of MSR-registers
3669
of a processor is included to the documentation on it (for example,
3670
IA-32 Intel Architecture Software Developer's Manual,
3671
Volume 3, Appendix B); each processor family has its own subset
3672
of the MSR-registers.
114 mikedld 3673
Parameters:
118 diamond 3674
  * eax = 68 - function number
3675
  * ebx = 4 - subfunction number
3676
  * ecx is ignored
3677
  * edx = MSR address
3678
  * esi:edi = high:low dword
114 mikedld 3679
Returned value:
499 diamond 3680
  * function does not return value
3681
Remarks:
118 diamond 3682
  * If ecx contains nonexistent or not implemented for this processor
3683
    MSR, processor will generate an exception in the kernel, which
3684
    will kill the thread.
3685
  * Previously it is necessary to check, whether MSRs are supported
3686
    as a whole, with the instruction 'cpuid'. Otherwise processor
3687
    will generate other exception in the kernel, which will anyway
3688
    kill the thread.
114 mikedld 3689
 
3690
======================================================================
193 diamond 3691
======= Function 68, subfunction 11 - initialize process heap. =======
114 mikedld 3692
======================================================================
3693
Parameters:
118 diamond 3694
  * eax = 68 - function number
193 diamond 3695
  * ebx = 11 - subfunction number
114 mikedld 3696
Returned value:
193 diamond 3697
  * eax = 0 - failed
3698
  * otherwise size of created heap
114 mikedld 3699
Remarks:
193 diamond 3700
  * The function call initializes heap, from which one can in future
3701
    allocate and free memory blocks with subfunctions 12 and 13.
3702
    Heap size is equal to total amount of free application memory.
3703
  * The second function call from the same process results in
3704
    returning the size of the existing heap.
3705
  * After creation of the heap calls to function 64 will be ignored.
114 mikedld 3706
 
3707
======================================================================
193 diamond 3708
======== Function 68, subfunction 12 - allocate memory block. ========
114 mikedld 3709
======================================================================
3710
Parameters:
118 diamond 3711
  * eax = 68 - function number
193 diamond 3712
  * ebx = 12 - subfunction number
3713
  * ecx = required size in bytes
114 mikedld 3714
Returned value:
193 diamond 3715
  * eax = pointer to the allocated block
114 mikedld 3716
Remarks:
193 diamond 3717
  * Before this call one must initialize process heap by call to
3718
    subfunction 11.
3719
  * The function allocates an integer number of pages (4 Kb) in such
3720
    way that the real size of allocated block is more than or equal to
3721
    requested size.
114 mikedld 3722
 
3723
======================================================================
193 diamond 3724
========== Function 68, subfunction 13 - free memory block. ==========
114 mikedld 3725
======================================================================
3726
Parameters:
118 diamond 3727
  * eax = 68 - function number
193 diamond 3728
  * ebx = 13 - subfunction number
3729
  * ecx = pointer to the memory block
114 mikedld 3730
Returned value:
193 diamond 3731
  * eax = 1 - success
3732
  * eax = 0 - failed
114 mikedld 3733
Remarks:
448 diamond 3734
  * The memory block must have been allocated by subfunction 12
3735
    or subfunction 20.
114 mikedld 3736
 
3737
======================================================================
193 diamond 3738
======== Function 68, subfunction 14 - wait for driver notify. =======
114 mikedld 3739
======================================================================
3740
Parameters:
118 diamond 3741
  * eax = 68 - function number
193 diamond 3742
  * ebx = 14 - subfunction number
3743
  * ecx = pointer to the buffer for information (8 bytes)
114 mikedld 3744
Returned value:
193 diamond 3745
  * buffer pointed to by ecx contains the following information:
3746
    * +0: dword: constant EV_INTR = 1
3747
    * +4: dword: driver data
114 mikedld 3748
Remarks:
193 diamond 3749
  * The current implementation at wait time uses "heavy" operations
3750
    of task switch.
114 mikedld 3751
 
3752
======================================================================
193 diamond 3753
====== Function 68, subfunction 15 - set FPU exception handler. ======
3754
======================================================================
3755
Parameters:
3756
  * eax = 68 - function number
3757
  * ebx = 15 - subfunction number
3758
  * ecx = address of the new exception handler
3759
Returned value:
3760
  * eax = address of the old exception handler (0, if it was not set)
3761
 
3762
======================================================================
3763
============= Function 68, subfunction 16 - load driver. =============
3764
======================================================================
3765
Parameters:
3766
  * eax = 68 - function number
3767
  * ebx = 16 - subfunction number
3768
  * ecx = pointer to ASCIIZ-string with driver name
3769
Returned value:
3770
  * eax = 0 - failed
3771
  * otherwise eax = driver handle
3772
Remarks:
3773
  * If the driver was not loaded yet, it is loaded;
3774
    if the driver was loaded yet, nothing happens.
3775
  * Driver name is case-sensitive.
3776
    Maximum length of the name is 16 characters, including
3777
    terminating null character, the rest is ignored.
346 diamond 3778
  * Driver ABC is loaded from file /rd/1/drivers/ABC.obj.
193 diamond 3779
 
3780
======================================================================
3781
============ Function 68, subfunction 17 - driver control. ===========
3782
======================================================================
3783
Parameters:
3784
  * eax = 68 - function number
3785
  * ebx = 17 - subfunction number
3786
  * ecx = pointer to the control structure:
3787
    * +0: dword: handle of driver
3788
    * +4: dword: code of driver function
3789
    * +8: dword: pointer to input data
3790
    * +12 = +0xC: dword: size of input data
3791
    * +16 = +0x10: dword: pointer to output data
3792
    * +20 = +0x14: dword: size of output data
3793
Returned value:
3794
  * eax = determined by driver
3795
Remarks:
3796
  * Function codes and the structure of input/output data
3797
    are defined by driver.
3798
  * Previously one must obtain driver handle by subfunction 16.
3799
 
3800
======================================================================
3801
====== Function 68, subfunction 18 - set SSE exception handler. ======
3802
======================================================================
3803
Parameters:
3804
  * eax = 68 - function number
3805
  * ebx = 15 - subfunction number
3806
  * ecx = address of the new exception handler
3807
Returned value:
3808
  * eax = address of the old exception handler (0, if it was not set)
3809
 
3810
======================================================================
277 diamond 3811
=============== Function 68, subfunction 19 - load DLL. ==============
3812
======================================================================
3813
Parameters:
3814
  * eax = 68 - function number
3815
  * ebx = 19 - subfunction number
3816
  * ecx = pointer to ASCIIZ-string with the full path to DLL
3817
Returned value:
3818
  * eax = 0 - failed
3819
  * otherwise eax = pointer to DLL export table
3820
Remarks:
3821
  * Export table is an array of structures of 2 dword's, terminated
3822
    by zero. The first dword in structure points to function name,
3823
    the second dword contains address of function.
3824
 
3825
======================================================================
448 diamond 3826
======= Function 68, subfunction 20 - reallocate memory block. =======
3827
======================================================================
3828
Parameters:
3829
  * eax = 68 - function number
3830
  * ebx = 20 - subfunction number
3831
  * ecx = new size in bytes
3832
  * edx = pointer to already allocated block
3833
Returned value:
3834
  * eax = pointer to the reallocated block, 0 = error
3835
Remarks:
3836
  * Before this call one must initialize process heap by call to
3837
    subfunction 11.
3838
  * The function allocates an integer number of pages (4 Kb) in such
3839
    way that the real size of allocated block is more than or equal to
3840
    requested size.
3841
  * If edx=0, the function call is equivalent to memory allocation
3842
    with subfunction 12. Otherwise the block at edx
3843
    must be allocated earlier with subfunction 12 or this subfunction.
3844
  * If ecx=0, the function frees memory block at edx and returns 0.
3845
  * The contents of the block are unchanged up to the shorter of
3846
    the new and old sizes.
3847
 
3848
======================================================================
118 diamond 3849
====================== Fucntion 69 - debugging. ======================
114 mikedld 3850
======================================================================
118 diamond 3851
A process can load other process as debugged by set of corresponding
193 diamond 3852
bit by call to subfunction 7 of function 70.
118 diamond 3853
A process can have only one debugger; one process can debug some
3854
others. The system notifies debugger on events occuring with
3855
debugged process. Messages are written to the buffer defined by
114 mikedld 3856
subfunction 0.
118 diamond 3857
Format of a message:
3858
  * +0: dword: message code
3859
  * +4: dword: PID of debugged process
3860
  * +8: there can be additional data depending on message code
3861
Message codes:
114 mikedld 3862
  * 1 = exception
118 diamond 3863
    * in addition dword-number of the exception is given
3864
    * process is suspended
3865
  * 2 = process has terminated
3866
    * comes at any termination: both through the system function -1,
3867
      and at "murder" by any other process (including debugger itself)
114 mikedld 3868
  * 3 = debug exception int 1 = #DB
118 diamond 3869
    * in addition dword-image of the register DR6 is given:
3870
      * bits 0-3: condition of the corresponding breakpoint (set by
3871
        subfunction 9) is satisfied
3872
      * бит 14: exception has occured because of the trace mode
3873
        (flag TF is set TF)
3874
    * process is suspended
3875
When debugger terminates, all debugged processes are killed.
3876
If debugger does not want this, it must previously detach by
114 mikedld 3877
subfunction 3.
3878
 
667 diamond 3879
All subfunctions except 4 and 5 are applicable only to
3880
processes/threads started from the current by function 70
3881
with set debugging flag.
118 diamond 3882
Debugging of multithreaded programs is not supported yet.
3883
The full list of subfunctions:
3884
  * subfunction 0 - define data area for debug messages
3885
  * subfunction 1 - get contents of registers of debugged thread
3886
  * subfunction 2 - set contents of registers of debugged thread
3887
  * subfunction 3 - detach from debugged process
3888
  * subfunction 4 - suspend debugged thread
3889
  * subfunction 5 - resume debugged thread
3890
  * subfunction 6 - read from the memory of debugged process
3891
  * subfunction 7 - write to the memory of debugged process
3892
  * subfunction 8 - terminate debugged thread
3893
  * subfunction 9 - set/clear hardware breakpoint
114 mikedld 3894
 
3895
======================================================================
118 diamond 3896
= Function 69, subfunction 0 - define data area fror debug messages. =
114 mikedld 3897
======================================================================
3898
Parameters:
118 diamond 3899
  * eax = 69 - function number
3900
  * ebx = 0 - subfunction number
114 mikedld 3901
  * ecx = pointer
3902
Format of data area:
118 diamond 3903
  * +0: dword: N = buffer size (not including this header)
3904
  * +4: dword: occupied place
114 mikedld 3905
  * +8: N*byte: buffer
3906
Returned value:
3907
  * function does not return value
3908
Remarks:
118 diamond 3909
  * If the size field is negative, the buffer is considered locked
3910
    and at arrival of new message the system will wait.
3911
    For synchronization frame all work with the buffer by operations
3912
    lock/unlock
131 diamond 3913
    	neg	[bufsize]
118 diamond 3914
  * Data in the buffer are considered as array of items with variable
3915
    length - messages. Format of a message is explained in
3916
    general description.
114 mikedld 3917
 
3918
======================================================================
118 diamond 3919
===================== Function 69, subfunction 1 =====================
3920
============ Get contents of registers of debugged thread. ===========
114 mikedld 3921
======================================================================
3922
Parameters:
118 diamond 3923
  * eax = 69 - function number
3924
  * ebx = 1 - subfunction number
114 mikedld 3925
  * ecx = thread identifier
118 diamond 3926
  * edx = size of context structure, must be 0x28=40 bytes
3927
  * esi = pointer to context structure
114 mikedld 3928
Returned value:
3929
  * function does not return value
118 diamond 3930
Format of context structure: (FPU is not supported yet)
114 mikedld 3931
  * +0: dword: eip
3932
  * +4: dword: eflags
3933
  * +8: dword: eax
3934
  * +12 = +0xC: dword: ecx
3935
  * +16 = +0x10: dword: edx
3936
  * +20 = +0x14: dword: ebx
3937
  * +24 = +0x18: dword: esp
3938
  * +28 = +0x1C: dword: ebp
3939
  * +32 = +0x20: dword: esi
3940
  * +36 = +0x24: dword: edi
3941
Remarks:
118 diamond 3942
  * If the thread executes code of ring-0, the function returns
3943
    contents of registers of ring-3.
3944
  * Process must be loaded for debugging (as is shown in
3945
    general description).
114 mikedld 3946
 
3947
======================================================================
118 diamond 3948
===================== Function 69, subfunction 2 =====================
3949
============ Set contents of registers of debugged thread. ===========
114 mikedld 3950
======================================================================
3951
Parameters:
118 diamond 3952
  * eax = 69 - function number
3953
  * ebx = 2 - subfunction number
114 mikedld 3954
  * ecx = thread identifier
118 diamond 3955
  * edx = size of context structure, must be 0x28=40 bytes
114 mikedld 3956
Returned value:
3957
  * function does not return value
118 diamond 3958
Format of context structure is shown in the description of
3959
subfunction 1.
114 mikedld 3960
Remarks:
118 diamond 3961
  * If the thread executes code of ring-0, the function returns
3962
    contents of registers of ring-3.
3963
  * Process must be loaded for debugging (as is shown in
3964
    general description).
114 mikedld 3965
 
3966
======================================================================
118 diamond 3967
===== Function 69, subfunction 3 - detach from debugged process. =====
114 mikedld 3968
======================================================================
3969
Parameters:
118 diamond 3970
  * eax = 69 - function number
3971
  * ebx = 3 - subfunction number
114 mikedld 3972
  * ecx = identifier
3973
Returned value:
3974
  * function does not return value
3975
Remarks:
118 diamond 3976
  * If the process was suspended, it resumes execution.
114 mikedld 3977
 
3978
======================================================================
667 diamond 3979
============= Function 69, subfunction 4 - suspend thread. ===========
114 mikedld 3980
======================================================================
3981
Parameters:
118 diamond 3982
  * eax = 69 - function number
3983
  * ebx = 4 - subfunction number
3984
  * ecx = thread identifier
114 mikedld 3985
Returned value:
3986
  * function does not return value
3987
 
3988
======================================================================
667 diamond 3989
============= Function 69, subfunction 5 - resume thread. ============
114 mikedld 3990
======================================================================
3991
Parameters:
118 diamond 3992
  * eax = 69 - function number
3993
  * ebx = 5 - subfunction number
3994
  * ecx = thread identifier
114 mikedld 3995
Returned value:
3996
  * function does not return value
3997
 
3998
======================================================================
118 diamond 3999
= Fucntion 69, subfunction 6 - read from memory of debugged process. =
114 mikedld 4000
======================================================================
4001
Parameters:
118 diamond 4002
  * eax = 69 - function number
4003
  * ebx = 6 - subfunction number
114 mikedld 4004
  * ecx = identifier
118 diamond 4005
  * edx = number of bytes to read
4006
  * esi = address in the memory of debugged process
4007
  * edi = pointer to buffer for data
114 mikedld 4008
Returned value:
118 diamond 4009
  * eax = -1 at an error (invalid PID or buffer)
4010
  * otherwise eax = number of read bytes (possibly, 0,
4011
    if esi is too large)
114 mikedld 4012
Remarks:
118 diamond 4013
  * Process must be loaded for debugging (as is shown in
4014
    general description).
114 mikedld 4015
 
4016
======================================================================
118 diamond 4017
== Function 69, subfunction 7 - write to memory of debugged process. =
114 mikedld 4018
======================================================================
4019
Parameters:
118 diamond 4020
  * eax = 69 - function number
4021
  * ebx = 7 - subfunction number
114 mikedld 4022
  * ecx = identifier
118 diamond 4023
  * edx = number of bytes to write
4024
  * esi = address of memory in debugged process
4025
  * edi = pointer to data
114 mikedld 4026
Returned value:
118 diamond 4027
  * eax = -1 at an error (invalid PID or buffer)
4028
  * otherwise eax = number of written bytes (possibly, 0,
4029
    if esi is too large)
114 mikedld 4030
Remarks:
118 diamond 4031
  * Process must be loaded for debugging (as is shown in
4032
    general description).
114 mikedld 4033
 
4034
======================================================================
118 diamond 4035
======= Function 69, subfunction 8 - terminate debugged thread. ======
114 mikedld 4036
======================================================================
4037
Parameters:
118 diamond 4038
  * eax = 69 - function number
4039
  * ebx = 8 - subfunction number
114 mikedld 4040
  * ecx = identifier
4041
Returned value:
4042
  * function does not return value
4043
Remarks:
118 diamond 4044
  * Process must be loaded for debugging (as is shown in
4045
    general description).
4046
  * The function is similar to subfunction 2 of function 18
4047
    with two differences: it requires first remark and
4048
    accepts PID rather than slot number.
114 mikedld 4049
 
4050
======================================================================
118 diamond 4051
===== Function 69, subfunction 9 - set/clear hardware breakpoint. ====
114 mikedld 4052
======================================================================
4053
Parameters:
118 diamond 4054
  * eax = 69 - function number
4055
  * ebx = 9 - subfunction number
114 mikedld 4056
  * ecx = thread identifier
118 diamond 4057
  * dl = index of breakpoint, from 0 to 3 inclusively
114 mikedld 4058
  * dh = flags:
118 diamond 4059
    * if high bit is cleared - set breakpoint:
114 mikedld 4060
      * bits 0-1 - condition:
4061
        * 00 = breakpoint on execution
118 diamond 4062
        * 01 = breakpoint on read
4063
        * 11 = breakpoint on read/write
4064
      * bits 2-3 - length; for breakpoints on exception it must be
4065
        00, otherwise one of
4066
        * 00 = byte
114 mikedld 4067
        * 01 = word
118 diamond 4068
        * 11 = dword
4069
      * esi = breakpoint address; must be aligned according to
4070
        the length (i.e. must be even for word breakpoints,
4071
        divisible by 4 for dword)
4072
    * if high bit is set - clear breakpoint
114 mikedld 4073
Returned value:
118 diamond 4074
  * eax = 0 - success
114 mikedld 4075
  * eax = 1 - error in the input data
118 diamond 4076
  * eax = 2 - (reserved, is never returned in the current
4077
    implementation) a global breakpoint with that index is already set
114 mikedld 4078
Remarks:
118 diamond 4079
  * Process must be loaded for debugging (as is shown in
4080
    general description).
4081
  * Hardware breakpoints are implemented through DRx-registers of
4082
    the processor, all limitations results from this.
4083
  * The function can reinstall the breakpoint, previously set
4084
    by it (and it does not inform on this).
4085
    Carry on the list of set breakpoints in the debugger.
4086
  * Breakpoints generate debug exception #DB, on which the system
4087
    notifies debugger.
4088
  * Breakpoints on write and read/write act after
4089
    execution of the caused it instruction.
114 mikedld 4090
 
4091
======================================================================
118 diamond 4092
==== Function 70 - work with file system with long names support. ====
114 mikedld 4093
======================================================================
4094
Parameters:
4095
  * eax = 70
118 diamond 4096
  * ebx = pointer to the information structure
114 mikedld 4097
Returned value:
118 diamond 4098
  * eax = 0 - success; otherwise file system error code
4099
  * some subfunctions return value in other registers too
4100
General format of the information structure:
4101
  * +0: dword: subfunction number
4102
  * +4: dword: file offset
4103
  * +8: dword: high dword of offset (must be 0) or flags field
114 mikedld 4104
  * +12 = +0xC: dword: size
118 diamond 4105
  * +16 = +0x10: dword: pointer to data
4106
  * +20 = +0x14: n db: ASCIIZ-string with the filename
114 mikedld 4107
    or
4108
  * +20 = +0x14: db 0
118 diamond 4109
  * +21 = +0x15: dd pointer to ASCIIZ-string with the filename
4110
Specifications - in documentation on the appropriate subfunction.
4111
Filename is case-insensitive. Russian letters must be written in
4112
the encoding cp866 (DOS).
4113
Format of filename:
114 mikedld 4114
/base/number/dir1/dir2/.../dirn/file,
118 diamond 4115
where /base/number identifies device, on which file is located:
114 mikedld 4116
one of
118 diamond 4117
  * /RD/1 = /RAMDISK/1 to access ramdisk
4118
  * /FD/1 = /FLOPPYDISK/1 to access first floppy drive,
4119
    /FD/2 = /FLOPPYDISK/2 to access second one
4120
  * /HD0/x, /HD1/x, /HD2/x, /HD3/x to access accordingly to devices
4121
    IDE0 (Primary Master), IDE1 (Primary Slave),
114 mikedld 4122
    IDE2 (Secondary Master), IDE3 (Secondary Slave);
118 diamond 4123
    x - partition number on the selected hard drive, varies from 1
4124
    to 255 (on each hard drive the indexing starts from 1)
4125
  * /CD0/1, /CD1/1, /CD2/1, /CD3/1 to access accordingly to
4126
    CD on IDE0 (Primary Master), IDE1 (Primary Slave),
4127
    IDE2 (Secondary Master), IDE3 (Secondary Slave)
546 diamond 4128
  * /SYS means system folder; with the usual boot (from floppy)
4129
    is equivalent to /RD/1
114 mikedld 4130
Examples:
4131
  * '/rd/1/kernel.asm',0
4132
  * '/HD0/1/kernel.asm',0
4133
  * '/hd0/2/menuet/pics/tanzania.bmp',0
4134
  * '/hd0/1/Program files/NameOfProgram/SomeFile.SomeExtension',0
546 diamond 4135
  * '/sys/MySuperApp.ini',0
118 diamond 4136
Available subfunctions:
114 mikedld 4137
  * subfunction 0 - read file
4138
  * subfunction 1 - read folder
4139
  * subfunction 2 - create/rewrite file
131 diamond 4140
  * subfunction 3 - write to existing file
133 diamond 4141
  * subfunction 4 - set file size
118 diamond 4142
  * subfunction 5 - get attributes of file/folder
4143
  * subfunction 6 - set attributes of file/folder
114 mikedld 4144
  * subfunction 7 - start application
193 diamond 4145
  * subfunction 8 - delete file/folder
321 diamond 4146
  * subfunction 9 - create folder
118 diamond 4147
For CD-drives due to hardware limitations only subfunctions
4148
0,1,5 and 7 are available, other subfunctions return error
4149
with code 2.
641 diamond 4150
At the first call of subfunctions 0,1,5,7 to ATAPI devices
4151
(CD and DVD) the manual control of tray is locked due to caching
4152
drive data. Unlocking is made when subfunction 4 of function 24
4153
is called for corresponding device.
114 mikedld 4154
 
4155
======================================================================
118 diamond 4156
=== Function 70, subfunction 0 - read file with long names support. ==
114 mikedld 4157
======================================================================
4158
Parameters:
118 diamond 4159
  * eax = 70 - function number
4160
  * ebx = pointer to the information structure
4161
Format of the information structure:
4162
  * +0: dword: 0 = subfunction number
4163
  * +4: dword: file offset (in bytes)
4164
  * +8: dword: 0 (reserved for high dword of offset)
4165
  * +12 = +0xC: dword: number of bytes to read
4166
  * +16 = +0x10: dword: pointer to buffer for data
4167
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4168
    given in the general description
114 mikedld 4169
    or
4170
  * +20 = +0x14: db 0
118 diamond 4171
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4172
Returned value:
118 diamond 4173
  * eax = 0 - success, otherwise file system error code
4174
  * ebx = number of read bytes or -1=0xffffffff if file was not found
114 mikedld 4175
Remarks:
118 diamond 4176
  * If file was ended before last requested block was read,
4177
    the function will read as many as it can, and after that return
4178
    eax=6 (EOF).
4179
  * The function does not allow to read folder (returns eax=10,
4180
    access denied).
114 mikedld 4181
 
118 diamond 4182
======================================================================
4183
== Function 70, subfunction 1 - read folder with long names support. =
4184
======================================================================
114 mikedld 4185
Parameters:
118 diamond 4186
  * eax = 70 - function number
4187
  * ebx = pointer to the information structure
4188
Format of the information structure:
4189
  * +0: dword: 1 = subfunction number
4190
  * +4: dword: index of starting block (beginning from 0)
4191
  * +8: dword: flags field:
114 mikedld 4192
    * bit 0 (mask 1): in what format to return names,
4193
      0=ANSI, 1=UNICODE
118 diamond 4194
    * other bits are reserved and must be set to 0 for the future
4195
      compatibility
4196
  * +12 = +0xC: dword: number of blocks to read
4197
  * +16 = +0x10: dword: pointer to buffer for data, buffer size
4198
    must be not less than 32 + [+12]*560 bytes
4199
  * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are
4200
    given in the general description
114 mikedld 4201
    or
4202
  * +20 = +0x14: db 0
118 diamond 4203
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4204
Returned value:
118 diamond 4205
  * eax = 0 - success, otherwise file system error code
4206
  * ebx = number of files, information on which was written to
4207
    the buffer, or -1=0xffffffff, if folder was not found
114 mikedld 4208
Structure of the buffer:
4209
  * +0: 32*byte: header
4210
  * +32 = +0x20: n1*byte: block with information on file 1
118 diamond 4211
  * +32+n1: n2*byte: block with information on file 2
114 mikedld 4212
  * ...
4213
Structure of header:
118 diamond 4214
  * +0: dword: version of structure (current is 1)
4215
  * +4: dword: number of placed blocks; is not greater than requested
4216
    in the field +12 of information structure; can be less, if
4217
    there are no more files in folder (the same as in ebx)
4218
  * +8: dword: total number of files in folder
4219
  * +12 = +0xC: 20*byte: reserved (zeroed)
4220
Structure of block of data for folder entry (BDFE):
4221
  * +0: dword: attributes of file:
4222
    * bit 0 (mask 1): file is read-only
4223
    * bit 1 (mask 2): file is hidden
4224
    * bit 2 (mask 4): file is system
4225
    * bit 3 (mask 8): this is not a file but volume label
4226
      (for one partition meets no more than once and
4227
      only in root folder)
4228
    * bit 4 (mask 0x10): this is a folder
4229
    * bit 5 (mask 0x20): file was not archived - many archivation
4230
      programs have an option to archive only files with this bit set,
4231
      and after archiving this bit is cleared - it can be useful
4232
      for automatically creating of backup-archives as at writing
4233
      this bit is usually set
4234
  * +4: byte: type of name data:
4235
    (coincides with bit 0 of flags in the information structure)
4236
    * 0 = ASCII = 1-byte representation of each character
4237
    * 1 = UNICODE = 2-byte representation of each character
114 mikedld 4238
  * +5: 3*byte: reserved (zero)
118 diamond 4239
  * +8: 4*byte: time of file creation
4240
  * +12 = +0xC: 4*byte: date of file creation
4241
  * +16 = +0x10: 4*byte: time of last access (read or write)
114 mikedld 4242
  * +20 = +0x14: 4*byte: date of last access
118 diamond 4243
  * +24 = +0x18: 4*byte: time of last modification
4244
  * +28 = +0x1C: 4*byte: date of last modification
4245
  * +32 = +0x20: qword: file size in bytes (up to 16777216 Tb)
114 mikedld 4246
  * +40 = +0x28: name
118 diamond 4247
    * for ASCII format: maximum length is 263 characters
4248
      (263 bytes), byte after the name has value 0
321 diamond 4249
    * for UNICODE format: maximum length is 259 characters
118 diamond 4250
      (518 bytes), 2 bytes after the name have value 0
4251
Time format:
114 mikedld 4252
  * +0: byte: seconds
4253
  * +1: byte: minutes
4254
  * +2: byte: hours
4255
  * +3: byte: reserved (0)
118 diamond 4256
  * for example, 23.59.59 is written as (in hex) 3B 3B 17 00
4257
Date format:
4258
  * +0: byte: day
4259
  * +1: byte: month
4260
  * +2: word: year
4261
  * for example, 25.11.1979 is written as (in hex) 19 0B BB 07
114 mikedld 4262
Remarks:
118 diamond 4263
  * If BDFE contains ASCII name, the length of BDFE is 304 bytes,
4264
    if UNICODE name - 560 bytes. Value of length is aligned
4265
    on 16-byte bound (to accelerate processing in CPU cache).
4266
  * First character after a name is zero (ASCIIZ-string). The further
4267
    data contain garbage.
4268
  * If files in folder were ended before requested number was read,
4269
    the function will read as many as it can, and after that return
4270
    eax=6 (EOF).
114 mikedld 4271
  * Any folder on the disk, except for root, contains two special
118 diamond 4272
    entries "." and "..", identifying accordingly the folder itself
4273
    and the parent folder.
4274
  * The function allows also to read virtual folders "/", "/rd",
4275
    "/fd", "/hd[n]", thus attributes of subfolders are set to 0x10,
4276
    and times and dates are zeroed. An alternative way to get the
4277
    equipment information - subfunction 11 of function 18.
114 mikedld 4278
 
4279
======================================================================
118 diamond 4280
===================== Function 70, subfunction 2 =====================
4281
============ Create/rewrite file with long names support. ============
114 mikedld 4282
======================================================================
4283
Parameters:
118 diamond 4284
  * eax = 70 - function number
4285
  * ebx = pointer to the information structure
4286
Format of the information structure:
4287
  * +0: dword: 2 = subfunction number
114 mikedld 4288
  * +4: dword: 0 (reserved)
4289
  * +8: dword: 0 (reserved)
118 diamond 4290
  * +12 = +0xC: dword: number of bytes to read
4291
  * +16 = +0x10: dword: pointer to data
4292
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4293
    given in the general description
114 mikedld 4294
    or
4295
  * +20 = +0x14: db 0
118 diamond 4296
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4297
Returned value:
118 diamond 4298
  * eax = 0 - success, otherwise file system error code
4299
  * ebx = number of written bytes (possibly 0)
114 mikedld 4300
Remarks:
118 diamond 4301
  * If a file with given name did not exist, it is created;
4302
    if it existed, it is rewritten.
4303
  * If there is not enough free space on disk, the function will
4304
    write as many as can and then return error code 8.
4305
  * The function is not supported for CD (returns error code 2).
114 mikedld 4306
 
4307
======================================================================
131 diamond 4308
===================== Function 70, subfunction 3 =====================
4309
=========== Write to existing file with long names support. ==========
4310
======================================================================
4311
Parameters:
4312
  * eax = 70 - function number
4313
  * ebx = pointer to the information structure
4314
Format of the information structure:
4315
  * +0: dword: 3 = subfunction number
4316
  * +4: dword: file offset (in bytes)
4317
  * +8: dword: high dword of offset (must be 0 for FAT)
4318
  * +12 = +0xC: dword: number of bytes to write
4319
  * +16 = +0x10: dword: pointer to data
4320
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4321
    given in the general description
4322
    or
4323
  * +20 = +0x14: db 0
4324
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
4325
Returned value:
4326
  * eax = 0 - success, otherwise file system error code
4327
  * ebx = number of written bytes (possibly 0)
4328
Remarks:
4329
  * The file must already exist, otherwise function returns eax=5.
4330
  * The only result of write 0 bytes is update in the file attributes
4331
    date/time of modification and access to the current date/time.
4332
  * If beginning and/or ending position is greater than file size
4333
    (except for the previous case), the file is expanded to needed
4334
    size with zero characters.
133 diamond 4335
  * The function is not supported for CD (returns error code 2).
131 diamond 4336
 
4337
======================================================================
133 diamond 4338
============ Function 70, subfunction 4 - set end of file. ===========
4339
======================================================================
4340
Parameters:
4341
  * eax = 70 - function number
4342
  * ebx = pointer to the information structure
4343
Format of the information structure:
4344
  * +0: dword: 4 = subfunction number
4345
  * +4: dword: low dword of new file size
4346
  * +8: dword: high dword of new file size (must be 0 for FAT)
4347
  * +12 = +0xC: dword: 0 (reserved)
4348
  * +16 = +0x10: dword: 0 (reserved)
4349
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4350
    given in the general description
4351
    or
4352
  * +20 = +0x14: db 0
4353
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
4354
Returned value:
4355
  * eax = 0 - success, otherwise file system error code
4356
  * ebx destroyed
4357
Remarks:
4358
  * If the new file size is less than old one, file is truncated.
4359
    If the new size is greater than old one, file is expanded with
4360
    characters with code 0. If the new size is equal to old one,
4361
    the only result of call is set date/time of modification and
4362
    access to the current date/time.
4363
  * If there is not enough free space on disk for expansion, the
4364
    function will expand to maximum possible size and then return
4365
    error code 8.
4366
  * The function is not supported for CD (returns error code 2).
4367
 
4368
======================================================================
118 diamond 4369
==== Function 70, subfunction 5 - get information on file/folder. ====
114 mikedld 4370
======================================================================
4371
Parameters:
118 diamond 4372
  * eax = 70 - function number
4373
  * ebx = pointer to the information structure
4374
Format of the information structure:
4375
  * +0: dword: 5 = subfunction number
114 mikedld 4376
  * +4: dword: 0 (reserved)
4377
  * +8: dword: 0 (reserved)
4378
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 4379
  * +16 = +0x10: dword: pointer to buffer for data (40 bytes)
4380
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4381
    given in the general description
114 mikedld 4382
    or
4383
  * +20 = +0x14: db 0
118 diamond 4384
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4385
Returned value:
118 diamond 4386
  * eax = 0 - success, otherwise file system error code
4387
  * ebx destroyed
4388
Information on file is returned in the BDFE format (block of data
4389
for folder entry), explained in the description of
4390
subfunction 1, but without filename
4391
(i.e. only first 40 = 0x28 bytes).
114 mikedld 4392
Remarks:
118 diamond 4393
  * The function does not support virtual folders such as /, /rd and
4394
    root folders like /rd/1.
114 mikedld 4395
 
4396
======================================================================
118 diamond 4397
===== Function 70, subfunction 6 - set attributes of file/folder. ====
114 mikedld 4398
======================================================================
4399
Parameters:
118 diamond 4400
  * eax = 70 - function number
4401
  * ebx = pointer to the information structure
4402
Format of the information structure:
4403
  * +0: dword: 6 = subfunction number
114 mikedld 4404
  * +4: dword: 0 (reserved)
4405
  * +8: dword: 0 (reserved)
4406
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 4407
  * +16 = +0x10: dword: pointer to buffer with attributes (32 bytes)
4408
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4409
    given in the general description
114 mikedld 4410
    or
4411
  * +20 = +0x14: db 0
118 diamond 4412
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4413
Returned value:
118 diamond 4414
  * eax = 0 - success, otherwise file system error code
4415
  * ebx destroyed
4416
File attributes are first 32 bytes in BDFE (block of data
4417
for folder entry), explained in the description of subfunction 1
4418
(that is, without name and size of file). Attribute
4419
file/folder/volume label (bits 3,4 in dword +0) is not changed.
4420
Byte +4 (name format) is ignored.
114 mikedld 4421
Remarks:
118 diamond 4422
  * The function does not support virtual folders such as /, /rd and
4423
    root folders like /rd/1.
4424
  * The function is not supported for CD (returns error code 2).
114 mikedld 4425
 
4426
======================================================================
118 diamond 4427
=========== Function 70, subfunction 7 - start application. ==========
114 mikedld 4428
======================================================================
4429
Parameters:
118 diamond 4430
  * eax = 70 - function number
4431
  * ebx = pointer to the information structure
4432
Format of the information structure:
4433
  * +0: dword: 7 = subfunction number
4434
  * +4: dword: flags field:
4435
    * бит 0: start process as debugged
4436
    * other bits are reserved and must be set to 0
4437
  * +8: dword: 0 or pointer to ASCIIZ-string with parameters
114 mikedld 4438
  * +12 = +0xC: dword: 0 (reserved)
4439
  * +16 = +0x10: dword: 0 (reserved)
118 diamond 4440
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4441
    given in the general description
114 mikedld 4442
    or
4443
  * +20 = +0x14: db 0
118 diamond 4444
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4445
Returned value:
4446
  * eax > 0 - program is loaded, eax contains PID
118 diamond 4447
  * eax < 0 - an error has occured, -eax contains
4448
    file system error code
4449
  * ebx destroyed
114 mikedld 4450
Remarks:
118 diamond 4451
  * Command line must be terminated by the character with the code 0
4452
    (ASCIIZ-string); function takes into account either all characters
4453
    up to terminating zero inclusively or first 256 character
4454
    regarding what is less.
4455
  * If the process is started as debugged, it is created in
4456
    the suspended state; to run use subfunction 5 of function 69.
114 mikedld 4457
 
4458
======================================================================
193 diamond 4459
========== Function 70, subfunction 8 - delete file/folder. ==========
4460
======================================================================
4461
Parameters:
4462
  * eax = 70 - function number
4463
  * ebx = pointer to the information structure
4464
Format of the information structure:
4465
  * +0: dword: 8 = subfunction number
4466
  * +4: dword: 0 (reserved)
4467
  * +8: dword: 0 (reserved)
4468
  * +12 = +0xC: dword: 0 (reserved)
4469
  * +16 = +0x10: dword: 0 (reserved)
4470
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4471
    given in the general description
4472
    or
4473
  * +20 = +0x14: db 0
4474
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
4475
Returned value:
4476
  * eax = 0 - success, otherwise file system error code
4477
  * ebx destroyed
4478
Remarks:
4479
  * The function is not supported for CD (returns error code 2).
4480
  * The function can delete only empty folders (attempt to delete
4481
    nonempty folder results in error with code 10, "access denied").
4482
 
4483
======================================================================
321 diamond 4484
============= Function 70, subfunction 9 - create folder. ============
4485
======================================================================
4486
Parameters:
4487
  * eax = 70 - function number
4488
  * ebx = pointer to the information structure
4489
Format of the information structure:
4490
  * +0: dword: 9 = subfunction number
4491
  * +4: dword: 0 (reserved)
4492
  * +8: dword: 0 (reserved)
4493
  * +12 = +0xC: dword: 0 (reserved)
4494
  * +16 = +0x10: dword: 0 (reserved)
4495
  * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are
4496
    given in the general description
4497
    or
4498
  * +20 = +0x14: db 0
4499
  * +21 = +0x15: dd pointer to ASCIIZ-string with folder name
4500
Returned value:
4501
  * eax = 0 - success, otherwise file system error code
4502
  * ebx destroyed
4503
Remarks:
4504
  * The function is not supported for CD (returns error code 2).
4505
  * The parent folder must already exist.
4506
  * If target folder already exists, function returns success (eax=0).
4507
 
4508
======================================================================
118 diamond 4509
========== Function 71, subfunction 1 - set window caption. ==========
114 mikedld 4510
======================================================================
4511
Parameters:
4512
  * eax = 71 - function number
4513
  * ebx = 1 - subfunction number
118 diamond 4514
  * ecx = pointer to caption string
114 mikedld 4515
Returned value:
118 diamond 4516
  * function does not return value
114 mikedld 4517
Remarks:
118 diamond 4518
  * String must be in the ASCIIZ-format. Disregarding real string
4519
    length, no more than 255 characters are drawn.
4520
  * Pass NULL in ecx to remove caption.
114 mikedld 4521
 
4522
======================================================================
665 diamond 4523
=============== Function 72 - send message to a window. ==============
4524
======================================================================
4525
 
4526
- Subfunction 1 - send message with parameter to the active window. --
4527
Parameters:
4528
  * eax = 72 - function number
4529
  * ebx = 1 - subfunction number
4530
  * ecx = event code: 2 or 3
4531
  * edx = parameter: key code for ecx=2, button identifier for ecx=3
4532
Returned value:
4533
  * eax = 0 - success
4534
  * eax = 1 - buffer is full
4535
 
4536
======================================================================
118 diamond 4537
=============== Function -1 - terminate thread/process ===============
114 mikedld 4538
======================================================================
4539
Parameters:
118 diamond 4540
  * eax = -1 - function number
114 mikedld 4541
Returned value:
118 diamond 4542
  * function does not return neither value nor control
114 mikedld 4543
Remarks:
118 diamond 4544
  * If the process did not create threads obviously, it has only
4545
    one thread, which termination results in process termination.
4546
  * If the current thread is last in the process, its termination
4547
    also results in process terminates.
4548
  * This function terminates the current thread. Other thread can be
4549
    killed by call to subfunction 2 of function 18.
114 mikedld 4550
 
4551
======================================================================
4552
=========================== List of events ===========================
4553
======================================================================
118 diamond 4554
Next event can be retrieved by the call of one from functions 10
4555
(to wait for event), 11 (to check without waiting), 23
4556
(to wait during the given time).
4557
These functions return only those events, which enter into a mask set
4558
by function 40. By default it is first three,
4559
there is enough for most applications.
114 mikedld 4560
Codes of events:
118 diamond 4561
  * 1 = redraw event (is reset by call to function 0)
4562
  * 2 = key on keyboard is pressed (acts, only when the window is
4563
    active) or hotkey is pressed; is reset, when all keys from
4564
    the buffer are read out by function 2
4565
  * 3 = button is pressed, defined earlier by function 8
4566
    (or close button, created implicitly by function 0;
4567
    minimize button is handled by the system and sends no message;
4568
    acts, only when the window is active;
4569
    is reset when all buttons from the buffer
4570
    are read out by function 17)
4571
  * 4 = reserved (in current implementation never comes even after
4572
    unmasking by function 40)
4573
  * 5 = the desktop background is redrawed (is reset automatically
4574
    after redraw, so if in redraw time program does not wait and
4575
    does not check events, it will not remark this event)
4576
  * 6 = mouse event (something happened - button pressing or moving;
4577
    is reset at reading)
4578
  * 7 = IPC event (see function 60 -
4579
    Inter Process Communication; is reset at reading)
4580
  * 8 = network event (is reset at reading)
4581
  * 9 = debug event (is reset at reading; see
4582
    debug subsystem)
4583
  * 16..31 = event with appropriate IRQ
4584
    (16=IRQ0, 31=IRQ15) (is reset after reading all IRQ data)
114 mikedld 4585
 
4586
======================================================================
118 diamond 4587
=================== Error codes of the file system ===================
114 mikedld 4588
======================================================================
118 diamond 4589
  * 0 = success
4590
  * 1 = base and/or partition of a hard disk is not defined
4591
    (by subfunctions 7, 8 of function 21)
4592
  * 2 = function is not supported for the given file system
4593
  * 3 = unknown file system
448 diamond 4594
  * 4 = reserved, is never returned in the current implementation
118 diamond 4595
  * 5 = file not found
4596
  * 6 = end of file, EOF
4597
  * 7 = pointer lies outside of application memory
4598
  * 8 = disk is full
4599
  * 9 = FAT table is destroyed
114 mikedld 4600
  * 10 = access denied
118 diamond 4601
  * 11 = device error
4602
Application start functions can return also following errors:
4603
  * 30 = 0x1E = not enough memory
4604
  * 31 = 0x1F = file is not executable
4605
  * 32 = 0x20 = too many processes