Subversion Repositories Kolibri OS

Rev

Rev 6235 | Rev 6402 | 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
6171 leency 31
      * Y=0,2 window types are outdated and should not be used anymore,
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)
759
  ebx - SSF_GET_CPU_REQUENCY (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
 
1681
--------- Subfunction 1 - set current folder for the thread. ---------
1682
Parameters:
1683
  * eax = 30 - function number
1684
  * ebx = 1 - subfunction number
1685
  * ecx = pointer to ASCIIZ-string with the path to new current folder
1686
Returned value:
1687
  * function does not return value
1688
 
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:
1696
  * eax = size of the current folder's name (including terminating 0)
1697
Remarks:
1698
  * If the buffer is too small to hold all data, only first (edx-1)
1699
    bytes are copied and than terminating 0 is inserted.
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.
521 diamond 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:
1709
          sysdir_name     rb 64
1710
          sysdir_path     rb 64
3780 Serge 1711
For example:
1712
dir_name1       db 'KolibriOS',0
3912 mario79 1713
                rb 64-10
3663 mario79 1714
dir_path1       db 'HD0/1',0
1715
                rb 64-6
1716
Returned value:
1717
  * function does not return value
1718
Remarks:
1719
  * The function can be called only 1 time for 1 session of the OS.
1720
 
6057 IgorA 1721
---------------------- Constants for registers: ----------------------
1722
  eax - SF_CURRENT_FOLDER (30)
1723
  ebx - SSF_SET_CF (1), SSF_GET_CF (2), SSF_ADD_SYS_FOLDER (3)
521 diamond 1724
======================================================================
2511 mario79 1725
========= Function 34 - who owner the pixel on the screen. ===========
1726
======================================================================
1727
Parameters:
1728
  * eax = 34 - function number
1729
  * ebx = x-coordinate (relative to the display)
1730
  * ecx = y-coordinate (relative to the display)
1731
 
1732
Returned value:
1733
  * eax = 0x000000XX - owner of pixel the slot window N
1734
    If incorrect values ebx and ecx then function returns 0
1735
  * The function takes the value from the area [_WinMapAddress]
3780 Serge 1736
 
6057 IgorA 1737
---------------------- Constants for registers: ----------------------
1738
  eax - SF_GET_PIXEL_OWNER (34)
2511 mario79 1739
======================================================================
118 diamond 1740
======= Function 35 - read the color of a pixel on the screen. =======
114 mikedld 1741
======================================================================
1742
Parameters:
1743
  * eax = 35
1744
  * ebx = y*xsize+x, where
118 diamond 1745
  * (x,y) = coordinates of a pixel (beginning from 0)
1746
  * xsize = horizontal screen size
114 mikedld 1747
Returned value:
118 diamond 1748
  * eax = color 0x00RRGGBB
114 mikedld 1749
Remarks:
118 diamond 1750
  * To get screen sizes use function 14. Pay attention,
1751
    that it subtracts 1 from both sizes.
1752
  * There is also direct access (without any system calls)
1753
    to videomemory through the selector gs. To get parameters of
1754
    the current videomode, use function 61.
114 mikedld 1755
 
6057 IgorA 1756
---------------------- Constants for registers: ----------------------
1757
  eax - SF_GET_PIXEL (35)
114 mikedld 1758
======================================================================
1018 diamond 1759
=================== Function 36 - read screen area. ==================
921 mario79 1760
======================================================================
1761
Paramters:
1762
  * eax = 36 - function number
1018 diamond 1763
  * ebx = pointer to the previously allocated memory area,
1764
        where will be placed the image in the format BBGGRRBBGGRR...
921 mario79 1765
  * ecx = [size on axis x]*65536 + [size on axis y]
1766
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
1767
Returned value:
1768
  * function does not return value
1769
Remarks:
1770
  * Coordinates of the image are coordinates of the upper left corner
923 mario79 1771
    of the image relative to the screen.
921 mario79 1772
  * Size of the image in bytes is 3*xsize*ysize.
1773
 
6057 IgorA 1774
---------------------- Constants for registers: ----------------------
1775
  eax - SF_GET_IMAGE (36)
921 mario79 1776
======================================================================
277 diamond 1777
=================== Function 37 - work with mouse. ===================
114 mikedld 1778
======================================================================
1779
 
118 diamond 1780
---------- Subfunction 0 - screen coordinates of the mouse -----------
114 mikedld 1781
Parameters:
118 diamond 1782
  * eax = 37 - function number
1783
  * ebx = 0 - subfunction number
114 mikedld 1784
Returned value:
118 diamond 1785
  * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer
1786
    (beginning from 0)
114 mikedld 1787
 
118 diamond 1788
-- Subfunction 1 - coordinates of the mouse relative to the window ---
114 mikedld 1789
Parameters:
118 diamond 1790
  * eax = 37 - function number
1791
  * ebx = 1 - subfunction number
114 mikedld 1792
Returned value:
118 diamond 1793
  * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer
1794
    relative to the application window (beginning from 0)
114 mikedld 1795
Remarks:
118 diamond 1796
  * The value is calculated by formula (x-xwnd)*65536 + (y-ywnd).
1797
    If y>=ywnd, the low word is non-negative and contains
1798
    relative y-coordinate, and the high word - relative x-coordinate
1799
    (with correct sign). Otherwise the low word is negative and still
1800
    contains relative y-coordinate, and to the high word
1801
    1 should be added.
114 mikedld 1802
 
5851 pathoswith 1803
------------- Subfunction 2 - states of the mouse buttons ------------
114 mikedld 1804
Parameters:
118 diamond 1805
  * eax = 37 - function number
1806
  * ebx = 2 - subfunction number
114 mikedld 1807
Returned value:
5851 pathoswith 1808
  * eax = bits 0-4 equal to subfunction 3
114 mikedld 1809
 
5851 pathoswith 1810
------- Subfunction 3 - states and events of the mouse buttons -------
1811
Parameters:
1812
  * eax = 37 - function number
1813
  * ebx = 3 - subfunction number
1814
Returned value:
1815
  * eax contains next information:
1816
 
1817
states:
1818
  * bit 0 is set = left button is held
1819
  * bit 1 is set = right button is held
1820
  * bit 2 is set = middle button is held
1821
  * bit 3 is set = 4th button is held
1822
  * bit 4 is set = 5th button is held
1823
 
1824
events:
1825
  * bit 8 is set = left button is pressed
1826
  * bit 9 is set = right button is pressed
1827
  * bit 10 is set = middle button is pressed
1828
 
1829
  * bit 15 is set = vertical scroll is used
1830
 
1831
  * bit 16 is set = left button is released
1832
  * bit 17 is set = right button is released
1833
  * bit 18 is set = middle button is released
1834
 
1835
  * bit 23 is set = horisontal scroll is used
1836
 
1837
  * bit 24 is set = doubleclick by left button
1838
 
277 diamond 1839
-------------------- Subfunction 4 - load cursor ---------------------
1840
Parameters:
1841
  * eax = 37 - function number
1842
  * ebx = 4 - subfunction number
1843
  * dx = data source:
1844
  * dx = LOAD_FROM_FILE = 0 - data in a file
1845
    * ecx = pointer to full path to the cursor file
1846
    * the file must be in the format .cur, which is standard for
1847
      MS Windows, at that of the size 32*32 pixels
1848
  * dx = LOAD_FROM_MEM = 1 - data of file are already loaded in memory
1849
    * ecx = pointer to data of the cursor file
1850
    * the data format is the same as in the previous case
1851
  * dx = LOAD_INDIRECT = 2 - data in memory
1852
    * ecx = pointer to cursor image in the format ARGB 32*32 pixels
1853
    * edx = 0xXXYY0002, where
1854
      * XX = x-coordinate of cursor hotspot
1855
      * YY = y-coordinate
1856
      * 0 <= XX, YY <= 31
1857
Returned value:
1858
  * eax = 0 - failed
1859
  * otherwise eax = cursor handle
1860
 
1861
--------------------- Subfunction 5 - set cursor ---------------------
1862
Sets new cursor for the window of the current thread.
1863
Parameters:
1864
  * eax = 37 - function number
1865
  * ebx = 5 - subfunction number
1866
  * ecx = cursor handle
1867
Returned value:
1868
  * eax = handle of previous cursor
1869
Remarks:
1870
  * If the handle is incorrect, the function restores the default
1871
    cursor (standard arrow). In particular, ecx=0 restores it.
1872
 
1873
------------------- Subfunction 6 - delete cursor --------------------
1874
Parameters:
1875
  * eax = 37 - function number
1876
  * ebx = 6 - subfunction number
1877
  * ecx = cursor handle
1878
Returned value:
1879
  * eax destroyed
1880
Remarks:
1881
  * The cursor must be loaded previously by the current thread
1882
    (with the call to subfunction 4). The function does not delete
1883
    system cursors and cursors, loaded by another applications.
1884
  * If the active cursor (set by subfunction 5) is deleted,
1885
    the system restores the default cursor (standard arrow).
1886
 
499 diamond 1887
------------------ Subfunction 7 - get scroll data -------------------
486 kastigar 1888
Parameters:
1889
  * eax = 37 - function number
1890
  * ebx = 7 - subfunction number
1891
Returned value:
499 diamond 1892
  * eax = [horizontal offset]*65536 + [vertical offset]
486 kastigar 1893
Remarks:
499 diamond 1894
  * Scroll data is available for active window only.
1895
  * Values are zeroed after reading.
1896
  * Values are signed.
486 kastigar 1897
 
6057 IgorA 1898
---------------------- Constants for registers: ----------------------
1899
  eax - SF_MOUSE_GET (37)
1900
  ebx - SSF_SCREEN_POSITION (0), SSF_WINDOW_POSITION (1),
1901
    SSF_BUTTON (2), SSF_BUTTON_EXT (3), SSF_LOAD_CURSOR (4),
1902
    SSF_SET_CURSOR (5), SSF_DEL_CURSOR (6), SSF_SCROLL_DATA (7)
114 mikedld 1903
======================================================================
1904
====================== Function 38 - draw line. ======================
1905
======================================================================
1906
Parameters:
118 diamond 1907
  * eax = 38 - function number
1908
  * ebx = [start coordinate on axis x]*65536 +
1909
              [end coordinate on axis x]
1910
  * ecx = [start coordinate on axis y]*65536 +
1911
              [end coordinate on axis y]
1912
  * edx = 0x00RRGGBB - color
133 diamond 1913
    edx = 0x01xxxxxx - draw inversed line
1914
          (low 24 bits are ignored)
114 mikedld 1915
Returned value:
1916
  * function does not return value
1917
Remarks:
118 diamond 1918
  * Coordinates are relative to the window.
1919
  * End point is also drawn.
114 mikedld 1920
 
6057 IgorA 1921
---------------------- Constants for registers: ----------------------
1922
  eax - SF_DRAW_LINE (38)
114 mikedld 1923
======================================================================
118 diamond 1924
== Function 39, subfunction 1 - get a size of the background image. ==
114 mikedld 1925
======================================================================
1926
Parameters:
118 diamond 1927
  * eax = 39 - function number
1928
  * ebx = 1 - subfunction number
114 mikedld 1929
Returned value:
1930
  * eax = [width]*65536 + [height]
1931
Remarks:
118 diamond 1932
  * There is a pair function to set sizes of background image -
1933
    subfunction 1 of function 15. After which it is necessary,
1934
    of course, anew to define image.
114 mikedld 1935
 
6057 IgorA 1936
---------------------- Constants for registers: ----------------------
1937
  eax - SF_BACKGROUND_GET (39)
114 mikedld 1938
======================================================================
118 diamond 1939
== Function 39, subfunction 2 - get pixel from the background image. =
114 mikedld 1940
======================================================================
1941
Parameters:
118 diamond 1942
  * eax = 39 - function number
1943
  * ebx = 2 - subfunction number
114 mikedld 1944
  * ecx = offset
1945
Returned value:
118 diamond 1946
  * eax = 0x00RRGGBB - pixel color, if offset is valid
1947
    (less than 0x160000-16)
1948
  * eax = 2 otherwise
114 mikedld 1949
Remarks:
118 diamond 1950
  * Do not rely on returned value for invalid offsets, it may be
1951
    changed in future kernel versions.
1952
  * Offset for pixel with coordinates (x,y)
1953
    is calculated as (x+y*xsize)*3.
2409 Serge 1954
  * There is a pair function to set pixel on the background image -
118 diamond 1955
    subfunction 2 of function 15.
114 mikedld 1956
 
6057 IgorA 1957
---------------------- Constants for registers: ----------------------
1958
  eax - SF_BACKGROUND_GET (39)
114 mikedld 1959
======================================================================
118 diamond 1960
== Function 39, subfunction 4 - get drawing mode for the background. =
114 mikedld 1961
======================================================================
1962
Parameters:
118 diamond 1963
  * eax = 39 - function number
1964
  * ebx = 4 - subfunction number
114 mikedld 1965
Returned value:
118 diamond 1966
  * eax = 1 - tile
1967
  * eax = 2 - stretch
114 mikedld 1968
Remarks:
2409 Serge 1969
  * There is a pair function to set drawing mode -
118 diamond 1970
    subfunction 4 of function 15.
114 mikedld 1971
 
6057 IgorA 1972
---------------------- Constants for registers: ----------------------
1973
  eax - SF_BACKGROUND_GET (39)
114 mikedld 1974
======================================================================
118 diamond 1975
=========== Function 40 - set the mask for expected events. ==========
114 mikedld 1976
======================================================================
118 diamond 1977
The mask for expected events affects function working with events
1978
10, 11, 23 - they notify only about events allowed by this mask.
114 mikedld 1979
Parameters:
118 diamond 1980
  * eax = 40 - function number
114 mikedld 1981
  * ebx = mask: bit i corresponds to event i+1 (see list of events)
118 diamond 1982
    (set bit permits notice on event)
3940 mario79 1983
    bit 31: mouse active/inactive filter
2414 Serge 1984
    bit 31 = 0 - inactive window receive mouse events
1985
    bit 31 = 1 - inactive window does not receive mouse events
1986
    bit 30: cursor position filter
1987
    bit 30 = 0 = the window receive mouse events if cursor
1988
                 outside window
1989
    bit 30 = 1 - the window does not receive mouse events if cursor
1990
                 outside window
114 mikedld 1991
Returned value:
1153 clevermous 1992
  * eax = previous value of mask
114 mikedld 1993
Remarks:
118 diamond 1994
  * Default mask (7=111b) enables nofices about redraw,
1995
    keys and buttons. This is enough for many applications.
1996
  * Events prohibited in the mask are saved anyway, when come;
1997
    they are simply not informed with event functions.
1998
  * Event functions take into account the mask on moment of
1999
    function call, not on moment of event arrival.
114 mikedld 2000
 
6057 IgorA 2001
---------------------- Constants for registers: ----------------------
2002
  eax - SF_SET_EVENTS_MASK (40)
114 mikedld 2003
======================================================================
118 diamond 2004
================ Function 43 - input/output to a port. ===============
114 mikedld 2005
======================================================================
2006
 
118 diamond 2007
------------------------ Output data to port -------------------------
114 mikedld 2008
Parameters:
118 diamond 2009
  * eax = 43 - function number
114 mikedld 2010
  * bl = byte for output
118 diamond 2011
  * ecx = port number 0xnnnn (from 0 to 0xFFFF)
114 mikedld 2012
Returned value:
118 diamond 2013
  * eax = 0 - success
2014
  * eax = 1 - the thread has not reserved the selected port
114 mikedld 2015
 
118 diamond 2016
------------------------ Input data from port ------------------------
114 mikedld 2017
Parameters:
118 diamond 2018
  * eax = 43 - function number
2019
  * ebx is ignored
2020
  * ecx = 0x8000nnnn, where nnnn = port number (from 0 to 0xFFFF)
114 mikedld 2021
Returned value:
118 diamond 2022
  * eax = 0 - success, thus ebx = entered byte
2023
  * eax = 1 - the thread has not reserved the selected port
114 mikedld 2024
Remarks:
118 diamond 2025
  * Previously the thread must reserve the selected port
2026
    for itself by function 46.
2027
  * Instead of call to this function it is better to use
2028
    processor instructions in/out - this is much
2029
    faster and a bit shorter and easier.
114 mikedld 2030
 
6057 IgorA 2031
---------------------- Constants for registers: ----------------------
2032
  eax - SF_PORT_IN_OUT (43)
114 mikedld 2033
======================================================================
118 diamond 2034
====== Function 46 - reserve/free a group of input/output ports. =====
114 mikedld 2035
======================================================================
118 diamond 2036
To work with reserved ports an application can access directly by
2037
commands in/out (recommended way) and can use function 43
2038
(not recommended way).
114 mikedld 2039
Parameters:
118 diamond 2040
  * eax = 46 - function number
114 mikedld 2041
  * ebx = 0 - reserve, 1 - free
118 diamond 2042
  * ecx = start port number
2043
  * edx = end port number (inclusive)
114 mikedld 2044
Returned value:
118 diamond 2045
  * eax = 0 - success
114 mikedld 2046
  * eax = 1 - error
2047
Remarks:
118 diamond 2048
  * For ports reservation: an error occurs if and only if
2049
    one from the following condition satisfies:
2050
    * start port is more than end port;
2051
    * the selected range contains incorrect port number
2052
      (correct are from 0 to 0xFFFF);
2053
    * limit for the total number of reserved areas is exceeded
2054
      (maximum 255 are allowed);
2055
    * the selected range intersects with any of earlier reserved
2056
  * For ports free: an error is an attempt to free range,
2057
    that was not earlier reserved by this function
2058
    (with same ecx,edx).
2059
  * If an error occurs (for both cases) function performs no action.
277 diamond 2060
  * At booting the system reserves for itself ports
2061
    0..0x2d, 0x30..0x4d, 0x50..0xdf, 0xe5..0xff (inclusively).
118 diamond 2062
  * When a thread terminates, all reserved by it ports
2063
    are freed automatically.
114 mikedld 2064
 
6057 IgorA 2065
---------------------- Constants for registers: ----------------------
2066
  eax - SF_SET_PORTS (46)
114 mikedld 2067
======================================================================
118 diamond 2068
============= Function 47 - draw a number in the window. =============
114 mikedld 2069
======================================================================
2070
Parameters:
118 diamond 2071
  * eax = 47 - function number
2072
  * ebx = parameters of conversion number to text:
114 mikedld 2073
    * bl = 0 - ecx contains number
665 diamond 2074
    * bl = 1 - ecx contains pointer to dword/qword-number
118 diamond 2075
    * bh = 0 - display in decimal number system
2076
    * bh = 1 - display in hexadecimal system
2077
    * bh = 2 - display in binary system
499 diamond 2078
    * bits 16-21 = how many digits to display
655 mario79 2079
    * bits 22-29 reserved and must be set to 0
665 diamond 2080
    * bit 30 set = display qword (64-bit) number (must be bl=1)
2081
    * bit 31 set = do not display leading zeroes of the number
118 diamond 2082
  * ecx = number (if bl=0) or pointer (if bl=1)
114 mikedld 2083
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
6272 pathoswith 2084
  * esi = 0xXXRRGGBB, where
2085
    * RR, GG, BB specify text color
2086
    * XX = 0B0FCSSS (bits):
2087
      * B=1 - fill background (color = edi)
2088
      * F specifies the font:
2089
 
2090
        1 = 8x16
2091
      * C=0 - draw to the window,
2092
        C=1 - draw to the user buffer (edi)
2093
      * SSS = (size multiplier)-1, so 0 = x1, 7 = x8
114 mikedld 2094
Returned value:
2095
  * function does not return value
2096
Remarks:
118 diamond 2097
  * The given length must not exceed 60.
2098
  * The exactly given amount of digits is output. If number is small
2099
    and can be written by smaller amount of digits, it is supplemented
2100
    by leading zeroes; if the number is big and can not be written by
2101
    given amount of digits, extra digits are not drawn.
114 mikedld 2102
 
6057 IgorA 2103
---------------------- Constants for registers: ----------------------
2104
  eax - SF_DRAW_NUMBER (47)
114 mikedld 2105
======================================================================
118 diamond 2106
========= Function 48, subfunction 0 - apply screen settings. ========
114 mikedld 2107
======================================================================
2108
Parameters:
118 diamond 2109
  * eax = 48 - function number
2110
  * ebx = 0 - subfunction number
114 mikedld 2111
  * ecx = 0 - reserved
2112
Returned value:
2113
  * function does not return value
2114
Remarks:
118 diamond 2115
  * Function redraws the screen after parameters change by
114 mikedld 2116
    subfunctions 1 and 2.
118 diamond 2117
  * Function call without prior call to one of indicated subfunctions
2118
    is ignored.
2119
  * Function call with nonzero ecx is ignored.
114 mikedld 2120
 
6057 IgorA 2121
---------------------- Constants for registers: ----------------------
2122
  eax - SF_STYLE_SETTINGS (48)
2123
  ebx - SSF_APPLY (0)
114 mikedld 2124
======================================================================
118 diamond 2125
=========== Function 48, subfunction 1 - set button style. ===========
114 mikedld 2126
======================================================================
2127
Parameters:
118 diamond 2128
  * eax = 48 - function number
2129
  * ebx = 1 - subfunction number
2130
  * ecx = button style:
2131
    * 0 = flat
2132
    * 1 = 3d
114 mikedld 2133
Returned value:
2134
  * function does not return value
2135
Remarks:
118 diamond 2136
  * After call to this function one should redraw the screen by
2137
    subfunction 0.
2138
  * Button style influences only to their draw of function 8.
114 mikedld 2139
 
6057 IgorA 2140
---------------------- Constants for registers: ----------------------
2141
  eax - SF_STYLE_SETTINGS (48)
2142
  ebx - SSF_SET_BUTTON_STYLE (1)
118 diamond 2143
======================================================================
2144
====== Function 48, subfunction 2 - set standard window colors. ======
2145
======================================================================
114 mikedld 2146
Parameters:
118 diamond 2147
  * eax = 48 - function number
2148
  * ebx = 2 - subfunction number
2149
  * ecx = pointer to the color table
114 mikedld 2150
  * edx = size of the color table
118 diamond 2151
    (must be 40 bytes for future compatibility)
2152
Format of the color table is shown in description of subfunction 3.
114 mikedld 2153
Returned value:
2154
  * function does not return value
2155
Remarks:
118 diamond 2156
  * After call to this function one should redraw the screen by
2157
    subfunction 0.
2158
  * Table of standard colors influences only to applications,
2159
    which receive this table obviously (by subfunction 3)
2160
    and use it (specifying colors from it to drawing functions).
2161
  * Table of standard colors is included in skin and is installed
2162
    anew with skin installation (by subfunction 8).
2163
  * Color table can be viewed/changed interactively with
2164
    the application 'desktop'.
114 mikedld 2165
 
6057 IgorA 2166
---------------------- Constants for registers: ----------------------
2167
  eax - SF_STYLE_SETTINGS (48)
2168
  ebx - SSF_SET_COLORS (2)
114 mikedld 2169
======================================================================
118 diamond 2170
====== Function 48, subfunction 3 - get standard window colors. ======
114 mikedld 2171
======================================================================
2172
Parameters:
118 diamond 2173
  * eax = 48 - function number
2174
  * ebx = 3 - subfunction number
2175
  * ecx = pointer to the buffer with size edx bytes,
2176
    where table will be written
2177
  * edx = size of color table
2178
    (must be 40 bytes for future compatibility)
114 mikedld 2179
Returned value:
2180
  * function does not return value
118 diamond 2181
Format of the color table:
2182
each item is dword-value for color 0x00RRGGBB
2183
  * +0: dword: frames - color of frame
2184
  * +4: dword: grab - color of header
2185
  * +8: dword: grab_button - color of button on header bar
2186
  * +12 = +0xC: dword: grab_button_text - color of text on button
2187
    on header bar
2188
  * +16 = +0x10: dword: grab_text - color of text on header
2189
  * +20 = +0x14: dword: work - color of working area
2190
  * +24 = +0x18: dword: work_button - color of button in working area
2191
  * +28 = +0x1C: dword: work_button_text - color of text on button
2192
    in working area
2193
  * +32 = +0x20: dword: work_text - color of text in working area
2194
  * +36 = +0x24: dword: work_graph - color of graphics in working area
114 mikedld 2195
Remarks:
118 diamond 2196
  * Structure of the color table is described in the standard
2197
    include file 'macros.inc' as 'system_colors'; for example,
2198
    it is possible to write:
5871 hidnplayr 2199
        sc      system_colors           ; variable declaration
2200
        ...                             ; somewhere one must call
2201
                                        ; this function with ecx=sc
2202
        mov     ecx, [sc.work_button_text]      ; read text color on
2203
                                        ; buttin in working area
118 diamond 2204
  * A program itself desides to use or not to use color table.
2205
    For usage program must simply at calls to drawing functions select
2206
    color taken from the table.
2207
  * At change of the table of standard colors (by subfunction 2 with
2208
    the subsequent application of changes by subfunction 0 or
2209
    at skin set by subfunction 8) the system sends to all windows
2210
    redraw message (the event with code 1).
2211
  * Color table can be viewed/changed interactively with
2212
    the application 'desktop'.
114 mikedld 2213
 
6057 IgorA 2214
---------------------- Constants for registers: ----------------------
2215
  eax - SF_STYLE_SETTINGS (48)
2216
  ebx - SSF_GET_COLORS (3)
114 mikedld 2217
======================================================================
118 diamond 2218
============ Function 48, subfunction 4 - get skin height. ===========
114 mikedld 2219
======================================================================
2220
Parameters:
118 diamond 2221
  * eax = 48 - function number
2222
  * ebx = 4 - subfunction number
114 mikedld 2223
Returned value:
118 diamond 2224
  * eax = skin height
114 mikedld 2225
Remarks:
118 diamond 2226
  * Skin height is defined as the height of a header
2227
    of skinned windows.
2228
  * See also general structure of window in the description
2229
    of function 0.
114 mikedld 2230
 
6057 IgorA 2231
---------------------- Constants for registers: ----------------------
2232
  eax - SF_STYLE_SETTINGS (48)
2233
  ebx - SSF_GET_SKIN_HEIGHT (4)
114 mikedld 2234
======================================================================
118 diamond 2235
======== Function 48, subfunction 5 - get screen working area. =======
114 mikedld 2236
======================================================================
2237
Parameters:
118 diamond 2238
  * eax = 48 - function number
2239
  * ebx = 5 - subfunction number
114 mikedld 2240
Returned value:
2241
  * eax = [left]*65536 + [right]
2242
  * ebx = [top]*65536 + [bottom]
2243
Remarks:
118 diamond 2244
  * The screen working area defines position and coordinates of
2245
    a maximized window.
2246
  * The screen working area in view of normal work is all screen
5452 leency 2247
    without taskbar ('@taskbar' application).
118 diamond 2248
  * (left,top) are coordinates of the left upper corner,
2249
    (right,bottom) are coordinates of the right lower one.
2250
    Thus the size of working area on x axis can be calculated by
2251
    formula right-left+1, on y axis - by formula bottom-right+1.
2252
  * See also function 14,
2253
    to get sizes of all screen.
2254
  * There is a pair function to set working area - subfunction 6.
114 mikedld 2255
 
6057 IgorA 2256
---------------------- Constants for registers: ----------------------
2257
  eax - SF_STYLE_SETTINGS (48)
2258
  ebx - SSF_GET_SCREEN_AREA (5)
114 mikedld 2259
======================================================================
118 diamond 2260
======== Function 48, subfunction 6 - set screen working area. =======
114 mikedld 2261
======================================================================
2262
Parameters:
118 diamond 2263
  * eax = 48 - function number
2264
  * ebx = 6 - subfunction number
114 mikedld 2265
  * ecx = [left]*65536 + [right]
2266
  * edx = [top]*65536 + [bottom]
2267
Returned value:
2268
  * function does not return value
2269
Remarks:
118 diamond 2270
  * The screen working area defines position and coordinates of
2271
    a maximized window.
5452 leency 2272
  * This function is used only by the application '@taskbar',
2273
    which set working area to all screen without taskbar.
118 diamond 2274
  * (left,top) are coordinates of the left upper corner,
2275
    (right,bottom) are coordinates of the right lower one.
2276
    Thus the size of working area on x axis can be calculated by
2277
    formula right-left+1, on y axis - by formula bottom-right+1.
2278
  * If 'left'>='right', x-coordinate of working area is not changed.
2279
    If 'left'<0, 'left' will not be set. If 'right' is greater than or
2280
    equal to screen width, 'right' will not be set.
2281
    Similarly on y axis.
2282
  * See also function 14,
2283
    to get sizes of all screen.
2284
  * There is a pair function to get working area - subfunction 5.
2285
  * This function redraws the screen automatically,
2286
    updating coordinates and sizes of maximized windows.
2287
    The system sends to all windows redraw message (the event 1).
114 mikedld 2288
 
6057 IgorA 2289
---------------------- Constants for registers: ----------------------
2290
  eax - SF_STYLE_SETTINGS (48)
2291
  ebx - SSF_SET_SCREEN_AREA (6)
114 mikedld 2292
======================================================================
118 diamond 2293
=========== Function 48, subfunction 7 - get skin margins. ===========
114 mikedld 2294
======================================================================
118 diamond 2295
Returns the area of a header of a skinned window, intended for
2296
a text of a header.
114 mikedld 2297
Parameters:
118 diamond 2298
  * eax = 48 - function number
2299
  * ebx = 7 - subfunction number
114 mikedld 2300
Returned value:
2301
  * eax = [left]*65536 + [right]
2302
  * ebx = [top]*65536 + [bottom]
2303
Remarks:
118 diamond 2304
  * An application decides itself to use or not to use this function.
2305
  * It is recommended to take into account returned value
2306
    of this function for choice of a place for drawing header text
2307
    (by function 4) or a substitute of header text
2308
    (at the discretion of an application).
114 mikedld 2309
 
6057 IgorA 2310
---------------------- Constants for registers: ----------------------
2311
  eax - SF_STYLE_SETTINGS (48)
2312
  ebx - SSF_GET_SKIN_MARGINS (7)
114 mikedld 2313
======================================================================
118 diamond 2314
============= Function 48, subfunction 8 - set used skin. ============
114 mikedld 2315
======================================================================
2316
Parameters:
118 diamond 2317
  * eax = 48 - function number
2318
  * ebx = 8 - subfunction number
4573 clevermous 2319
  * ecx = pointer to filename of the skin
114 mikedld 2320
Returned value:
118 diamond 2321
  * eax = 0 - success
2322
  * otherwise eax = file system error code; if file does not
2323
    contain valid skin, function returns error 3
2324
    (unknown file system).
114 mikedld 2325
Remarks:
118 diamond 2326
  * After successful skin loading the system sends to all windows
2327
    redraw message (the event 1).
2328
  * At booting the system reads skin from file 'default.skn'
2329
    on ramdisk.
2330
  * User can change the skin statically by creating hisself
2331
    'default.skn' or dynamically with the application 'desktop'.
114 mikedld 2332
 
6057 IgorA 2333
---------------------- Constants for registers: ----------------------
2334
  eax - SF_STYLE_SETTINGS (48)
2335
  ebx - SSF_SET_SKIN (8)
114 mikedld 2336
======================================================================
5848 pathoswith 2337
====== Function 48, subfunction 9 - get font smoothing setting. ======
5682 leency 2338
======================================================================
2339
Parameters:
2340
  * eax = 48 - function number
2341
  * ebx = 9 - subfunction number
5848 pathoswith 2342
Returned value:
2343
  * eax = 2 - subpixel, 1 - anti-aliasing, 0 - off
5682 leency 2344
 
6057 IgorA 2345
---------------------- Constants for registers: ----------------------
2346
  eax - SF_STYLE_SETTINGS (48)
2347
  ebx - SSF_GET_FONT_SMOOTH (9)
5682 leency 2348
======================================================================
5848 pathoswith 2349
========== Function 48, subfunction 10 - set font smoothing. =========
2350
======================================================================
2351
Parameters:
2352
  * eax = 48 - function number
2353
  * ebx = 10 - subfunction number
2354
  * cl  = 2 - subpixel, 1 - anti-aliasing, 0 - off
2355
 
6057 IgorA 2356
---------------------- Constants for registers: ----------------------
2357
  eax - SF_STYLE_SETTINGS (48)
2358
  ebx - SSF_SET_FONT_SMOOTH (10)
5848 pathoswith 2359
======================================================================
5867 pathoswith 2360
============ Function 48, subfunction 11 - get font size. ============
2361
======================================================================
2362
Parameters:
2363
  * eax = 48 - function number
2364
  * ebx = 9 - subfunction number
2365
Returned value:
2366
  * eax = current font height in pixels
2367
 
6057 IgorA 2368
---------------------- Constants for registers: ----------------------
2369
  eax - SF_STYLE_SETTINGS (48)
2370
  ebx - SSF_GET_FONT_SIZE (11)
5867 pathoswith 2371
======================================================================
2372
============ Function 48, subfunction 12 - set font size. ============
2373
======================================================================
2374
Parameters:
2375
  * eax = 48 - function number
2376
  * ebx = 10 - subfunction number
2377
  * cl  = new font height in pixels
2378
 
6057 IgorA 2379
---------------------- Constants for registers: ----------------------
2380
  eax - SF_STYLE_SETTINGS (48)
2381
  ebx - SSF_SET_FONT_SIZE (12)
5867 pathoswith 2382
======================================================================
118 diamond 2383
=========== Function 49 - Advanced Power Management (APM). ===========
114 mikedld 2384
======================================================================
2385
Parameters:
118 diamond 2386
  * eax = 49 - function number
2387
  * dx = number of the APM function
2388
    (analogue of ax in APM specification)
2389
  * bx, cx = parameters of the APM function
114 mikedld 2390
Returned value:
118 diamond 2391
  * 16-bit registers ax, bx, cx, dx, si, di and carry flag CF
2392
    are set according to the APM specification
2393
  * high halves of 32-bit registers eax, ebx, ecx,
2394
    edx, esi, edi are destroyed
114 mikedld 2395
Remarks:
118 diamond 2396
  * APM 1.2 specification is described in the document
2397
    "Advanced Power Management (APM) BIOS Specification"
2398
    (Revision 1.2), available at
114 mikedld 2399
    http://www.microsoft.com/whdc/archive/amp_12.mspx;
118 diamond 2400
    besides it is included in famous Interrupt List by Ralf Brown
114 mikedld 2401
    (http://www.pobox.com/~ralf/files.html,
2402
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/).
2403
 
6057 IgorA 2404
---------------------- Constants for registers: ----------------------
2405
  eax - SF_APM (49)
114 mikedld 2406
======================================================================
118 diamond 2407
=================== Function 50 - set window shape. ==================
114 mikedld 2408
======================================================================
118 diamond 2409
Normal windows have rectangular shape. This function can give to
2410
a window any shape. The shape is given by a set of points inside
2411
the base rectangle belonging to a window. Position and coordinates
2412
of the base rectangle are set by function 0
2413
and changed by function 67.
114 mikedld 2414
 
118 diamond 2415
--------------------------- Set shape data ---------------------------
114 mikedld 2416
Parameters:
118 diamond 2417
  * eax = 50 - function number
2418
  * ebx = 0 - subfunction number
2419
  * ecx = pointer to shape data (array of bytes 0/1)
114 mikedld 2420
Returned value:
2421
  * function does not return value
2422
 
118 diamond 2423
-------------------------- Set shape scale ---------------------------
114 mikedld 2424
Parameters:
118 diamond 2425
  * eax = 50 - function number
2426
  * ebx = 1 - subfunction number
2427
  * ecx sets a scale: each byte of data defines
2428
    (2^scale)*(2^scale) pixels
114 mikedld 2429
Returned value:
2430
  * function does not return value
2431
Remarks:
118 diamond 2432
  * Default scale is 0 (scale factor is 1). If in the shape data
2433
    one byte corresponds to one pixel, there is no necessity
2434
    to set scale.
2435
  * Let's designate xsize = window width (in pixels), ysize = height;
2436
    pay attention, that they are one pixel more than defined by
114 mikedld 2437
    functions 0, 67.
118 diamond 2438
  * On definition of scale xsize and ysize must be divisible
2439
    on 2^scale.
2440
  * Byte of data on offset 'a' must be 0/1 and defines belonging
2441
    to a window of square with the side 2^scale (if scale=0,
2442
    this is one pixel) and coordinates of the left upper corner
114 mikedld 2443
    (a mod (xsize shr scale), a div (xsize shr scale))
118 diamond 2444
  * Data size: (xsize shr scale)*(ysize shr scale).
2445
  * Data must be presented in the memory and not change
2446
    after set of shape.
2447
  * The system views the shape data at every window redraw by
2448
    function 0.
2449
  * The call of subfunction 0 with NULL pointer results in return
2450
    to the rectangular shape.
114 mikedld 2451
 
6057 IgorA 2452
---------------------- Constants for registers: ----------------------
2453
  eax - SF_SET_WINDOW_SHAPE (50)
114 mikedld 2454
======================================================================
2455
==================== Function 51 - create thread. ====================
2456
======================================================================
2457
Parameters:
118 diamond 2458
  * eax = 51 - function number
2459
  * ebx = 1 - unique subfunction
2460
  * ecx = address of thread entry point (starting eip)
2461
  * edx = pointer to thread stack (starting esp)
114 mikedld 2462
Returned value:
118 diamond 2463
  * eax = -1 - error (there is too many threads)
2464
  * otherwise eax = TID - thread identifier
114 mikedld 2465
 
6057 IgorA 2466
---------------------- Constants for registers: ----------------------
2467
  eax - SF_CREATE_THREAD (51)
114 mikedld 2468
======================================================================
4199 mario79 2469
==================== Function 54, subfunction 0 ======================
2470
============== Get the number of slots in the clipboard. =============
2471
======================================================================
2472
Parameters:
2473
  * eax = 54 - function number
2474
  * ebx = 0 - subfunction number
2475
Returned value:
2476
  * eax = slots in the clipboard
2477
  * eax = -1 - main list area not found
2478
 
6057 IgorA 2479
---------------------- Constants for registers: ----------------------
2480
  eax - SF_CLIPBOARD (54)
2481
  ebx - SSF_GET_SLOT_COUNT (0)
4199 mario79 2482
======================================================================
2483
==================== Function 54, subfunction 1 ======================
2484
================= Read the data from the clipboard. ==================
2485
======================================================================
2486
Parameters:
2487
  * eax = 54 - function number
2488
  * ebx = 1 - subfunction number
2489
  * eсx = slot number
2490
Returned value:
2491
  * eax = if successful - pointer to a memory with data
2492
  * eax = 1 - error
2493
  * eax = -1 - main list area not found
6079 serge 2494
 
6057 IgorA 2495
---------------------- Constants for registers: ----------------------
2496
  eax - SF_CLIPBOARD (54)
2497
  ebx - SSF_READ_CB (1)
4199 mario79 2498
======================================================================
2499
==================== Function 54, subfunction 2 ======================
2500
================= Write the data to the clipboard. ===================
2501
======================================================================
2502
Parameters:
2503
  * eax = 54 - function number
2504
  * ebx = 2 - subfunction number
2505
  * eсx = the number of bytes to be copied
2506
  * edx = a pointer to a buffer for data to be copied
2507
Returned value:
2508
  * eax = 0 - success
2509
  * eax = 1 - error
2510
  * eax = -1 - main list area not found
6057 IgorA 2511
 
2512
---------------------- Constants for registers: ----------------------
2513
  eax - SF_CLIPBOARD (54)
2514
  ebx - SSF_WRITE_CB (2)
4199 mario79 2515
======================================================================
2516
===================== Function 54, subfunction 3 =====================
2517
================ Delete the last slot in the clipboard ===============
2518
======================================================================
2519
Parameters:
2520
  * eax = 54 - function number
2521
  * ebx = 3 - subfunction number
2522
Returned value:
2523
  * eax = 0 - success
2524
  * eax = 1 - error
2525
  * eax = -1 - main list area not found
6057 IgorA 2526
 
2527
---------------------- Constants for registers: ----------------------
2528
  eax - SF_CLIPBOARD (54)
2529
  ebx - SSF_DEL_SLOT (3)
4199 mario79 2530
======================================================================
2531
===================== Function 54, subfunction 4 =====================
2532
===================== Alarm reset the lock buffer ====================
2533
======================================================================
2534
Parameters:
2535
  * eax = 54 - function number
2536
  * ebx = 4 - subfunction number
2537
Returned value:
2538
  * eax = 0 - success
2539
  * eax = -1 - main list area not found or no blocking
2540
Remarks:
2541
  * Used in exceptional cases, where no responsible or killed
2542
    application blocked the clipboard operations.
2543
 
6057 IgorA 2544
---------------------- Constants for registers: ----------------------
2545
  eax - SF_CLIPBOARD (54)
2546
  ebx - SSF_UNLOCK_BUFFER (4)
4199 mario79 2547
======================================================================
2409 Serge 2548
 Function 55, subfunction 55 - begin to play data on built-in speaker.
114 mikedld 2549
======================================================================
2550
Parameters:
118 diamond 2551
  * eax = 55 - function number
2552
  * ebx = 55 - subfunction number
2553
  * esi = pointer to data
114 mikedld 2554
Returned value:
118 diamond 2555
  * eax = 0 - success
2556
  * eax = 55 - error (speaker is off or busy)
2557
Data is an array of items with variable length.
2558
Format of each item is defined by first byte:
114 mikedld 2559
  * 0 = end of data
118 diamond 2560
  * 1..0x80 = sets sound duration on 1/100 of second; sound note
2561
    is defined by immediate value of frequency
2562
    * following word (2 bytes) contains frequency divider;
2563
      frequency is defined as 1193180/divider
114 mikedld 2564
  * 0x81 = invalid
118 diamond 2565
  * 0x82..0xFF = note is defined by octave and number:
2566
    * duration in 1/100 of second = (first byte)-0x81
114 mikedld 2567
    * there is one more byte;
118 diamond 2568
    * (second byte)=0xFF - delay
2569
    * otherwise it looks like a*0x10+b, where b=number of the note in
2570
      an octave from 1 to 12, a=number of octave (beginning from 0)
114 mikedld 2571
Remarks:
118 diamond 2572
  * Speaker play can be disabled/enabled by
2573
    subfunction 8 of function 18.
2574
  * Function returns control, having informed the system
2575
    an information on request. Play itself goes independently from
2576
    the program.
2577
  * The data must be kept in the memory at least up to the end
2578
    of play.
114 mikedld 2579
 
6057 IgorA 2580
---------------------- Constants for registers: ----------------------
2581
  eax - SF_SPEAKER_PLAY (55)
114 mikedld 2582
======================================================================
641 diamond 2583
======================= Function 57 - PCI BIOS. ======================
2584
======================================================================
2585
Parameters:
2586
  * eax = 57 - function number
2587
  * ebp corresponds to al in PCI BIOS specification
2588
  * other registers are set according to PCI BIOS specification
2589
Returned value:
2590
  * CF is undefined
2591
  * other registers are set according to PCI BIOS specification
2592
Remarks:
2593
  * Many effects of this function can be also achieved with
2594
    corresponding subfunctions of function 62.
2595
  * The function calls PCI32 BIOS extension, documented e.g. in
2596
    http://alpha1.dyns.net/files/PCI/bios21.pdf.
2597
  * If BIOS does not support this extension, its behavior is emulated
2598
    (through kernel-mode analogues of subfunctions of function 62).
2599
 
6057 IgorA 2600
---------------------- Constants for registers: ----------------------
2601
  eax - SF_PCI_BIOS (57)
641 diamond 2602
======================================================================
118 diamond 2603
========== Function 60 - Inter Process Communication (IPC). ==========
114 mikedld 2604
======================================================================
118 diamond 2605
IPC is used for message dispatching from one process/thread to
2606
another. Previously it is necessary to agree how to interpret
114 mikedld 2607
the concrete message.
2608
 
118 diamond 2609
----------- Subfunction 1 - set the area for IPC receiving -----------
2610
Is called by process-receiver.
114 mikedld 2611
Parameters:
118 diamond 2612
  * eax = 60 - function number
2613
  * ebx = 1 - subfunction number
2614
  * ecx = pointer to the buffer
2615
  * edx = size of the buffer
114 mikedld 2616
Returned value:
118 diamond 2617
  * eax = 0 - always success
2618
Format of IPC-buffer:
2619
  * +0: dword: if nonzero, buffer is considered locked;
2620
    lock/unlock the buffer, when you work with it and need that
2621
    buffer data are not changed from outside (no new messages)
114 mikedld 2622
  * +4: dword: occupied place in the buffer (in bytes)
2623
  * +8: first message
2624
  * +8+n: second message
2625
  * ...
118 diamond 2626
Format of a message:
2627
  * +0: dword: PID of sender
2628
  * +4: dword: message length (not including this header)
2629
  * +8: n*byte: message data
114 mikedld 2630
 
118 diamond 2631
------------------ Subfunction 2 - send IPC message ------------------
2632
Is called by process-sender.
114 mikedld 2633
Parameters:
118 diamond 2634
  * eax = 60 - function number
2635
  * ebx = 2 - subfunction number
114 mikedld 2636
  * ecx = PID of receiver
118 diamond 2637
  * edx = pointer to the message data
2638
  * esi = message length (in bytes)
114 mikedld 2639
Returned value:
118 diamond 2640
  * eax = 0 - success
2641
  * eax = 1 - the receiver has not defined buffer for IPC messages
2642
    (can be, still have no time,
2643
    and can be, this is not right process)
2644
  * eax = 2 - the receiver has blocked IPC-buffer; try to wait a bit
2645
  * eax = 3 - overflow of IPC-buffer of the receiver
114 mikedld 2646
  * eax = 4 - process/thread with such PID does not exist
2647
Remarks:
118 diamond 2648
  * Immediately after writing of IPC-message to the buffer the system
2649
    sends to the receiver the event with code 7 (see event codes).
114 mikedld 2650
 
6057 IgorA 2651
---------------------- Constants for registers: ----------------------
2652
  eax - SF_IPC (60)
2653
  ebx - SSF_SET_AREA (1), SSF_SEND_MESSAGE (2)
114 mikedld 2654
======================================================================
118 diamond 2655
==== Function 61 - get parameters for the direct graphics access. ====
114 mikedld 2656
======================================================================
118 diamond 2657
The data of the graphics screen (the memory area which displays
2658
screen contents) are accessible to a program directly, without
2659
any system calls, through the selector gs:
5871 hidnplayr 2660
        mov     eax, [gs:0]
118 diamond 2661
places in eax the first dword of the buffer, which contains
2662
information on color of the left upper point (and, possibly, colors
2663
of several following).
5871 hidnplayr 2664
        mov     [gs:0], eax
118 diamond 2665
by work in VESA modes with LFB sets color of the left upper point
2666
(and, possibly, colors of several following).
2667
To interpret the data of graphics screen program needs to know
2668
some parameters, returning by this function.
114 mikedld 2669
Remarks:
118 diamond 2670
  * Graphics parameters changes very seldom at work,
2671
    namely, only in cases, when user works with the application VRR.
2672
  * At videomode change the system redraws all windows (event
2673
    with code 1) and redraws the background (event 5).
2674
    Same events occur in other cases too, which meet much more often,
2675
    than videomode change.
2676
  * By operation in videomodes with LFB the selector gs points to
2677
    LFB itself, so reading/writing on gs result directly in
2678
    change of screen contents. By operation in videomodes without
2679
    LFB gs points to some data area in the kernel, and all functions
2680
    of screen output fulfil honesty double operation on writing
2681
    directly to the screen and writing to this buffer. In result
2682
    at reading contents of this buffer the results correspond to
2683
    screen contents (with, generally speaking, large color
2684
    resolution), and writing is ignored.
2685
    One exception is the mode 320*200, for which main loop of the
2686
    system thread updates the screen according to mouse movements.
114 mikedld 2687
 
2688
------------------------- Screen resolution --------------------------
2689
Parameters:
118 diamond 2690
  * eax = 61 - function number
2691
  * ebx = 1 - subfunction number
114 mikedld 2692
Returned value:
118 diamond 2693
  * eax = [resolution on x axis]*65536 + [resolution on y axis]
114 mikedld 2694
Remarks:
118 diamond 2695
  * One can use function 14 paying attention that
2696
    it returns sizes on 1 pixel less. It is fully equivalent way.
114 mikedld 2697
 
118 diamond 2698
---------------------- Number of bits per pixel ----------------------
114 mikedld 2699
Parameters:
118 diamond 2700
  * eax = 61 - function number
2701
  * ebx = 2 - subfunction number
114 mikedld 2702
Returned value:
118 diamond 2703
  * eax = number of bits per pixel (24 or 32)
114 mikedld 2704
 
118 diamond 2705
-------------------- Number of bytes per scanline --------------------
114 mikedld 2706
Parameters:
118 diamond 2707
  * eax = 61 - function number
2708
  * ebx = 3 - subfunction number
114 mikedld 2709
Returned value:
118 diamond 2710
  * eax = number of bytes occupied by one scanline
114 mikedld 2711
    (horizontal line on the screen)
2712
 
6057 IgorA 2713
---------------------- Constants for registers: ----------------------
2714
  eax - SF_GET_GRAPHICAL_PARAMS (61)
2715
  ebx - SSF_SCREEN_SIZE (1), SSF_BITS_PER_PIXEL (2),
2716
    SSF_BYTES_PER_LINE (3)
114 mikedld 2717
======================================================================
118 diamond 2718
===== Function 62, subfunction 0 - get version of PCI-interface. =====
114 mikedld 2719
======================================================================
2720
Parameters:
118 diamond 2721
  * eax = 62 - function number
2722
  * bl = 0 - subfunction number
114 mikedld 2723
Returned value:
118 diamond 2724
  * eax = -1 - PCI access is disabled; otherwise
2725
  * ah.al = version of PCI-interface (ah=version, al=subversion)
2726
  * high word of eax is zeroed
114 mikedld 2727
Remarks:
118 diamond 2728
  * Previously low-level access to PCI for applications must be
2729
    enabled by subfunction 12 of function 21.
2730
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 2731
 
6057 IgorA 2732
---------------------- Constants for registers: ----------------------
2733
  eax - SF_PCI (62)
2734
  ebx - SSF_GET_VERSION (0)
114 mikedld 2735
======================================================================
118 diamond 2736
==== Function 62, subfunction 1 - get number of the last PCI-bus. ====
114 mikedld 2737
======================================================================
2738
Parameters:
118 diamond 2739
  * eax = 62 - function number
2740
  * bl = 1 - subfunction number
114 mikedld 2741
Returned value:
118 diamond 2742
  * eax = -1 - access to PCI is disabled; otherwise
2743
  * al = number of the last PCI-bus; other bytes of eax are destroyed
114 mikedld 2744
Remarks:
118 diamond 2745
  * Previously low-level access to PCI for applications must be
2746
    enabled by subfunction 12 of function 21.
2747
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 2748
 
6057 IgorA 2749
---------------------- Constants for registers: ----------------------
2750
  eax - SF_PCI (62)
2751
  ebx - SSF_GET_LAST_BUS (1)
114 mikedld 2752
======================================================================
118 diamond 2753
===================== Function 62, subfunction 2 =====================
2754
===== Get mechanism of addressing to the PCI configuration space. ====
114 mikedld 2755
======================================================================
2756
Parameters:
118 diamond 2757
  * eax = 62 - function number
2758
  * bl = 2 - subfunction number
114 mikedld 2759
Returned value:
118 diamond 2760
  * eax = -1 - access to PCI is disabled; otherwise
2761
  * al = mechanism (1 or 2); other bytes of eax are destroyed
114 mikedld 2762
Remarks:
118 diamond 2763
  * Previously low-level access to PCI for applications must be
2764
    enabled by subfunction 12 of function 21.
2765
  * Addressing mechanism is selected depending on
2766
    equipment characteristics.
2767
  * Subfunctions of read and write work automatically
2768
    with the selected mechanism.
114 mikedld 2769
 
6057 IgorA 2770
---------------------- Constants for registers: ----------------------
2771
  eax - SF_PCI (62)
2772
  ebx - SSF_GET_ADRR_MODE (2)
114 mikedld 2773
======================================================================
118 diamond 2774
======== Function 62, subfunctions 4,5,6 - read PCI-register. ========
114 mikedld 2775
======================================================================
2776
Parameters:
118 diamond 2777
  * eax = 62 - function number
2778
  * bl = 4 - read byte
2779
  * bl = 5 - read word
2780
  * bl = 6 - read dword
114 mikedld 2781
  * bh = number of PCI-bus
118 diamond 2782
  * ch = dddddfff, where ddddd = number of the device on the bus,
2783
    fff = function number of device
2784
  * cl = number of register (must be even for bl=5,
2785
    divisible by 4 for bl=6)
114 mikedld 2786
Returned value:
118 diamond 2787
  * eax = -1 - error (access to PCI is disabled or parameters
2788
    are not supported); otherwise
2789
  * al/ax/eax (depending on requested size) contains the data;
2790
    the other part of register eax is destroyed
114 mikedld 2791
Remarks:
118 diamond 2792
  * Previously low-level access to PCI for applications must be
2793
    enabled by subfunction 12 of function 21.
2794
  * Access mechanism 2 supports only 16 devices on a bus and ignores
2795
    function number. To get access mechanism use subfunction 2.
2796
  * Some registers are standard and exist for all devices, some are
2797
    defined by the concrete device. The list of registers of the
2798
    first type can be found e.g. in famous
114 mikedld 2799
    Interrupt List by Ralf Brown
2800
    (http://www.pobox.com/~ralf/files.html,
2801
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/);
118 diamond 2802
    registers of the second type must be listed
2803
    in the device documentation.
114 mikedld 2804
 
6057 IgorA 2805
---------------------- Constants for registers: ----------------------
2806
  eax - SF_PCI (62)
2807
  ebx - SSF_READ_BYTE (4), SSF_READ_WORD (5), SSF_READ_DWORD (6)
114 mikedld 2808
======================================================================
118 diamond 2809
====== Function 62, subfunctions 8,9,10 - write to PCI-register. =====
114 mikedld 2810
======================================================================
2811
Parameters:
118 diamond 2812
  * eax = 62 - function number
2813
  * bl = 8 - write byte
2814
  * bl = 9 - write word
2815
  * bl = 10 - write dword
114 mikedld 2816
  * bh = number of PCI-bus
118 diamond 2817
  * ch = dddddfff, where ddddd = number of the device on the bus,
2818
    fff = function number of device
2819
  * cl = number of register (must be even for bl=9,
2820
    divisible by 4 for bl=10)
2821
  * dl/dx/edx (depending on requested size) contatins
2822
    the data to write
114 mikedld 2823
Returned value:
118 diamond 2824
  * eax = -1 - error (access to PCI is disabled or parameters
2825
    are not supported)
2826
  * eax = 0 - success
114 mikedld 2827
Remarks:
118 diamond 2828
  * Previously low-level access to PCI for applications must be
2829
    enabled by subfunction 12 of function 21.
2830
  * Access mechanism 2 supports only 16 devices on a bus and ignores
2831
    function number. To get access mechanism use subfunction 2.
2832
  * Some registers are standard and exist for all devices, some are
2833
    defined by the concrete device. The list of registers of the
2834
    first type can be found e.g. in famous Interrupt List by
2835
    Ralf Brown; registers of the second type must be listed
2836
    in the device documentation.
114 mikedld 2837
 
6057 IgorA 2838
---------------------- Constants for registers: ----------------------
2839
  eax - SF_PCI (62)
2840
  ebx - SSF_WRITE_BYTE (8), SSF_WRITE_WORD (9), SSF_WRITE_DWORD (10)
114 mikedld 2841
======================================================================
118 diamond 2842
============== Function 63 - work with the debug board. ==============
114 mikedld 2843
======================================================================
118 diamond 2844
The debug board is the global system buffer (with the size
499 diamond 2845
1024 bytes), to which any program can write (generally speaking,
118 diamond 2846
arbitrary) data and from which other program can read these data.
2847
By the agreement written data are text strings interpreted as
2848
debug messages on a course of program execution. The kernel in
2849
some situations also writes to the debug board information on
2850
execution of some functions; by the agreement kernel messages
2851
begins from the prefix "K : ".
2852
For view of the debug board the application 'board' was created,
2853
which reads data from the buffer and displays them in its window.
2854
'board' interpretes the sequence of codes 13,10 as newline.
2855
A character with null code in an end of line is not necessary,
114 mikedld 2856
but also does not prevent.
118 diamond 2857
Because debugger has been written, the value of the debug board
2858
has decreased, as debugger allows to inspect completely a course of
2859
program execution without any efforts from the direction of program
2860
itself. Nevertheless in some cases the debug board is still useful.
114 mikedld 2861
 
118 diamond 2862
----------------------------- Write byte -----------------------------
114 mikedld 2863
Parameters:
118 diamond 2864
  * eax = 63 - function number
2865
  * ebx = 1 - subfunction number
2866
  * cl = data byte
114 mikedld 2867
Returned value:
2868
  * function does not return value
2869
Remarks:
118 diamond 2870
  * Byte is written to the buffer. Buffer size is 512 bytes.
2871
    At buffer overflow all obtained data are lost.
2872
  * For output to the debug board of more complicated objects
2873
    (strings, numbers) it is enough to call this function in cycle.
2874
    It is possible not to write the appropriate code manually and use
2875
    file 'debug.inc', which is included into the distributive.
114 mikedld 2876
 
118 diamond 2877
----------------------------- Read byte ------------------------------
2878
Takes away byte from the buffer.
114 mikedld 2879
Parameters:
118 diamond 2880
  * eax = 63 - function number
2881
  * ebx = 2 - subfunction number
114 mikedld 2882
Returned value:
118 diamond 2883
  * eax = ebx = 0 - the buffer is empty
2884
  * eax = byte, ebx = 1 - byte was successfully read
114 mikedld 2885
 
6057 IgorA 2886
---------------------- Constants for registers: ----------------------
2887
  eax - SF_BOARD (63)
2888
  ebx - SSF_DEBUG_WRITE (1), SSF_DEBUG_READ (2)
114 mikedld 2889
======================================================================
118 diamond 2890
============== Function 64 - resize application memory. ==============
114 mikedld 2891
======================================================================
2892
Parameters:
118 diamond 2893
  * eax = 64 - function number
2894
  * ebx = 1 - unique subfunction
2895
  * ecx = new memory size
114 mikedld 2896
Returned value:
118 diamond 2897
  * eax = 0 - success
2898
  * eax = 1 - not enough memory
114 mikedld 2899
Remarks:
193 diamond 2900
  * There is another way to dynamically allocate/free memory -
2901
    subfunctions 11, 12, 13 of function 68.
2902
  * The function cannot be used together with 68.11, 68.12, 68.13.
2903
    The function call will be ignored after creation of process heap
2904
    with function 68.11.
114 mikedld 2905
 
6057 IgorA 2906
---------------------- Constants for registers: ----------------------
2907
  eax - SF_MEMORY_RESIZE (64)
114 mikedld 2908
======================================================================
283 diamond 2909
======== Function 65 - draw image with palette in the window. ========
2910
======================================================================
2911
Parameters:
2912
  * eax = 65 - function number
2913
  * ebx = pointer to the image
2914
  * ecx = [size on axis x]*65536 + [size on axis y]
2915
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
2730 dunkaist 2916
  * esi = number of bits per pixel, must be 1,2,4,8,9,15,16,24 or 32;
1018 diamond 2917
  * edi = pointer to palette (2 to the power esi colors 0x00RRGGBB);
2918
          ignored when esi > 8
314 diamond 2919
  * ebp = offset of next row data relative to previous row data
283 diamond 2920
Returned value:
2921
  * function does not return value
2922
Remarks:
2923
  * Coordinates of the image are coordinates of the upper left corner
2924
    of the image relative to the window.
1018 diamond 2925
  * Format of image with 1 bit per pixel: each byte of image
2926
    (possibly excluding last bytes in rows), contains information on
2927
    the color of 8 pixels, MSB corresponds to first pixel.
2928
  * Format of image with 2 bits per pixel: each byte of image
2929
    (possibly excluding last bytes in rows), contains information on
2930
    the color of 4 pixels, two MSBs correspond to first pixel.
2931
  * Format of image with 4 bits per pixel: each byte of image
2932
    excluding last bytes in rows (if width is odd) contains
2933
    information on the color of 2 pixels, high-order tetrad
2934
    corresponds to first pixel.
2935
  * Format of image with 8 bits per pixel: each byte of image is
2936
    index in the palette.
2730 dunkaist 2937
  * Format of image with 9 bits per pixel: array of one byte values;
2938
    each byte (8 bit) represents the intensity of gray for one pixel;
2939
    this format is equal to 8bpp without palette.
1018 diamond 2940
  * Format of image with 15 bits per pixel: the color of each pixel
2941
    is coded as (bit representation) 0RRRRRGGGGGBBBBB - 5 bits per
2942
    each color.
2943
  * Format of image with 16 bits per pixel: the color of each pixel
2944
    is coded as RRRRRGGGGGGBBBBB (5+6+5).
2945
  * Format of image with 24 bits per pixel: the color of each pixel
2946
    is coded as 3 bytes - sequentially blue, green, red components.
2947
  * Format of image with 32 bits per pixel: similar to 24, but
2948
    one additional ignored byte is present.
314 diamond 2949
  * The call to function 7 is equivalent to call to this function
2950
    with esi=24, ebp=0.
283 diamond 2951
 
6057 IgorA 2952
---------------------- Constants for registers: ----------------------
2953
  eax - SF_PUT_IMAGE_EXT (65)
283 diamond 2954
======================================================================
118 diamond 2955
================== Function 66 - work with keyboard. =================
114 mikedld 2956
======================================================================
118 diamond 2957
The input mode influences results of reading keys by function 2.
2958
When a program loads, ASCII input mode is set for it.
114 mikedld 2959
 
118 diamond 2960
-------------- Subfunction 1 - set keyboard input mode. --------------
114 mikedld 2961
Parameters:
118 diamond 2962
  * eax = 66 - function number
2963
  * ebx = 1 - subfunction number
114 mikedld 2964
  * ecx = mode:
2965
    * 0 = normal (ASCII-characters)
2966
    * 1 = scancodes
2967
Returned value:
2968
  * function does not return value
2969
 
118 diamond 2970
-------------- Subfunction 2 - get keyboard input mode. --------------
114 mikedld 2971
Parameters:
118 diamond 2972
  * eax = 66 - function number
2973
  * ebx = 2 - subfunction number
114 mikedld 2974
Returned value:
2975
  * eax = current mode
2976
 
118 diamond 2977
------------ Subfunction 3 - get status of control keys. -------------
114 mikedld 2978
Parameters:
118 diamond 2979
  * eax = 66 - function number
2980
  * ebx = 3 - subfunction number
114 mikedld 2981
Returned value:
2982
  * eax = bit mask:
3355 mario79 2983
  * bit 0  (mask 1): left Shift is pressed
2984
  * bit 1  (mask 2): right Shift is pressed
2985
  * bit 2  (mask 4): left Ctrl is pressed
2986
  * bit 3  (mask 8): right Ctrl is pressed
2987
  * bit 4  (mask 0x10): left Alt is pressed
2988
  * bit 5  (mask 0x20): right Alt is pressed
2989
  * bit 6  (mask 0x40): CapsLock is on
2990
  * bit 7  (mask 0x80): NumLock is on
2991
  * bit 8  (mask 0x100): ScrollLock is on
2992
  * bit 9  (mask 0x200): left Win is pressed
2993
  * bit 10 (mask 0x400): right Win is pressed
118 diamond 2994
  * other bits are cleared
114 mikedld 2995
 
118 diamond 2996
-------------- Subfunction 4 - set system-wide hotkey. ---------------
2997
When hotkey is pressed, the system notifies only those applications,
2998
which have installed it; the active application (which receives
2999
all normal input) does not receive such keys.
3000
The notification consists in sending event with the code 2.
3001
Reading hotkey is the same as reading normal key - by function 2.
114 mikedld 3002
Parameters:
118 diamond 3003
  * eax = 66 - function number
3004
  * ebx = 4 - subfunction number
3005
  * cl determines key scancode;
3006
    use cl=0 to give combinations such as Ctrl+Shift
3007
  * edx = 0xXYZ determines possible states of control keys:
3008
    * Z (low 4 bits) determines state of LShift and RShift:
3009
      * 0 = no key must be pressed;
3010
      * 1 = exactly one key must be pressed;
3011
      * 2 = both keys must be pressed;
3012
      * 3 = must be pressed LShift, but not RShift;
3013
      * 4 = must be pressed RShift, but not LShift
3014
    * Y - similar for LCtrl and RCtrl;
3015
    * X - similar for LAlt and RAlt
114 mikedld 3016
Returned value:
118 diamond 3017
  * eax=0 - success
3018
  * eax=1 - too mant hotkeys (maximum 256 are allowed)
114 mikedld 3019
Remarks:
118 diamond 3020
  * Hotkey can work either at pressing or at release. Release
3021
    scancode of a key is more on 128 than pressing scancode
3022
    (i.e. high bit is set).
3023
  * Several applications can set the same combination;
3024
    all such applications will be informed on pressing
3025
    such combination.
114 mikedld 3026
 
118 diamond 3027
-------------- Subfunction 5 - delete installed hotkey. --------------
114 mikedld 3028
Parameters:
118 diamond 3029
  * eax = 66 - function number
3030
  * ebx = 5 - subfunction number
3031
  * cl = scancode of key and edx = 0xXYZ the same as in subfunction 4
114 mikedld 3032
Returned value:
118 diamond 3033
  * eax = 0 - success
114 mikedld 3034
  * eax = 1 - there is no such hotkey
3035
Remarks:
118 diamond 3036
  * When a process/thread terminates, all hotkey installed by it are
3037
    deleted.
3038
  * The call to this subfunction does not affect other applications.
3039
    If other application has defined the same combination, it will
3040
    still receive notices.
114 mikedld 3041
 
2709 mario79 3042
--------------- Subfunction 6 - block the normal input. --------------
3043
Parameters:
3044
  * eax = 66 - function number
3045
  * ebx = 6 - subfunction number
3046
Returned value:
3047
  * function does not return value
3048
Remarks:
3049
  * Blocking the normal keyboard input for installed hotkeys
3050
  * To emulate a mouse via the keyboard, the application MOUSEMUL
3051
 
3052
------------ Subfunction 7 - unlock the normal input. ----------------
3053
Parameters:
3054
  * eax = 66 - function number
3055
  * ebx = 7 - subfunction number
3056
Returned value:
3057
  * function does not return value
3058
Remarks:
3059
  * Unlocking the results of the f. 66.6
3060
  * To emulate a mouse via the keyboard, the application MOUSEMUL
3061
 
6057 IgorA 3062
---------------------- Constants for registers: ----------------------
3063
  eax - SF_KEYBOARD (66)
3064
  ebx - SSF_SET_INPUT_MODE (1), SSF_GET_INPUT_MODE (2),
3065
    SSF_GET_CONTROL_KEYS (3), SSF_SET_SYS_HOTKEY (4),
3066
    SSF_DEL_SYS_HOTKEY (5),  SSF_LOCK_INPUT (6), SSF_UNLOCK_INPUT (7)
114 mikedld 3067
======================================================================
118 diamond 3068
========= Function 67 - change position/sizes of the window. =========
114 mikedld 3069
======================================================================
3070
Parameters:
118 diamond 3071
  * eax = 67 - function number
114 mikedld 3072
  * ebx = new x-coordinate of the window
3073
  * ecx = new y-coordinate of the window
3074
  * edx = new x-size of the window
3075
  * esi = new y-size of the window
3076
Returned value:
3077
  * function does not return value
3078
Remarks:
118 diamond 3079
  * The value -1 for a parameter means "do not change"; e.g. to move
3080
    the window without resizing it is possible to specify edx=esi=-1.
3081
  * Previously the window must be defined by function 0.
114 mikedld 3082
    It sets initial coordinates and sizes of the window.
118 diamond 3083
  * Sizes of the window are understood in sense of function 0,
3084
    that is one pixel less than real sizes.
3085
  * The function call for maximized windows is simply ignored.
3086
  * For windows of appropriate styles position and/or sizes can be
3087
    changed by user; current position and sizes can be obtained by
3088
    call to function 9.
3089
  * The function sends to the window redraw event (with the code 1).
114 mikedld 3090
 
6057 IgorA 3091
---------------------- Constants for registers: ----------------------
3092
  eax - SF_CHANGE_WINDOW (67)
114 mikedld 3093
======================================================================
118 diamond 3094
====== Function 68, subfunction 0 - get the task switch counter. =====
114 mikedld 3095
======================================================================
3096
Parameters:
118 diamond 3097
  * eax = 68 - function number
3098
  * ebx = 0 - subfunction number
114 mikedld 3099
Returned value:
118 diamond 3100
  * eax = number of task switches from the system booting
3101
    (modulo 2^32)
114 mikedld 3102
 
6057 IgorA 3103
---------------------- Constants for registers: ----------------------
3104
  eax - SF_SYS_MISC (68)
3105
  ebx - SSF_GET_TASK_SWITCH_COUNT (0)
114 mikedld 3106
======================================================================
118 diamond 3107
======= Function 68, subfunction 1 - switch to the next thread. ======
114 mikedld 3108
======================================================================
118 diamond 3109
The function completes the current time slice allocated to the
3110
thread and switches to the next. (Which thread in which process
3111
will be next, is unpredictable). Later, when execution queue
3112
will reach the current thread, execution will be continued.
114 mikedld 3113
Parameters:
118 diamond 3114
  * eax = 68 - function number
3115
  * ebx = 1 - subfunction number
114 mikedld 3116
Returned value:
3117
  * function does not return value
3118
 
6057 IgorA 3119
---------------------- Constants for registers: ----------------------
3120
  eax - SF_SYS_MISC (68)
3121
  ebx - SSF_SWITCH_TASK (1)
114 mikedld 3122
======================================================================
118 diamond 3123
============= Function 68, subfunction 2 - cache + rdpmc. ============
114 mikedld 3124
======================================================================
3125
Parameters:
118 diamond 3126
  * eax = 68 - function number
3127
  * ebx = 2 - subfunction number
3128
  * ecx = required action:
3129
    * ecx = 0 - enable instruction 'rdpmc'
3130
      (ReaD Performance-Monitoring Counters) for applications
3131
    * ecx = 1 - find out whether cache is disabled/enabled
3132
    * ecx = 2 - enable cache
3133
    * ecx = 3 - disable cache
114 mikedld 3134
Returned value:
3135
  * for ecx=0:
118 diamond 3136
    * eax = the value of cr4
114 mikedld 3137
  * for ecx=1:
3138
    * eax = (cr0 and 0x60000000):
118 diamond 3139
    * eax = 0 - cache is on
3140
    * eax <> 0 - cache is off
114 mikedld 3141
  * for ecx=2 and ecx=3:
3142
    * function does not return value
3143
 
6057 IgorA 3144
---------------------- Constants for registers: ----------------------
3145
  eax - SF_SYS_MISC (68)
3146
  ebx - SSF_PERFORMANCE (2)
3147
  ecx - SSSF_ALLOW_RDPMC (0), SSSF_CACHE_STATUS (1),
3148
    SSSF_CACHE_ON (2), SSSF_CACHE_OFF (3)
114 mikedld 3149
======================================================================
3150
=========== Function 68, subfunction 3 - read MSR-register. ==========
3151
======================================================================
118 diamond 3152
MSR = Model Specific Register; the complete list of MSR-registers
3153
of a processor is included to the documentation on it (for example,
3154
IA-32 Intel Architecture Software Developer's Manual,
3155
Volume 3, Appendix B); each processor family has its own subset
3156
of the MSR-registers.
114 mikedld 3157
Parameters:
118 diamond 3158
  * eax = 68 - function number
3159
  * ebx = 3 - subfunction number
3160
  * ecx is ignored
3161
  * edx = MSR address
114 mikedld 3162
Returned value:
118 diamond 3163
  * ebx:eax = high:low dword of the result
114 mikedld 3164
Remarks:
118 diamond 3165
  * If ecx contains nonexistent or not implemented for this processor
3166
    MSR, processor will generate an exception in the kernel, which
3167
    will kill the thread.
3168
  * Previously it is necessary to check, whether MSRs are supported
3169
    as a whole, with the instruction 'cpuid'. Otherwise processor
3170
    will generate other exception in the kernel, which will anyway
3171
    kill the thread.
114 mikedld 3172
 
6057 IgorA 3173
---------------------- Constants for registers: ----------------------
3174
  eax - SF_SYS_MISC (68)
3175
  ebx - SSF_READ_MSR (3)
114 mikedld 3176
======================================================================
118 diamond 3177
========= Function 68, subfunction 4 - write to MSR-register. ========
114 mikedld 3178
======================================================================
118 diamond 3179
MSR = Model Specific Register; the complete list of MSR-registers
3180
of a processor is included to the documentation on it (for example,
3181
IA-32 Intel Architecture Software Developer's Manual,
3182
Volume 3, Appendix B); each processor family has its own subset
3183
of the MSR-registers.
114 mikedld 3184
Parameters:
118 diamond 3185
  * eax = 68 - function number
3186
  * ebx = 4 - subfunction number
3187
  * ecx is ignored
3188
  * edx = MSR address
3189
  * esi:edi = high:low dword
114 mikedld 3190
Returned value:
499 diamond 3191
  * function does not return value
3192
Remarks:
118 diamond 3193
  * If ecx contains nonexistent or not implemented for this processor
3194
    MSR, processor will generate an exception in the kernel, which
3195
    will kill the thread.
3196
  * Previously it is necessary to check, whether MSRs are supported
3197
    as a whole, with the instruction 'cpuid'. Otherwise processor
3198
    will generate other exception in the kernel, which will anyway
3199
    kill the thread.
114 mikedld 3200
 
6057 IgorA 3201
---------------------- Constants for registers: ----------------------
3202
  eax - SF_SYS_MISC (68)
3203
  ebx - SSF_WRITE_MSR (4)
114 mikedld 3204
======================================================================
193 diamond 3205
======= Function 68, subfunction 11 - initialize process heap. =======
114 mikedld 3206
======================================================================
3207
Parameters:
118 diamond 3208
  * eax = 68 - function number
193 diamond 3209
  * ebx = 11 - subfunction number
114 mikedld 3210
Returned value:
193 diamond 3211
  * eax = 0 - failed
3212
  * otherwise size of created heap
114 mikedld 3213
Remarks:
193 diamond 3214
  * The function call initializes heap, from which one can in future
3215
    allocate and free memory blocks with subfunctions 12 and 13.
3216
    Heap size is equal to total amount of free application memory.
3217
  * The second function call from the same process results in
3218
    returning the size of the existing heap.
3219
  * After creation of the heap calls to function 64 will be ignored.
114 mikedld 3220
 
6057 IgorA 3221
---------------------- Constants for registers: ----------------------
3222
  eax - SF_SYS_MISC (68)
3223
  ebx - SSF_HEAP_INIT (11)
114 mikedld 3224
======================================================================
193 diamond 3225
======== Function 68, subfunction 12 - allocate memory block. ========
114 mikedld 3226
======================================================================
3227
Parameters:
118 diamond 3228
  * eax = 68 - function number
193 diamond 3229
  * ebx = 12 - subfunction number
3230
  * ecx = required size in bytes
114 mikedld 3231
Returned value:
193 diamond 3232
  * eax = pointer to the allocated block
114 mikedld 3233
Remarks:
193 diamond 3234
  * Before this call one must initialize process heap by call to
3235
    subfunction 11.
3236
  * The function allocates an integer number of pages (4 Kb) in such
3237
    way that the real size of allocated block is more than or equal to
3238
    requested size.
114 mikedld 3239
 
6057 IgorA 3240
---------------------- Constants for registers: ----------------------
3241
  eax - SF_SYS_MISC (68)
3242
  ebx - SSF_MEM_ALLOC (12)
114 mikedld 3243
======================================================================
193 diamond 3244
========== Function 68, subfunction 13 - free memory block. ==========
114 mikedld 3245
======================================================================
3246
Parameters:
118 diamond 3247
  * eax = 68 - function number
193 diamond 3248
  * ebx = 13 - subfunction number
3249
  * ecx = pointer to the memory block
114 mikedld 3250
Returned value:
193 diamond 3251
  * eax = 1 - success
3252
  * eax = 0 - failed
114 mikedld 3253
Remarks:
448 diamond 3254
  * The memory block must have been allocated by subfunction 12
3255
    or subfunction 20.
114 mikedld 3256
 
6057 IgorA 3257
---------------------- Constants for registers: ----------------------
3258
  eax - SF_SYS_MISC (68)
3259
  ebx - SSF_MEM_FREE (13)
114 mikedld 3260
======================================================================
1074 Galkov 3261
===================== Function 68, subfunction 14 ====================
1662 Nasarus 3262
============ Wait for signal from another program/driver. ============
114 mikedld 3263
======================================================================
3264
Parameters:
118 diamond 3265
  * eax = 68 - function number
193 diamond 3266
  * ebx = 14 - subfunction number
1074 Galkov 3267
  * ecx = pointer to the buffer for information (24 bytes)
114 mikedld 3268
Returned value:
193 diamond 3269
  * buffer pointed to by ecx contains the following information:
1662 Nasarus 3270
    * +0: dword: identifier for following data of signal
3271
    * +4: dword: data of signal (20 bytes), format of which is defined
3272
          by the first dword
114 mikedld 3273
 
6057 IgorA 3274
---------------------- Constants for registers: ----------------------
3275
  eax - SF_SYS_MISC (68)
3276
  ebx - SSF_WAIT_SIGNAL (14)
114 mikedld 3277
======================================================================
193 diamond 3278
============= Function 68, subfunction 16 - load driver. =============
3279
======================================================================
3280
Parameters:
3281
  * eax = 68 - function number
3282
  * ebx = 16 - subfunction number
3283
  * ecx = pointer to ASCIIZ-string with driver name
3284
Returned value:
3285
  * eax = 0 - failed
3286
  * otherwise eax = driver handle
3287
Remarks:
3288
  * If the driver was not loaded yet, it is loaded;
3289
    if the driver was loaded yet, nothing happens.
3290
  * Driver name is case-sensitive.
3291
    Maximum length of the name is 16 characters, including
3292
    terminating null character, the rest is ignored.
346 diamond 3293
  * Driver ABC is loaded from file /rd/1/drivers/ABC.obj.
193 diamond 3294
 
6057 IgorA 3295
---------------------- Constants for registers: ----------------------
3296
  eax - SF_SYS_MISC (68)
3297
  ebx - SSF_LOAD_DRIVER (16)
193 diamond 3298
======================================================================
3299
============ Function 68, subfunction 17 - driver control. ===========
3300
======================================================================
3301
Parameters:
3302
  * eax = 68 - function number
3303
  * ebx = 17 - subfunction number
3304
  * ecx = pointer to the control structure:
3305
    * +0: dword: handle of driver
3306
    * +4: dword: code of driver function
3307
    * +8: dword: pointer to input data
3308
    * +12 = +0xC: dword: size of input data
3309
    * +16 = +0x10: dword: pointer to output data
3310
    * +20 = +0x14: dword: size of output data
3311
Returned value:
1662 Nasarus 3312
  * eax = determined by driver
193 diamond 3313
Remarks:
3314
  * Function codes and the structure of input/output data
3315
    are defined by driver.
3316
  * Previously one must obtain driver handle by subfunction 16.
3317
 
6057 IgorA 3318
---------------------- Constants for registers: ----------------------
3319
  eax - SF_SYS_MISC (68)
3320
  ebx - SSF_CONTROL_DRIVER (17)
193 diamond 3321
======================================================================
277 diamond 3322
=============== Function 68, subfunction 19 - load DLL. ==============
3323
======================================================================
3324
Parameters:
3325
  * eax = 68 - function number
3326
  * ebx = 19 - subfunction number
3327
  * ecx = pointer to ASCIIZ-string with the full path to DLL
3328
Returned value:
3329
  * eax = 0 - failed
3330
  * otherwise eax = pointer to DLL export table
3331
Remarks:
3332
  * Export table is an array of structures of 2 dword's, terminated
3333
    by zero. The first dword in structure points to function name,
3334
    the second dword contains address of function.
3335
 
6057 IgorA 3336
---------------------- Constants for registers: ----------------------
3337
  eax - SF_SYS_MISC (68)
3338
  ebx - SSF_LOAD_DLL (19)
277 diamond 3339
======================================================================
448 diamond 3340
======= Function 68, subfunction 20 - reallocate memory block. =======
3341
======================================================================
3342
Parameters:
3343
  * eax = 68 - function number
3344
  * ebx = 20 - subfunction number
3345
  * ecx = new size in bytes
3346
  * edx = pointer to already allocated block
3347
Returned value:
3348
  * eax = pointer to the reallocated block, 0 = error
3349
Remarks:
3350
  * Before this call one must initialize process heap by call to
3351
    subfunction 11.
3352
  * The function allocates an integer number of pages (4 Kb) in such
3353
    way that the real size of allocated block is more than or equal to
3354
    requested size.
3355
  * If edx=0, the function call is equivalent to memory allocation
3356
    with subfunction 12. Otherwise the block at edx
3357
    must be allocated earlier with subfunction 12 or this subfunction.
3358
  * If ecx=0, the function frees memory block at edx and returns 0.
3359
  * The contents of the block are unchanged up to the shorter of
3360
    the new and old sizes.
3361
 
6057 IgorA 3362
---------------------- Constants for registers: ----------------------
3363
  eax - SF_SYS_MISC (68)
3364
  ebx - SSF_MEM_REALLOC (20)
448 diamond 3365
======================================================================
2646 mario79 3366
=========== Function 68, subfunction 21 - load driver PE. ============
3367
======================================================================
3368
Parameters:
3369
  * eax = 68 - function number
3370
  * ebx = 21 - subfunction number
3371
  * ecx = pointer to ASCIIZ-string with driver name
2647 mario79 3372
  * edx = pointer to command line
2646 mario79 3373
Returned value:
3374
  * eax = 0 - failed
3375
  * otherwise eax = driver handle
3376
Remarks:
3377
  * If the driver was not loaded yet, it is loaded;
3378
    if the driver was loaded yet, nothing happens.
3379
 
6057 IgorA 3380
---------------------- Constants for registers: ----------------------
3381
  eax - SF_SYS_MISC (68)
3382
  ebx - SSF_LOAD_DRIVER_PE (21)
2646 mario79 3383
======================================================================
1662 Nasarus 3384
======== Function 68, subfunction 22 - open named memory area. =======
1077 Galkov 3385
======================================================================
3386
Parameters:
3387
  * eax = 68 - function number
1662 Nasarus 3388
  * ebx = 22 - subfunction number
3389
  * ecx = area name. Maximum of 31 characters with terminating zero
3390
  * edx = area size in bytes for SHM_CREATE and SHM_OPEN_ALWAYS
3391
  * esi = flags for open and access:
3392
    * SHM_OPEN        = 0x00 - open existing memory area. If an area
3393
                          with such name does not exist, the function
3394
                          will return error code 5.
3395
    * SHM_OPEN_ALWAYS = 0x04 - open existing or create new
3396
                          memory area.
3397
    * SHM_CREATE      = 0x08 - create new memory area. If an area
3398
                          with such name already exists, the function
3399
                          will return error code 10.
3400
    * SHM_READ        = 0x00 - only read access
3401
    * SHM_WRITE       = 0x01 - read and write access
3402
Returned value:
3403
  * eax = pointer to memory area, 0 if error has occured
3404
  * if new area is created (SHM_CREATE or SHM_OPEN_ALWAYS):
3405
    edx = 0 - success, otherwise - error code
3406
  * if existing area is opened (SHM_OPEN or SHM_OPEN_ALWAYS):
3407
    edx = error code (if eax=0) or area size in bytes
3408
Error codes:
3409
  * E_NOTFOUND = 5
3410
  * E_ACCESS = 10
3411
  * E_NOMEM = 30
3412
  * E_PARAM = 33
3413
Remarks:
3414
  * Before this call one must initialize process heap by call to
3415
    subfunction 11.
3416
  * If a new area is created, access flags set maximal rights
3417
    for other processes. An attempt from other process to open
3418
    with denied rights will fail with error code E_ACCESS.
3419
  * The process which has created an area always has write access.
3420
 
6057 IgorA 3421
---------------------- Constants for registers: ----------------------
3422
  eax - SF_SYS_MISC (68)
3423
  ebx - SSF_MEM_OPEN (22)
1662 Nasarus 3424
======================================================================
3425
======= Function 68, subfunction 23 - close named memory area. =======
3426
======================================================================
3427
Parameters:
3428
  * eax = 68 - function number
3429
  * ebx = 23 - subfunction number
3430
  * ecx = area name. Maximum of 31 characters with terminating zero
3431
Returned value:
3432
  * eax destroyed
3433
Remarks:
3434
  * A memory area is physically freed (with deleting all data and
3435
    freeing physical memory), when all threads which have opened
3436
    this area will close it.
3437
  * When thread is terminating, all opened by it areas are closed.
3438
 
6057 IgorA 3439
---------------------- Constants for registers: ----------------------
3440
  eax - SF_SYS_MISC (68)
3441
  ebx - SSF_MEM_CLOSE (23)
1662 Nasarus 3442
======================================================================
3443
======== Function 68, subfunction 24 - set exception handler. ========
3444
======================================================================
3445
Parameters:
3446
  * eax = 68 - function number
1077 Galkov 3447
  * ebx = 24 - subfunction number
3448
  * ecx = address of the new exception handler
1662 Nasarus 3449
  * edx = the mask of handled exceptions
1077 Galkov 3450
Returned value:
3451
  * eax = address of the old exception handler (0, if it was not set)
1662 Nasarus 3452
  * ebx = the old mask of handled exceptions
1077 Galkov 3453
Remarks:
1662 Nasarus 3454
  * Bit number in mask of exceptions corresponds to exception number
3455
    in CPU-specification (Intel-PC). For example, FPU exceptions have
3456
    number 16 (#MF), and SSE exceptions - 19 (#XF).
3457
  * The current implementation ignores the inquiry for hook of 7
3458
    exception - the system handles #NM by its own.
3459
  * The exception handler is called with exception number as first
3460
    (and only) stack parameter. So, correct exit from the handler is
3461
    RET 4. It returns to the instruction, that caused the exception,
3462
    for faults, and to the next instruction for traps (see
3463
    classification of exceptions in CPU specification).
3464
  * When user handler receives control, the corresponding bit in
3465
    the exception mask is cleared. Raising this exception
3466
    in consequence leads to default handling, that is,
3467
    terminating the application in absence of debugger or
3468
    suspend with notification of debugger otherwise.
3469
  * After user handler completes critical operations, it can set
3470
    the corresponding bit in the exception mask with subfunction 25.
3471
    Also user handler is responsible for clearing exceptions flags in
3472
    FPU and/or SSE.
1077 Galkov 3473
 
6057 IgorA 3474
---------------------- Constants for registers: ----------------------
3475
  eax - SF_SYS_MISC (68)
3476
  ebx - SSF_SET_EXCEPTION_HANDLER (24)
1077 Galkov 3477
======================================================================
5983 pathoswith 3478
======== Function 68, subfunction 25 - set exception activity ========
1077 Galkov 3479
======================================================================
3480
Parameters:
3481
  * eax = 68 - function number
3482
  * ebx = 25 - subfunction number
3483
  * ecx = signal number
3484
  * edx = value of activity (0/1)
3485
Returned value:
1662 Nasarus 3486
  * eax = -1 - invalid signal number
3487
  * otherwise eax = old value of activity for this signal (0/1)
1077 Galkov 3488
Remarks:
1662 Nasarus 3489
  * In current implementation only mask for user excepton handler,
3490
    which has been previously set by subfunction 24,
3491
    is changed. Signal number corresponds to exception number.
1077 Galkov 3492
 
6057 IgorA 3493
---------------------- Constants for registers: ----------------------
3494
  eax - SF_SYS_MISC (68)
3495
  ebx - SSF_SET_EXCEPTION_STATE (25)
1077 Galkov 3496
======================================================================
3787 Serge 3497
====== Function 68, subfunction 26 - release memory pages ============
3498
======================================================================
3499
Parameters:
3500
  * eax = 68 - function number
3501
  * ebx = 26 - subfunction number
3502
  * ecx = pointer to the memory block, allocated by subfunction 12
3503
  * edx = offset from the block beginnings
3504
  * esi = the size of the region of memory to release, in bytes
3505
Remarks:
3506
  * function release range of pages from ecx+edx to ecx+edx+esi
3507
    and set virtual memory into reserved state.
3508
 
6057 IgorA 3509
---------------------- Constants for registers: ----------------------
3510
  eax - SF_SYS_MISC (68)
3511
  ebx - SSF_MEM_FREE_EXT (26)
3787 Serge 3512
======================================================================
3513
========== Function 68, subfunction 27 - load file ===================
3514
======================================================================
3515
Parameters:
3516
  * eax = 68 - function number
3517
  * ebx = 27 - subfunction number
3518
  * ecx = pointer to ASCIIZ-string with the filename
3519
Returned value:
3520
  * eax = pointer to the loaded file, or zero
3521
  * edx = size of the loaded file, or zero
3522
Remarks:
3523
  * function loads file and unpacks, if necessary
3524
 
6057 IgorA 3525
---------------------- Constants for registers: ----------------------
3526
  eax - SF_SYS_MISC (68)
3527
  ebx - SSF_LOAD_FILE (27)
3787 Serge 3528
======================================================================
1662 Nasarus 3529
====================== Function 69 - debugging. ======================
114 mikedld 3530
======================================================================
118 diamond 3531
A process can load other process as debugged by set of corresponding
193 diamond 3532
bit by call to subfunction 7 of function 70.
118 diamond 3533
A process can have only one debugger; one process can debug some
3534
others. The system notifies debugger on events occuring with
3535
debugged process. Messages are written to the buffer defined by
114 mikedld 3536
subfunction 0.
118 diamond 3537
Format of a message:
3538
  * +0: dword: message code
3539
  * +4: dword: PID of debugged process
3540
  * +8: there can be additional data depending on message code
3541
Message codes:
114 mikedld 3542
  * 1 = exception
118 diamond 3543
    * in addition dword-number of the exception is given
3544
    * process is suspended
3545
  * 2 = process has terminated
3546
    * comes at any termination: both through the system function -1,
3547
      and at "murder" by any other process (including debugger itself)
114 mikedld 3548
  * 3 = debug exception int 1 = #DB
118 diamond 3549
    * in addition dword-image of the register DR6 is given:
3550
      * bits 0-3: condition of the corresponding breakpoint (set by
3551
        subfunction 9) is satisfied
3539 clevermous 3552
      * bit 14: exception has occured because of the trace mode
118 diamond 3553
        (flag TF is set TF)
3554
    * process is suspended
3555
When debugger terminates, all debugged processes are killed.
3556
If debugger does not want this, it must previously detach by
114 mikedld 3557
subfunction 3.
3558
 
1018 diamond 3559
All subfunctions are applicable only to processes/threads started
3560
from the current by function 70 with set debugging flag.
118 diamond 3561
Debugging of multithreaded programs is not supported yet.
3562
The full list of subfunctions:
3563
  * subfunction 0 - define data area for debug messages
3564
  * subfunction 1 - get contents of registers of debugged thread
3565
  * subfunction 2 - set contents of registers of debugged thread
3566
  * subfunction 3 - detach from debugged process
3567
  * subfunction 4 - suspend debugged thread
3568
  * subfunction 5 - resume debugged thread
3569
  * subfunction 6 - read from the memory of debugged process
3570
  * subfunction 7 - write to the memory of debugged process
3571
  * subfunction 8 - terminate debugged thread
3572
  * subfunction 9 - set/clear hardware breakpoint
114 mikedld 3573
 
6057 IgorA 3574
---------------------- Constants for registers: ----------------------
3575
  eax - SF_DEBUG (69)
3576
  ebx - SSF_SET_MESSAGE_AREA (0), SSF_GET_REGISTERS (1),
3577
    SSF_SET_REGISTERS (2), SSF_DETACH (3), SSF_SUSPEND (4),
3578
    SSF_RESUME (5), SSF_READ_MEMORY (6), SSF_WRITE_MEMORY (7),
3579
    SSF_TERMINATE (8), SSF_DEFINE_BREAKPOINT (9)
114 mikedld 3580
======================================================================
118 diamond 3581
= Function 69, subfunction 0 - define data area fror debug messages. =
114 mikedld 3582
======================================================================
3583
Parameters:
118 diamond 3584
  * eax = 69 - function number
3585
  * ebx = 0 - subfunction number
114 mikedld 3586
  * ecx = pointer
3587
Format of data area:
118 diamond 3588
  * +0: dword: N = buffer size (not including this header)
3589
  * +4: dword: occupied place
114 mikedld 3590
  * +8: N*byte: buffer
3591
Returned value:
3592
  * function does not return value
3593
Remarks:
118 diamond 3594
  * If the size field is negative, the buffer is considered locked
3595
    and at arrival of new message the system will wait.
3596
    For synchronization frame all work with the buffer by operations
3597
    lock/unlock
5871 hidnplayr 3598
        neg     [bufsize]
118 diamond 3599
  * Data in the buffer are considered as array of items with variable
3600
    length - messages. Format of a message is explained in
3601
    general description.
114 mikedld 3602
 
6057 IgorA 3603
---------------------- Constants for registers: ----------------------
3604
  eax - SF_DEBUG (69)
3605
  ebx - SSF_SET_MESSAGE_AREA (0)
114 mikedld 3606
======================================================================
118 diamond 3607
===================== Function 69, subfunction 1 =====================
3608
============ Get contents of registers of debugged thread. ===========
114 mikedld 3609
======================================================================
3610
Parameters:
118 diamond 3611
  * eax = 69 - function number
3612
  * ebx = 1 - subfunction number
114 mikedld 3613
  * ecx = thread identifier
118 diamond 3614
  * edx = size of context structure, must be 0x28=40 bytes
3615
  * esi = pointer to context structure
114 mikedld 3616
Returned value:
3617
  * function does not return value
118 diamond 3618
Format of context structure: (FPU is not supported yet)
114 mikedld 3619
  * +0: dword: eip
3620
  * +4: dword: eflags
3621
  * +8: dword: eax
3622
  * +12 = +0xC: dword: ecx
3623
  * +16 = +0x10: dword: edx
3624
  * +20 = +0x14: dword: ebx
3625
  * +24 = +0x18: dword: esp
3626
  * +28 = +0x1C: dword: ebp
3627
  * +32 = +0x20: dword: esi
3628
  * +36 = +0x24: dword: edi
3629
Remarks:
118 diamond 3630
  * If the thread executes code of ring-0, the function returns
3631
    contents of registers of ring-3.
3632
  * Process must be loaded for debugging (as is shown in
3633
    general description).
114 mikedld 3634
 
6057 IgorA 3635
---------------------- Constants for registers: ----------------------
3636
  eax - SF_DEBUG (69)
3637
  ebx - SSF_GET_REGISTERS (1)
114 mikedld 3638
======================================================================
118 diamond 3639
===================== Function 69, subfunction 2 =====================
3640
============ Set contents of registers of debugged thread. ===========
114 mikedld 3641
======================================================================
3642
Parameters:
118 diamond 3643
  * eax = 69 - function number
3644
  * ebx = 2 - subfunction number
114 mikedld 3645
  * ecx = thread identifier
118 diamond 3646
  * edx = size of context structure, must be 0x28=40 bytes
114 mikedld 3647
Returned value:
3648
  * function does not return value
118 diamond 3649
Format of context structure is shown in the description of
3650
subfunction 1.
114 mikedld 3651
Remarks:
118 diamond 3652
  * If the thread executes code of ring-0, the function returns
3653
    contents of registers of ring-3.
3654
  * Process must be loaded for debugging (as is shown in
3655
    general description).
114 mikedld 3656
 
6057 IgorA 3657
---------------------- Constants for registers: ----------------------
3658
  eax - SF_DEBUG (69)
3659
  ebx - SSF_SET_REGISTERS (2)
114 mikedld 3660
======================================================================
118 diamond 3661
===== Function 69, subfunction 3 - detach from debugged process. =====
114 mikedld 3662
======================================================================
3663
Parameters:
118 diamond 3664
  * eax = 69 - function number
3665
  * ebx = 3 - subfunction number
114 mikedld 3666
  * ecx = identifier
3667
Returned value:
3668
  * function does not return value
3669
Remarks:
118 diamond 3670
  * If the process was suspended, it resumes execution.
114 mikedld 3671
 
6057 IgorA 3672
---------------------- Constants for registers: ----------------------
3673
  eax - SF_DEBUG (69)
3674
  ebx - SSF_DETACH (3)
114 mikedld 3675
======================================================================
1018 diamond 3676
======== Function 69, subfunction 4 - suspend debugged thread. =======
114 mikedld 3677
======================================================================
3678
Parameters:
118 diamond 3679
  * eax = 69 - function number
3680
  * ebx = 4 - subfunction number
3681
  * ecx = thread identifier
114 mikedld 3682
Returned value:
3683
  * function does not return value
1018 diamond 3684
Remarks:
3685
  * Process must be loaded for debugging (as is shown in
3686
    general description).
114 mikedld 3687
 
6057 IgorA 3688
---------------------- Constants for registers: ----------------------
3689
  eax - SF_DEBUG (69)
3690
  ebx - SSF_SUSPEND (4)
114 mikedld 3691
======================================================================
1018 diamond 3692
======== Function 69, subfunction 5 - resume debugged thread. ========
114 mikedld 3693
======================================================================
3694
Parameters:
118 diamond 3695
  * eax = 69 - function number
3696
  * ebx = 5 - subfunction number
3697
  * ecx = thread identifier
114 mikedld 3698
Returned value:
3699
  * function does not return value
1018 diamond 3700
Remarks:
3701
  * Process must be loaded for debugging (as is shown in
3702
    general description).
114 mikedld 3703
 
6057 IgorA 3704
---------------------- Constants for registers: ----------------------
3705
  eax - SF_DEBUG (69)
3706
  ebx - SSF_RESUME (5)
114 mikedld 3707
======================================================================
118 diamond 3708
= Fucntion 69, subfunction 6 - read from memory of debugged process. =
114 mikedld 3709
======================================================================
3710
Parameters:
118 diamond 3711
  * eax = 69 - function number
3712
  * ebx = 6 - subfunction number
114 mikedld 3713
  * ecx = identifier
118 diamond 3714
  * edx = number of bytes to read
3715
  * esi = address in the memory of debugged process
3716
  * edi = pointer to buffer for data
114 mikedld 3717
Returned value:
118 diamond 3718
  * eax = -1 at an error (invalid PID or buffer)
3719
  * otherwise eax = number of read bytes (possibly, 0,
3720
    if esi is too large)
114 mikedld 3721
Remarks:
118 diamond 3722
  * Process must be loaded for debugging (as is shown in
3723
    general description).
114 mikedld 3724
 
6057 IgorA 3725
---------------------- Constants for registers: ----------------------
3726
  eax - SF_DEBUG (69)
3727
  ebx - SSF_READ_MEMORY (6)
114 mikedld 3728
======================================================================
118 diamond 3729
== Function 69, subfunction 7 - write to memory of debugged process. =
114 mikedld 3730
======================================================================
3731
Parameters:
118 diamond 3732
  * eax = 69 - function number
3733
  * ebx = 7 - subfunction number
114 mikedld 3734
  * ecx = identifier
118 diamond 3735
  * edx = number of bytes to write
3736
  * esi = address of memory in debugged process
3737
  * edi = pointer to data
114 mikedld 3738
Returned value:
118 diamond 3739
  * eax = -1 at an error (invalid PID or buffer)
3740
  * otherwise eax = number of written bytes (possibly, 0,
3741
    if esi is too large)
114 mikedld 3742
Remarks:
118 diamond 3743
  * Process must be loaded for debugging (as is shown in
3744
    general description).
114 mikedld 3745
 
6057 IgorA 3746
---------------------- Constants for registers: ----------------------
3747
  eax - SF_DEBUG (69)
3748
  ebx - SSF_WRITE_MEMORY (7)
114 mikedld 3749
======================================================================
118 diamond 3750
======= Function 69, subfunction 8 - terminate debugged thread. ======
114 mikedld 3751
======================================================================
3752
Parameters:
118 diamond 3753
  * eax = 69 - function number
3754
  * ebx = 8 - subfunction number
114 mikedld 3755
  * ecx = identifier
3756
Returned value:
3757
  * function does not return value
3758
Remarks:
118 diamond 3759
  * Process must be loaded for debugging (as is shown in
3760
    general description).
3761
  * The function is similar to subfunction 2 of function 18
3762
    with two differences: it requires first remark and
3763
    accepts PID rather than slot number.
114 mikedld 3764
 
6057 IgorA 3765
---------------------- Constants for registers: ----------------------
3766
  eax - SF_DEBUG (69)
3767
  ebx - SSF_TERMINATE (8)
114 mikedld 3768
======================================================================
118 diamond 3769
===== Function 69, subfunction 9 - set/clear hardware breakpoint. ====
114 mikedld 3770
======================================================================
3771
Parameters:
118 diamond 3772
  * eax = 69 - function number
3773
  * ebx = 9 - subfunction number
114 mikedld 3774
  * ecx = thread identifier
118 diamond 3775
  * dl = index of breakpoint, from 0 to 3 inclusively
114 mikedld 3776
  * dh = flags:
118 diamond 3777
    * if high bit is cleared - set breakpoint:
114 mikedld 3778
      * bits 0-1 - condition:
3779
        * 00 = breakpoint on execution
118 diamond 3780
        * 01 = breakpoint on read
3781
        * 11 = breakpoint on read/write
3782
      * bits 2-3 - length; for breakpoints on exception it must be
3783
        00, otherwise one of
3784
        * 00 = byte
114 mikedld 3785
        * 01 = word
118 diamond 3786
        * 11 = dword
3787
      * esi = breakpoint address; must be aligned according to
3788
        the length (i.e. must be even for word breakpoints,
3789
        divisible by 4 for dword)
3790
    * if high bit is set - clear breakpoint
114 mikedld 3791
Returned value:
118 diamond 3792
  * eax = 0 - success
114 mikedld 3793
  * eax = 1 - error in the input data
118 diamond 3794
  * eax = 2 - (reserved, is never returned in the current
3795
    implementation) a global breakpoint with that index is already set
114 mikedld 3796
Remarks:
118 diamond 3797
  * Process must be loaded for debugging (as is shown in
3798
    general description).
3799
  * Hardware breakpoints are implemented through DRx-registers of
3800
    the processor, all limitations results from this.
3801
  * The function can reinstall the breakpoint, previously set
3802
    by it (and it does not inform on this).
3803
    Carry on the list of set breakpoints in the debugger.
3804
  * Breakpoints generate debug exception #DB, on which the system
3805
    notifies debugger.
3806
  * Breakpoints on write and read/write act after
3807
    execution of the caused it instruction.
114 mikedld 3808
 
6057 IgorA 3809
---------------------- Constants for registers: ----------------------
3810
  eax - SF_DEBUG (69)
3811
  ebx - SSF_DEFINE_BREAKPOINT (9)
114 mikedld 3812
======================================================================
118 diamond 3813
==== Function 70 - work with file system with long names support. ====
114 mikedld 3814
======================================================================
3815
Parameters:
3816
  * eax = 70
118 diamond 3817
  * ebx = pointer to the information structure
114 mikedld 3818
Returned value:
118 diamond 3819
  * eax = 0 - success; otherwise file system error code
3820
  * some subfunctions return value in other registers too
3821
General format of the information structure:
3822
  * +0: dword: subfunction number
3823
  * +4: dword: file offset
3824
  * +8: dword: high dword of offset (must be 0) or flags field
114 mikedld 3825
  * +12 = +0xC: dword: size
118 diamond 3826
  * +16 = +0x10: dword: pointer to data
3827
  * +20 = +0x14: n db: ASCIIZ-string with the filename
114 mikedld 3828
    or
3829
  * +20 = +0x14: db 0
118 diamond 3830
  * +21 = +0x15: dd pointer to ASCIIZ-string with the filename
3831
Specifications - in documentation on the appropriate subfunction.
3832
Filename is case-insensitive. Russian letters must be written in
3833
the encoding cp866 (DOS).
3834
Format of filename:
114 mikedld 3835
/base/number/dir1/dir2/.../dirn/file,
118 diamond 3836
where /base/number identifies device, on which file is located:
114 mikedld 3837
one of
118 diamond 3838
  * /RD/1 = /RAMDISK/1 to access ramdisk
3839
  * /FD/1 = /FLOPPYDISK/1 to access first floppy drive,
3840
    /FD/2 = /FLOPPYDISK/2 to access second one
3841
  * /HD0/x, /HD1/x, /HD2/x, /HD3/x to access accordingly to devices
3842
    IDE0 (Primary Master), IDE1 (Primary Slave),
114 mikedld 3843
    IDE2 (Secondary Master), IDE3 (Secondary Slave);
118 diamond 3844
    x - partition number on the selected hard drive, varies from 1
3845
    to 255 (on each hard drive the indexing starts from 1)
3846
  * /CD0/1, /CD1/1, /CD2/1, /CD3/1 to access accordingly to
3847
    CD on IDE0 (Primary Master), IDE1 (Primary Slave),
3848
    IDE2 (Secondary Master), IDE3 (Secondary Slave)
546 diamond 3849
  * /SYS means system folder; with the usual boot (from floppy)
3850
    is equivalent to /RD/1
114 mikedld 3851
Examples:
3852
  * '/rd/1/kernel.asm',0
3853
  * '/HD0/1/kernel.asm',0
3854
  * '/hd0/2/menuet/pics/tanzania.bmp',0
3855
  * '/hd0/1/Program files/NameOfProgram/SomeFile.SomeExtension',0
546 diamond 3856
  * '/sys/MySuperApp.ini',0
3780 Serge 3857
Also function supports relative names.  If the path begins not
3858
with '/', it is considered relative to a current folder. To get or
1662 Nasarus 3859
set a current folder, use the function 30.
3860
 
118 diamond 3861
Available subfunctions:
114 mikedld 3862
  * subfunction 0 - read file
3863
  * subfunction 1 - read folder
3864
  * subfunction 2 - create/rewrite file
131 diamond 3865
  * subfunction 3 - write to existing file
133 diamond 3866
  * subfunction 4 - set file size
118 diamond 3867
  * subfunction 5 - get attributes of file/folder
3868
  * subfunction 6 - set attributes of file/folder
114 mikedld 3869
  * subfunction 7 - start application
193 diamond 3870
  * subfunction 8 - delete file/folder
321 diamond 3871
  * subfunction 9 - create folder
118 diamond 3872
For CD-drives due to hardware limitations only subfunctions
3873
0,1,5 and 7 are available, other subfunctions return error
3874
with code 2.
641 diamond 3875
At the first call of subfunctions 0,1,5,7 to ATAPI devices
3876
(CD and DVD) the manual control of tray is locked due to caching
3877
drive data. Unlocking is made when subfunction 4 of function 24
3878
is called for corresponding device.
114 mikedld 3879
 
6057 IgorA 3880
---------------------- Constants for registers: ----------------------
3881
  eax - SF_FILE (70)
3882
 [ebx] - SSF_READ_FILE (0), SSF_READ_FOLDER (1), SSF_CREATE_FILE (2),
3883
    SSF_WRITE_FILE (3), SSF_SET_END (4), SSF_GET_INFO (5),
3884
    SSF_SET_INFO (6), SSF_START_APP (7), SSF_DELETE (8),
3885
    SSF_CREATE_FOLDER (9)
114 mikedld 3886
======================================================================
118 diamond 3887
=== Function 70, subfunction 0 - read file with long names support. ==
114 mikedld 3888
======================================================================
3889
Parameters:
118 diamond 3890
  * eax = 70 - function number
3891
  * ebx = pointer to the information structure
3892
Format of the information structure:
3893
  * +0: dword: 0 = subfunction number
3894
  * +4: dword: file offset (in bytes)
3895
  * +8: dword: 0 (reserved for high dword of offset)
3896
  * +12 = +0xC: dword: number of bytes to read
3897
  * +16 = +0x10: dword: pointer to buffer for data
3898
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3899
    given in the general description
114 mikedld 3900
    or
3901
  * +20 = +0x14: db 0
118 diamond 3902
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3903
Returned value:
118 diamond 3904
  * eax = 0 - success, otherwise file system error code
3905
  * ebx = number of read bytes or -1=0xffffffff if file was not found
114 mikedld 3906
Remarks:
118 diamond 3907
  * If file was ended before last requested block was read,
3908
    the function will read as many as it can, and after that return
3909
    eax=6 (EOF).
3910
  * The function does not allow to read folder (returns eax=10,
3911
    access denied).
114 mikedld 3912
 
6057 IgorA 3913
---------------------- Constants for registers: ----------------------
3914
  eax - SF_FILE (70)
3915
 [ebx] - SSF_READ_FILE (0)
118 diamond 3916
======================================================================
3917
== Function 70, subfunction 1 - read folder with long names support. =
3918
======================================================================
114 mikedld 3919
Parameters:
118 diamond 3920
  * eax = 70 - function number
3921
  * ebx = pointer to the information structure
3922
Format of the information structure:
3923
  * +0: dword: 1 = subfunction number
3924
  * +4: dword: index of starting block (beginning from 0)
3925
  * +8: dword: flags field:
114 mikedld 3926
    * bit 0 (mask 1): in what format to return names,
3927
      0=ANSI, 1=UNICODE
118 diamond 3928
    * other bits are reserved and must be set to 0 for the future
3929
      compatibility
3930
  * +12 = +0xC: dword: number of blocks to read
3931
  * +16 = +0x10: dword: pointer to buffer for data, buffer size
3932
    must be not less than 32 + [+12]*560 bytes
3933
  * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are
3934
    given in the general description
114 mikedld 3935
    or
3936
  * +20 = +0x14: db 0
118 diamond 3937
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3938
Returned value:
118 diamond 3939
  * eax = 0 - success, otherwise file system error code
3940
  * ebx = number of files, information on which was written to
3941
    the buffer, or -1=0xffffffff, if folder was not found
114 mikedld 3942
Structure of the buffer:
3943
  * +0: 32*byte: header
3944
  * +32 = +0x20: n1*byte: block with information on file 1
118 diamond 3945
  * +32+n1: n2*byte: block with information on file 2
114 mikedld 3946
  * ...
3947
Structure of header:
118 diamond 3948
  * +0: dword: version of structure (current is 1)
3949
  * +4: dword: number of placed blocks; is not greater than requested
3950
    in the field +12 of information structure; can be less, if
3951
    there are no more files in folder (the same as in ebx)
3952
  * +8: dword: total number of files in folder
3953
  * +12 = +0xC: 20*byte: reserved (zeroed)
3954
Structure of block of data for folder entry (BDFE):
3955
  * +0: dword: attributes of file:
3956
    * bit 0 (mask 1): file is read-only
3957
    * bit 1 (mask 2): file is hidden
3958
    * bit 2 (mask 4): file is system
3959
    * bit 3 (mask 8): this is not a file but volume label
3960
      (for one partition meets no more than once and
3961
      only in root folder)
3962
    * bit 4 (mask 0x10): this is a folder
3963
    * bit 5 (mask 0x20): file was not archived - many archivation
3964
      programs have an option to archive only files with this bit set,
3965
      and after archiving this bit is cleared - it can be useful
3966
      for automatically creating of backup-archives as at writing
3967
      this bit is usually set
3968
  * +4: byte: type of name data:
3969
    (coincides with bit 0 of flags in the information structure)
3970
    * 0 = ASCII = 1-byte representation of each character
3971
    * 1 = UNICODE = 2-byte representation of each character
114 mikedld 3972
  * +5: 3*byte: reserved (zero)
118 diamond 3973
  * +8: 4*byte: time of file creation
3974
  * +12 = +0xC: 4*byte: date of file creation
3975
  * +16 = +0x10: 4*byte: time of last access (read or write)
114 mikedld 3976
  * +20 = +0x14: 4*byte: date of last access
118 diamond 3977
  * +24 = +0x18: 4*byte: time of last modification
3978
  * +28 = +0x1C: 4*byte: date of last modification
3979
  * +32 = +0x20: qword: file size in bytes (up to 16777216 Tb)
114 mikedld 3980
  * +40 = +0x28: name
118 diamond 3981
    * for ASCII format: maximum length is 263 characters
3982
      (263 bytes), byte after the name has value 0
321 diamond 3983
    * for UNICODE format: maximum length is 259 characters
118 diamond 3984
      (518 bytes), 2 bytes after the name have value 0
3985
Time format:
114 mikedld 3986
  * +0: byte: seconds
3987
  * +1: byte: minutes
3988
  * +2: byte: hours
3989
  * +3: byte: reserved (0)
118 diamond 3990
  * for example, 23.59.59 is written as (in hex) 3B 3B 17 00
3991
Date format:
3992
  * +0: byte: day
3993
  * +1: byte: month
3994
  * +2: word: year
3995
  * for example, 25.11.1979 is written as (in hex) 19 0B BB 07
114 mikedld 3996
Remarks:
118 diamond 3997
  * If BDFE contains ASCII name, the length of BDFE is 304 bytes,
3998
    if UNICODE name - 560 bytes. Value of length is aligned
3999
    on 16-byte bound (to accelerate processing in CPU cache).
4000
  * First character after a name is zero (ASCIIZ-string). The further
4001
    data contain garbage.
4002
  * If files in folder were ended before requested number was read,
4003
    the function will read as many as it can, and after that return
4004
    eax=6 (EOF).
114 mikedld 4005
  * Any folder on the disk, except for root, contains two special
118 diamond 4006
    entries "." and "..", identifying accordingly the folder itself
4007
    and the parent folder.
4008
  * The function allows also to read virtual folders "/", "/rd",
4009
    "/fd", "/hd[n]", thus attributes of subfolders are set to 0x10,
4010
    and times and dates are zeroed. An alternative way to get the
4011
    equipment information - subfunction 11 of function 18.
114 mikedld 4012
 
6057 IgorA 4013
---------------------- Constants for registers: ----------------------
4014
  eax - SF_FILE (70)
4015
 [ebx] - SSF_READ_FOLDER (1)
114 mikedld 4016
======================================================================
118 diamond 4017
===================== Function 70, subfunction 2 =====================
4018
============ Create/rewrite file with long names support. ============
114 mikedld 4019
======================================================================
4020
Parameters:
118 diamond 4021
  * eax = 70 - function number
4022
  * ebx = pointer to the information structure
4023
Format of the information structure:
4024
  * +0: dword: 2 = subfunction number
114 mikedld 4025
  * +4: dword: 0 (reserved)
4026
  * +8: dword: 0 (reserved)
4066 shikhin 4027
  * +12 = +0xC: dword: number of bytes to write
118 diamond 4028
  * +16 = +0x10: dword: pointer to data
4029
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4030
    given in the general description
114 mikedld 4031
    or
4032
  * +20 = +0x14: db 0
118 diamond 4033
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4034
Returned value:
118 diamond 4035
  * eax = 0 - success, otherwise file system error code
4036
  * ebx = number of written bytes (possibly 0)
114 mikedld 4037
Remarks:
118 diamond 4038
  * If a file with given name did not exist, it is created;
4039
    if it existed, it is rewritten.
4040
  * If there is not enough free space on disk, the function will
4041
    write as many as can and then return error code 8.
4042
  * The function is not supported for CD (returns error code 2).
114 mikedld 4043
 
6057 IgorA 4044
---------------------- Constants for registers: ----------------------
4045
  eax - SF_FILE (70)
4046
 [ebx] - SSF_CREATE_FILE (2)
114 mikedld 4047
======================================================================
131 diamond 4048
===================== Function 70, subfunction 3 =====================
4049
=========== Write to existing file with long names support. ==========
4050
======================================================================
4051
Parameters:
4052
  * eax = 70 - function number
4053
  * ebx = pointer to the information structure
4054
Format of the information structure:
4055
  * +0: dword: 3 = subfunction number
4056
  * +4: dword: file offset (in bytes)
4057
  * +8: dword: high dword of offset (must be 0 for FAT)
4058
  * +12 = +0xC: dword: number of bytes to write
4059
  * +16 = +0x10: dword: pointer to data
4060
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4061
    given in the general description
4062
    or
4063
  * +20 = +0x14: db 0
4064
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
4065
Returned value:
4066
  * eax = 0 - success, otherwise file system error code
4067
  * ebx = number of written bytes (possibly 0)
4068
Remarks:
4069
  * The file must already exist, otherwise function returns eax=5.
4070
  * The only result of write 0 bytes is update in the file attributes
4071
    date/time of modification and access to the current date/time.
4072
  * If beginning and/or ending position is greater than file size
4073
    (except for the previous case), the file is expanded to needed
4074
    size with zero characters.
133 diamond 4075
  * The function is not supported for CD (returns error code 2).
131 diamond 4076
 
6057 IgorA 4077
---------------------- Constants for registers: ----------------------
4078
  eax - SF_FILE (70)
4079
 [ebx] - SSF_WRITE_FILE (3)
131 diamond 4080
======================================================================
133 diamond 4081
============ Function 70, subfunction 4 - set end of file. ===========
4082
======================================================================
4083
Parameters:
4084
  * eax = 70 - function number
4085
  * ebx = pointer to the information structure
4086
Format of the information structure:
4087
  * +0: dword: 4 = subfunction number
4088
  * +4: dword: low dword of new file size
4089
  * +8: dword: high dword of new file size (must be 0 for FAT)
4090
  * +12 = +0xC: dword: 0 (reserved)
4091
  * +16 = +0x10: dword: 0 (reserved)
4092
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4093
    given in the general description
4094
    or
4095
  * +20 = +0x14: db 0
4096
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
4097
Returned value:
4098
  * eax = 0 - success, otherwise file system error code
4099
  * ebx destroyed
4100
Remarks:
4101
  * If the new file size is less than old one, file is truncated.
4102
    If the new size is greater than old one, file is expanded with
4103
    characters with code 0. If the new size is equal to old one,
4104
    the only result of call is set date/time of modification and
4105
    access to the current date/time.
4106
  * If there is not enough free space on disk for expansion, the
4107
    function will expand to maximum possible size and then return
4108
    error code 8.
4109
  * The function is not supported for CD (returns error code 2).
4110
 
6057 IgorA 4111
---------------------- Constants for registers: ----------------------
4112
  eax - SF_FILE (70)
4113
 [ebx] - SSF_SET_END (4)
133 diamond 4114
======================================================================
118 diamond 4115
==== Function 70, subfunction 5 - get information on file/folder. ====
114 mikedld 4116
======================================================================
4117
Parameters:
118 diamond 4118
  * eax = 70 - function number
4119
  * ebx = pointer to the information structure
4120
Format of the information structure:
4121
  * +0: dword: 5 = subfunction number
114 mikedld 4122
  * +4: dword: 0 (reserved)
4123
  * +8: dword: 0 (reserved)
4124
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 4125
  * +16 = +0x10: dword: pointer to buffer for data (40 bytes)
4126
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4127
    given in the general description
114 mikedld 4128
    or
4129
  * +20 = +0x14: db 0
118 diamond 4130
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4131
Returned value:
118 diamond 4132
  * eax = 0 - success, otherwise file system error code
4133
  * ebx destroyed
4134
Information on file is returned in the BDFE format (block of data
4135
for folder entry), explained in the description of
4136
subfunction 1, but without filename
4137
(i.e. only first 40 = 0x28 bytes).
114 mikedld 4138
Remarks:
118 diamond 4139
  * The function does not support virtual folders such as /, /rd and
4140
    root folders like /rd/1.
114 mikedld 4141
 
6057 IgorA 4142
---------------------- Constants for registers: ----------------------
4143
  eax - SF_FILE (70)
4144
 [ebx] - SSF_GET_INFO (5)
114 mikedld 4145
======================================================================
118 diamond 4146
===== Function 70, subfunction 6 - set attributes of file/folder. ====
114 mikedld 4147
======================================================================
4148
Parameters:
118 diamond 4149
  * eax = 70 - function number
4150
  * ebx = pointer to the information structure
4151
Format of the information structure:
4152
  * +0: dword: 6 = subfunction number
114 mikedld 4153
  * +4: dword: 0 (reserved)
4154
  * +8: dword: 0 (reserved)
4155
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 4156
  * +16 = +0x10: dword: pointer to buffer with attributes (32 bytes)
4157
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4158
    given in the general description
114 mikedld 4159
    or
4160
  * +20 = +0x14: db 0
118 diamond 4161
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4162
Returned value:
118 diamond 4163
  * eax = 0 - success, otherwise file system error code
4164
  * ebx destroyed
4165
File attributes are first 32 bytes in BDFE (block of data
4166
for folder entry), explained in the description of subfunction 1
4167
(that is, without name and size of file). Attribute
4168
file/folder/volume label (bits 3,4 in dword +0) is not changed.
4169
Byte +4 (name format) is ignored.
114 mikedld 4170
Remarks:
118 diamond 4171
  * The function does not support virtual folders such as /, /rd and
4172
    root folders like /rd/1.
4173
  * The function is not supported for CD (returns error code 2).
114 mikedld 4174
 
6057 IgorA 4175
---------------------- Constants for registers: ----------------------
4176
  eax - SF_FILE (70)
4177
 [ebx] - SSF_SET_INFO (6)
114 mikedld 4178
======================================================================
118 diamond 4179
=========== Function 70, subfunction 7 - start application. ==========
114 mikedld 4180
======================================================================
4181
Parameters:
118 diamond 4182
  * eax = 70 - function number
4183
  * ebx = pointer to the information structure
4184
Format of the information structure:
4185
  * +0: dword: 7 = subfunction number
4186
  * +4: dword: flags field:
3539 clevermous 4187
    * bit 0: start process as debugged
118 diamond 4188
    * other bits are reserved and must be set to 0
4189
  * +8: dword: 0 or pointer to ASCIIZ-string with parameters
114 mikedld 4190
  * +12 = +0xC: dword: 0 (reserved)
4191
  * +16 = +0x10: dword: 0 (reserved)
118 diamond 4192
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4193
    given in the general description
114 mikedld 4194
    or
4195
  * +20 = +0x14: db 0
118 diamond 4196
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 4197
Returned value:
4198
  * eax > 0 - program is loaded, eax contains PID
118 diamond 4199
  * eax < 0 - an error has occured, -eax contains
4200
    file system error code
4201
  * ebx destroyed
114 mikedld 4202
Remarks:
118 diamond 4203
  * Command line must be terminated by the character with the code 0
4204
    (ASCIIZ-string); function takes into account either all characters
4205
    up to terminating zero inclusively or first 256 character
4206
    regarding what is less.
4207
  * If the process is started as debugged, it is created in
4208
    the suspended state; to run use subfunction 5 of function 69.
114 mikedld 4209
 
6057 IgorA 4210
---------------------- Constants for registers: ----------------------
4211
  eax - SF_FILE (70)
4212
 [ebx] - SSF_START_APP (7)
114 mikedld 4213
======================================================================
193 diamond 4214
========== Function 70, subfunction 8 - delete file/folder. ==========
4215
======================================================================
4216
Parameters:
4217
  * eax = 70 - function number
4218
  * ebx = pointer to the information structure
4219
Format of the information structure:
4220
  * +0: dword: 8 = subfunction number
4221
  * +4: dword: 0 (reserved)
4222
  * +8: dword: 0 (reserved)
4223
  * +12 = +0xC: dword: 0 (reserved)
4224
  * +16 = +0x10: dword: 0 (reserved)
4225
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
4226
    given in the general description
4227
    or
4228
  * +20 = +0x14: db 0
4229
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
4230
Returned value:
4231
  * eax = 0 - success, otherwise file system error code
4232
  * ebx destroyed
4233
Remarks:
4234
  * The function is not supported for CD (returns error code 2).
4235
  * The function can delete only empty folders (attempt to delete
4236
    nonempty folder results in error with code 10, "access denied").
4237
 
6057 IgorA 4238
---------------------- Constants for registers: ----------------------
4239
  eax - SF_FILE (70)
4240
 [ebx] - SSF_DELETE (8)
193 diamond 4241
======================================================================
321 diamond 4242
============= Function 70, subfunction 9 - create folder. ============
4243
======================================================================
4244
Parameters:
4245
  * eax = 70 - function number
4246
  * ebx = pointer to the information structure
4247
Format of the information structure:
4248
  * +0: dword: 9 = subfunction number
4249
  * +4: dword: 0 (reserved)
4250
  * +8: dword: 0 (reserved)
4251
  * +12 = +0xC: dword: 0 (reserved)
4252
  * +16 = +0x10: dword: 0 (reserved)
4253
  * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are
4254
    given in the general description
4255
    or
4256
  * +20 = +0x14: db 0
4257
  * +21 = +0x15: dd pointer to ASCIIZ-string with folder name
4258
Returned value:
4259
  * eax = 0 - success, otherwise file system error code
4260
  * ebx destroyed
4261
Remarks:
4262
  * The function is not supported for CD (returns error code 2).
4263
  * The parent folder must already exist.
4264
  * If target folder already exists, function returns success (eax=0).
4265
 
6057 IgorA 4266
---------------------- Constants for registers: ----------------------
4267
  eax - SF_FILE (70)
4268
 [ebx] - SSF_CREATE_FOLDER (9)
321 diamond 4269
======================================================================
118 diamond 4270
========== Function 71, subfunction 1 - set window caption. ==========
114 mikedld 4271
======================================================================
4272
Parameters:
4273
  * eax = 71 - function number
4274
  * ebx = 1 - subfunction number
5926 pathoswith 4275
  * ecx = pointer to zero terminated string
114 mikedld 4276
Returned value:
118 diamond 4277
  * function does not return value
114 mikedld 4278
Remarks:
5926 pathoswith 4279
  * You may set the caption string encoding by putting
4280
    at the start of the string a byte with next values:
4281
    1 = cp866
4282
    2 = UTF-16LE
4283
    3 = UTF-8
4284
    otherwise will be used cp866.
118 diamond 4285
  * Pass NULL in ecx to remove caption.
114 mikedld 4286
 
6057 IgorA 4287
---------------------- Constants for registers: ----------------------
4288
  eax - SF_SET_CAPTION (71)
114 mikedld 4289
======================================================================
665 diamond 4290
=============== Function 72 - send message to a window. ==============
4291
======================================================================
4292
 
4293
- Subfunction 1 - send message with parameter to the active window. --
4294
Parameters:
4295
  * eax = 72 - function number
4296
  * ebx = 1 - subfunction number
4297
  * ecx = event code: 2 or 3
4298
  * edx = parameter: key code for ecx=2, button identifier for ecx=3
4299
Returned value:
4300
  * eax = 0 - success
4301
  * eax = 1 - buffer is full
4302
 
6057 IgorA 4303
---------------------- Constants for registers: ----------------------
4304
  eax - SF_SEND_MESSAGE (72)
665 diamond 4305
======================================================================
3315 mario79 4306
===================== Function 73 - blit bitmap  =====================
4307
======================================================================
4308
 
4309
Parameters:
4310
  * eax = 73 - function number
4311
 
4312
  * ebx = ROP and optional flags
4313
     31           6 5  4 3   0
4314
     [  reserved  ][T][B][ROP]
4315
     ROP - raster operation code
4316
        0: Copy
4317
     1-15: reserved
4318
     B   - blit into the background surface
4319
     T   - transparent blit
4320
 
4321
  * ecx = pointer to the function parameters
4322
        destination offset and clipping
4323
     +0 signed dword: destination rectangle X offset from the window
4324
                      top-left corner
4325
     +4 signed dword: destination rectangle Y offset from the window
4326
                      top-left corner
4327
     +8 dword:        destination rectangle width
4328
    +12 dword:        destination rectangle height
4329
 
4330
        source offset and clipping
4331
    +16 signed dword: source rectangle X offset from the bitmap
4332
                      top-left corner
4333
    +20 signed dword: source rectangle Y offset from the bitmap
4334
                      top-left corner
4335
    +24 dword:        source rectangle width
4336
    +28 dword:        source rectangle height
4337
 
3338 mario79 4338
    +32: dword: bitmap data - must be 32bpp
4339
    +36: dword: size of the bitmap row in bytes
3315 mario79 4340
 
4341
Returned value:
4342
  * function does not return value
4343
 
6057 IgorA 4344
---------------------- Constants for registers: ----------------------
4345
  eax - SF_BLITTER (73)
3315 mario79 4346
======================================================================
5871 hidnplayr 4347
= Function 74, Subfunction 255, Get number of active network devices. =
3571 hidnplayr 4348
======================================================================
4349
Parameters:
4350
  * eax = 74 - function number
5871 hidnplayr 4351
  * bl = 255 - subfunction number
3571 hidnplayr 4352
Returned value:
4353
  * eax = number of active network devices
4354
 
6057 IgorA 4355
---------------------- Constants for registers: ----------------------
4356
  eax - SF_NETWORK_GET (74)
4357
   bl - SSF_DEVICE_COUNT (255)
3571 hidnplayr 4358
======================================================================
4359
======== Function 74, Subfunction 0, Get network device type. ========
4360
======================================================================
4361
Parameters:
4362
  * eax = 74 - function number
4363
  * bl = 0 - subfunction number
4364
  * bh = device number
4365
Returned value:
5871 hidnplayr 4366
  * eax = device type number
3571 hidnplayr 4367
 
6057 IgorA 4368
---------------------- Constants for registers: ----------------------
4369
  eax - SF_NETWORK_GET (74)
4370
   bl - SSF_DEVICE_TYPE (0)
3571 hidnplayr 4371
======================================================================
4372
======== Function 74, Subfunction 1, Get network device name. ========
4373
======================================================================
4374
Parameters:
4375
  * eax = 74 - function number
4376
  * bl = 1 - subfunction number
4377
  * bh = device number
4378
  * ecx = pointer to 64 byte buffer
4379
Returned value:
4380
  * eax = -1 on error
4381
  * The network device name is written into the buffer, on success
4382
 
6057 IgorA 4383
---------------------- Constants for registers: ----------------------
4384
  eax - SF_NETWORK_GET (74)
4385
   bl - SSF_DEVICE_NAME (1)
3571 hidnplayr 4386
======================================================================
4387
========= Function 74, Subfunction 2, Reset network device. ==========
4388
======================================================================
4389
Parameters:
4390
  * eax = 74 - function number
4391
  * bl = 2 - subfunction number
4392
  * bh = device number
4393
Returned value:
4394
  * eax = -1 on error
4395
 
6057 IgorA 4396
---------------------- Constants for registers: ----------------------
4397
  eax - SF_NETWORK_GET (74)
4398
   bl - SSF_RESET_DEVICE (2)
3571 hidnplayr 4399
======================================================================
4400
========== Function 74, Subfunction 3, Stop network device. ==========
4401
======================================================================
4402
Parameters:
4403
  * eax = 74 - function number
4404
  * bl = 3 - subfunction number
4405
  * bh = device number
4406
Returned value:
4407
  * eax = -1 on error
5983 pathoswith 4408
 
6057 IgorA 4409
---------------------- Constants for registers: ----------------------
4410
  eax - SF_NETWORK_GET (74)
4411
   bl - SSF_STOP_DEVICE (3)
5871 hidnplayr 4412
======================================================================
4413
=========== Function 74, Subfunction 4, Get device pointer. ==========
4414
======================================================================
4415
Parameters:
4416
  * eax = 74 - function number
4417
  * bl = 4 - subfunction number
4418
  * bh = device number
4419
Returned value:
5983 pathoswith 4420
  * eax = device pointer, -1 on error
4421
 
6057 IgorA 4422
---------------------- Constants for registers: ----------------------
4423
  eax - SF_NETWORK_GET (74)
4424
   bl - SSF_DEVICE_POINER (4)
5871 hidnplayr 4425
======================================================================
4426
========= Function 74, Subfunction 6, Get packet TX counter. =========
4427
======================================================================
4428
Parameters:
4429
  * eax = 74 - function number
4430
  * bl = 6 - subfunction number
4431
  * bh = device number
4432
Returned value:
4433
  * eax = Number of packets sent since device start, -1 on error
5983 pathoswith 4434
 
6057 IgorA 4435
---------------------- Constants for registers: ----------------------
4436
  eax - SF_NETWORK_GET (74)
4437
   bl - SSF_TX_PACKET_COUNT (6)
5871 hidnplayr 4438
======================================================================
4439
========= Function 74, Subfunction 7, Get packet RX counter. =========
4440
======================================================================
4441
Parameters:
4442
  * eax = 74 - function number
4443
  * bl = 7 - subfunction number
4444
  * bh = device number
4445
Returned value:
4446
  * eax = Number of packets received since device start, -1 on error
5983 pathoswith 4447
 
6057 IgorA 4448
---------------------- Constants for registers: ----------------------
4449
  eax - SF_NETWORK_GET (74)
4450
   bl - SSF_RX_PACKET_COUNT (7)
5871 hidnplayr 4451
======================================================================
4452
========== Function 74, Subfunction 8, Get TX byte counter. ==========
4453
======================================================================
4454
Parameters:
4455
  * eax = 74 - function number
4456
  * bl = 8 - subfunction number
4457
  * bh = device number
4458
Returned value:
4459
  * eax = Number of bytes sent since device start (lower dword)
4460
                  -1 on error
4461
  * ebx = Number of bytes sent since device start (higher dword)
3571 hidnplayr 4462
 
6057 IgorA 4463
---------------------- Constants for registers: ----------------------
4464
  eax - SF_NETWORK_GET (74)
4465
   bl - SSF_TX_BYTE_COUNT (8)
3571 hidnplayr 4466
======================================================================
5871 hidnplayr 4467
========== Function 74, Subfunction 9, Get RX byte counter. ==========
4468
======================================================================
4469
Parameters:
4470
  * eax = 74 - function number
4471
  * bl = 9 - subfunction number
4472
  * bh = device number
4473
Returned value:
4474
  * eax = Number of bytes received since device start (lower dword)
4475
                  -1 on error
4476
  * ebx = Number of bytes received since device start (higher dword)
5983 pathoswith 4477
 
6057 IgorA 4478
---------------------- Constants for registers: ----------------------
4479
  eax - SF_NETWORK_GET (74)
4480
   bl - SSF_RX_BYTE_COUNT (9)
5871 hidnplayr 4481
======================================================================
4482
========== Function 74, Subfunction 10, Get link status. =============
4483
======================================================================
4484
Parameters:
4485
  * eax = 74 - function number
4486
  * bl = 10 - subfunction number
4487
  * bh = device number
4488
Returned value:
4489
  * eax = link status, -1 on error
5983 pathoswith 4490
 
5871 hidnplayr 4491
  Link status:
4492
    ETH_LINK_DOWN   =    0b         ; Link is down
4493
    ETH_LINK_UNKNOWN=    1b         ; There could be an active link
4494
    ETH_LINK_FD     =   10b         ; full duplex flag
4495
    ETH_LINK_10M    =  100b         ; 10 mbit
4496
    ETH_LINK_100M   = 1000b         ; 100 mbit
5983 pathoswith 4497
    ETH_LINK_1G     = 1100b         ; gigabit
4498
 
6057 IgorA 4499
---------------------- Constants for registers: ----------------------
4500
  eax - SF_NETWORK_GET (74)
4501
   bl - SSF_LINK_STATUS (10)
5871 hidnplayr 4502
======================================================================
3571 hidnplayr 4503
============== Function 75, Subfunction 0, Open socket. ==============
4504
======================================================================
4505
Parameters:
4506
  * eax = 75 - function number
4507
  * bl = 0 - subfunction number
4508
  * ecx = domain
4509
  * edx = type
4510
  * esi = protocol
4511
Returned value:
4512
  * eax = socket number, -1 on error
3867 hidnplayr 4513
  * ebx = errorcode
3571 hidnplayr 4514
 
6057 IgorA 4515
---------------------- Constants for registers: ----------------------
4516
  eax - SF_NETWORK_SOCKET (75)
4517
   bl - SSF_OPEN (0)
3571 hidnplayr 4518
======================================================================
4519
============= Function 75, Subfunction 1, Close socket. ==============
4520
======================================================================
4521
Parameters:
4522
  * eax = 75 - function number
4523
  * bl = 1 - subfunction number
4524
  * ecx = socket number
4525
Returned value:
4526
  * eax = -1 on error
3867 hidnplayr 4527
  * ebx = errorcode
3571 hidnplayr 4528
 
6057 IgorA 4529
---------------------- Constants for registers: ----------------------
4530
  eax - SF_NETWORK_SOCKET (75)
4531
   bl - SSF_CLOSE (1)
3571 hidnplayr 4532
======================================================================
4533
================== Function 75, Subfunction 2, Bind. =================
4534
======================================================================
4535
Parameters:
4536
  * eax = 75 - function number
4537
  * bl = 2 - subfunction number
4538
  * ecx = socket number
4539
  * edx = pointer to sockaddr structure
4540
  * esi = length of sockaddr structure
4541
Returned value:
4542
  * eax = -1 on error
3867 hidnplayr 4543
  * ebx = errorcode
3571 hidnplayr 4544
 
6057 IgorA 4545
---------------------- Constants for registers: ----------------------
4546
  eax - SF_NETWORK_SOCKET (75)
4547
   bl - SSF_BIND (2)
3571 hidnplayr 4548
======================================================================
4549
================= Function 75, Subfunction 3, Listen. ================
4550
======================================================================
4551
Parameters:
4552
  * eax = 75 - function number
4553
  * bl = 3 - subfunction number
4554
  * ecx = socket number
4555
  * edx = backlog
4556
Returned value:
4557
  * eax = -1 on error
3867 hidnplayr 4558
  * ebx = errorcode
3571 hidnplayr 4559
 
6057 IgorA 4560
---------------------- Constants for registers: ----------------------
4561
  eax - SF_NETWORK_SOCKET (75)
4562
   bl - SSF_LISTEN (3)
3571 hidnplayr 4563
======================================================================
4564
================ Function 75, Subfunction 4, Connect. ================
4565
======================================================================
4566
Parameters:
4567
  * eax = 75 - function number
4568
  * bl = 4 - subfunction number
4569
  * ecx = socket number
4570
  * edx = pointer to sockaddr structure
4571
  * esi = length of sockaddr structure
4572
Returned value:
4573
  * eax = -1 on error
3867 hidnplayr 4574
  * ebx = errorcode
3571 hidnplayr 4575
 
6057 IgorA 4576
---------------------- Constants for registers: ----------------------
4577
  eax - SF_NETWORK_SOCKET (75)
4578
   bl - SSF_CONNECT (4)
3571 hidnplayr 4579
======================================================================
4580
================= Function 75, Subfunction 5, Accept. ================
4581
======================================================================
4582
Parameters:
4583
  * eax = 75 - function number
4584
  * bl = 5 - subfunction number
4585
  * ecx = socket number
4586
  * edx = pointer to sockaddr structure
4587
  * esi = length of sockaddr structure
4588
Returned value:
3867 hidnplayr 4589
  * eax = socket number of accepted socket, -1 on error
4590
  * ebx = errorcode
3571 hidnplayr 4591
 
6057 IgorA 4592
---------------------- Constants for registers: ----------------------
4593
  eax - SF_NETWORK_SOCKET (75)
4594
   bl - SSF_ACCEPT (5)
3571 hidnplayr 4595
======================================================================
4596
================== Function 75, Subfunction 6, Send. =================
4597
======================================================================
4598
Parameters:
4599
  * eax = 75 - function number
4600
  * bl = 6 - subfunction number
4601
  * ecx = socket number
4602
  * edx = pointer to buffer
4603
  * esi = length of buffer
3867 hidnplayr 4604
  * edi = flags
3571 hidnplayr 4605
Returned value:
4606
  * eax = number of bytes copied, -1 on error
3867 hidnplayr 4607
  * ebx = errorcode
3571 hidnplayr 4608
 
6057 IgorA 4609
---------------------- Constants for registers: ----------------------
4610
  eax - SF_NETWORK_SOCKET (75)
4611
   bl - SSF_SEND (6)
3571 hidnplayr 4612
======================================================================
4613
================ Function 75, Subfunction 7, Receive. ================
4614
======================================================================
4615
Parameters:
4616
  * eax = 75 - function number
4617
  * bl = 7 - subfunction number
4618
  * ecx = socket number
4619
  * edx = pointer to buffer
4620
  * esi = length of buffer
4621
  * edi = flags
4622
Returned value:
4623
  * eax = number of bytes copied, -1 on error
3867 hidnplayr 4624
  * ebx = errorcode
3571 hidnplayr 4625
 
6057 IgorA 4626
---------------------- Constants for registers: ----------------------
4627
  eax - SF_NETWORK_SOCKET (75)
4628
   bl - SSF_RECEIVE (7)
3571 hidnplayr 4629
======================================================================
4630
=========== Function 75, Subfunction 8, Set socket options. ==========
4631
======================================================================
4632
Parameters:
4633
  * eax = 75 - function number
4634
  * bl = 8 - subfunction number
4635
  * ecx = socket number
4636
  * edx = pointer to optstruct
4637
Returned value:
4638
  * eax = -1 on error
3867 hidnplayr 4639
  * ebx = errorcode
3571 hidnplayr 4640
Remarks:
4641
 
6079 serge 4642
  Optstruct:
5871 hidnplayr 4643
    dd level
4644
    dd optionname
4645
    dd optlength
4646
    db options...
3571 hidnplayr 4647
 
6057 IgorA 4648
---------------------- Constants for registers: ----------------------
4649
  eax - SF_NETWORK_SOCKET (75)
4650
   bl - SSF_SET_OPTIONS (8)
3571 hidnplayr 4651
======================================================================
4652
=========== Function 75, Subfunction 9, Get socket options. ==========
4653
======================================================================
4654
Parameters:
4655
  * eax = 75 - function number
4656
  * bl = 9 - subfunction number
4657
  * ecx = socket number
4658
  * edx = pointer to optstruct
4659
Returned value:
4660
  * eax = -1 on error
3867 hidnplayr 4661
  * ebx = errorcode
3571 hidnplayr 4662
Remarks:
4663
 
6079 serge 4664
  Optstruct:
5871 hidnplayr 4665
    dd level
4666
    dd optionname
4667
    dd optlength
4668
    db options...
3571 hidnplayr 4669
 
6057 IgorA 4670
---------------------- Constants for registers: ----------------------
4671
  eax - SF_NETWORK_SOCKET (75)
4672
   bl - SSF_GET_OPTIONS (9)
3571 hidnplayr 4673
======================================================================
6235 pathoswith 4674
============ Function 75, Subfunction 10, Get socketpair. ============
3571 hidnplayr 4675
======================================================================
4676
Parameters:
4677
  * eax = 75 - function number
4678
  * bl = 10 - subfunction number
4679
Returned value:
4680
  * eax = socketnum1, -1 on error
3867 hidnplayr 4681
  * ebx = socketnum2, errorcode on error
6057 IgorA 4682
 
4683
---------------------- Constants for registers: ----------------------
4684
  eax - SF_NETWORK_SOCKET (75)
4685
   bl - SSF_GET_PAIR (10)
5871 hidnplayr 4686
======================================================================
4687
============ Function 76, Network options and statistics. ============
4688
======================================================================
4689
Parameters:
4690
  * eax = 76 - function number
4691
  * high half of ebx = protocol number
4692
  * bh = device number
4693
  * bl = subfunction number
3571 hidnplayr 4694
 
6235 pathoswith 4695
Protocols and subfunctions:
4696
 
4697
 
5871 hidnplayr 4698
 
6079 serge 4699
 
6235 pathoswith 4700
    common subfunctions:
4701
 
4702
        1 - Read # packets received
4703
 
4704
1 - IPv4:
5871 hidnplayr 4705
        2 - Read IP
4706
        3 - Write IP
4707
        4 - Read DNS
4708
        5 - Write DNS
4709
        6 - Read subnet
4710
        7 - Write subnet
4711
        8 - Read gateway
4712
        9 - Write gateway
6079 serge 4713
 
6235 pathoswith 4714
2 - ICMP:
5871 hidnplayr 4715
        3 - enable/disable ICMP echo reply
4716
 
6235 pathoswith 4717
3 - UDP
4718
4 - TCP
5871 hidnplayr 4719
 
6235 pathoswith 4720
5 - ARP:
5871 hidnplayr 4721
        2 - Read # ARP entry's
4722
        3 - Read ARP entry
4723
        4 - Add static ARP entry
4724
        5 - Remove ARP entry (-1 = remove all)
4725
        6 - Send ARP announce on specified interface
6079 serge 4726
        7 - Read # ARP conflicts (IP address conflicts)
5871 hidnplayr 4727
 
6057 IgorA 4728
---------------------- Constants for registers: ----------------------
4729
  eax - SF_NETWORK_PROTOCOL (76)
3571 hidnplayr 4730
======================================================================
6079 serge 4731
========== Function 77, Subfunction 0, Create futex object ===========
4732
======================================================================
4733
Parameters:
4734
  * eax = 77 - function number
4735
  * ebx = 0 - subfunction number
4736
  * ecx = pointer to futex dword
4737
Returned value:
4738
  * eax = futex handle, 0 on error
4739
Remarks:
4740
  * Use subfunction 1 to destroy the futex.
4741
    The kernel destroys the futexes automatically when the process
4742
    terminates.
6235 pathoswith 4743
 
4744
---------------------- Constants for registers: ----------------------
4745
  eax - SF_FUTEX (77)
4746
  ebx - SSF_CREATE (0)
6079 serge 4747
======================================================================
4748
========= Function 77, Subfunction 1, Destroy futex object ===========
4749
======================================================================
4750
Parameters:
4751
  * eax = 77 - function number
4752
  * ebx = 1 - subfunction number
4753
  * ecx = futex handle
4754
Returned value:
4755
  * eax = 0 - successfull, -1 on error
4756
Remarks:
4757
  * The futex handle must have been created by subfunction 0
4758
 
6235 pathoswith 4759
---------------------- Constants for registers: ----------------------
4760
  eax - SF_FUTEX (77)
4761
  ebx - SSF_DESTROY (1)
6079 serge 4762
======================================================================
4763
=============== Function 77, Subfunction 2, Futex wait ===============
4764
======================================================================
4765
Parameters:
4766
  * eax = 77 - function number
4767
  * ebx = 2 - subfunction number
4768
  * ecx = futex handle
4769
  * edx = control value
4770
  * esi = timeout in system ticks or 0 for infinity
4771
Returned value:
6089 serge 4772
  * eax = 0 - successfull
4773
	 -1 - timeout
4774
	 -2 - futex dword does not have the same value as edx
6079 serge 4775
Remarks:
4776
  * This functionn tests that the value at the futex dword still
4777
    contains the expected control value, and if so, then sleeps
4778
    waiting for a wake operation on the futex.
4779
  * The futex handle must have been created by subfunction 0
4780
 
6235 pathoswith 4781
---------------------- Constants for registers: ----------------------
4782
  eax - SF_FUTEX (77)
4783
  ebx - SSF_WAIT (2)
6079 serge 4784
======================================================================
4785
=============== Function 77, Subfunction 3, Futex wake ===============
4786
======================================================================
4787
Parameters:
4788
  * eax = 77 - function number
4789
  * ebx = 3 - subfunction number
4790
  * ecx = futex handle
4791
  * edx = number of waiters to wake
4792
Returned value:
4793
  * eax = number of waiters that were woken up
4794
 
4795
Remarks:
4796
  * This function wakes at most edx of the waiters that are
4797
    waiting (e.g., inside futex wait) on the futex dword
4798
  * The futex handle must have been created by subfunction 0
4799
 
6235 pathoswith 4800
---------------------- Constants for registers: ----------------------
4801
  eax - SF_FUTEX (77)
4802
  ebx - SSF_WAKE (3)
6079 serge 4803
======================================================================
118 diamond 4804
=============== Function -1 - terminate thread/process ===============
114 mikedld 4805
======================================================================
4806
Parameters:
118 diamond 4807
  * eax = -1 - function number
114 mikedld 4808
Returned value:
118 diamond 4809
  * function does not return neither value nor control
114 mikedld 4810
Remarks:
118 diamond 4811
  * If the process did not create threads obviously, it has only
4812
    one thread, which termination results in process termination.
4813
  * If the current thread is last in the process, its termination
4814
    also results in process terminates.
4815
  * This function terminates the current thread. Other thread can be
4816
    killed by call to subfunction 2 of function 18.
114 mikedld 4817
 
6235 pathoswith 4818
---------------------- Constants for registers: ----------------------
4819
  eax - SF_TERMINATE_PROCESS (-1)
114 mikedld 4820
======================================================================
4821
=========================== List of events ===========================
4822
======================================================================
118 diamond 4823
Next event can be retrieved by the call of one from functions 10
4824
(to wait for event), 11 (to check without waiting), 23
4825
(to wait during the given time).
4826
These functions return only those events, which enter into a mask set
4827
by function 40. By default it is first three,
4828
there is enough for most applications.
114 mikedld 4829
Codes of events:
118 diamond 4830
  * 1 = redraw event (is reset by call to function 0)
4831
  * 2 = key on keyboard is pressed (acts, only when the window is
4832
    active) or hotkey is pressed; is reset, when all keys from
4833
    the buffer are read out by function 2
4834
  * 3 = button is pressed, defined earlier by function 8
4835
    (or close button, created implicitly by function 0;
4836
    minimize button is handled by the system and sends no message;
4837
    acts, only when the window is active;
4838
    is reset when all buttons from the buffer
4839
    are read out by function 17)
4840
  * 4 = reserved (in current implementation never comes even after
4841
    unmasking by function 40)
2513 mario79 4842
  * 5 = kernel finished redrawing of the desktop background
118 diamond 4843
  * 6 = mouse event (something happened - button pressing or moving;
4844
    is reset at reading)
4845
  * 7 = IPC event (see function 60 -
4846
    Inter Process Communication; is reset at reading)
4847
  * 8 = network event (is reset at reading)
4848
  * 9 = debug event (is reset at reading; see
4849
    debug subsystem)
4850
  * 16..31 = event with appropriate IRQ
4851
    (16=IRQ0, 31=IRQ15) (is reset after reading all IRQ data)
114 mikedld 4852
 
4853
======================================================================
118 diamond 4854
=================== Error codes of the file system ===================
114 mikedld 4855
======================================================================
118 diamond 4856
  * 0 = success
4857
  * 2 = function is not supported for the given file system
4858
  * 3 = unknown file system
4859
  * 5 = file not found
4860
  * 6 = end of file, EOF
4861
  * 7 = pointer lies outside of application memory
4862
  * 8 = disk is full
6235 pathoswith 4863
  * 9 = file system error
114 mikedld 4864
  * 10 = access denied
118 diamond 4865
  * 11 = device error
6235 pathoswith 4866
  * 12 = file system requires more memory
4867
 
118 diamond 4868
Application start functions can return also following errors:
4869
  * 30 = 0x1E = not enough memory
4870
  * 31 = 0x1F = file is not executable
4871
  * 32 = 0x20 = too many processes