Subversion Repositories Kolibri OS

Rev

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

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