Subversion Repositories Kolibri OS

Rev

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

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