Subversion Repositories Kolibri OS

Rev

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

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