Subversion Repositories Kolibri OS

Rev

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

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