Subversion Repositories Kolibri OS

Rev

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