Subversion Repositories Kolibri OS

Rev

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

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