Subversion Repositories Kolibri OS

Rev

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

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