Subversion Repositories Kolibri OS

Rev

Rev 9047 | 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
2233
  * +0: dword: frames - color of frame
2234
  * +4: dword: grab - color of header
2235
  * +8: dword: grab_button - color of button on header bar
2236
  * +12 = +0xC: dword: grab_button_text - color of text on button
2237
    on header bar
2238
  * +16 = +0x10: dword: grab_text - color of text on header
2239
  * +20 = +0x14: dword: work - color of working area
2240
  * +24 = +0x18: dword: work_button - color of button in working area
2241
  * +28 = +0x1C: dword: work_button_text - color of text on button
2242
    in working area
2243
  * +32 = +0x20: dword: work_text - color of text in working area
2244
  * +36 = +0x24: dword: work_graph - color of graphics in working area
114 mikedld 2245
Remarks:
118 diamond 2246
  * Structure of the color table is described in the standard
2247
    include file 'macros.inc' as 'system_colors'; for example,
2248
    it is possible to write:
5871 hidnplayr 2249
        sc      system_colors           ; variable declaration
2250
        ...                             ; somewhere one must call
2251
                                        ; this function with ecx=sc
2252
        mov     ecx, [sc.work_button_text]      ; read text color on
7722 dunkaist 2253
                                        ; button in working area
2254
  * A program itself decides to use or not to use color table.
118 diamond 2255
    For usage program must simply at calls to drawing functions select
2256
    color taken from the table.
2257
  * At change of the table of standard colors (by subfunction 2 with
2258
    the subsequent application of changes by subfunction 0 or
2259
    at skin set by subfunction 8) the system sends to all windows
2260
    redraw message (the event with code 1).
2261
  * Color table can be viewed/changed interactively with
2262
    the application 'desktop'.
114 mikedld 2263
 
6057 IgorA 2264
---------------------- Constants for registers: ----------------------
2265
  eax - SF_STYLE_SETTINGS (48)
2266
  ebx - SSF_GET_COLORS (3)
114 mikedld 2267
======================================================================
118 diamond 2268
============ Function 48, subfunction 4 - get skin height. ===========
114 mikedld 2269
======================================================================
2270
Parameters:
118 diamond 2271
  * eax = 48 - function number
2272
  * ebx = 4 - subfunction number
114 mikedld 2273
Returned value:
118 diamond 2274
  * eax = skin height
114 mikedld 2275
Remarks:
118 diamond 2276
  * Skin height is defined as the height of a header
2277
    of skinned windows.
2278
  * See also general structure of window in the description
2279
    of function 0.
114 mikedld 2280
 
6057 IgorA 2281
---------------------- Constants for registers: ----------------------
2282
  eax - SF_STYLE_SETTINGS (48)
2283
  ebx - SSF_GET_SKIN_HEIGHT (4)
114 mikedld 2284
======================================================================
118 diamond 2285
======== Function 48, subfunction 5 - get screen working area. =======
114 mikedld 2286
======================================================================
2287
Parameters:
118 diamond 2288
  * eax = 48 - function number
2289
  * ebx = 5 - subfunction number
114 mikedld 2290
Returned value:
2291
  * eax = [left]*65536 + [right]
2292
  * ebx = [top]*65536 + [bottom]
2293
Remarks:
118 diamond 2294
  * The screen working area defines position and coordinates of
2295
    a maximized window.
2296
  * The screen working area in view of normal work is all screen
5452 leency 2297
    without taskbar ('@taskbar' application).
118 diamond 2298
  * (left,top) are coordinates of the left upper corner,
2299
    (right,bottom) are coordinates of the right lower one.
2300
    Thus the size of working area on x axis can be calculated by
8994 leency 2301
    formula right-left+1, on y axis - by formula bottom-top+1.
118 diamond 2302
  * See also function 14,
2303
    to get sizes of all screen.
2304
  * There is a pair function to set working area - subfunction 6.
114 mikedld 2305
 
6057 IgorA 2306
---------------------- Constants for registers: ----------------------
2307
  eax - SF_STYLE_SETTINGS (48)
2308
  ebx - SSF_GET_SCREEN_AREA (5)
114 mikedld 2309
======================================================================
118 diamond 2310
======== Function 48, subfunction 6 - set screen working area. =======
114 mikedld 2311
======================================================================
2312
Parameters:
118 diamond 2313
  * eax = 48 - function number
2314
  * ebx = 6 - subfunction number
114 mikedld 2315
  * ecx = [left]*65536 + [right]
2316
  * edx = [top]*65536 + [bottom]
2317
Returned value:
2318
  * function does not return value
2319
Remarks:
118 diamond 2320
  * The screen working area defines position and coordinates of
2321
    a maximized window.
5452 leency 2322
  * This function is used only by the application '@taskbar',
2323
    which set working area to all screen without taskbar.
118 diamond 2324
  * (left,top) are coordinates of the left upper corner,
2325
    (right,bottom) are coordinates of the right lower one.
2326
    Thus the size of working area on x axis can be calculated by
2327
    formula right-left+1, on y axis - by formula bottom-right+1.
2328
  * If 'left'>='right', x-coordinate of working area is not changed.
2329
    If 'left'<0, 'left' will not be set. If 'right' is greater than or
2330
    equal to screen width, 'right' will not be set.
2331
    Similarly on y axis.
2332
  * See also function 14,
2333
    to get sizes of all screen.
2334
  * There is a pair function to get working area - subfunction 5.
2335
  * This function redraws the screen automatically,
2336
    updating coordinates and sizes of maximized windows.
2337
    The system sends to all windows redraw message (the event 1).
114 mikedld 2338
 
6057 IgorA 2339
---------------------- Constants for registers: ----------------------
2340
  eax - SF_STYLE_SETTINGS (48)
2341
  ebx - SSF_SET_SCREEN_AREA (6)
114 mikedld 2342
======================================================================
118 diamond 2343
=========== Function 48, subfunction 7 - get skin margins. ===========
114 mikedld 2344
======================================================================
118 diamond 2345
Returns the area of a header of a skinned window, intended for
2346
a text of a header.
114 mikedld 2347
Parameters:
118 diamond 2348
  * eax = 48 - function number
2349
  * ebx = 7 - subfunction number
114 mikedld 2350
Returned value:
2351
  * eax = [left]*65536 + [right]
2352
  * ebx = [top]*65536 + [bottom]
2353
Remarks:
118 diamond 2354
  * An application decides itself to use or not to use this function.
2355
  * It is recommended to take into account returned value
2356
    of this function for choice of a place for drawing header text
2357
    (by function 4) or a substitute of header text
2358
    (at the discretion of an application).
114 mikedld 2359
 
6057 IgorA 2360
---------------------- Constants for registers: ----------------------
2361
  eax - SF_STYLE_SETTINGS (48)
2362
  ebx - SSF_GET_SKIN_MARGINS (7)
114 mikedld 2363
======================================================================
118 diamond 2364
============= Function 48, subfunction 8 - set used skin. ============
114 mikedld 2365
======================================================================
2366
Parameters:
118 diamond 2367
  * eax = 48 - function number
2368
  * ebx = 8 - subfunction number
4573 clevermous 2369
  * ecx = pointer to filename of the skin
114 mikedld 2370
Returned value:
118 diamond 2371
  * eax = 0 - success
2372
  * otherwise eax = file system error code; if file does not
2373
    contain valid skin, function returns error 3
2374
    (unknown file system).
114 mikedld 2375
Remarks:
118 diamond 2376
  * After successful skin loading the system sends to all windows
2377
    redraw message (the event 1).
2378
  * At booting the system reads skin from file 'default.skn'
2379
    on ramdisk.
2380
  * User can change the skin statically by creating hisself
2381
    'default.skn' or dynamically with the application 'desktop'.
114 mikedld 2382
 
6057 IgorA 2383
---------------------- Constants for registers: ----------------------
2384
  eax - SF_STYLE_SETTINGS (48)
2385
  ebx - SSF_SET_SKIN (8)
114 mikedld 2386
======================================================================
5848 pathoswith 2387
====== Function 48, subfunction 9 - get font smoothing setting. ======
5682 leency 2388
======================================================================
2389
Parameters:
2390
  * eax = 48 - function number
2391
  * ebx = 9 - subfunction number
5848 pathoswith 2392
Returned value:
2393
  * eax = 2 - subpixel, 1 - anti-aliasing, 0 - off
5682 leency 2394
 
6057 IgorA 2395
---------------------- Constants for registers: ----------------------
2396
  eax - SF_STYLE_SETTINGS (48)
2397
  ebx - SSF_GET_FONT_SMOOTH (9)
5682 leency 2398
======================================================================
5848 pathoswith 2399
========== Function 48, subfunction 10 - set font smoothing. =========
2400
======================================================================
2401
Parameters:
2402
  * eax = 48 - function number
2403
  * ebx = 10 - subfunction number
2404
  * cl  = 2 - subpixel, 1 - anti-aliasing, 0 - off
2405
 
6057 IgorA 2406
---------------------- Constants for registers: ----------------------
2407
  eax - SF_STYLE_SETTINGS (48)
2408
  ebx - SSF_SET_FONT_SMOOTH (10)
5848 pathoswith 2409
======================================================================
5867 pathoswith 2410
============ Function 48, subfunction 11 - get font size. ============
2411
======================================================================
2412
Parameters:
2413
  * eax = 48 - function number
7722 dunkaist 2414
  * ebx = 11 - subfunction number
5867 pathoswith 2415
Returned value:
2416
  * eax = current font height in pixels
2417
 
6057 IgorA 2418
---------------------- Constants for registers: ----------------------
2419
  eax - SF_STYLE_SETTINGS (48)
2420
  ebx - SSF_GET_FONT_SIZE (11)
5867 pathoswith 2421
======================================================================
2422
============ Function 48, subfunction 12 - set font size. ============
2423
======================================================================
2424
Parameters:
2425
  * eax = 48 - function number
7722 dunkaist 2426
  * ebx = 12 - subfunction number
5867 pathoswith 2427
  * cl  = new font height in pixels
2428
 
6057 IgorA 2429
---------------------- Constants for registers: ----------------------
2430
  eax - SF_STYLE_SETTINGS (48)
2431
  ebx - SSF_SET_FONT_SIZE (12)
5867 pathoswith 2432
======================================================================
6800 pathoswith 2433
== Function 48, subfunction 13 - set skin, specifying the encoding. ==
2434
======================================================================
2435
Parameters:
2436
  * eax = 48 - function number
2437
  * ebx = 13 - subfunction number
2438
  * ecx = pointer to the skin file path string
2439
  * edx = string encoding, details can be found in function 80 description.
2440
Returned value:
2441
  * eax = 0 - success
2442
  * otherwise eax = file system error code; if file does not
2443
    contain valid skin, function returns error 3
2444
    (unknown file system).
2445
Remarks:
2446
  * After successful skin loading the system sends to all windows
2447
    redraw message (the event 1).
2448
  * At booting the system reads skin from file 'default.skn'
2449
    on ramdisk.
2450
  * User can change the skin statically by creating hisself
2451
    'default.skn' or dynamically with the application 'desktop'.
2452
 
2453
======================================================================
118 diamond 2454
=========== Function 49 - Advanced Power Management (APM). ===========
114 mikedld 2455
======================================================================
2456
Parameters:
118 diamond 2457
  * eax = 49 - function number
2458
  * dx = number of the APM function
2459
    (analogue of ax in APM specification)
2460
  * bx, cx = parameters of the APM function
114 mikedld 2461
Returned value:
118 diamond 2462
  * 16-bit registers ax, bx, cx, dx, si, di and carry flag CF
2463
    are set according to the APM specification
2464
  * high halves of 32-bit registers eax, ebx, ecx,
2465
    edx, esi, edi are destroyed
114 mikedld 2466
Remarks:
118 diamond 2467
  * APM 1.2 specification is described in the document
2468
    "Advanced Power Management (APM) BIOS Specification"
2469
    (Revision 1.2), available at
114 mikedld 2470
    http://www.microsoft.com/whdc/archive/amp_12.mspx;
118 diamond 2471
    besides it is included in famous Interrupt List by Ralf Brown
114 mikedld 2472
    (http://www.pobox.com/~ralf/files.html,
2473
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/).
2474
 
6057 IgorA 2475
---------------------- Constants for registers: ----------------------
2476
  eax - SF_APM (49)
114 mikedld 2477
======================================================================
118 diamond 2478
=================== Function 50 - set window shape. ==================
114 mikedld 2479
======================================================================
118 diamond 2480
Normal windows have rectangular shape. This function can give to
2481
a window any shape. The shape is given by a set of points inside
2482
the base rectangle belonging to a window. Position and coordinates
2483
of the base rectangle are set by function 0
2484
and changed by function 67.
114 mikedld 2485
 
118 diamond 2486
--------------------------- Set shape data ---------------------------
114 mikedld 2487
Parameters:
118 diamond 2488
  * eax = 50 - function number
2489
  * ebx = 0 - subfunction number
2490
  * ecx = pointer to shape data (array of bytes 0/1)
114 mikedld 2491
Returned value:
2492
  * function does not return value
2493
 
118 diamond 2494
-------------------------- Set shape scale ---------------------------
114 mikedld 2495
Parameters:
118 diamond 2496
  * eax = 50 - function number
2497
  * ebx = 1 - subfunction number
2498
  * ecx sets a scale: each byte of data defines
2499
    (2^scale)*(2^scale) pixels
114 mikedld 2500
Returned value:
2501
  * function does not return value
2502
Remarks:
118 diamond 2503
  * Default scale is 0 (scale factor is 1). If in the shape data
2504
    one byte corresponds to one pixel, there is no necessity
2505
    to set scale.
2506
  * Let's designate xsize = window width (in pixels), ysize = height;
2507
    pay attention, that they are one pixel more than defined by
114 mikedld 2508
    functions 0, 67.
118 diamond 2509
  * On definition of scale xsize and ysize must be divisible
2510
    on 2^scale.
2511
  * Byte of data on offset 'a' must be 0/1 and defines belonging
2512
    to a window of square with the side 2^scale (if scale=0,
2513
    this is one pixel) and coordinates of the left upper corner
114 mikedld 2514
    (a mod (xsize shr scale), a div (xsize shr scale))
118 diamond 2515
  * Data size: (xsize shr scale)*(ysize shr scale).
2516
  * Data must be presented in the memory and not change
2517
    after set of shape.
2518
  * The system views the shape data at every window redraw by
2519
    function 0.
2520
  * The call of subfunction 0 with NULL pointer results in return
2521
    to the rectangular shape.
114 mikedld 2522
 
6057 IgorA 2523
---------------------- Constants for registers: ----------------------
2524
  eax - SF_SET_WINDOW_SHAPE (50)
114 mikedld 2525
======================================================================
2526
==================== Function 51 - create thread. ====================
2527
======================================================================
2528
Parameters:
118 diamond 2529
  * eax = 51 - function number
2530
  * ebx = 1 - unique subfunction
2531
  * ecx = address of thread entry point (starting eip)
2532
  * edx = pointer to thread stack (starting esp)
114 mikedld 2533
Returned value:
118 diamond 2534
  * eax = -1 - error (there is too many threads)
2535
  * otherwise eax = TID - thread identifier
114 mikedld 2536
 
6057 IgorA 2537
---------------------- Constants for registers: ----------------------
2538
  eax - SF_CREATE_THREAD (51)
114 mikedld 2539
======================================================================
4199 mario79 2540
==================== Function 54, subfunction 0 ======================
2541
============== Get the number of slots in the clipboard. =============
2542
======================================================================
2543
Parameters:
2544
  * eax = 54 - function number
2545
  * ebx = 0 - subfunction number
2546
Returned value:
2547
  * eax = slots in the clipboard
2548
  * eax = -1 - main list area not found
2549
 
6057 IgorA 2550
---------------------- Constants for registers: ----------------------
2551
  eax - SF_CLIPBOARD (54)
2552
  ebx - SSF_GET_SLOT_COUNT (0)
4199 mario79 2553
======================================================================
2554
==================== Function 54, subfunction 1 ======================
2555
================= Read the data from the clipboard. ==================
2556
======================================================================
2557
Parameters:
2558
  * eax = 54 - function number
2559
  * ebx = 1 - subfunction number
2560
  * eсx = slot number
2561
Returned value:
2562
  * eax = if successful - pointer to a memory with data
2563
  * eax = 1 - error
2564
  * eax = -1 - main list area not found
6974 0CodErr 2565
Remarks:
2566
  * The function must be used in conjunction with 68.11. The
2567
    application must pre-initialize the local heap by calling 68.11.
6079 serge 2568
 
6057 IgorA 2569
---------------------- Constants for registers: ----------------------
2570
  eax - SF_CLIPBOARD (54)
2571
  ebx - SSF_READ_CB (1)
4199 mario79 2572
======================================================================
2573
==================== Function 54, subfunction 2 ======================
2574
================= Write the data to the clipboard. ===================
2575
======================================================================
2576
Parameters:
2577
  * eax = 54 - function number
2578
  * ebx = 2 - subfunction number
2579
  * eсx = the number of bytes to be copied
2580
  * edx = a pointer to a buffer for data to be copied
2581
Returned value:
2582
  * eax = 0 - success
2583
  * eax = 1 - error
2584
  * eax = -1 - main list area not found
6057 IgorA 2585
 
2586
---------------------- Constants for registers: ----------------------
2587
  eax - SF_CLIPBOARD (54)
2588
  ebx - SSF_WRITE_CB (2)
4199 mario79 2589
======================================================================
2590
===================== Function 54, subfunction 3 =====================
2591
================ Delete the last slot in the clipboard ===============
2592
======================================================================
2593
Parameters:
2594
  * eax = 54 - function number
2595
  * ebx = 3 - subfunction number
2596
Returned value:
2597
  * eax = 0 - success
2598
  * eax = 1 - error
2599
  * eax = -1 - main list area not found
6057 IgorA 2600
 
2601
---------------------- Constants for registers: ----------------------
2602
  eax - SF_CLIPBOARD (54)
2603
  ebx - SSF_DEL_SLOT (3)
4199 mario79 2604
======================================================================
2605
===================== Function 54, subfunction 4 =====================
2606
===================== Alarm reset the lock buffer ====================
2607
======================================================================
2608
Parameters:
2609
  * eax = 54 - function number
2610
  * ebx = 4 - subfunction number
2611
Returned value:
2612
  * eax = 0 - success
2613
  * eax = -1 - main list area not found or no blocking
2614
Remarks:
2615
  * Used in exceptional cases, where no responsible or killed
2616
    application blocked the clipboard operations.
2617
 
6057 IgorA 2618
---------------------- Constants for registers: ----------------------
2619
  eax - SF_CLIPBOARD (54)
2620
  ebx - SSF_UNLOCK_BUFFER (4)
4199 mario79 2621
======================================================================
2409 Serge 2622
 Function 55, subfunction 55 - begin to play data on built-in speaker.
114 mikedld 2623
======================================================================
2624
Parameters:
118 diamond 2625
  * eax = 55 - function number
2626
  * ebx = 55 - subfunction number
2627
  * esi = pointer to data
114 mikedld 2628
Returned value:
118 diamond 2629
  * eax = 0 - success
2630
  * eax = 55 - error (speaker is off or busy)
2631
Data is an array of items with variable length.
2632
Format of each item is defined by first byte:
114 mikedld 2633
  * 0 = end of data
118 diamond 2634
  * 1..0x80 = sets sound duration on 1/100 of second; sound note
2635
    is defined by immediate value of frequency
2636
    * following word (2 bytes) contains frequency divider;
2637
      frequency is defined as 1193180/divider
114 mikedld 2638
  * 0x81 = invalid
118 diamond 2639
  * 0x82..0xFF = note is defined by octave and number:
2640
    * duration in 1/100 of second = (first byte)-0x81
114 mikedld 2641
    * there is one more byte;
118 diamond 2642
    * (second byte)=0xFF - delay
2643
    * otherwise it looks like a*0x10+b, where b=number of the note in
2644
      an octave from 1 to 12, a=number of octave (beginning from 0)
114 mikedld 2645
Remarks:
118 diamond 2646
  * Speaker play can be disabled/enabled by
2647
    subfunction 8 of function 18.
2648
  * Function returns control, having informed the system
2649
    an information on request. Play itself goes independently from
2650
    the program.
2651
  * The data must be kept in the memory at least up to the end
2652
    of play.
114 mikedld 2653
 
6057 IgorA 2654
---------------------- Constants for registers: ----------------------
2655
  eax - SF_SPEAKER_PLAY (55)
114 mikedld 2656
======================================================================
641 diamond 2657
======================= Function 57 - PCI BIOS. ======================
2658
======================================================================
2659
Parameters:
2660
  * eax = 57 - function number
2661
  * ebp corresponds to al in PCI BIOS specification
2662
  * other registers are set according to PCI BIOS specification
2663
Returned value:
2664
  * CF is undefined
2665
  * other registers are set according to PCI BIOS specification
2666
Remarks:
2667
  * Many effects of this function can be also achieved with
2668
    corresponding subfunctions of function 62.
2669
  * The function calls PCI32 BIOS extension, documented e.g. in
2670
    http://alpha1.dyns.net/files/PCI/bios21.pdf.
2671
  * If BIOS does not support this extension, its behavior is emulated
2672
    (through kernel-mode analogues of subfunctions of function 62).
2673
 
6057 IgorA 2674
---------------------- Constants for registers: ----------------------
2675
  eax - SF_PCI_BIOS (57)
641 diamond 2676
======================================================================
118 diamond 2677
========== Function 60 - Inter Process Communication (IPC). ==========
114 mikedld 2678
======================================================================
118 diamond 2679
IPC is used for message dispatching from one process/thread to
2680
another. Previously it is necessary to agree how to interpret
114 mikedld 2681
the concrete message.
2682
 
118 diamond 2683
----------- Subfunction 1 - set the area for IPC receiving -----------
2684
Is called by process-receiver.
114 mikedld 2685
Parameters:
118 diamond 2686
  * eax = 60 - function number
2687
  * ebx = 1 - subfunction number
2688
  * ecx = pointer to the buffer
2689
  * edx = size of the buffer
114 mikedld 2690
Returned value:
118 diamond 2691
  * eax = 0 - always success
2692
Format of IPC-buffer:
2693
  * +0: dword: if nonzero, buffer is considered locked;
2694
    lock/unlock the buffer, when you work with it and need that
2695
    buffer data are not changed from outside (no new messages)
114 mikedld 2696
  * +4: dword: occupied place in the buffer (in bytes)
2697
  * +8: first message
2698
  * +8+n: second message
2699
  * ...
118 diamond 2700
Format of a message:
2701
  * +0: dword: PID of sender
2702
  * +4: dword: message length (not including this header)
2703
  * +8: n*byte: message data
114 mikedld 2704
 
118 diamond 2705
------------------ Subfunction 2 - send IPC message ------------------
2706
Is called by process-sender.
114 mikedld 2707
Parameters:
118 diamond 2708
  * eax = 60 - function number
2709
  * ebx = 2 - subfunction number
114 mikedld 2710
  * ecx = PID of receiver
118 diamond 2711
  * edx = pointer to the message data
2712
  * esi = message length (in bytes)
114 mikedld 2713
Returned value:
118 diamond 2714
  * eax = 0 - success
2715
  * eax = 1 - the receiver has not defined buffer for IPC messages
2716
    (can be, still have no time,
2717
    and can be, this is not right process)
2718
  * eax = 2 - the receiver has blocked IPC-buffer; try to wait a bit
2719
  * eax = 3 - overflow of IPC-buffer of the receiver
114 mikedld 2720
  * eax = 4 - process/thread with such PID does not exist
2721
Remarks:
118 diamond 2722
  * Immediately after writing of IPC-message to the buffer the system
2723
    sends to the receiver the event with code 7 (see event codes).
114 mikedld 2724
 
6057 IgorA 2725
---------------------- Constants for registers: ----------------------
2726
  eax - SF_IPC (60)
2727
  ebx - SSF_SET_AREA (1), SSF_SEND_MESSAGE (2)
114 mikedld 2728
======================================================================
118 diamond 2729
==== Function 61 - get parameters for the direct graphics access. ====
114 mikedld 2730
======================================================================
118 diamond 2731
The data of the graphics screen (the memory area which displays
2732
screen contents) are accessible to a program directly, without
2733
any system calls, through the selector gs:
5871 hidnplayr 2734
        mov     eax, [gs:0]
118 diamond 2735
places in eax the first dword of the buffer, which contains
2736
information on color of the left upper point (and, possibly, colors
2737
of several following).
5871 hidnplayr 2738
        mov     [gs:0], eax
118 diamond 2739
by work in VESA modes with LFB sets color of the left upper point
2740
(and, possibly, colors of several following).
2741
To interpret the data of graphics screen program needs to know
2742
some parameters, returning by this function.
114 mikedld 2743
Remarks:
7121 dunkaist 2744
  * Graphics parameters changes very seldom at work.
118 diamond 2745
  * At videomode change the system redraws all windows (event
2746
    with code 1) and redraws the background (event 5).
2747
    Same events occur in other cases too, which meet much more often,
2748
    than videomode change.
2749
  * By operation in videomodes with LFB the selector gs points to
2750
    LFB itself, so reading/writing on gs result directly in
2751
    change of screen contents. By operation in videomodes without
2752
    LFB gs points to some data area in the kernel, and all functions
2753
    of screen output fulfil honesty double operation on writing
2754
    directly to the screen and writing to this buffer. In result
2755
    at reading contents of this buffer the results correspond to
2756
    screen contents (with, generally speaking, large color
2757
    resolution), and writing is ignored.
2758
    One exception is the mode 320*200, for which main loop of the
2759
    system thread updates the screen according to mouse movements.
114 mikedld 2760
 
2761
------------------------- Screen resolution --------------------------
2762
Parameters:
118 diamond 2763
  * eax = 61 - function number
2764
  * ebx = 1 - subfunction number
114 mikedld 2765
Returned value:
118 diamond 2766
  * eax = [resolution on x axis]*65536 + [resolution on y axis]
114 mikedld 2767
Remarks:
118 diamond 2768
  * One can use function 14 paying attention that
2769
    it returns sizes on 1 pixel less. It is fully equivalent way.
114 mikedld 2770
 
118 diamond 2771
---------------------- Number of bits per pixel ----------------------
114 mikedld 2772
Parameters:
118 diamond 2773
  * eax = 61 - function number
2774
  * ebx = 2 - subfunction number
114 mikedld 2775
Returned value:
118 diamond 2776
  * eax = number of bits per pixel (24 or 32)
114 mikedld 2777
 
118 diamond 2778
-------------------- Number of bytes per scanline --------------------
114 mikedld 2779
Parameters:
118 diamond 2780
  * eax = 61 - function number
2781
  * ebx = 3 - subfunction number
114 mikedld 2782
Returned value:
118 diamond 2783
  * eax = number of bytes occupied by one scanline
114 mikedld 2784
    (horizontal line on the screen)
2785
 
6057 IgorA 2786
---------------------- Constants for registers: ----------------------
2787
  eax - SF_GET_GRAPHICAL_PARAMS (61)
2788
  ebx - SSF_SCREEN_SIZE (1), SSF_BITS_PER_PIXEL (2),
2789
    SSF_BYTES_PER_LINE (3)
114 mikedld 2790
======================================================================
118 diamond 2791
===== Function 62, subfunction 0 - get version of PCI-interface. =====
114 mikedld 2792
======================================================================
2793
Parameters:
118 diamond 2794
  * eax = 62 - function number
2795
  * bl = 0 - subfunction number
114 mikedld 2796
Returned value:
118 diamond 2797
  * eax = -1 - PCI access is disabled; otherwise
2798
  * ah.al = version of PCI-interface (ah=version, al=subversion)
2799
  * high word of eax is zeroed
114 mikedld 2800
Remarks:
118 diamond 2801
  * Previously low-level access to PCI for applications must be
2802
    enabled by subfunction 12 of function 21.
2803
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 2804
 
6057 IgorA 2805
---------------------- Constants for registers: ----------------------
2806
  eax - SF_PCI (62)
2807
  ebx - SSF_GET_VERSION (0)
114 mikedld 2808
======================================================================
118 diamond 2809
==== Function 62, subfunction 1 - get number of the last PCI-bus. ====
114 mikedld 2810
======================================================================
2811
Parameters:
118 diamond 2812
  * eax = 62 - function number
2813
  * bl = 1 - subfunction number
114 mikedld 2814
Returned value:
118 diamond 2815
  * eax = -1 - access to PCI is disabled; otherwise
2816
  * al = number of the last PCI-bus; other bytes of eax are destroyed
114 mikedld 2817
Remarks:
118 diamond 2818
  * Previously low-level access to PCI for applications must be
2819
    enabled by subfunction 12 of function 21.
2820
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 2821
 
6057 IgorA 2822
---------------------- Constants for registers: ----------------------
2823
  eax - SF_PCI (62)
2824
  ebx - SSF_GET_LAST_BUS (1)
114 mikedld 2825
======================================================================
118 diamond 2826
===================== Function 62, subfunction 2 =====================
2827
===== Get mechanism of addressing to the PCI configuration space. ====
114 mikedld 2828
======================================================================
2829
Parameters:
118 diamond 2830
  * eax = 62 - function number
2831
  * bl = 2 - subfunction number
114 mikedld 2832
Returned value:
118 diamond 2833
  * eax = -1 - access to PCI is disabled; otherwise
2834
  * al = mechanism (1 or 2); other bytes of eax are destroyed
114 mikedld 2835
Remarks:
118 diamond 2836
  * Previously low-level access to PCI for applications must be
2837
    enabled by subfunction 12 of function 21.
2838
  * Addressing mechanism is selected depending on
2839
    equipment characteristics.
2840
  * Subfunctions of read and write work automatically
2841
    with the selected mechanism.
114 mikedld 2842
 
6057 IgorA 2843
---------------------- Constants for registers: ----------------------
2844
  eax - SF_PCI (62)
2845
  ebx - SSF_GET_ADRR_MODE (2)
114 mikedld 2846
======================================================================
118 diamond 2847
======== Function 62, subfunctions 4,5,6 - read PCI-register. ========
114 mikedld 2848
======================================================================
2849
Parameters:
118 diamond 2850
  * eax = 62 - function number
2851
  * bl = 4 - read byte
2852
  * bl = 5 - read word
2853
  * bl = 6 - read dword
114 mikedld 2854
  * bh = number of PCI-bus
118 diamond 2855
  * ch = dddddfff, where ddddd = number of the device on the bus,
2856
    fff = function number of device
2857
  * cl = number of register (must be even for bl=5,
2858
    divisible by 4 for bl=6)
114 mikedld 2859
Returned value:
118 diamond 2860
  * eax = -1 - error (access to PCI is disabled or parameters
2861
    are not supported); otherwise
2862
  * al/ax/eax (depending on requested size) contains the data;
2863
    the other part of register eax is destroyed
114 mikedld 2864
Remarks:
118 diamond 2865
  * Previously low-level access to PCI for applications must be
2866
    enabled by subfunction 12 of function 21.
2867
  * Access mechanism 2 supports only 16 devices on a bus and ignores
2868
    function number. To get access mechanism use subfunction 2.
2869
  * Some registers are standard and exist for all devices, some are
2870
    defined by the concrete device. The list of registers of the
2871
    first type can be found e.g. in famous
114 mikedld 2872
    Interrupt List by Ralf Brown
2873
    (http://www.pobox.com/~ralf/files.html,
2874
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/);
118 diamond 2875
    registers of the second type must be listed
2876
    in the device documentation.
114 mikedld 2877
 
6057 IgorA 2878
---------------------- Constants for registers: ----------------------
2879
  eax - SF_PCI (62)
2880
  ebx - SSF_READ_BYTE (4), SSF_READ_WORD (5), SSF_READ_DWORD (6)
114 mikedld 2881
======================================================================
118 diamond 2882
====== Function 62, subfunctions 8,9,10 - write to PCI-register. =====
114 mikedld 2883
======================================================================
2884
Parameters:
118 diamond 2885
  * eax = 62 - function number
2886
  * bl = 8 - write byte
2887
  * bl = 9 - write word
2888
  * bl = 10 - write dword
114 mikedld 2889
  * bh = number of PCI-bus
118 diamond 2890
  * ch = dddddfff, where ddddd = number of the device on the bus,
2891
    fff = function number of device
2892
  * cl = number of register (must be even for bl=9,
2893
    divisible by 4 for bl=10)
7722 dunkaist 2894
  * dl/dx/edx (depending on requested size) contains
118 diamond 2895
    the data to write
114 mikedld 2896
Returned value:
118 diamond 2897
  * eax = -1 - error (access to PCI is disabled or parameters
2898
    are not supported)
2899
  * eax = 0 - success
114 mikedld 2900
Remarks:
118 diamond 2901
  * Previously low-level access to PCI for applications must be
2902
    enabled by subfunction 12 of function 21.
2903
  * Access mechanism 2 supports only 16 devices on a bus and ignores
2904
    function number. To get access mechanism use subfunction 2.
2905
  * Some registers are standard and exist for all devices, some are
2906
    defined by the concrete device. The list of registers of the
2907
    first type can be found e.g. in famous Interrupt List by
2908
    Ralf Brown; registers of the second type must be listed
2909
    in the device documentation.
114 mikedld 2910
 
6057 IgorA 2911
---------------------- Constants for registers: ----------------------
2912
  eax - SF_PCI (62)
2913
  ebx - SSF_WRITE_BYTE (8), SSF_WRITE_WORD (9), SSF_WRITE_DWORD (10)
114 mikedld 2914
======================================================================
118 diamond 2915
============== Function 63 - work with the debug board. ==============
114 mikedld 2916
======================================================================
118 diamond 2917
The debug board is the global system buffer (with the size
499 diamond 2918
1024 bytes), to which any program can write (generally speaking,
118 diamond 2919
arbitrary) data and from which other program can read these data.
2920
By the agreement written data are text strings interpreted as
2921
debug messages on a course of program execution. The kernel in
2922
some situations also writes to the debug board information on
2923
execution of some functions; by the agreement kernel messages
2924
begins from the prefix "K : ".
2925
For view of the debug board the application 'board' was created,
2926
which reads data from the buffer and displays them in its window.
2927
'board' interpretes the sequence of codes 13,10 as newline.
2928
A character with null code in an end of line is not necessary,
114 mikedld 2929
but also does not prevent.
118 diamond 2930
Because debugger has been written, the value of the debug board
2931
has decreased, as debugger allows to inspect completely a course of
2932
program execution without any efforts from the direction of program
2933
itself. Nevertheless in some cases the debug board is still useful.
114 mikedld 2934
 
118 diamond 2935
----------------------------- Write byte -----------------------------
114 mikedld 2936
Parameters:
118 diamond 2937
  * eax = 63 - function number
2938
  * ebx = 1 - subfunction number
2939
  * cl = data byte
114 mikedld 2940
Returned value:
2941
  * function does not return value
2942
Remarks:
118 diamond 2943
  * Byte is written to the buffer. Buffer size is 512 bytes.
2944
    At buffer overflow all obtained data are lost.
2945
  * For output to the debug board of more complicated objects
2946
    (strings, numbers) it is enough to call this function in cycle.
2947
    It is possible not to write the appropriate code manually and use
2948
    file 'debug.inc', which is included into the distributive.
114 mikedld 2949
 
118 diamond 2950
----------------------------- Read byte ------------------------------
2951
Takes away byte from the buffer.
114 mikedld 2952
Parameters:
118 diamond 2953
  * eax = 63 - function number
2954
  * ebx = 2 - subfunction number
114 mikedld 2955
Returned value:
118 diamond 2956
  * eax = ebx = 0 - the buffer is empty
2957
  * eax = byte, ebx = 1 - byte was successfully read
114 mikedld 2958
 
6057 IgorA 2959
---------------------- Constants for registers: ----------------------
2960
  eax - SF_BOARD (63)
2961
  ebx - SSF_DEBUG_WRITE (1), SSF_DEBUG_READ (2)
114 mikedld 2962
======================================================================
118 diamond 2963
============== Function 64 - resize application memory. ==============
114 mikedld 2964
======================================================================
2965
Parameters:
118 diamond 2966
  * eax = 64 - function number
2967
  * ebx = 1 - unique subfunction
2968
  * ecx = new memory size
114 mikedld 2969
Returned value:
118 diamond 2970
  * eax = 0 - success
2971
  * eax = 1 - not enough memory
114 mikedld 2972
Remarks:
193 diamond 2973
  * There is another way to dynamically allocate/free memory -
6893 pathoswith 2974
    subfunctions 12, 13 and 20 of function 68, but after creation
2975
    of the process heap 64 function call will be ignored.
6974 0CodErr 2976
  * The function cannot be used together with 68.11, 68.12, 68.13.
2977
    The function call will be ignored after creation of process heap
2978
    with function 68.11.
2979
 
6057 IgorA 2980
---------------------- Constants for registers: ----------------------
2981
  eax - SF_MEMORY_RESIZE (64)
114 mikedld 2982
======================================================================
283 diamond 2983
======== Function 65 - draw image with palette in the window. ========
2984
======================================================================
2985
Parameters:
2986
  * eax = 65 - function number
2987
  * ebx = pointer to the image
2988
  * ecx = [size on axis x]*65536 + [size on axis y]
2989
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
2730 dunkaist 2990
  * esi = number of bits per pixel, must be 1,2,4,8,9,15,16,24 or 32;
1018 diamond 2991
  * edi = pointer to palette (2 to the power esi colors 0x00RRGGBB);
2992
          ignored when esi > 8
314 diamond 2993
  * ebp = offset of next row data relative to previous row data
283 diamond 2994
Returned value:
2995
  * function does not return value
2996
Remarks:
2997
  * Coordinates of the image are coordinates of the upper left corner
2998
    of the image relative to the window.
1018 diamond 2999
  * Format of image with 1 bit per pixel: each byte of image
3000
    (possibly excluding last bytes in rows), contains information on
3001
    the color of 8 pixels, MSB corresponds to first pixel.
3002
  * Format of image with 2 bits per pixel: each byte of image
3003
    (possibly excluding last bytes in rows), contains information on
3004
    the color of 4 pixels, two MSBs correspond to first pixel.
3005
  * Format of image with 4 bits per pixel: each byte of image
3006
    excluding last bytes in rows (if width is odd) contains
3007
    information on the color of 2 pixels, high-order tetrad
3008
    corresponds to first pixel.
3009
  * Format of image with 8 bits per pixel: each byte of image is
3010
    index in the palette.
2730 dunkaist 3011
  * Format of image with 9 bits per pixel: array of one byte values;
3012
    each byte (8 bit) represents the intensity of gray for one pixel;
3013
    this format is equal to 8bpp without palette.
1018 diamond 3014
  * Format of image with 15 bits per pixel: the color of each pixel
3015
    is coded as (bit representation) 0RRRRRGGGGGBBBBB - 5 bits per
3016
    each color.
3017
  * Format of image with 16 bits per pixel: the color of each pixel
3018
    is coded as RRRRRGGGGGGBBBBB (5+6+5).
3019
  * Format of image with 24 bits per pixel: the color of each pixel
3020
    is coded as 3 bytes - sequentially blue, green, red components.
3021
  * Format of image with 32 bits per pixel: similar to 24, but
6402 ashmew2 3022
    one additional ignored byte is present. It's format is BGRX,
3023
    where X is the ignored byte.
314 diamond 3024
  * The call to function 7 is equivalent to call to this function
3025
    with esi=24, ebp=0.
283 diamond 3026
 
6057 IgorA 3027
---------------------- Constants for registers: ----------------------
3028
  eax - SF_PUT_IMAGE_EXT (65)
283 diamond 3029
======================================================================
118 diamond 3030
================== Function 66 - work with keyboard. =================
114 mikedld 3031
======================================================================
118 diamond 3032
The input mode influences results of reading keys by function 2.
3033
When a program loads, ASCII input mode is set for it.
114 mikedld 3034
 
118 diamond 3035
-------------- Subfunction 1 - set keyboard input mode. --------------
114 mikedld 3036
Parameters:
118 diamond 3037
  * eax = 66 - function number
3038
  * ebx = 1 - subfunction number
114 mikedld 3039
  * ecx = mode:
3040
    * 0 = normal (ASCII-characters)
3041
    * 1 = scancodes
3042
Returned value:
3043
  * function does not return value
3044
 
118 diamond 3045
-------------- Subfunction 2 - get keyboard input mode. --------------
114 mikedld 3046
Parameters:
118 diamond 3047
  * eax = 66 - function number
3048
  * ebx = 2 - subfunction number
114 mikedld 3049
Returned value:
3050
  * eax = current mode
3051
 
118 diamond 3052
------------ Subfunction 3 - get status of control keys. -------------
114 mikedld 3053
Parameters:
118 diamond 3054
  * eax = 66 - function number
3055
  * ebx = 3 - subfunction number
114 mikedld 3056
Returned value:
3057
  * eax = bit mask:
3355 mario79 3058
  * bit 0  (mask 1): left Shift is pressed
3059
  * bit 1  (mask 2): right Shift is pressed
3060
  * bit 2  (mask 4): left Ctrl is pressed
3061
  * bit 3  (mask 8): right Ctrl is pressed
3062
  * bit 4  (mask 0x10): left Alt is pressed
3063
  * bit 5  (mask 0x20): right Alt is pressed
3064
  * bit 6  (mask 0x40): CapsLock is on
3065
  * bit 7  (mask 0x80): NumLock is on
3066
  * bit 8  (mask 0x100): ScrollLock is on
3067
  * bit 9  (mask 0x200): left Win is pressed
3068
  * bit 10 (mask 0x400): right Win is pressed
118 diamond 3069
  * other bits are cleared
114 mikedld 3070
 
118 diamond 3071
-------------- Subfunction 4 - set system-wide hotkey. ---------------
3072
When hotkey is pressed, the system notifies only those applications,
3073
which have installed it; the active application (which receives
3074
all normal input) does not receive such keys.
3075
The notification consists in sending event with the code 2.
3076
Reading hotkey is the same as reading normal key - by function 2.
114 mikedld 3077
Parameters:
118 diamond 3078
  * eax = 66 - function number
3079
  * ebx = 4 - subfunction number
3080
  * cl determines key scancode;
3081
    use cl=0 to give combinations such as Ctrl+Shift
3082
  * edx = 0xXYZ determines possible states of control keys:
3083
    * Z (low 4 bits) determines state of LShift and RShift:
3084
      * 0 = no key must be pressed;
3085
      * 1 = exactly one key must be pressed;
3086
      * 2 = both keys must be pressed;
3087
      * 3 = must be pressed LShift, but not RShift;
3088
      * 4 = must be pressed RShift, but not LShift
3089
    * Y - similar for LCtrl and RCtrl;
3090
    * X - similar for LAlt and RAlt
114 mikedld 3091
Returned value:
118 diamond 3092
  * eax=0 - success
7722 dunkaist 3093
  * eax=1 - too many hotkeys (maximum 256 are allowed)
114 mikedld 3094
Remarks:
118 diamond 3095
  * Hotkey can work either at pressing or at release. Release
3096
    scancode of a key is more on 128 than pressing scancode
3097
    (i.e. high bit is set).
3098
  * Several applications can set the same combination;
3099
    all such applications will be informed on pressing
3100
    such combination.
114 mikedld 3101
 
118 diamond 3102
-------------- Subfunction 5 - delete installed hotkey. --------------
114 mikedld 3103
Parameters:
118 diamond 3104
  * eax = 66 - function number
3105
  * ebx = 5 - subfunction number
3106
  * cl = scancode of key and edx = 0xXYZ the same as in subfunction 4
114 mikedld 3107
Returned value:
118 diamond 3108
  * eax = 0 - success
114 mikedld 3109
  * eax = 1 - there is no such hotkey
3110
Remarks:
118 diamond 3111
  * When a process/thread terminates, all hotkey installed by it are
3112
    deleted.
3113
  * The call to this subfunction does not affect other applications.
3114
    If other application has defined the same combination, it will
3115
    still receive notices.
114 mikedld 3116
 
2709 mario79 3117
--------------- Subfunction 6 - block the normal input. --------------
3118
Parameters:
3119
  * eax = 66 - function number
3120
  * ebx = 6 - subfunction number
3121
Returned value:
3122
  * function does not return value
3123
Remarks:
3124
  * Blocking the normal keyboard input for installed hotkeys
3125
  * To emulate a mouse via the keyboard, the application MOUSEMUL
3126
 
3127
------------ Subfunction 7 - unlock the normal input. ----------------
3128
Parameters:
3129
  * eax = 66 - function number
3130
  * ebx = 7 - subfunction number
3131
Returned value:
3132
  * function does not return value
3133
Remarks:
3134
  * Unlocking the results of the f. 66.6
3135
  * To emulate a mouse via the keyboard, the application MOUSEMUL
3136
 
6057 IgorA 3137
---------------------- Constants for registers: ----------------------
3138
  eax - SF_KEYBOARD (66)
3139
  ebx - SSF_SET_INPUT_MODE (1), SSF_GET_INPUT_MODE (2),
3140
    SSF_GET_CONTROL_KEYS (3), SSF_SET_SYS_HOTKEY (4),
3141
    SSF_DEL_SYS_HOTKEY (5),  SSF_LOCK_INPUT (6), SSF_UNLOCK_INPUT (7)
114 mikedld 3142
======================================================================
118 diamond 3143
========= Function 67 - change position/sizes of the window. =========
114 mikedld 3144
======================================================================
3145
Parameters:
118 diamond 3146
  * eax = 67 - function number
114 mikedld 3147
  * ebx = new x-coordinate of the window
3148
  * ecx = new y-coordinate of the window
3149
  * edx = new x-size of the window
3150
  * esi = new y-size of the window
3151
Returned value:
3152
  * function does not return value
3153
Remarks:
118 diamond 3154
  * The value -1 for a parameter means "do not change"; e.g. to move
3155
    the window without resizing it is possible to specify edx=esi=-1.
3156
  * Previously the window must be defined by function 0.
114 mikedld 3157
    It sets initial coordinates and sizes of the window.
118 diamond 3158
  * Sizes of the window are understood in sense of function 0,
3159
    that is one pixel less than real sizes.
3160
  * The function call for maximized windows is simply ignored.
3161
  * For windows of appropriate styles position and/or sizes can be
3162
    changed by user; current position and sizes can be obtained by
3163
    call to function 9.
3164
  * The function sends to the window redraw event (with the code 1).
114 mikedld 3165
 
6057 IgorA 3166
---------------------- Constants for registers: ----------------------
3167
  eax - SF_CHANGE_WINDOW (67)
114 mikedld 3168
======================================================================
118 diamond 3169
====== Function 68, subfunction 0 - get the task switch counter. =====
114 mikedld 3170
======================================================================
3171
Parameters:
118 diamond 3172
  * eax = 68 - function number
3173
  * ebx = 0 - subfunction number
114 mikedld 3174
Returned value:
118 diamond 3175
  * eax = number of task switches from the system booting
3176
    (modulo 2^32)
114 mikedld 3177
 
6057 IgorA 3178
---------------------- Constants for registers: ----------------------
3179
  eax - SF_SYS_MISC (68)
3180
  ebx - SSF_GET_TASK_SWITCH_COUNT (0)
114 mikedld 3181
======================================================================
118 diamond 3182
======= Function 68, subfunction 1 - switch to the next thread. ======
114 mikedld 3183
======================================================================
118 diamond 3184
The function completes the current time slice allocated to the
3185
thread and switches to the next. (Which thread in which process
3186
will be next, is unpredictable). Later, when execution queue
3187
will reach the current thread, execution will be continued.
114 mikedld 3188
Parameters:
118 diamond 3189
  * eax = 68 - function number
3190
  * ebx = 1 - subfunction number
114 mikedld 3191
Returned value:
3192
  * function does not return value
3193
 
6057 IgorA 3194
---------------------- Constants for registers: ----------------------
3195
  eax - SF_SYS_MISC (68)
3196
  ebx - SSF_SWITCH_TASK (1)
114 mikedld 3197
======================================================================
118 diamond 3198
============= Function 68, subfunction 2 - cache + rdpmc. ============
114 mikedld 3199
======================================================================
3200
Parameters:
118 diamond 3201
  * eax = 68 - function number
3202
  * ebx = 2 - subfunction number
3203
  * ecx = required action:
3204
    * ecx = 0 - enable instruction 'rdpmc'
3205
      (ReaD Performance-Monitoring Counters) for applications
3206
    * ecx = 1 - find out whether cache is disabled/enabled
3207
    * ecx = 2 - enable cache
3208
    * ecx = 3 - disable cache
114 mikedld 3209
Returned value:
3210
  * for ecx=0:
118 diamond 3211
    * eax = the value of cr4
114 mikedld 3212
  * for ecx=1:
3213
    * eax = (cr0 and 0x60000000):
118 diamond 3214
    * eax = 0 - cache is on
3215
    * eax <> 0 - cache is off
114 mikedld 3216
  * for ecx=2 and ecx=3:
3217
    * function does not return value
3218
 
6057 IgorA 3219
---------------------- Constants for registers: ----------------------
3220
  eax - SF_SYS_MISC (68)
3221
  ebx - SSF_PERFORMANCE (2)
3222
  ecx - SSSF_ALLOW_RDPMC (0), SSSF_CACHE_STATUS (1),
3223
    SSSF_CACHE_ON (2), SSSF_CACHE_OFF (3)
114 mikedld 3224
======================================================================
3225
=========== Function 68, subfunction 3 - read MSR-register. ==========
3226
======================================================================
118 diamond 3227
MSR = Model Specific Register; the complete list of MSR-registers
3228
of a processor is included to the documentation on it (for example,
3229
IA-32 Intel Architecture Software Developer's Manual,
3230
Volume 3, Appendix B); each processor family has its own subset
3231
of the MSR-registers.
114 mikedld 3232
Parameters:
118 diamond 3233
  * eax = 68 - function number
3234
  * ebx = 3 - subfunction number
3235
  * ecx is ignored
3236
  * edx = MSR address
114 mikedld 3237
Returned value:
118 diamond 3238
  * ebx:eax = high:low dword of the result
114 mikedld 3239
Remarks:
118 diamond 3240
  * If ecx contains nonexistent or not implemented for this processor
3241
    MSR, processor will generate an exception in the kernel, which
3242
    will kill the thread.
3243
  * Previously it is necessary to check, whether MSRs are supported
3244
    as a whole, with the instruction 'cpuid'. Otherwise processor
3245
    will generate other exception in the kernel, which will anyway
3246
    kill the thread.
114 mikedld 3247
 
6057 IgorA 3248
---------------------- Constants for registers: ----------------------
3249
  eax - SF_SYS_MISC (68)
3250
  ebx - SSF_READ_MSR (3)
114 mikedld 3251
======================================================================
118 diamond 3252
========= Function 68, subfunction 4 - write to MSR-register. ========
114 mikedld 3253
======================================================================
118 diamond 3254
MSR = Model Specific Register; the complete list of MSR-registers
3255
of a processor is included to the documentation on it (for example,
3256
IA-32 Intel Architecture Software Developer's Manual,
3257
Volume 3, Appendix B); each processor family has its own subset
3258
of the MSR-registers.
114 mikedld 3259
Parameters:
118 diamond 3260
  * eax = 68 - function number
3261
  * ebx = 4 - subfunction number
3262
  * ecx is ignored
3263
  * edx = MSR address
3264
  * esi:edi = high:low dword
114 mikedld 3265
Returned value:
499 diamond 3266
  * function does not return value
3267
Remarks:
118 diamond 3268
  * If ecx contains nonexistent or not implemented for this processor
3269
    MSR, processor will generate an exception in the kernel, which
3270
    will kill the thread.
3271
  * Previously it is necessary to check, whether MSRs are supported
3272
    as a whole, with the instruction 'cpuid'. Otherwise processor
3273
    will generate other exception in the kernel, which will anyway
3274
    kill the thread.
114 mikedld 3275
 
6057 IgorA 3276
---------------------- Constants for registers: ----------------------
3277
  eax - SF_SYS_MISC (68)
3278
  ebx - SSF_WRITE_MSR (4)
114 mikedld 3279
======================================================================
6974 0CodErr 3280
=== Function 68, subfunction 11 - initialize process heap ============
114 mikedld 3281
======================================================================
3282
Parameters:
118 diamond 3283
  * eax = 68 - function number
193 diamond 3284
  * ebx = 11 - subfunction number
114 mikedld 3285
Returned value:
193 diamond 3286
  * eax = 0 - failed
3287
  * otherwise size of created heap
114 mikedld 3288
Remarks:
6893 pathoswith 3289
  * The function call initializes heap for subfunctions 12, 13 and 20.
3290
  * If the process heap is already created, this function will return
3291
    the size of the existing heap.
193 diamond 3292
    Heap size is equal to total amount of free application memory.
3293
  * After creation of the heap calls to function 64 will be ignored.
114 mikedld 3294
 
6057 IgorA 3295
---------------------- Constants for registers: ----------------------
3296
  eax - SF_SYS_MISC (68)
3297
  ebx - SSF_HEAP_INIT (11)
114 mikedld 3298
======================================================================
193 diamond 3299
======== Function 68, subfunction 12 - allocate memory block. ========
114 mikedld 3300
======================================================================
3301
Parameters:
118 diamond 3302
  * eax = 68 - function number
193 diamond 3303
  * ebx = 12 - subfunction number
3304
  * ecx = required size in bytes
114 mikedld 3305
Returned value:
193 diamond 3306
  * eax = pointer to the allocated block
114 mikedld 3307
Remarks:
193 diamond 3308
  * The function allocates an integer number of pages (4 Kb) in such
3309
    way that the real size of allocated block is more than or equal to
3310
    requested size.
114 mikedld 3311
 
6057 IgorA 3312
---------------------- Constants for registers: ----------------------
3313
  eax - SF_SYS_MISC (68)
3314
  ebx - SSF_MEM_ALLOC (12)
114 mikedld 3315
======================================================================
193 diamond 3316
========== Function 68, subfunction 13 - free memory block. ==========
114 mikedld 3317
======================================================================
3318
Parameters:
118 diamond 3319
  * eax = 68 - function number
193 diamond 3320
  * ebx = 13 - subfunction number
3321
  * ecx = pointer to the memory block
114 mikedld 3322
Returned value:
193 diamond 3323
  * eax = 1 - success
3324
  * eax = 0 - failed
114 mikedld 3325
Remarks:
448 diamond 3326
  * The memory block must have been allocated by subfunction 12
3327
    or subfunction 20.
114 mikedld 3328
 
6057 IgorA 3329
---------------------- Constants for registers: ----------------------
3330
  eax - SF_SYS_MISC (68)
3331
  ebx - SSF_MEM_FREE (13)
114 mikedld 3332
======================================================================
1074 Galkov 3333
===================== Function 68, subfunction 14 ====================
1662 Nasarus 3334
============ Wait for signal from another program/driver. ============
114 mikedld 3335
======================================================================
3336
Parameters:
118 diamond 3337
  * eax = 68 - function number
193 diamond 3338
  * ebx = 14 - subfunction number
1074 Galkov 3339
  * ecx = pointer to the buffer for information (24 bytes)
114 mikedld 3340
Returned value:
193 diamond 3341
  * buffer pointed to by ecx contains the following information:
1662 Nasarus 3342
    * +0: dword: identifier for following data of signal
3343
    * +4: dword: data of signal (20 bytes), format of which is defined
3344
          by the first dword
114 mikedld 3345
 
6057 IgorA 3346
---------------------- Constants for registers: ----------------------
3347
  eax - SF_SYS_MISC (68)
3348
  ebx - SSF_WAIT_SIGNAL (14)
114 mikedld 3349
======================================================================
193 diamond 3350
============= Function 68, subfunction 16 - load driver. =============
3351
======================================================================
3352
Parameters:
3353
  * eax = 68 - function number
3354
  * ebx = 16 - subfunction number
3355
  * ecx = pointer to ASCIIZ-string with driver name
3356
Returned value:
3357
  * eax = 0 - failed
3358
  * otherwise eax = driver handle
3359
Remarks:
3360
  * If the driver was not loaded yet, it is loaded;
3361
    if the driver was loaded yet, nothing happens.
3362
  * Driver name is case-sensitive.
3363
    Maximum length of the name is 16 characters, including
3364
    terminating null character, the rest is ignored.
8088 dunkaist 3365
  * Driver ABC is loaded from file /sys/drivers/ABC.sys.
193 diamond 3366
 
6057 IgorA 3367
---------------------- Constants for registers: ----------------------
3368
  eax - SF_SYS_MISC (68)
3369
  ebx - SSF_LOAD_DRIVER (16)
193 diamond 3370
======================================================================
3371
============ Function 68, subfunction 17 - driver control. ===========
3372
======================================================================
3373
Parameters:
3374
  * eax = 68 - function number
3375
  * ebx = 17 - subfunction number
3376
  * ecx = pointer to the control structure:
3377
    * +0: dword: handle of driver
3378
    * +4: dword: code of driver function
3379
    * +8: dword: pointer to input data
3380
    * +12 = +0xC: dword: size of input data
3381
    * +16 = +0x10: dword: pointer to output data
3382
    * +20 = +0x14: dword: size of output data
3383
Returned value:
1662 Nasarus 3384
  * eax = determined by driver
193 diamond 3385
Remarks:
3386
  * Function codes and the structure of input/output data
3387
    are defined by driver.
3388
  * Previously one must obtain driver handle by subfunction 16.
3389
 
6057 IgorA 3390
---------------------- Constants for registers: ----------------------
3391
  eax - SF_SYS_MISC (68)
3392
  ebx - SSF_CONTROL_DRIVER (17)
193 diamond 3393
======================================================================
6798 pathoswith 3394
== Function 68, subfunction 18 - load DLL, specifying the encoding. ==
277 diamond 3395
======================================================================
3396
Parameters:
3397
  * eax = 68 - function number
6798 pathoswith 3398
  * ebx = 18 - subfunction number
3399
  * ecx = pointer to the string with path to DLL
3400
  * edx = string encoding, details can be found in function 80 description.
277 diamond 3401
Returned value:
3402
  * eax = 0 - failed
3403
  * otherwise eax = pointer to DLL export table
3404
Remarks:
3405
  * Export table is an array of structures of 2 dword's, terminated
3406
    by zero. The first dword in structure points to function name,
3407
    the second dword contains address of function.
3408
 
6798 pathoswith 3409
======================================================================
3410
=============== Function 68, subfunction 19 - load DLL. ==============
3411
======================================================================
3412
Parameters:
3413
  * eax = 68 - function number
3414
  * ebx = 19 - subfunction number
3415
  * ecx = pointer to the string with path to DLL,
3416
    rules of path forming can be found in function 70 description.
3417
Returned value:
3418
  * eax = 0 - failed
3419
  * otherwise eax = pointer to DLL export table
3420
 
6057 IgorA 3421
---------------------- Constants for registers: ----------------------
3422
  eax - SF_SYS_MISC (68)
3423
  ebx - SSF_LOAD_DLL (19)
277 diamond 3424
======================================================================
448 diamond 3425
======= Function 68, subfunction 20 - reallocate memory block. =======
3426
======================================================================
3427
Parameters:
3428
  * eax = 68 - function number
3429
  * ebx = 20 - subfunction number
3430
  * ecx = new size in bytes
3431
  * edx = pointer to already allocated block
3432
Returned value:
3433
  * eax = pointer to the reallocated block, 0 = error
3434
Remarks:
6974 0CodErr 3435
  * Before this call one must initialize process heap by call to
3436
    subfunction 11.
448 diamond 3437
  * The function allocates an integer number of pages (4 Kb) in such
3438
    way that the real size of allocated block is more than or equal to
3439
    requested size.
3440
  * If edx=0, the function call is equivalent to memory allocation
3441
    with subfunction 12. Otherwise the block at edx
3442
    must be allocated earlier with subfunction 12 or this subfunction.
3443
  * If ecx=0, the function frees memory block at edx and returns 0.
3444
  * The contents of the block are unchanged up to the shorter of
3445
    the new and old sizes.
3446
 
6057 IgorA 3447
---------------------- Constants for registers: ----------------------
3448
  eax - SF_SYS_MISC (68)
3449
  ebx - SSF_MEM_REALLOC (20)
448 diamond 3450
======================================================================
2646 mario79 3451
=========== Function 68, subfunction 21 - load driver PE. ============
3452
======================================================================
3453
Parameters:
3454
  * eax = 68 - function number
3455
  * ebx = 21 - subfunction number
3456
  * ecx = pointer to ASCIIZ-string with driver name
2647 mario79 3457
  * edx = pointer to command line
2646 mario79 3458
Returned value:
3459
  * eax = 0 - failed
3460
  * otherwise eax = driver handle
3461
Remarks:
3462
  * If the driver was not loaded yet, it is loaded;
3463
    if the driver was loaded yet, nothing happens.
3464
 
6057 IgorA 3465
---------------------- Constants for registers: ----------------------
3466
  eax - SF_SYS_MISC (68)
3467
  ebx - SSF_LOAD_DRIVER_PE (21)
2646 mario79 3468
======================================================================
1662 Nasarus 3469
======== Function 68, subfunction 22 - open named memory area. =======
1077 Galkov 3470
======================================================================
3471
Parameters:
3472
  * eax = 68 - function number
1662 Nasarus 3473
  * ebx = 22 - subfunction number
3474
  * ecx = area name. Maximum of 31 characters with terminating zero
3475
  * edx = area size in bytes for SHM_CREATE and SHM_OPEN_ALWAYS
3476
  * esi = flags for open and access:
3477
    * SHM_OPEN        = 0x00 - open existing memory area. If an area
3478
                          with such name does not exist, the function
3479
                          will return error code 5.
3480
    * SHM_OPEN_ALWAYS = 0x04 - open existing or create new
3481
                          memory area.
3482
    * SHM_CREATE      = 0x08 - create new memory area. If an area
3483
                          with such name already exists, the function
3484
                          will return error code 10.
3485
    * SHM_READ        = 0x00 - only read access
3486
    * SHM_WRITE       = 0x01 - read and write access
3487
Returned value:
7722 dunkaist 3488
  * eax = pointer to memory area, 0 if error has occurred
1662 Nasarus 3489
  * if new area is created (SHM_CREATE or SHM_OPEN_ALWAYS):
3490
    edx = 0 - success, otherwise - error code
3491
  * if existing area is opened (SHM_OPEN or SHM_OPEN_ALWAYS):
3492
    edx = error code (if eax=0) or area size in bytes
3493
Error codes:
3494
  * E_NOTFOUND = 5
3495
  * E_ACCESS = 10
3496
  * E_NOMEM = 30
3497
  * E_PARAM = 33
3498
Remarks:
6974 0CodErr 3499
  * Before this call one must initialize process heap by call to
3500
    subfunction 11.
1662 Nasarus 3501
  * If a new area is created, access flags set maximal rights
3502
    for other processes. An attempt from other process to open
3503
    with denied rights will fail with error code E_ACCESS.
3504
  * The process which has created an area always has write access.
3505
 
6057 IgorA 3506
---------------------- Constants for registers: ----------------------
3507
  eax - SF_SYS_MISC (68)
3508
  ebx - SSF_MEM_OPEN (22)
1662 Nasarus 3509
======================================================================
3510
======= Function 68, subfunction 23 - close named memory area. =======
3511
======================================================================
3512
Parameters:
3513
  * eax = 68 - function number
3514
  * ebx = 23 - subfunction number
3515
  * ecx = area name. Maximum of 31 characters with terminating zero
3516
Returned value:
3517
  * eax destroyed
3518
Remarks:
3519
  * A memory area is physically freed (with deleting all data and
3520
    freeing physical memory), when all threads which have opened
3521
    this area will close it.
3522
  * When thread is terminating, all opened by it areas are closed.
3523
 
6057 IgorA 3524
---------------------- Constants for registers: ----------------------
3525
  eax - SF_SYS_MISC (68)
3526
  ebx - SSF_MEM_CLOSE (23)
1662 Nasarus 3527
======================================================================
3528
======== Function 68, subfunction 24 - set exception handler. ========
3529
======================================================================
3530
Parameters:
3531
  * eax = 68 - function number
1077 Galkov 3532
  * ebx = 24 - subfunction number
3533
  * ecx = address of the new exception handler
1662 Nasarus 3534
  * edx = the mask of handled exceptions
1077 Galkov 3535
Returned value:
3536
  * eax = address of the old exception handler (0, if it was not set)
1662 Nasarus 3537
  * ebx = the old mask of handled exceptions
1077 Galkov 3538
Remarks:
1662 Nasarus 3539
  * Bit number in mask of exceptions corresponds to exception number
3540
    in CPU-specification (Intel-PC). For example, FPU exceptions have
3541
    number 16 (#MF), and SSE exceptions - 19 (#XF).
3542
  * The current implementation ignores the inquiry for hook of 7
3543
    exception - the system handles #NM by its own.
3544
  * The exception handler is called with exception number as first
3545
    (and only) stack parameter. So, correct exit from the handler is
3546
    RET 4. It returns to the instruction, that caused the exception,
3547
    for faults, and to the next instruction for traps (see
3548
    classification of exceptions in CPU specification).
3549
  * When user handler receives control, the corresponding bit in
3550
    the exception mask is cleared. Raising this exception
3551
    in consequence leads to default handling, that is,
3552
    terminating the application in absence of debugger or
3553
    suspend with notification of debugger otherwise.
3554
  * After user handler completes critical operations, it can set
3555
    the corresponding bit in the exception mask with subfunction 25.
3556
    Also user handler is responsible for clearing exceptions flags in
3557
    FPU and/or SSE.
1077 Galkov 3558
 
6057 IgorA 3559
---------------------- Constants for registers: ----------------------
3560
  eax - SF_SYS_MISC (68)
3561
  ebx - SSF_SET_EXCEPTION_HANDLER (24)
1077 Galkov 3562
======================================================================
5983 pathoswith 3563
======== Function 68, subfunction 25 - set exception activity ========
1077 Galkov 3564
======================================================================
3565
Parameters:
3566
  * eax = 68 - function number
3567
  * ebx = 25 - subfunction number
3568
  * ecx = signal number
3569
  * edx = value of activity (0/1)
3570
Returned value:
1662 Nasarus 3571
  * eax = -1 - invalid signal number
3572
  * otherwise eax = old value of activity for this signal (0/1)
1077 Galkov 3573
Remarks:
7722 dunkaist 3574
  * In current implementation only mask for user exception handler,
1662 Nasarus 3575
    which has been previously set by subfunction 24,
3576
    is changed. Signal number corresponds to exception number.
1077 Galkov 3577
 
6057 IgorA 3578
---------------------- Constants for registers: ----------------------
3579
  eax - SF_SYS_MISC (68)
3580
  ebx - SSF_SET_EXCEPTION_STATE (25)
1077 Galkov 3581
======================================================================
3787 Serge 3582
====== Function 68, subfunction 26 - release memory pages ============
3583
======================================================================
3584
Parameters:
3585
  * eax = 68 - function number
3586
  * ebx = 26 - subfunction number
3587
  * ecx = pointer to the memory block, allocated by subfunction 12
3588
  * edx = offset from the block beginnings
3589
  * esi = the size of the region of memory to release, in bytes
3590
Remarks:
3591
  * function release range of pages from ecx+edx to ecx+edx+esi
3592
    and set virtual memory into reserved state.
3593
 
6057 IgorA 3594
---------------------- Constants for registers: ----------------------
3595
  eax - SF_SYS_MISC (68)
3596
  ebx - SSF_MEM_FREE_EXT (26)
3787 Serge 3597
======================================================================
3598
========== Function 68, subfunction 27 - load file ===================
3599
======================================================================
3600
Parameters:
3601
  * eax = 68 - function number
3602
  * ebx = 27 - subfunction number
6511 pathoswith 3603
  * ecx = pointer to the string with path to file,
3604
    rules of path forming can be found in function 70 description.
3787 Serge 3605
Returned value:
3606
  * eax = pointer to the loaded file, or zero
3607
  * edx = size of the loaded file, or zero
3608
Remarks:
3609
  * function loads file and unpacks, if necessary
6974 0CodErr 3610
  * Before this call one must initialize process heap by call to
3611
    subfunction 11.
3787 Serge 3612
 
6057 IgorA 3613
---------------------- Constants for registers: ----------------------
3614
  eax - SF_SYS_MISC (68)
3615
  ebx - SSF_LOAD_FILE (27)
3787 Serge 3616
======================================================================
6798 pathoswith 3617
== Function 68, subfunction 28 - load file, specifying the encoding ==
3618
======================================================================
3619
Parameters:
3620
  * eax = 68 - function number
3621
  * ebx = 28 - subfunction number
3622
  * ecx = pointer to the string with path to file
3623
  * edx = string encoding, details can be found in function 80 description.
3624
Returned value:
3625
  * eax = pointer to the loaded file, or zero
3626
  * edx = size of the loaded file, or zero
3627
Remarks:
3628
  * function loads file and unpacks, if necessary
7967 hidnplayr 3629
======================================================================
3630
======== Function 68, subfunction 29 - allocate ring memory. =========
3631
======================================================================
3632
Parameters:
3633
  * eax = 68 - function number
3634
  * ebx = 29 - subfunction number
3635
  * ecx = required size in bytes
3636
Returned value:
3637
  * eax = 0 - failed
3638
  * eax = pointer to the allocated ring
3639
Remarks:
3640
  * The requested size must be an exact multiple of pagesize (4 Kb)
3641
  * The function allocates memory in such a way that you can read and
3642
    write beyond the size of the allocated memory and will reach the
3643
    beginning of the buffer again.
6798 pathoswith 3644
 
7967 hidnplayr 3645
---------------------- Constants for registers: ----------------------
3646
  eax - SF_SYS_MISC (68)
3647
  ebx - SSF_MEM_ALLOC_RING (29)
9048 Boppan 3648
======================================================================
3649
============ Function 68, subfunction 30 - load PE-file ==============
3650
======================================================================
3651
Parameters:
3652
  * eax = 68 - function number
3653
  * ebx = 30 - subfunction number
3654
  * ecx = pointer to the string with path to file,
3655
    rules of path forming can be found in function 70 description.
3656
Returned value:
3657
  * eax > 0xFFFFF000 - error, -eax = error code
3658
  * eax <= 0xFFFFF000 - pointer to the loaded file
3659
Remarks:
3660
  * This function is to be called only by system loader from
3661
    kolibri.dll; the file loaded is not ready yet, it requires further
3662
    configuration. Use dlopen() from kolibri.dll instead of this
3663
    function.
3664
======================================================================
3665
=========== Function 68, subfunction 31 - unload PE-file =============
3666
======================================================================
3667
Parameters:
3668
  * eax = 68 - function number
3669
  * ebx = 31 - subfunction number
3670
  * ecx = pointer to the loaded file
3671
Returned value:
3672
  * eax = 0 - success
3673
  * eax = -1 - provided address does not correspond to any loaded file
3674
Remarks:
3675
  * This function is to be called only by system loader from
3676
    kolibri.dll. Use dlclose() from kolibri.dll instead of this
3677
    function.
3678
======================================================================
3679
===== Function 68, subfunction 32 - modify memory access rights ======
3680
======================================================================
3681
Parameters:
3682
  * eax = 68 - function number
3683
  * ebx = 32 - subfunction number
3684
  * ecx = new access rights: zero or more of the following bits:
3685
    * PROT_READ = 1 - allow reading
3686
    * PROT_WRITE = 2 - allow writing
3687
    * PROT_EXEC = 4 - allow execution
3688
  * edx = pointer to begin of memory region
3689
  * esi = size of memory region in bytes
3690
Returned value:
3691
  * eax = -1 - error
3692
  * else eax = old access rights
3693
Remarks:
3694
  * The function modifies access rights to whole pages (4096 bytes).
3695
  * The function modifies access rights to all the pages intersecting
3696
    provided memory region.
3697
  * It is considered an error if a memory region returned by function
3698
    68.22 is passed to this function.
3699
  * If any part of the passed memory region is incorrect, then the
3700
    function returns an error. However it is not guaranteed that
3701
    access rights of the correct part have been changed.
3702
  * If there was no error, the function returns old access rights of
3703
    the first provided page.
3704
  * Current implementation does not support execution access rights
3705
    without reading rights. Therefore bit PROT_EXEC is ignored on
3706
    entering the function, and becomes a copy of PROT_READ at exit.
3707
---------------------- Constants for registers: ----------------------
3708
  eax - SF_SYS_MISC (68)
3709
  ebx - SSF_MPROTECT (32)
7967 hidnplayr 3710
 
6798 pathoswith 3711
======================================================================
1662 Nasarus 3712
====================== Function 69 - debugging. ======================
114 mikedld 3713
======================================================================
118 diamond 3714
A process can load other process as debugged by set of corresponding
193 diamond 3715
bit by call to subfunction 7 of function 70.
118 diamond 3716
A process can have only one debugger; one process can debug some
7722 dunkaist 3717
others. The system notifies debugger on events occurring with
118 diamond 3718
debugged process. Messages are written to the buffer defined by
114 mikedld 3719
subfunction 0.
118 diamond 3720
Format of a message:
3721
  * +0: dword: message code
3722
  * +4: dword: PID of debugged process
3723
  * +8: there can be additional data depending on message code
3724
Message codes:
114 mikedld 3725
  * 1 = exception
118 diamond 3726
    * in addition dword-number of the exception is given
3727
    * process is suspended
3728
  * 2 = process has terminated
3729
    * comes at any termination: both through the system function -1,
3730
      and at "murder" by any other process (including debugger itself)
114 mikedld 3731
  * 3 = debug exception int 1 = #DB
118 diamond 3732
    * in addition dword-image of the register DR6 is given:
3733
      * bits 0-3: condition of the corresponding breakpoint (set by
3734
        subfunction 9) is satisfied
7722 dunkaist 3735
      * bit 14: exception has occurred because of the trace mode
118 diamond 3736
        (flag TF is set TF)
3737
    * process is suspended
3738
When debugger terminates, all debugged processes are killed.
3739
If debugger does not want this, it must previously detach by
114 mikedld 3740
subfunction 3.
3741
 
1018 diamond 3742
All subfunctions are applicable only to processes/threads started
3743
from the current by function 70 with set debugging flag.
118 diamond 3744
Debugging of multithreaded programs is not supported yet.
3745
The full list of subfunctions:
3746
  * subfunction 0 - define data area for debug messages
3747
  * subfunction 1 - get contents of registers of debugged thread
3748
  * subfunction 2 - set contents of registers of debugged thread
3749
  * subfunction 3 - detach from debugged process
3750
  * subfunction 4 - suspend debugged thread
3751
  * subfunction 5 - resume debugged thread
3752
  * subfunction 6 - read from the memory of debugged process
3753
  * subfunction 7 - write to the memory of debugged process
3754
  * subfunction 8 - terminate debugged thread
3755
  * subfunction 9 - set/clear hardware breakpoint
114 mikedld 3756
 
6057 IgorA 3757
---------------------- Constants for registers: ----------------------
3758
  eax - SF_DEBUG (69)
3759
  ebx - SSF_SET_MESSAGE_AREA (0), SSF_GET_REGISTERS (1),
3760
    SSF_SET_REGISTERS (2), SSF_DETACH (3), SSF_SUSPEND (4),
3761
    SSF_RESUME (5), SSF_READ_MEMORY (6), SSF_WRITE_MEMORY (7),
3762
    SSF_TERMINATE (8), SSF_DEFINE_BREAKPOINT (9)
114 mikedld 3763
======================================================================
118 diamond 3764
= Function 69, subfunction 0 - define data area fror debug messages. =
114 mikedld 3765
======================================================================
3766
Parameters:
118 diamond 3767
  * eax = 69 - function number
3768
  * ebx = 0 - subfunction number
114 mikedld 3769
  * ecx = pointer
3770
Format of data area:
118 diamond 3771
  * +0: dword: N = buffer size (not including this header)
3772
  * +4: dword: occupied place
114 mikedld 3773
  * +8: N*byte: buffer
3774
Returned value:
3775
  * function does not return value
3776
Remarks:
118 diamond 3777
  * If the size field is negative, the buffer is considered locked
3778
    and at arrival of new message the system will wait.
3779
    For synchronization frame all work with the buffer by operations
3780
    lock/unlock
5871 hidnplayr 3781
        neg     [bufsize]
118 diamond 3782
  * Data in the buffer are considered as array of items with variable
3783
    length - messages. Format of a message is explained in
3784
    general description.
114 mikedld 3785
 
6057 IgorA 3786
---------------------- Constants for registers: ----------------------
3787
  eax - SF_DEBUG (69)
3788
  ebx - SSF_SET_MESSAGE_AREA (0)
114 mikedld 3789
======================================================================
118 diamond 3790
===================== Function 69, subfunction 1 =====================
3791
============ Get contents of registers of debugged thread. ===========
114 mikedld 3792
======================================================================
3793
Parameters:
118 diamond 3794
  * eax = 69 - function number
3795
  * ebx = 1 - subfunction number
114 mikedld 3796
  * ecx = thread identifier
118 diamond 3797
  * edx = size of context structure, must be 0x28=40 bytes
3798
  * esi = pointer to context structure
114 mikedld 3799
Returned value:
3800
  * function does not return value
118 diamond 3801
Format of context structure: (FPU is not supported yet)
114 mikedld 3802
  * +0: dword: eip
3803
  * +4: dword: eflags
3804
  * +8: dword: eax
3805
  * +12 = +0xC: dword: ecx
3806
  * +16 = +0x10: dword: edx
3807
  * +20 = +0x14: dword: ebx
3808
  * +24 = +0x18: dword: esp
3809
  * +28 = +0x1C: dword: ebp
3810
  * +32 = +0x20: dword: esi
3811
  * +36 = +0x24: dword: edi
3812
Remarks:
118 diamond 3813
  * If the thread executes code of ring-0, the function returns
3814
    contents of registers of ring-3.
3815
  * Process must be loaded for debugging (as is shown in
3816
    general description).
114 mikedld 3817
 
6057 IgorA 3818
---------------------- Constants for registers: ----------------------
3819
  eax - SF_DEBUG (69)
3820
  ebx - SSF_GET_REGISTERS (1)
114 mikedld 3821
======================================================================
118 diamond 3822
===================== Function 69, subfunction 2 =====================
3823
============ Set contents of registers of debugged thread. ===========
114 mikedld 3824
======================================================================
3825
Parameters:
118 diamond 3826
  * eax = 69 - function number
3827
  * ebx = 2 - subfunction number
114 mikedld 3828
  * ecx = thread identifier
118 diamond 3829
  * edx = size of context structure, must be 0x28=40 bytes
6758 pathoswith 3830
  * esi -> context structure
114 mikedld 3831
Returned value:
3832
  * function does not return value
118 diamond 3833
Format of context structure is shown in the description of
3834
subfunction 1.
114 mikedld 3835
Remarks:
118 diamond 3836
  * If the thread executes code of ring-0, the function returns
3837
    contents of registers of ring-3.
3838
  * Process must be loaded for debugging (as is shown in
3839
    general description).
114 mikedld 3840
 
6057 IgorA 3841
---------------------- Constants for registers: ----------------------
3842
  eax - SF_DEBUG (69)
3843
  ebx - SSF_SET_REGISTERS (2)
114 mikedld 3844
======================================================================
118 diamond 3845
===== Function 69, subfunction 3 - detach from debugged process. =====
114 mikedld 3846
======================================================================
3847
Parameters:
118 diamond 3848
  * eax = 69 - function number
3849
  * ebx = 3 - subfunction number
114 mikedld 3850
  * ecx = identifier
3851
Returned value:
3852
  * function does not return value
3853
Remarks:
118 diamond 3854
  * If the process was suspended, it resumes execution.
114 mikedld 3855
 
6057 IgorA 3856
---------------------- Constants for registers: ----------------------
3857
  eax - SF_DEBUG (69)
3858
  ebx - SSF_DETACH (3)
114 mikedld 3859
======================================================================
1018 diamond 3860
======== Function 69, subfunction 4 - suspend debugged thread. =======
114 mikedld 3861
======================================================================
3862
Parameters:
118 diamond 3863
  * eax = 69 - function number
3864
  * ebx = 4 - subfunction number
3865
  * ecx = thread identifier
114 mikedld 3866
Returned value:
3867
  * function does not return value
1018 diamond 3868
Remarks:
3869
  * Process must be loaded for debugging (as is shown in
3870
    general description).
114 mikedld 3871
 
6057 IgorA 3872
---------------------- Constants for registers: ----------------------
3873
  eax - SF_DEBUG (69)
3874
  ebx - SSF_SUSPEND (4)
114 mikedld 3875
======================================================================
1018 diamond 3876
======== Function 69, subfunction 5 - resume debugged thread. ========
114 mikedld 3877
======================================================================
3878
Parameters:
118 diamond 3879
  * eax = 69 - function number
3880
  * ebx = 5 - subfunction number
3881
  * ecx = thread identifier
114 mikedld 3882
Returned value:
3883
  * function does not return value
1018 diamond 3884
Remarks:
3885
  * Process must be loaded for debugging (as is shown in
3886
    general description).
114 mikedld 3887
 
6057 IgorA 3888
---------------------- Constants for registers: ----------------------
3889
  eax - SF_DEBUG (69)
3890
  ebx - SSF_RESUME (5)
114 mikedld 3891
======================================================================
118 diamond 3892
= Fucntion 69, subfunction 6 - read from memory of debugged process. =
114 mikedld 3893
======================================================================
3894
Parameters:
118 diamond 3895
  * eax = 69 - function number
3896
  * ebx = 6 - subfunction number
114 mikedld 3897
  * ecx = identifier
118 diamond 3898
  * edx = number of bytes to read
3899
  * esi = address in the memory of debugged process
3900
  * edi = pointer to buffer for data
114 mikedld 3901
Returned value:
118 diamond 3902
  * eax = -1 at an error (invalid PID or buffer)
3903
  * otherwise eax = number of read bytes (possibly, 0,
3904
    if esi is too large)
114 mikedld 3905
Remarks:
118 diamond 3906
  * Process must be loaded for debugging (as is shown in
3907
    general description).
114 mikedld 3908
 
6057 IgorA 3909
---------------------- Constants for registers: ----------------------
3910
  eax - SF_DEBUG (69)
3911
  ebx - SSF_READ_MEMORY (6)
114 mikedld 3912
======================================================================
118 diamond 3913
== Function 69, subfunction 7 - write to memory of debugged process. =
114 mikedld 3914
======================================================================
3915
Parameters:
118 diamond 3916
  * eax = 69 - function number
3917
  * ebx = 7 - subfunction number
114 mikedld 3918
  * ecx = identifier
118 diamond 3919
  * edx = number of bytes to write
3920
  * esi = address of memory in debugged process
3921
  * edi = pointer to data
114 mikedld 3922
Returned value:
118 diamond 3923
  * eax = -1 at an error (invalid PID or buffer)
3924
  * otherwise eax = number of written bytes (possibly, 0,
3925
    if esi is too large)
114 mikedld 3926
Remarks:
118 diamond 3927
  * Process must be loaded for debugging (as is shown in
3928
    general description).
114 mikedld 3929
 
6057 IgorA 3930
---------------------- Constants for registers: ----------------------
3931
  eax - SF_DEBUG (69)
3932
  ebx - SSF_WRITE_MEMORY (7)
114 mikedld 3933
======================================================================
118 diamond 3934
======= Function 69, subfunction 8 - terminate debugged thread. ======
114 mikedld 3935
======================================================================
3936
Parameters:
118 diamond 3937
  * eax = 69 - function number
3938
  * ebx = 8 - subfunction number
114 mikedld 3939
  * ecx = identifier
3940
Returned value:
3941
  * function does not return value
3942
Remarks:
118 diamond 3943
  * Process must be loaded for debugging (as is shown in
3944
    general description).
3945
  * The function is similar to subfunction 2 of function 18
3946
    with two differences: it requires first remark and
3947
    accepts PID rather than slot number.
114 mikedld 3948
 
6057 IgorA 3949
---------------------- Constants for registers: ----------------------
3950
  eax - SF_DEBUG (69)
3951
  ebx - SSF_TERMINATE (8)
114 mikedld 3952
======================================================================
118 diamond 3953
===== Function 69, subfunction 9 - set/clear hardware breakpoint. ====
114 mikedld 3954
======================================================================
3955
Parameters:
118 diamond 3956
  * eax = 69 - function number
3957
  * ebx = 9 - subfunction number
114 mikedld 3958
  * ecx = thread identifier
118 diamond 3959
  * dl = index of breakpoint, from 0 to 3 inclusively
114 mikedld 3960
  * dh = flags:
118 diamond 3961
    * if high bit is cleared - set breakpoint:
114 mikedld 3962
      * bits 0-1 - condition:
3963
        * 00 = breakpoint on execution
118 diamond 3964
        * 01 = breakpoint on read
3965
        * 11 = breakpoint on read/write
3966
      * bits 2-3 - length; for breakpoints on exception it must be
3967
        00, otherwise one of
3968
        * 00 = byte
114 mikedld 3969
        * 01 = word
118 diamond 3970
        * 11 = dword
3971
      * esi = breakpoint address; must be aligned according to
3972
        the length (i.e. must be even for word breakpoints,
3973
        divisible by 4 for dword)
3974
    * if high bit is set - clear breakpoint
114 mikedld 3975
Returned value:
118 diamond 3976
  * eax = 0 - success
114 mikedld 3977
  * eax = 1 - error in the input data
118 diamond 3978
  * eax = 2 - (reserved, is never returned in the current
3979
    implementation) a global breakpoint with that index is already set
114 mikedld 3980
Remarks:
118 diamond 3981
  * Process must be loaded for debugging (as is shown in
3982
    general description).
3983
  * Hardware breakpoints are implemented through DRx-registers of
3984
    the processor, all limitations results from this.
3985
  * The function can reinstall the breakpoint, previously set
3986
    by it (and it does not inform on this).
3987
    Carry on the list of set breakpoints in the debugger.
3988
  * Breakpoints generate debug exception #DB, on which the system
3989
    notifies debugger.
3990
  * Breakpoints on write and read/write act after
3991
    execution of the caused it instruction.
114 mikedld 3992
 
6057 IgorA 3993
---------------------- Constants for registers: ----------------------
3994
  eax - SF_DEBUG (69)
3995
  ebx - SSF_DEFINE_BREAKPOINT (9)
114 mikedld 3996
======================================================================
118 diamond 3997
==== Function 70 - work with file system with long names support. ====
114 mikedld 3998
======================================================================
3999
Parameters:
4000
  * eax = 70
118 diamond 4001
  * ebx = pointer to the information structure
114 mikedld 4002
Returned value:
118 diamond 4003
  * eax = 0 - success; otherwise file system error code
4004
  * some subfunctions return value in other registers too
4005
General format of the information structure:
4006
  * +0: dword: subfunction number
6798 pathoswith 4007
  * +4: dword: offset in file or folder
4008
  * +8: dword: higher part of offset or flags
4009
  * +12 = +0xC: dword: size of data
118 diamond 4010
  * +16 = +0x10: dword: pointer to data
6473 pathoswith 4011
  * +20 = +0x14: ?: path - zero terminated string
6502 pathoswith 4012
  or
6473 pathoswith 4013
  * +20 = +0x14: byte: 0
4014
  * +21 = +0x15: dword: pointer to string
6502 pathoswith 4015
Case sensitivity depends on filesystem.
6758 pathoswith 4016
If a path not begins with '/', it is considered a relative.
6798 pathoswith 4017
To get or set the current folder, use the sysfunction 30.
4018
'../' in the path means a lift by one folder relatively current folder.
6502 pathoswith 4019
To set the encoding, put at the start of the string a byte with next values:
4020
  * 1 = cp866
4021
  * 2 = UTF-16LE
4022
  * 3 = UTF-8
6758 pathoswith 4023
  otherwise will be used cp866. In an absolute path
4024
  you may put this byte after the '/' or put an additional '/' before it.
6798 pathoswith 4025
  Also, you may use the sysfunction 80.
6758 pathoswith 4026
Format of an absolute path:
6473 pathoswith 4027
  /base/number/dir1/dir2/.../dirn/file,
4028
where base/number identifies device, on which file is located:
4029
  * RD/1 = ramdisk
4030
  * FD/1 = first floppy drive,
4031
    FD/2 = second floppy drive
4032
  * HD0/x, HD1/x, HD2/x, HD3/x = hard drives accordingly on
118 diamond 4033
    IDE0 (Primary Master), IDE1 (Primary Slave),
114 mikedld 4034
    IDE2 (Secondary Master), IDE3 (Secondary Slave);
6473 pathoswith 4035
    x - partition number on the selected hard drive, starts from 1
4036
  * CD0/1, CD1/1, CD2/1, CD3/1 = same for cd
4037
  * SYS = system folder (encoding inaffected key),
4038
    second key may be set by sysfunction 30.3.
114 mikedld 4039
Examples:
6473 pathoswith 4040
  * '/sys/example.asm',0
4041
  * '/rd/1/example.asm',0
4042
  * '/HD0/1/folder/file.txt',0
4043
  * '/hd2/2/pics/tanzania.bmp',0
4044
  * 2,'/',0,'sys','/',0,'F',0,'I',0,'L',0,'E',0,0,0
1662 Nasarus 4045
 
118 diamond 4046
Available subfunctions:
114 mikedld 4047
  * subfunction 0 - read file
4048
  * subfunction 1 - read folder
4049
  * subfunction 2 - create/rewrite file
131 diamond 4050
  * subfunction 3 - write to existing file
133 diamond 4051
  * subfunction 4 - set file size
118 diamond 4052
  * subfunction 5 - get attributes of file/folder
4053
  * subfunction 6 - set attributes of file/folder
114 mikedld 4054
  * subfunction 7 - start application
193 diamond 4055
  * subfunction 8 - delete file/folder
321 diamond 4056
  * subfunction 9 - create folder
118 diamond 4057
For CD-drives due to hardware limitations only subfunctions
4058
0,1,5 and 7 are available, other subfunctions return error
4059
with code 2.
641 diamond 4060
At the first call of subfunctions 0,1,5,7 to ATAPI devices
4061
(CD and DVD) the manual control of tray is locked due to caching
4062
drive data. Unlocking is made when subfunction 4 of function 24
4063
is called for corresponding device.
114 mikedld 4064
 
6057 IgorA 4065
---------------------- Constants for registers: ----------------------
4066
  eax - SF_FILE (70)
4067
 [ebx] - SSF_READ_FILE (0), SSF_READ_FOLDER (1), SSF_CREATE_FILE (2),
4068
    SSF_WRITE_FILE (3), SSF_SET_END (4), SSF_GET_INFO (5),
4069
    SSF_SET_INFO (6), SSF_START_APP (7), SSF_DELETE (8),
4070
    SSF_CREATE_FOLDER (9)
114 mikedld 4071
======================================================================
118 diamond 4072
=== Function 70, subfunction 0 - read file with long names support. ==
114 mikedld 4073
======================================================================
4074
Parameters:
118 diamond 4075
  * eax = 70 - function number
4076
  * ebx = pointer to the information structure
4077
Format of the information structure:
4078
  * +0: dword: 0 = subfunction number
4079
  * +4: dword: file offset (in bytes)
4080
  * +8: dword: 0 (reserved for high dword of offset)
4081
  * +12 = +0xC: dword: number of bytes to read
4082
  * +16 = +0x10: dword: pointer to buffer for data
6473 pathoswith 4083
  * +20 = +0x14: path, general rules of names forming
114 mikedld 4084
Returned value:
118 diamond 4085
  * eax = 0 - success, otherwise file system error code
6880 pathoswith 4086
  * ebx = number of bytes read
114 mikedld 4087
Remarks:
118 diamond 4088
  * If file was ended before last requested block was read,
4089
    the function will read as many as it can, and after that return
4090
    eax=6 (EOF).
4091
  * The function does not allow to read folder (returns eax=10,
4092
    access denied).
114 mikedld 4093
 
6057 IgorA 4094
---------------------- Constants for registers: ----------------------
4095
  eax - SF_FILE (70)
4096
 [ebx] - SSF_READ_FILE (0)
118 diamond 4097
======================================================================
4098
== Function 70, subfunction 1 - read folder with long names support. =
4099
======================================================================
114 mikedld 4100
Parameters:
118 diamond 4101
  * eax = 70 - function number
4102
  * ebx = pointer to the information structure
4103
Format of the information structure:
4104
  * +0: dword: 1 = subfunction number
4105
  * +4: dword: index of starting block (beginning from 0)
6798 pathoswith 4106
  * +8: dword: names encoding:
4107
 
4108
    1 = cp866
4109
    2 = UTF-16LE
4110
    3 = UTF-8
118 diamond 4111
  * +12 = +0xC: dword: number of blocks to read
6798 pathoswith 4112
  * +16 = +0x10: dword: pointer to buffer for data
6473 pathoswith 4113
  * +20 = +0x14: path, general rules of names forming
114 mikedld 4114
Returned value:
118 diamond 4115
  * eax = 0 - success, otherwise file system error code
6880 pathoswith 4116
  * ebx = number of file information blocks, written to the buffer
114 mikedld 4117
Structure of the buffer:
6473 pathoswith 4118
  * header (32 bytes)
4119
  * block with information on file 1
4120
  * block with information on file 2
114 mikedld 4121
  * ...
4122
Structure of header:
118 diamond 4123
  * +0: dword: version of structure (current is 1)
4124
  * +4: dword: number of placed blocks; is not greater than requested
4125
    in the field +12 of information structure; can be less, if
4126
    there are no more files in folder (the same as in ebx)
4127
  * +8: dword: total number of files in folder
4128
  * +12 = +0xC: 20*byte: reserved (zeroed)
4129
Structure of block of data for folder entry (BDFE):
4130
  * +0: dword: attributes of file:
4131
    * bit 0 (mask 1): file is read-only
4132
    * bit 1 (mask 2): file is hidden
4133
    * bit 2 (mask 4): file is system
6901 pathoswith 4134
    * bit 3 (mask 8): this is the volume label (using by subfunction 5)
118 diamond 4135
    * bit 4 (mask 0x10): this is a folder
4136
    * bit 5 (mask 0x20): file was not archived - many archivation
4137
      programs have an option to archive only files with this bit set,
4138
      and after archiving this bit is cleared - it can be useful
4139
      for automatically creating of backup-archives as at writing
4140
      this bit is usually set
6798 pathoswith 4141
  * +4: dword: encoding, equals to field +8 in the information structure
118 diamond 4142
  * +8: 4*byte: time of file creation
4143
  * +12 = +0xC: 4*byte: date of file creation
4144
  * +16 = +0x10: 4*byte: time of last access (read or write)
114 mikedld 4145
  * +20 = +0x14: 4*byte: date of last access
118 diamond 4146
  * +24 = +0x18: 4*byte: time of last modification
4147
  * +28 = +0x1C: 4*byte: date of last modification
4148
  * +32 = +0x20: qword: file size in bytes (up to 16777216 Tb)
6798 pathoswith 4149
  * +40 = +0x28: name, 264 bytes in cp866, otherwise - 520 bytes.
118 diamond 4150
Time format:
114 mikedld 4151
  * +0: byte: seconds
4152
  * +1: byte: minutes
4153
  * +2: byte: hours
4154
  * +3: byte: reserved (0)
118 diamond 4155
  * for example, 23.59.59 is written as (in hex) 3B 3B 17 00
4156
Date format:
4157
  * +0: byte: day
4158
  * +1: byte: month
4159
  * +2: word: year
4160
  * for example, 25.11.1979 is written as (in hex) 19 0B BB 07
114 mikedld 4161
Remarks:
6473 pathoswith 4162
  * If BDFE contains cp866 name, the length of BDFE is 304 bytes,
6798 pathoswith 4163
    otherwise - 560 bytes.
6473 pathoswith 4164
  * Name string is zero terminated, further data contain garbage.
118 diamond 4165
  * If files in folder were ended before requested number was read,
4166
    the function will read as many as it can, and after that return
4167
    eax=6 (EOF).
114 mikedld 4168
  * Any folder on the disk, except for root, contains two special
118 diamond 4169
    entries "." and "..", identifying accordingly the folder itself
4170
    and the parent folder.
4171
  * The function allows also to read virtual folders "/", "/rd",
4172
    "/fd", "/hd[n]", thus attributes of subfolders are set to 0x10,
4173
    and times and dates are zeroed. An alternative way to get the
4174
    equipment information - subfunction 11 of function 18.
114 mikedld 4175
 
6057 IgorA 4176
---------------------- Constants for registers: ----------------------
4177
  eax - SF_FILE (70)
4178
 [ebx] - SSF_READ_FOLDER (1)
114 mikedld 4179
======================================================================
118 diamond 4180
===================== Function 70, subfunction 2 =====================
4181
============ Create/rewrite file with long names support. ============
114 mikedld 4182
======================================================================
4183
Parameters:
118 diamond 4184
  * eax = 70 - function number
4185
  * ebx = pointer to the information structure
4186
Format of the information structure:
4187
  * +0: dword: 2 = subfunction number
114 mikedld 4188
  * +4: dword: 0 (reserved)
4189
  * +8: dword: 0 (reserved)
4066 shikhin 4190
  * +12 = +0xC: dword: number of bytes to write
118 diamond 4191
  * +16 = +0x10: dword: pointer to data
6473 pathoswith 4192
  * +20 = +0x14: path, general rules of names forming
114 mikedld 4193
Returned value:
118 diamond 4194
  * eax = 0 - success, otherwise file system error code
4195
  * ebx = number of written bytes (possibly 0)
114 mikedld 4196
Remarks:
118 diamond 4197
  * If a file with given name did not exist, it is created;
4198
    if it existed, it is rewritten.
4199
  * If there is not enough free space on disk, the function will
4200
    write as many as can and then return error code 8.
4201
  * The function is not supported for CD (returns error code 2).
114 mikedld 4202
 
6057 IgorA 4203
---------------------- Constants for registers: ----------------------
4204
  eax - SF_FILE (70)
4205
 [ebx] - SSF_CREATE_FILE (2)
114 mikedld 4206
======================================================================
131 diamond 4207
===================== Function 70, subfunction 3 =====================
4208
=========== Write to existing file with long names support. ==========
4209
======================================================================
4210
Parameters:
4211
  * eax = 70 - function number
4212
  * ebx = pointer to the information structure
4213
Format of the information structure:
4214
  * +0: dword: 3 = subfunction number
4215
  * +4: dword: file offset (in bytes)
4216
  * +8: dword: high dword of offset (must be 0 for FAT)
4217
  * +12 = +0xC: dword: number of bytes to write
4218
  * +16 = +0x10: dword: pointer to data
6473 pathoswith 4219
  * +20 = +0x14: path, general rules of names forming
131 diamond 4220
Returned value:
4221
  * eax = 0 - success, otherwise file system error code
4222
  * ebx = number of written bytes (possibly 0)
4223
Remarks:
4224
  * The file must already exist, otherwise function returns eax=5.
4225
  * The only result of write 0 bytes is update in the file attributes
4226
    date/time of modification and access to the current date/time.
4227
  * If beginning and/or ending position is greater than file size
4228
    (except for the previous case), the file is expanded to needed
4229
    size with zero characters.
133 diamond 4230
  * The function is not supported for CD (returns error code 2).
131 diamond 4231
 
6057 IgorA 4232
---------------------- Constants for registers: ----------------------
4233
  eax - SF_FILE (70)
4234
 [ebx] - SSF_WRITE_FILE (3)
131 diamond 4235
======================================================================
133 diamond 4236
============ Function 70, subfunction 4 - set end of file. ===========
4237
======================================================================
4238
Parameters:
4239
  * eax = 70 - function number
4240
  * ebx = pointer to the information structure
4241
Format of the information structure:
4242
  * +0: dword: 4 = subfunction number
4243
  * +4: dword: low dword of new file size
4244
  * +8: dword: high dword of new file size (must be 0 for FAT)
4245
  * +12 = +0xC: dword: 0 (reserved)
4246
  * +16 = +0x10: dword: 0 (reserved)
6473 pathoswith 4247
  * +20 = +0x14: path, general rules of names forming
133 diamond 4248
Returned value:
4249
  * eax = 0 - success, otherwise file system error code
4250
  * ebx destroyed
4251
Remarks:
6758 pathoswith 4252
  * If new file size is less than old one, file will be truncated.
4253
    If new size is greater than old one, file will be expanded, and if
4254
    size difference is up to 16 MB, new space will be cleared with 0.
133 diamond 4255
  * If there is not enough free space on disk for expansion, the
4256
    function will expand to maximum possible size and then return
4257
    error code 8.
4258
  * The function is not supported for CD (returns error code 2).
4259
 
6057 IgorA 4260
---------------------- Constants for registers: ----------------------
4261
  eax - SF_FILE (70)
4262
 [ebx] - SSF_SET_END (4)
133 diamond 4263
======================================================================
118 diamond 4264
==== Function 70, subfunction 5 - get information on file/folder. ====
114 mikedld 4265
======================================================================
4266
Parameters:
118 diamond 4267
  * eax = 70 - function number
4268
  * ebx = pointer to the information structure
4269
Format of the information structure:
4270
  * +0: dword: 5 = subfunction number
114 mikedld 4271
  * +4: dword: 0 (reserved)
6427 pathoswith 4272
  * +8: dword: 0 or flags (for the root folder)
114 mikedld 4273
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 4274
  * +16 = +0x10: dword: pointer to buffer for data (40 bytes)
6473 pathoswith 4275
  * +20 = +0x14: path, general rules of names forming
114 mikedld 4276
Returned value:
118 diamond 4277
  * eax = 0 - success, otherwise file system error code
4278
  * ebx destroyed
4279
Information on file is returned in the BDFE format (block of data
6427 pathoswith 4280
for folder entry), explained in the description of subfunction 1,
4281
but without filename, except the root folder.
114 mikedld 4282
Remarks:
6876 pathoswith 4283
  * For the root folder returns the partition size,
4284
    and if encoding byte is non-zero, the volume label.
6875 pathoswith 4285
  * For the device returns only the size.
114 mikedld 4286
 
6057 IgorA 4287
---------------------- Constants for registers: ----------------------
4288
  eax - SF_FILE (70)
4289
 [ebx] - SSF_GET_INFO (5)
114 mikedld 4290
======================================================================
118 diamond 4291
===== Function 70, subfunction 6 - set attributes of file/folder. ====
114 mikedld 4292
======================================================================
4293
Parameters:
118 diamond 4294
  * eax = 70 - function number
4295
  * ebx = pointer to the information structure
4296
Format of the information structure:
4297
  * +0: dword: 6 = subfunction number
114 mikedld 4298
  * +4: dword: 0 (reserved)
4299
  * +8: dword: 0 (reserved)
4300
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 4301
  * +16 = +0x10: dword: pointer to buffer with attributes (32 bytes)
6473 pathoswith 4302
  * +20 = +0x14: path, general rules of names forming
114 mikedld 4303
Returned value:
118 diamond 4304
  * eax = 0 - success, otherwise file system error code
4305
  * ebx destroyed
4306
File attributes are first 32 bytes in BDFE (block of data
4307
for folder entry), explained in the description of subfunction 1
4308
(that is, without name and size of file). Attribute
4309
file/folder/volume label (bits 3,4 in dword +0) is not changed.
4310
Byte +4 (name format) is ignored.
114 mikedld 4311
Remarks:
118 diamond 4312
  * The function does not support virtual folders such as /, /rd and
4313
    root folders like /rd/1.
4314
  * The function is not supported for CD (returns error code 2).
114 mikedld 4315
 
6057 IgorA 4316
---------------------- Constants for registers: ----------------------
4317
  eax - SF_FILE (70)
4318
 [ebx] - SSF_SET_INFO (6)
114 mikedld 4319
======================================================================
118 diamond 4320
=========== Function 70, subfunction 7 - start application. ==========
114 mikedld 4321
======================================================================
4322
Parameters:
118 diamond 4323
  * eax = 70 - function number
4324
  * ebx = pointer to the information structure
4325
Format of the information structure:
4326
  * +0: dword: 7 = subfunction number
4327
  * +4: dword: flags field:
3539 clevermous 4328
    * bit 0: start process as debugged
118 diamond 4329
    * other bits are reserved and must be set to 0
4330
  * +8: dword: 0 or pointer to ASCIIZ-string with parameters
114 mikedld 4331
  * +12 = +0xC: dword: 0 (reserved)
4332
  * +16 = +0x10: dword: 0 (reserved)
6473 pathoswith 4333
  * +20 = +0x14: path, general rules of names forming
114 mikedld 4334
Returned value:
4335
  * eax > 0 - program is loaded, eax contains PID
7722 dunkaist 4336
  * eax < 0 - an error has occurred, -eax contains
118 diamond 4337
    file system error code
4338
  * ebx destroyed
114 mikedld 4339
Remarks:
118 diamond 4340
  * Command line must be terminated by the character with the code 0
4341
    (ASCIIZ-string); function takes into account either all characters
4342
    up to terminating zero inclusively or first 256 character
4343
    regarding what is less.
4344
  * If the process is started as debugged, it is created in
4345
    the suspended state; to run use subfunction 5 of function 69.
114 mikedld 4346
 
6057 IgorA 4347
---------------------- Constants for registers: ----------------------
4348
  eax - SF_FILE (70)
4349
 [ebx] - SSF_START_APP (7)
114 mikedld 4350
======================================================================
193 diamond 4351
========== Function 70, subfunction 8 - delete file/folder. ==========
4352
======================================================================
4353
Parameters:
4354
  * eax = 70 - function number
4355
  * ebx = pointer to the information structure
4356
Format of the information structure:
4357
  * +0: dword: 8 = subfunction number
4358
  * +4: dword: 0 (reserved)
4359
  * +8: dword: 0 (reserved)
4360
  * +12 = +0xC: dword: 0 (reserved)
4361
  * +16 = +0x10: dword: 0 (reserved)
6473 pathoswith 4362
  * +20 = +0x14: path, general rules of names forming
193 diamond 4363
Returned value:
4364
  * eax = 0 - success, otherwise file system error code
4365
  * ebx destroyed
4366
Remarks:
4367
  * The function is not supported for CD (returns error code 2).
4368
  * The function can delete only empty folders (attempt to delete
4369
    nonempty folder results in error with code 10, "access denied").
4370
 
6057 IgorA 4371
---------------------- Constants for registers: ----------------------
4372
  eax - SF_FILE (70)
4373
 [ebx] - SSF_DELETE (8)
193 diamond 4374
======================================================================
321 diamond 4375
============= Function 70, subfunction 9 - create folder. ============
4376
======================================================================
4377
Parameters:
4378
  * eax = 70 - function number
4379
  * ebx = pointer to the information structure
4380
Format of the information structure:
4381
  * +0: dword: 9 = subfunction number
4382
  * +4: dword: 0 (reserved)
4383
  * +8: dword: 0 (reserved)
4384
  * +12 = +0xC: dword: 0 (reserved)
4385
  * +16 = +0x10: dword: 0 (reserved)
6473 pathoswith 4386
  * +20 = +0x14: path, general rules of names forming
321 diamond 4387
Returned value:
4388
  * eax = 0 - success, otherwise file system error code
4389
  * ebx destroyed
4390
Remarks:
4391
  * The function is not supported for CD (returns error code 2).
4392
  * The parent folder must already exist.
4393
  * If target folder already exists, function returns success (eax=0).
4394
 
6057 IgorA 4395
---------------------- Constants for registers: ----------------------
4396
  eax - SF_FILE (70)
4397
 [ebx] - SSF_CREATE_FOLDER (9)
321 diamond 4398
======================================================================
6917 pathoswith 4399
============= Function 70, subfunction 10 - rename/move. =============
4400
======================================================================
4401
Parameters:
4402
  * eax = 70 - function number
4403
  * ebx = pointer to the information structure
4404
Format of the information structure:
4405
  * +0: dword: 10 = subfunction number
4406
  * +4: dword: 0 (reserved)
4407
  * +8: dword: 0 (reserved)
4408
  * +12 = +0xC: dword: 0 (reserved)
4409
  * +16 = +0x10: dword: pointer to the new name/path string
4410
  * +20 = +0x14: path, general rules of names forming
4411
Returned value:
4412
  * eax = 0 - success, otherwise file system error code
4413
  * ebx destroyed
4414
Remarks:
4415
  * New path forming differs from general rules:
4416
    relative path relates to the target's parent folder,
4417
    absolute path relates to the partition's root folder.
4418
======================================================================
6802 pathoswith 4419
================== Function 71 - set window caption ==================
114 mikedld 4420
======================================================================
4421
Parameters:
4422
  * eax = 71 - function number
6802 pathoswith 4423
  * ebx = 1
4424
  * ecx = pointer to zero terminated string,
4425
    the string may start with an encoding byte:
4426
    1 = cp866
4427
    2 = UTF-16LE
4428
    3 = UTF-8
4429
  or:
4430
  * ebx = 2
5926 pathoswith 4431
  * ecx = pointer to zero terminated string
6802 pathoswith 4432
  * dl  = string encoding
114 mikedld 4433
Returned value:
118 diamond 4434
  * function does not return value
114 mikedld 4435
Remarks:
118 diamond 4436
  * Pass NULL in ecx to remove caption.
114 mikedld 4437
 
6057 IgorA 4438
---------------------- Constants for registers: ----------------------
4439
  eax - SF_SET_CAPTION (71)
114 mikedld 4440
======================================================================
665 diamond 4441
=============== Function 72 - send message to a window. ==============
4442
======================================================================
4443
 
4444
- Subfunction 1 - send message with parameter to the active window. --
4445
Parameters:
4446
  * eax = 72 - function number
4447
  * ebx = 1 - subfunction number
4448
  * ecx = event code: 2 or 3
4449
  * edx = parameter: key code for ecx=2, button identifier for ecx=3
4450
Returned value:
4451
  * eax = 0 - success
4452
  * eax = 1 - buffer is full
4453
 
6057 IgorA 4454
---------------------- Constants for registers: ----------------------
4455
  eax - SF_SEND_MESSAGE (72)
665 diamond 4456
======================================================================
3315 mario79 4457
===================== Function 73 - blit bitmap  =====================
4458
======================================================================
4459
 
4460
Parameters:
4461
  * eax = 73 - function number
4462
 
4463
  * ebx = ROP and optional flags
6790 0CodErr 4464
     31      30 29 28       6 5  4 3   0
4465
     [reserved][CR][reserved][T][B][ROP]
3315 mario79 4466
     ROP - raster operation code
4467
        0: Copy
4468
     1-15: reserved
4469
     B   - blit into the background surface
4470
     T   - transparent blit
6790 0CodErr 4471
     CR  - blit client relative
3315 mario79 4472
 
4473
  * ecx = pointer to the function parameters
4474
        destination offset and clipping
4475
     +0 signed dword: destination rectangle X offset from the window
4476
                      top-left corner
4477
     +4 signed dword: destination rectangle Y offset from the window
4478
                      top-left corner
4479
     +8 dword:        destination rectangle width
4480
    +12 dword:        destination rectangle height
4481
 
4482
        source offset and clipping
4483
    +16 signed dword: source rectangle X offset from the bitmap
4484
                      top-left corner
4485
    +20 signed dword: source rectangle Y offset from the bitmap
4486
                      top-left corner
4487
    +24 dword:        source rectangle width
4488
    +28 dword:        source rectangle height
4489
 
3338 mario79 4490
    +32: dword: bitmap data - must be 32bpp
4491
    +36: dword: size of the bitmap row in bytes
3315 mario79 4492
 
4493
Returned value:
4494
  * function does not return value
4495
 
6057 IgorA 4496
---------------------- Constants for registers: ----------------------
4497
  eax - SF_BLITTER (73)
3315 mario79 4498
======================================================================
5871 hidnplayr 4499
= Function 74, Subfunction 255, Get number of active network devices. =
3571 hidnplayr 4500
======================================================================
4501
Parameters:
4502
  * eax = 74 - function number
5871 hidnplayr 4503
  * bl = 255 - subfunction number
3571 hidnplayr 4504
Returned value:
4505
  * eax = number of active network devices
4506
 
6057 IgorA 4507
---------------------- Constants for registers: ----------------------
4508
  eax - SF_NETWORK_GET (74)
4509
   bl - SSF_DEVICE_COUNT (255)
3571 hidnplayr 4510
======================================================================
4511
======== Function 74, Subfunction 0, Get network device type. ========
4512
======================================================================
4513
Parameters:
4514
  * eax = 74 - function number
4515
  * bl = 0 - subfunction number
4516
  * bh = device number
4517
Returned value:
7915 dunkaist 4518
  * eax = device type number, -1 on error
3571 hidnplayr 4519
 
6057 IgorA 4520
---------------------- Constants for registers: ----------------------
4521
  eax - SF_NETWORK_GET (74)
4522
   bl - SSF_DEVICE_TYPE (0)
3571 hidnplayr 4523
======================================================================
4524
======== Function 74, Subfunction 1, Get network device name. ========
4525
======================================================================
4526
Parameters:
4527
  * eax = 74 - function number
4528
  * bl = 1 - subfunction number
4529
  * bh = device number
4530
  * ecx = pointer to 64 byte buffer
4531
Returned value:
4532
  * eax = -1 on error
4533
  * The network device name is written into the buffer, on success
4534
 
6057 IgorA 4535
---------------------- Constants for registers: ----------------------
4536
  eax - SF_NETWORK_GET (74)
4537
   bl - SSF_DEVICE_NAME (1)
3571 hidnplayr 4538
======================================================================
4539
========= Function 74, Subfunction 2, Reset network device. ==========
4540
======================================================================
4541
Parameters:
4542
  * eax = 74 - function number
4543
  * bl = 2 - subfunction number
4544
  * bh = device number
4545
Returned value:
4546
  * eax = -1 on error
4547
 
6057 IgorA 4548
---------------------- Constants for registers: ----------------------
4549
  eax - SF_NETWORK_GET (74)
4550
   bl - SSF_RESET_DEVICE (2)
3571 hidnplayr 4551
======================================================================
4552
========== Function 74, Subfunction 3, Stop network device. ==========
4553
======================================================================
4554
Parameters:
4555
  * eax = 74 - function number
4556
  * bl = 3 - subfunction number
4557
  * bh = device number
4558
Returned value:
4559
  * eax = -1 on error
5983 pathoswith 4560
 
6057 IgorA 4561
---------------------- Constants for registers: ----------------------
4562
  eax - SF_NETWORK_GET (74)
4563
   bl - SSF_STOP_DEVICE (3)
5871 hidnplayr 4564
======================================================================
4565
=========== Function 74, Subfunction 4, Get device pointer. ==========
4566
======================================================================
4567
Parameters:
4568
  * eax = 74 - function number
4569
  * bl = 4 - subfunction number
4570
  * bh = device number
4571
Returned value:
5983 pathoswith 4572
  * eax = device pointer, -1 on error
4573
 
6057 IgorA 4574
---------------------- Constants for registers: ----------------------
4575
  eax - SF_NETWORK_GET (74)
7722 dunkaist 4576
   bl - SSF_DEVICE_POINTER (4)
5871 hidnplayr 4577
======================================================================
4578
========= Function 74, Subfunction 6, Get packet TX counter. =========
4579
======================================================================
4580
Parameters:
4581
  * eax = 74 - function number
4582
  * bl = 6 - subfunction number
4583
  * bh = device number
4584
Returned value:
4585
  * eax = Number of packets sent since device start, -1 on error
5983 pathoswith 4586
 
6057 IgorA 4587
---------------------- Constants for registers: ----------------------
4588
  eax - SF_NETWORK_GET (74)
4589
   bl - SSF_TX_PACKET_COUNT (6)
5871 hidnplayr 4590
======================================================================
4591
========= Function 74, Subfunction 7, Get packet RX counter. =========
4592
======================================================================
4593
Parameters:
4594
  * eax = 74 - function number
4595
  * bl = 7 - subfunction number
4596
  * bh = device number
4597
Returned value:
4598
  * eax = Number of packets received since device start, -1 on error
5983 pathoswith 4599
 
6057 IgorA 4600
---------------------- Constants for registers: ----------------------
4601
  eax - SF_NETWORK_GET (74)
4602
   bl - SSF_RX_PACKET_COUNT (7)
5871 hidnplayr 4603
======================================================================
4604
========== Function 74, Subfunction 8, Get TX byte counter. ==========
4605
======================================================================
4606
Parameters:
4607
  * eax = 74 - function number
4608
  * bl = 8 - subfunction number
4609
  * bh = device number
4610
Returned value:
4611
  * eax = Number of bytes sent since device start (lower dword)
7915 dunkaist 4612
          -1 on error
5871 hidnplayr 4613
  * ebx = Number of bytes sent since device start (higher dword)
3571 hidnplayr 4614
 
6057 IgorA 4615
---------------------- Constants for registers: ----------------------
4616
  eax - SF_NETWORK_GET (74)
4617
   bl - SSF_TX_BYTE_COUNT (8)
3571 hidnplayr 4618
======================================================================
5871 hidnplayr 4619
========== Function 74, Subfunction 9, Get RX byte counter. ==========
4620
======================================================================
4621
Parameters:
4622
  * eax = 74 - function number
4623
  * bl = 9 - subfunction number
4624
  * bh = device number
4625
Returned value:
4626
  * eax = Number of bytes received since device start (lower dword)
7915 dunkaist 4627
          -1 on error
5871 hidnplayr 4628
  * ebx = Number of bytes received since device start (higher dword)
5983 pathoswith 4629
 
6057 IgorA 4630
---------------------- Constants for registers: ----------------------
4631
  eax - SF_NETWORK_GET (74)
4632
   bl - SSF_RX_BYTE_COUNT (9)
5871 hidnplayr 4633
======================================================================
4634
========== Function 74, Subfunction 10, Get link status. =============
4635
======================================================================
4636
Parameters:
4637
  * eax = 74 - function number
4638
  * bl = 10 - subfunction number
4639
  * bh = device number
4640
Returned value:
4641
  * eax = link status, -1 on error
5983 pathoswith 4642
 
5871 hidnplayr 4643
  Link status:
4644
    ETH_LINK_DOWN   =    0b         ; Link is down
4645
    ETH_LINK_UNKNOWN=    1b         ; There could be an active link
4646
    ETH_LINK_FD     =   10b         ; full duplex flag
4647
    ETH_LINK_10M    =  100b         ; 10 mbit
4648
    ETH_LINK_100M   = 1000b         ; 100 mbit
5983 pathoswith 4649
    ETH_LINK_1G     = 1100b         ; gigabit
4650
 
6057 IgorA 4651
---------------------- Constants for registers: ----------------------
4652
  eax - SF_NETWORK_GET (74)
4653
   bl - SSF_LINK_STATUS (10)
5871 hidnplayr 4654
======================================================================
9017 hidnplayr 4655
==== Function 74, Subfunction 11, Get TX error packets counter. ======
4656
======================================================================
4657
Parameters:
4658
  * eax = 74 - function number
4659
  * bl = 11 - subfunction number
4660
  * bh = device number
4661
Returned value:
4662
  * eax = Number of erroneous packets received since device start, -1 on error
4663
 
4664
---------------------- Constants for registers: ----------------------
4665
  eax - SF_NETWORK_GET (74)
4666
   bl - SSF_TX_PACKET_ERROR_COUNT (11)
4667
======================================================================
4668
=== Function 74, Subfunction 12, Get TX dropped packets counter. =====
4669
======================================================================
4670
Parameters:
4671
  * eax = 74 - function number
4672
  * bl = 12 - subfunction number
4673
  * bh = device number
4674
Returned value:
4675
  * eax = Number of dropped packets since device start, -1 on error
4676
 
4677
---------------------- Constants for registers: ----------------------
4678
  eax - SF_NETWORK_GET (74)
4679
   bl - SSF_TX_PACKET_DROP_COUNT (12)
4680
======================================================================
4681
==== Function 74, Subfunction 13, Get TX missed packets counter. =====
4682
======================================================================
4683
Parameters:
4684
  * eax = 74 - function number
4685
  * bl = 13 - subfunction number
4686
  * bh = device number
4687
Returned value:
4688
  * eax = Number of missed packets since device start, -1 on error
4689
 
4690
---------------------- Constants for registers: ----------------------
4691
  eax - SF_NETWORK_GET (74)
4692
   bl - SSF_TX_PACKET_MISS_COUNT (13)
4693
   ======================================================================
4694
==== Function 74, Subfunction 14, Get RX error packets counter. ======
4695
======================================================================
4696
Parameters:
4697
  * eax = 74 - function number
4698
  * bl = 14 - subfunction number
4699
  * bh = device number
4700
Returned value:
4701
  * eax = Number of erroneous packets received since device start, -1 on error
4702
 
4703
---------------------- Constants for registers: ----------------------
4704
  eax - SF_NETWORK_GET (74)
4705
   bl - SSF_RX_PACKET_ERROR_COUNT (14)
4706
======================================================================
4707
=== Function 74, Subfunction 15, Get RX dropped packets counter. =====
4708
======================================================================
4709
Parameters:
4710
  * eax = 74 - function number
4711
  * bl = 15 - subfunction number
4712
  * bh = device number
4713
Returned value:
4714
  * eax = Number of dropped packets since device start, -1 on error
4715
 
4716
---------------------- Constants for registers: ----------------------
4717
  eax - SF_NETWORK_GET (74)
4718
   bl - SSF_RX_PACKET_DROP_COUNT (12)
4719
======================================================================
4720
==== Function 74, Subfunction 16, Get RX missed packets counter. =====
4721
======================================================================
4722
Parameters:
4723
  * eax = 74 - function number
4724
  * bl = 16 - subfunction number
4725
  * bh = device number
4726
Returned value:
4727
  * eax = Number of missed packets since device start, -1 on error
4728
 
4729
---------------------- Constants for registers: ----------------------
4730
  eax - SF_NETWORK_GET (74)
4731
   bl - SSF_RX_PACKET_MISS_COUNT (16)
4732
======================================================================
3571 hidnplayr 4733
============== Function 75, Subfunction 0, Open socket. ==============
4734
======================================================================
4735
Parameters:
4736
  * eax = 75 - function number
4737
  * bl = 0 - subfunction number
4738
  * ecx = domain
4739
  * edx = type
4740
  * esi = protocol
4741
Returned value:
4742
  * eax = socket number, -1 on error
3867 hidnplayr 4743
  * ebx = errorcode
3571 hidnplayr 4744
 
6057 IgorA 4745
---------------------- Constants for registers: ----------------------
4746
  eax - SF_NETWORK_SOCKET (75)
4747
   bl - SSF_OPEN (0)
3571 hidnplayr 4748
======================================================================
4749
============= Function 75, Subfunction 1, Close socket. ==============
4750
======================================================================
4751
Parameters:
4752
  * eax = 75 - function number
4753
  * bl = 1 - subfunction number
4754
  * ecx = socket number
4755
Returned value:
4756
  * eax = -1 on error
3867 hidnplayr 4757
  * ebx = errorcode
3571 hidnplayr 4758
 
6057 IgorA 4759
---------------------- Constants for registers: ----------------------
4760
  eax - SF_NETWORK_SOCKET (75)
4761
   bl - SSF_CLOSE (1)
3571 hidnplayr 4762
======================================================================
4763
================== Function 75, Subfunction 2, Bind. =================
4764
======================================================================
4765
Parameters:
4766
  * eax = 75 - function number
4767
  * bl = 2 - subfunction number
4768
  * ecx = socket number
4769
  * edx = pointer to sockaddr structure
4770
  * esi = length of sockaddr structure
6712 0CodErr 4771
Format of SockAddr structure:
4772
  * +0: Word: Family
4773
  * +2: 14*Byte: Data
3571 hidnplayr 4774
Returned value:
4775
  * eax = -1 on error
3867 hidnplayr 4776
  * ebx = errorcode
3571 hidnplayr 4777
 
6057 IgorA 4778
---------------------- Constants for registers: ----------------------
4779
  eax - SF_NETWORK_SOCKET (75)
4780
   bl - SSF_BIND (2)
3571 hidnplayr 4781
======================================================================
4782
================= Function 75, Subfunction 3, Listen. ================
4783
======================================================================
4784
Parameters:
4785
  * eax = 75 - function number
4786
  * bl = 3 - subfunction number
4787
  * ecx = socket number
4788
  * edx = backlog
4789
Returned value:
4790
  * eax = -1 on error
3867 hidnplayr 4791
  * ebx = errorcode
3571 hidnplayr 4792
 
6057 IgorA 4793
---------------------- Constants for registers: ----------------------
4794
  eax - SF_NETWORK_SOCKET (75)
4795
   bl - SSF_LISTEN (3)
3571 hidnplayr 4796
======================================================================
4797
================ Function 75, Subfunction 4, Connect. ================
4798
======================================================================
4799
Parameters:
4800
  * eax = 75 - function number
4801
  * bl = 4 - subfunction number
4802
  * ecx = socket number
4803
  * edx = pointer to sockaddr structure
4804
  * esi = length of sockaddr structure
6712 0CodErr 4805
Format of SockAddr structure:
4806
  * +0: Word: Family
6758 pathoswith 4807
  * +2: 14*Byte: Data
3571 hidnplayr 4808
Returned value:
4809
  * eax = -1 on error
3867 hidnplayr 4810
  * ebx = errorcode
3571 hidnplayr 4811
 
6057 IgorA 4812
---------------------- Constants for registers: ----------------------
4813
  eax - SF_NETWORK_SOCKET (75)
4814
   bl - SSF_CONNECT (4)
3571 hidnplayr 4815
======================================================================
4816
================= Function 75, Subfunction 5, Accept. ================
4817
======================================================================
4818
Parameters:
4819
  * eax = 75 - function number
4820
  * bl = 5 - subfunction number
4821
  * ecx = socket number
4822
  * edx = pointer to sockaddr structure
4823
  * esi = length of sockaddr structure
6712 0CodErr 4824
Format of SockAddr structure:
4825
  * +0: Word: Family
6758 pathoswith 4826
  * +2: 14*Byte: Data
3571 hidnplayr 4827
Returned value:
3867 hidnplayr 4828
  * eax = socket number of accepted socket, -1 on error
4829
  * ebx = errorcode
3571 hidnplayr 4830
 
6057 IgorA 4831
---------------------- Constants for registers: ----------------------
4832
  eax - SF_NETWORK_SOCKET (75)
4833
   bl - SSF_ACCEPT (5)
3571 hidnplayr 4834
======================================================================
4835
================== Function 75, Subfunction 6, Send. =================
4836
======================================================================
4837
Parameters:
4838
  * eax = 75 - function number
4839
  * bl = 6 - subfunction number
4840
  * ecx = socket number
4841
  * edx = pointer to buffer
4842
  * esi = length of buffer
3867 hidnplayr 4843
  * edi = flags
3571 hidnplayr 4844
Returned value:
4845
  * eax = number of bytes copied, -1 on error
3867 hidnplayr 4846
  * ebx = errorcode
3571 hidnplayr 4847
 
6057 IgorA 4848
---------------------- Constants for registers: ----------------------
4849
  eax - SF_NETWORK_SOCKET (75)
4850
   bl - SSF_SEND (6)
3571 hidnplayr 4851
======================================================================
4852
================ Function 75, Subfunction 7, Receive. ================
4853
======================================================================
4854
Parameters:
4855
  * eax = 75 - function number
4856
  * bl = 7 - subfunction number
4857
  * ecx = socket number
4858
  * edx = pointer to buffer
4859
  * esi = length of buffer
4860
  * edi = flags
4861
Returned value:
4862
  * eax = number of bytes copied, -1 on error
3867 hidnplayr 4863
  * ebx = errorcode
3571 hidnplayr 4864
 
6057 IgorA 4865
---------------------- Constants for registers: ----------------------
4866
  eax - SF_NETWORK_SOCKET (75)
4867
   bl - SSF_RECEIVE (7)
3571 hidnplayr 4868
======================================================================
4869
=========== Function 75, Subfunction 8, Set socket options. ==========
4870
======================================================================
4871
Parameters:
4872
  * eax = 75 - function number
4873
  * bl = 8 - subfunction number
4874
  * ecx = socket number
4875
  * edx = pointer to optstruct
4876
Returned value:
4877
  * eax = -1 on error
3867 hidnplayr 4878
  * ebx = errorcode
3571 hidnplayr 4879
Remarks:
4880
 
6079 serge 4881
  Optstruct:
5871 hidnplayr 4882
    dd level
4883
    dd optionname
4884
    dd optlength
4885
    db options...
3571 hidnplayr 4886
 
6057 IgorA 4887
---------------------- Constants for registers: ----------------------
4888
  eax - SF_NETWORK_SOCKET (75)
4889
   bl - SSF_SET_OPTIONS (8)
3571 hidnplayr 4890
======================================================================
4891
=========== Function 75, Subfunction 9, Get socket options. ==========
4892
======================================================================
4893
Parameters:
4894
  * eax = 75 - function number
4895
  * bl = 9 - subfunction number
4896
  * ecx = socket number
4897
  * edx = pointer to optstruct
4898
Returned value:
4899
  * eax = -1 on error
3867 hidnplayr 4900
  * ebx = errorcode
3571 hidnplayr 4901
Remarks:
4902
 
6079 serge 4903
  Optstruct:
5871 hidnplayr 4904
    dd level
4905
    dd optionname
4906
    dd optlength
4907
    db options...
3571 hidnplayr 4908
 
6057 IgorA 4909
---------------------- Constants for registers: ----------------------
4910
  eax - SF_NETWORK_SOCKET (75)
4911
   bl - SSF_GET_OPTIONS (9)
3571 hidnplayr 4912
======================================================================
6235 pathoswith 4913
============ Function 75, Subfunction 10, Get socketpair. ============
3571 hidnplayr 4914
======================================================================
4915
Parameters:
4916
  * eax = 75 - function number
4917
  * bl = 10 - subfunction number
4918
Returned value:
4919
  * eax = socketnum1, -1 on error
3867 hidnplayr 4920
  * ebx = socketnum2, errorcode on error
6057 IgorA 4921
 
4922
---------------------- Constants for registers: ----------------------
4923
  eax - SF_NETWORK_SOCKET (75)
4924
   bl - SSF_GET_PAIR (10)
5871 hidnplayr 4925
======================================================================
4926
============ Function 76, Network options and statistics. ============
4927
======================================================================
4928
Parameters:
4929
  * eax = 76 - function number
4930
  * high half of ebx = protocol number
4931
  * bh = device number
4932
  * bl = subfunction number
3571 hidnplayr 4933
 
6634 hidnplayr 4934
======================================================================
4935
==== Function 76, Protocol 0 - Ethernet, Subfunction 0, Read MAC. ====
4936
======================================================================
4937
Parameters:
4938
  * eax = 76 - function number
4939
  * high half of ebx = 0 (Ethernet)
4940
  * bh = device number
4941
  * bl = 0 (Read MAC)
4942
Returned value:
4943
  * eax = -1 on error, otherwise lower bits of MAC
4944
  * bx = upper bits of MAC
6758 pathoswith 4945
 
6634 hidnplayr 4946
======================================================================
4947
= Function 76, Protocol 1 - IPv4, Subfunction 0, Read # Packets sent =
4948
======================================================================
4949
Parameters:
4950
  * eax = 76 - function number
4951
  * high half of ebx = 1 (IPv4)
4952
  * bh = device number
4953
  * bl = 0 (Read # packets sent)
4954
Returned value:
4955
  * eax = number of packets sent (-1 on error)
6758 pathoswith 4956
 
6634 hidnplayr 4957
======================================================================
4958
= Function 76, Protocol 1 - IPv4, Subfunction 1, Read # Packets rcvd =
4959
======================================================================
4960
Parameters:
4961
  * eax = 76 - function number
4962
  * high half of ebx = 1 (IPv4)
4963
  * bh = device number
4964
  * bl = 1 (Read # packets received)
4965
Returned value:
4966
  * eax = number of packets received (-1 on error)
6758 pathoswith 4967
 
6634 hidnplayr 4968
======================================================================
4969
=== Function 76, Protocol 1 - IPv4, Subfunction 2, Read IP address ===
4970
======================================================================
4971
Parameters:
4972
  * eax = 76 - function number
4973
  * high half of ebx = 1 (IPv4)
4974
  * bh = device number
4975
  * bl = 2 (Read IP address)
4976
Returned value:
4977
  * eax = IP address (-1 on error)
6758 pathoswith 4978
 
6634 hidnplayr 4979
======================================================================
4980
=== Function 76, Protocol 1 - IPv4, Subfunction 3, Set IP address ====
4981
======================================================================
4982
Parameters:
4983
  * eax = 76 - function number
4984
  * high half of ebx = 1 (IPv4)
4985
  * bh = device number
4986
  * bl = 3 (Set IP address)
4987
  * ecx = IP address
4988
Returned value:
4989
  * eax = -1 on error
6235 pathoswith 4990
 
6634 hidnplayr 4991
======================================================================
4992
== Function 76, Protocol 1 - IPv4, Subfunction 4, Read DNS address ===
4993
======================================================================
4994
Parameters:
4995
  * eax = 76 - function number
4996
  * high half of ebx = 1 (IPv4)
4997
  * bh = device number
4998
  * bl = 4 (Read DNS server IP address)
4999
Returned value:
5000
  * eax = DNS server IP address (-1 on error)
6758 pathoswith 5001
 
6634 hidnplayr 5002
======================================================================
5003
=== Function 76, Protocol 1 - IPv4, Subfunction 5, Set DNS address ===
5004
======================================================================
5005
Parameters:
5006
  * eax = 76 - function number
5007
  * high half of ebx = 1 (IPv4)
5008
  * bh = device number
5009
  * bl = 5 (Set DNS address)
5010
  * ecx = DNS server IP address
5011
Returned value:
5012
  * eax = -1 on error
6079 serge 5013
 
6634 hidnplayr 5014
======================================================================
5015
== Function 76, Protocol 1 - IPv4, Subfunction 6, Read subnet mask ===
5016
======================================================================
5017
Parameters:
5018
  * eax = 76 - function number
5019
  * high half of ebx = 1 (IPv4)
5020
  * bh = device number
5021
  * bl = 6 (Read subnet mask)
5022
Returned value:
5023
  * eax = subnet mask (-1 on error)
6758 pathoswith 5024
 
6634 hidnplayr 5025
======================================================================
5026
=== Function 76, Protocol 1 - IPv4, Subfunction 7, Set subnet mask ===
5027
======================================================================
5028
Parameters:
5029
  * eax = 76 - function number
5030
  * high half of ebx = 1 (IPv4)
5031
  * bh = device number
7915 dunkaist 5032
  * bl = 7 (Set subnet mask)
6634 hidnplayr 5033
  * ecx = subnet mask
5034
Returned value:
5035
  * eax = -1 on error
6758 pathoswith 5036
 
6634 hidnplayr 5037
======================================================================
5038
===== Function 76, Protocol 1 - IPv4, Subfunction 8, Read gateway ====
5039
======================================================================
5040
Parameters:
5041
  * eax = 76 - function number
5042
  * high half of ebx = 1 (IPv4)
5043
  * bh = device number
5044
  * bl = 8 (Read gateway IP address)
5045
Returned value:
5046
  * eax = gateway IP address (-1 on error)
6758 pathoswith 5047
 
6634 hidnplayr 5048
======================================================================
5049
===== Function 76, Protocol 1 - IPv4, Subfunction 9, Set gateway =====
5050
======================================================================
5051
Parameters:
5052
  * eax = 76 - function number
5053
  * high half of ebx = 1 (IPv4)
5054
  * bh = device number
5055
  * bl = 9 (Set getway address)
5056
  * ecx = gateway IP address
5057
Returned value:
5058
  * eax = -1 on error
6758 pathoswith 5059
 
6634 hidnplayr 5060
======================================================================
5061
= Function 76, Protocol 2 - ICMP, Subfunction 0, Read # Packets sent =
5062
======================================================================
5063
Parameters:
5064
  * eax = 76 - function number
5065
  * high half of ebx = 2 (ICMP)
5066
  * bh = device number
5067
  * bl = 0 (Read # packets sent)
5068
Returned value:
5069
  * eax = number of packets sent (-1 on error)
6758 pathoswith 5070
 
6634 hidnplayr 5071
======================================================================
5072
= Function 76, Protocol 2 - ICMP, Subfunction 1, Read # Packets rcvd =
5073
======================================================================
5074
Parameters:
5075
  * eax = 76 - function number
5076
  * high half of ebx = 2 (ICMP)
5077
  * bh = device number
5078
  * bl = 1 (Read # packets received)
5079
Returned value:
5080
  * eax = number of packets received (-1 on error)
6758 pathoswith 5081
 
6634 hidnplayr 5082
======================================================================
5083
= Function 76, Protocol 3 - UDP, Subfunction 0, Read # Packets sent ==
5084
======================================================================
5085
Parameters:
5086
  * eax = 76 - function number
5087
  * high half of ebx = 3 (UDP)
5088
  * bh = device number
5089
  * bl = 0 (Read # packets sent)
5090
Returned value:
5091
  * eax = number of packets sent (-1 on error)
6758 pathoswith 5092
 
6634 hidnplayr 5093
======================================================================
5094
= Function 76, Protocol 3 - UDP, Subfunction 1, Read # Packets rcvd ==
5095
======================================================================
5096
Parameters:
5097
  * eax = 76 - function number
5098
  * high half of ebx = 3 (UDP)
5099
  * bh = device number
5100
  * bl = 1 (Read # packets received)
5101
Returned value:
5102
  * eax = number of packets received (-1 on error)
6758 pathoswith 5103
 
6634 hidnplayr 5104
======================================================================
5105
= Function 76, Protocol 4 - TCP, Subfunction 0, Read # Packets sent ==
5106
======================================================================
5107
Parameters:
5108
  * eax = 76 - function number
5109
  * high half of ebx = 4 (TCP)
5110
  * bh = device number
5111
  * bl = 0 (Read # packets sent)
5112
Returned value:
5113
  * eax = number of packets sent (-1 on error)
6758 pathoswith 5114
 
6634 hidnplayr 5115
======================================================================
5116
= Function 76, Protocol 4 - TCP, Subfunction 1, Read # Packets rcvd ==
5117
======================================================================
5118
Parameters:
5119
  * eax = 76 - function number
5120
  * high half of ebx = 4 (TCP)
5121
  * bh = device number
5122
  * bl = 1 (Read # packets received)
5123
Returned value:
5124
  * eax = number of packets received (-1 on error)
6758 pathoswith 5125
 
6634 hidnplayr 5126
======================================================================
5127
= Function 76, Protocol 5 - ARP, Subfunction 0, Read # Packets sent ==
5128
======================================================================
5129
Parameters:
5130
  * eax = 76 - function number
5131
  * high half of ebx = 5 (ARP)
5132
  * bh = device number
5133
  * bl = 0 (Read # packets sent)
5134
Returned value:
5135
  * eax = number of packets sent (-1 on error)
6758 pathoswith 5136
 
6634 hidnplayr 5137
======================================================================
5138
= Function 76, Protocol 5 - ARP, Subfunction 1, Read # Packets rcvd ==
5139
======================================================================
5140
Parameters:
5141
  * eax = 76 - function number
5142
  * high half of ebx = 5 (ARP)
5143
  * bh = device number
5144
  * bl = 1 (Read # packets received)
5145
Returned value:
5146
  * eax = number of packets received (-1 on error)
6758 pathoswith 5147
 
6634 hidnplayr 5148
======================================================================
5149
== Function 76, Protocol 5 - ARP, Subfunction 2, Read # ARP entries ==
5150
======================================================================
5151
Parameters:
5152
  * eax = 76 - function number
5153
  * high half of ebx = 5 (ARP)
5154
  * bh = device number
5155
  * bl = 2 (Read # current entries in the ARP table)
5156
Returned value:
5157
  * eax = number of entries (-1 on error)
6079 serge 5158
 
6634 hidnplayr 5159
======================================================================
5160
==== Function 76, Protocol 5 - ARP, Subfunction 3, Read ARP entry ====
5161
======================================================================
5162
Parameters:
5163
  * eax = 76 - function number
5164
  * high half of ebx = 5 (ARP)
5165
  * bh = device number
5166
  * bl = 3 (Read ARP entry)
5167
  * ecx = ARP entry number (0 based)
5168
  * edi = ptr to buffer where ARP entry will be written
5169
Returned value:
5170
  * eax = -1 on error
6758 pathoswith 5171
Remarks:
7915 dunkaist 5172
  * ARP_entry struct is defined in ARP.inc in kernel and currently
5173
    looks like this:
6634 hidnplayr 5174
struct  ARP_entry
5175
        IP              dd ?
5176
        MAC             dp ?
5177
        Status          dw ?
5178
        TTL             dw ?
6758 pathoswith 5179
ends
5871 hidnplayr 5180
 
6634 hidnplayr 5181
======================================================================
7915 dunkaist 5182
===== Function 76, Protocol 5 - ARP, Subfunction 4, Add ARP entry ====
6634 hidnplayr 5183
======================================================================
5184
Parameters:
5185
  * eax = 76 - function number
5186
  * high half of ebx = 5 (ARP)
5187
  * bh = device number
5188
  * bl = 4 (Add ARP entry)
5189
  * esi = ptr to buffer holding ARP entry
5190
Returned value:
5191
  * eax = -1 on error
6758 pathoswith 5192
Remarks:
7915 dunkaist 5193
  * See previous function for details on ARP entry.
6758 pathoswith 5194
 
6634 hidnplayr 5195
======================================================================
7915 dunkaist 5196
=== Function 76, Protocol 5 - ARP, Subfunction 5, Remove ARP entry ===
6634 hidnplayr 5197
======================================================================
5198
Parameters:
5199
  * eax = 76 - function number
5200
  * high half of ebx = 5 (ARP)
5201
  * bh = device number
7915 dunkaist 5202
  * bl = 5 (Remove ARP entry)
6634 hidnplayr 5203
  * ecx = ARP entry number (0 based), use -1 to clear whole ARP table.
5204
Returned value:
5205
  * eax = -1 on error
5206
 
5207
======================================================================
5208
=== Function 76, Protocol 5 - ARP, Subfunction 6, Send ARP announce ==
5209
======================================================================
5210
Parameters:
5211
  * eax = 76 - function number
5212
  * high half of ebx = 5 (ARP)
5213
  * bh = device number
5214
  * bl = 6 (Send ARP announce)
5215
Returned value:
5216
  * eax = -1 on error
6758 pathoswith 5217
 
6634 hidnplayr 5218
======================================================================
5219
=== Function 76, Protocol 5 - ARP, Subfunction 7, Read # conflicts ===
5220
======================================================================
5221
Parameters:
5222
  * eax = 76 - function number
5223
  * high half of ebx = 5 (ARP)
5224
  * bh = device number
5225
  * bl = 7 (Read # IP address conflicts that have occured)
5226
Returned value:
5227
  * eax = # IP address conflicts (-1 on error)
5871 hidnplayr 5228
 
6057 IgorA 5229
---------------------- Constants for registers: ----------------------
5230
  eax - SF_NETWORK_PROTOCOL (76)
3571 hidnplayr 5231
======================================================================
6079 serge 5232
========== Function 77, Subfunction 0, Create futex object ===========
5233
======================================================================
5234
Parameters:
5235
  * eax = 77 - function number
5236
  * ebx = 0 - subfunction number
5237
  * ecx = pointer to futex dword
5238
Returned value:
5239
  * eax = futex handle, 0 on error
5240
Remarks:
5241
  * Use subfunction 1 to destroy the futex.
5242
    The kernel destroys the futexes automatically when the process
5243
    terminates.
6235 pathoswith 5244
 
5245
---------------------- Constants for registers: ----------------------
5246
  eax - SF_FUTEX (77)
5247
  ebx - SSF_CREATE (0)
6079 serge 5248
======================================================================
5249
========= Function 77, Subfunction 1, Destroy futex object ===========
5250
======================================================================
5251
Parameters:
5252
  * eax = 77 - function number
5253
  * ebx = 1 - subfunction number
5254
  * ecx = futex handle
5255
Returned value:
5256
  * eax = 0 - successfull, -1 on error
5257
Remarks:
5258
  * The futex handle must have been created by subfunction 0
5259
 
6235 pathoswith 5260
---------------------- Constants for registers: ----------------------
5261
  eax - SF_FUTEX (77)
5262
  ebx - SSF_DESTROY (1)
6079 serge 5263
======================================================================
5264
=============== Function 77, Subfunction 2, Futex wait ===============
5265
======================================================================
5266
Parameters:
5267
  * eax = 77 - function number
5268
  * ebx = 2 - subfunction number
5269
  * ecx = futex handle
5270
  * edx = control value
5271
  * esi = timeout in system ticks or 0 for infinity
5272
Returned value:
6089 serge 5273
  * eax = 0 - successfull
5274
	 -1 - timeout
5275
	 -2 - futex dword does not have the same value as edx
6079 serge 5276
Remarks:
5277
  * This functionn tests that the value at the futex dword still
5278
    contains the expected control value, and if so, then sleeps
5279
    waiting for a wake operation on the futex.
5280
  * The futex handle must have been created by subfunction 0
5281
 
6235 pathoswith 5282
---------------------- Constants for registers: ----------------------
5283
  eax - SF_FUTEX (77)
5284
  ebx - SSF_WAIT (2)
6079 serge 5285
======================================================================
5286
=============== Function 77, Subfunction 3, Futex wake ===============
5287
======================================================================
5288
Parameters:
5289
  * eax = 77 - function number
5290
  * ebx = 3 - subfunction number
5291
  * ecx = futex handle
5292
  * edx = number of waiters to wake
5293
Returned value:
5294
  * eax = number of waiters that were woken up
5295
 
5296
Remarks:
5297
  * This function wakes at most edx of the waiters that are
5298
    waiting (e.g., inside futex wait) on the futex dword
5299
  * The futex handle must have been created by subfunction 0
5300
 
6235 pathoswith 5301
---------------------- Constants for registers: ----------------------
5302
  eax - SF_FUTEX (77)
5303
  ebx - SSF_WAKE (3)
6079 serge 5304
======================================================================
6798 pathoswith 5305
=== Function 80 - file system interface with parameter of encoding ===
5306
======================================================================
5307
Parameters:
5308
  * eax = 80
5309
  * ebx = pointer to the information structure
5310
Returned value:
5311
  * eax = 0 - success; otherwise file system error code
5312
  * some subfunctions return value in other registers too
5313
General format of the information structure:
5314
  * +0: dword: subfunction number
5315
  * +4: dword: offset in file or folder
5316
  * +8: dword: higher part of offset or flags
5317
  * +12 = +0xC: dword: size of data
5318
  * +16 = +0x10: dword: pointer to data
5319
  * +20 = +0x14: dword: string encoding:
5320
    1 = cp866
5321
    2 = UTF-16LE
5322
    3 = UTF-8
5323
 
5324
  * +24 = +0x18: dword: pointer to zero terminated string with path
5325
 
5326
The rest is similar to sysfunction 70.
5327
 
5328
======================================================================
118 diamond 5329
=============== Function -1 - terminate thread/process ===============
114 mikedld 5330
======================================================================
5331
Parameters:
118 diamond 5332
  * eax = -1 - function number
114 mikedld 5333
Returned value:
118 diamond 5334
  * function does not return neither value nor control
114 mikedld 5335
Remarks:
118 diamond 5336
  * If the process did not create threads obviously, it has only
5337
    one thread, which termination results in process termination.
5338
  * If the current thread is last in the process, its termination
5339
    also results in process terminates.
5340
  * This function terminates the current thread. Other thread can be
5341
    killed by call to subfunction 2 of function 18.
114 mikedld 5342
 
6235 pathoswith 5343
---------------------- Constants for registers: ----------------------
5344
  eax - SF_TERMINATE_PROCESS (-1)
114 mikedld 5345
======================================================================
5346
=========================== List of events ===========================
5347
======================================================================
118 diamond 5348
Next event can be retrieved by the call of one from functions 10
5349
(to wait for event), 11 (to check without waiting), 23
5350
(to wait during the given time).
5351
These functions return only those events, which enter into a mask set
5352
by function 40. By default it is first three,
5353
there is enough for most applications.
114 mikedld 5354
Codes of events:
118 diamond 5355
  * 1 = redraw event (is reset by call to function 0)
5356
  * 2 = key on keyboard is pressed (acts, only when the window is
5357
    active) or hotkey is pressed; is reset, when all keys from
5358
    the buffer are read out by function 2
5359
  * 3 = button is pressed, defined earlier by function 8
5360
    (or close button, created implicitly by function 0;
5361
    minimize button is handled by the system and sends no message;
5362
    acts, only when the window is active;
5363
    is reset when all buttons from the buffer
5364
    are read out by function 17)
5365
  * 4 = reserved (in current implementation never comes even after
5366
    unmasking by function 40)
2513 mario79 5367
  * 5 = kernel finished redrawing of the desktop background
118 diamond 5368
  * 6 = mouse event (something happened - button pressing or moving;
5369
    is reset at reading)
5370
  * 7 = IPC event (see function 60 -
5371
    Inter Process Communication; is reset at reading)
5372
  * 8 = network event (is reset at reading)
5373
  * 9 = debug event (is reset at reading; see
5374
    debug subsystem)
5375
  * 16..31 = event with appropriate IRQ
5376
    (16=IRQ0, 31=IRQ15) (is reset after reading all IRQ data)
114 mikedld 5377
 
5378
======================================================================
118 diamond 5379
=================== Error codes of the file system ===================
114 mikedld 5380
======================================================================
118 diamond 5381
  * 0 = success
5382
  * 2 = function is not supported for the given file system
5383
  * 3 = unknown file system
5384
  * 5 = file not found
5385
  * 6 = end of file, EOF
5386
  * 7 = pointer lies outside of application memory
5387
  * 8 = disk is full
6235 pathoswith 5388
  * 9 = file system error
114 mikedld 5389
  * 10 = access denied
118 diamond 5390
  * 11 = device error
6235 pathoswith 5391
  * 12 = file system requires more memory
5392
 
118 diamond 5393
Application start functions can return also following errors:
5394
  * 30 = 0x1E = not enough memory
5395
  * 31 = 0x1F = file is not executable
5396
  * 32 = 0x20 = too many processes