Subversion Repositories Kolibri OS

Rev

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

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