Subversion Repositories Kolibri OS

Rev

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

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