Subversion Repositories Kolibri OS

Rev

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