Subversion Repositories Kolibri OS

Rev

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

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