Subversion Repositories Kolibri OS

Rev

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

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