Subversion Repositories Kolibri OS

Rev

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