Subversion Repositories Kolibri OS

Rev

Rev 5682 | Rev 5836 | 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.
5810 hidnplayr 1450
  * To get system time use function 3.
1451
 
1452
======================================================================
1453
===================== Function 26, subfunction 10 ====================
1454
========== Get the value of the high precision time counter. =========
1455
======================================================================
1456
Parameters:
1457
  * eax = 26 - function number
1458
  * ebx = 10 - subfunction number
1459
Returned value:
1460
  * eax = number of nanoseconds since system boot time (lower DWORD)
1461
  * edx = number of nanoseconds since system boot time (high DWORD)
1462
Remarks:
1463
  * The counter is based on HPET, if HPET is not available, resolution
1464
    will be reduced to 10 000 000 nanoseconds.
114 mikedld 1465
 
1466
======================================================================
118 diamond 1467
===================== Function 26, subfunction 11 ====================
1468
========== Find out whether low-level HD access is enabled. ==========
114 mikedld 1469
======================================================================
1470
Parameters:
118 diamond 1471
  * eax = 26 - function number
1472
  * ebx = 11 - subfunction number
114 mikedld 1473
Returned value:
118 diamond 1474
  * eax = 0/1 - disabled/enabled
114 mikedld 1475
Remarks:
118 diamond 1476
  * Is used in LBA read (subfunction 8 of function 58).
1477
  * To set current state use subfunction 11 of function 21.
114 mikedld 1478
 
1479
======================================================================
118 diamond 1480
===================== Function 26, subfunction 12 ====================
1481
========== Find out whether low-level PCI access is enabled. =========
114 mikedld 1482
======================================================================
1483
Parameters:
118 diamond 1484
  * eax = 26 - function number
1485
  * ebx = 12 - subfunction number
114 mikedld 1486
Returned value:
118 diamond 1487
  * eax = 0/1 - disabled/enabled
114 mikedld 1488
Remarks:
118 diamond 1489
  * Is used by operations with PCI bus (function 62).
1490
  * The current implementation uses only low bit of ecx.
1491
  * To set the current state use subfunction 12 of function 21.
114 mikedld 1492
 
1493
======================================================================
118 diamond 1494
=================== Function 29 - get system date. ===================
114 mikedld 1495
======================================================================
1496
Parameters:
118 diamond 1497
  * eax = 29 - function number
114 mikedld 1498
Returned value:
1499
  * eax = 0x00DDMMYY, where
118 diamond 1500
    (binary-decimal coding, BCD, is used)
1501
  * YY = two low digits of year (00..99)
1502
  * MM = month (01..12)
1503
  * DD = day (01..31)
114 mikedld 1504
Remarks:
118 diamond 1505
  * To set system date use function 22.
114 mikedld 1506
 
1507
======================================================================
521 diamond 1508
============= Function 30 - work with the current folder. ============
1509
======================================================================
1510
 
1511
--------- Subfunction 1 - set current folder for the thread. ---------
1512
Parameters:
1513
  * eax = 30 - function number
1514
  * ebx = 1 - subfunction number
1515
  * ecx = pointer to ASCIIZ-string with the path to new current folder
1516
Returned value:
1517
  * function does not return value
1518
 
1519
--------- Subfunction 2 - get current folder for the thread. ---------
1520
Parameters:
1521
  * eax = 30 - function number
1522
  * ebx = 2 - subfunction number
1523
  * ecx = pointer to buffer
1524
  * edx = size of buffer
1525
Returned value:
1526
  * eax = size of the current folder's name (including terminating 0)
1527
Remarks:
1528
  * If the buffer is too small to hold all data, only first (edx-1)
1529
    bytes are copied and than terminating 0 is inserted.
1662 Nasarus 1530
  * By default, current folder for the thread is "/rd/1".
2409 Serge 1531
  * At process/thread creation the current folder will be inherited
1662 Nasarus 1532
    from the parent.
521 diamond 1533
 
3663 mario79 1534
--- Subfunction 3 - install the add.system directory for the kernel --
1535
Parameters:
1536
  * eax = 30 - function number
1537
  * ebx = 3 - subfunction number
1538
  * ecx = pointer to a block of data:
1539
          sysdir_name     rb 64
1540
          sysdir_path     rb 64
3780 Serge 1541
For example:
1542
dir_name1       db 'KolibriOS',0
3912 mario79 1543
                rb 64-10
3663 mario79 1544
dir_path1       db 'HD0/1',0
1545
                rb 64-6
1546
Returned value:
1547
  * function does not return value
1548
Remarks:
1549
  * The function can be called only 1 time for 1 session of the OS.
1550
 
521 diamond 1551
======================================================================
2511 mario79 1552
========= Function 34 - who owner the pixel on the screen. ===========
1553
======================================================================
1554
Parameters:
1555
  * eax = 34 - function number
1556
  * ebx = x-coordinate (relative to the display)
1557
  * ecx = y-coordinate (relative to the display)
1558
 
1559
Returned value:
1560
  * eax = 0x000000XX - owner of pixel the slot window N
1561
    If incorrect values ebx and ecx then function returns 0
1562
  * The function takes the value from the area [_WinMapAddress]
3780 Serge 1563
 
2511 mario79 1564
======================================================================
118 diamond 1565
======= Function 35 - read the color of a pixel on the screen. =======
114 mikedld 1566
======================================================================
1567
Parameters:
1568
  * eax = 35
1569
  * ebx = y*xsize+x, where
118 diamond 1570
  * (x,y) = coordinates of a pixel (beginning from 0)
1571
  * xsize = horizontal screen size
114 mikedld 1572
Returned value:
118 diamond 1573
  * eax = color 0x00RRGGBB
114 mikedld 1574
Remarks:
118 diamond 1575
  * To get screen sizes use function 14. Pay attention,
1576
    that it subtracts 1 from both sizes.
1577
  * There is also direct access (without any system calls)
1578
    to videomemory through the selector gs. To get parameters of
1579
    the current videomode, use function 61.
114 mikedld 1580
 
1581
======================================================================
1018 diamond 1582
=================== Function 36 - read screen area. ==================
921 mario79 1583
======================================================================
1584
Paramters:
1585
  * eax = 36 - function number
1018 diamond 1586
  * ebx = pointer to the previously allocated memory area,
1587
        where will be placed the image in the format BBGGRRBBGGRR...
921 mario79 1588
  * ecx = [size on axis x]*65536 + [size on axis y]
1589
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
1590
Returned value:
1591
  * function does not return value
1592
Remarks:
1593
  * Coordinates of the image are coordinates of the upper left corner
923 mario79 1594
    of the image relative to the screen.
921 mario79 1595
  * Size of the image in bytes is 3*xsize*ysize.
1596
 
1597
======================================================================
277 diamond 1598
=================== Function 37 - work with mouse. ===================
114 mikedld 1599
======================================================================
1600
 
118 diamond 1601
---------- Subfunction 0 - screen coordinates of the mouse -----------
114 mikedld 1602
Parameters:
118 diamond 1603
  * eax = 37 - function number
1604
  * ebx = 0 - subfunction number
114 mikedld 1605
Returned value:
118 diamond 1606
  * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer
1607
    (beginning from 0)
114 mikedld 1608
 
118 diamond 1609
-- Subfunction 1 - coordinates of the mouse relative to the window ---
114 mikedld 1610
Parameters:
118 diamond 1611
  * eax = 37 - function number
1612
  * ebx = 1 - subfunction number
114 mikedld 1613
Returned value:
118 diamond 1614
  * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer
1615
    relative to the application window (beginning from 0)
114 mikedld 1616
Remarks:
118 diamond 1617
  * The value is calculated by formula (x-xwnd)*65536 + (y-ywnd).
1618
    If y>=ywnd, the low word is non-negative and contains
1619
    relative y-coordinate, and the high word - relative x-coordinate
1620
    (with correct sign). Otherwise the low word is negative and still
1621
    contains relative y-coordinate, and to the high word
1622
    1 should be added.
114 mikedld 1623
 
118 diamond 1624
------------ Subfunction 2 - pressed buttons of the mouse ------------
114 mikedld 1625
Parameters:
118 diamond 1626
  * eax = 37 - function number
1627
  * ebx = 2 - subfunction number
114 mikedld 1628
Returned value:
118 diamond 1629
  * eax contains information on the pressed mouse buttons:
1630
  * bit 0 is set = left button is pressed
1631
  * bit 1 is set = right button is pressed
486 kastigar 1632
  * bit 2 is set = middle button is pressed
1633
  * bit 3 is set = 4th button is pressed
1634
  * bit 4 is set = 5th button is pressed
118 diamond 1635
  * other bits are cleared
114 mikedld 1636
 
277 diamond 1637
-------------------- Subfunction 4 - load cursor ---------------------
1638
Parameters:
1639
  * eax = 37 - function number
1640
  * ebx = 4 - subfunction number
1641
  * dx = data source:
1642
  * dx = LOAD_FROM_FILE = 0 - data in a file
1643
    * ecx = pointer to full path to the cursor file
1644
    * the file must be in the format .cur, which is standard for
1645
      MS Windows, at that of the size 32*32 pixels
1646
  * dx = LOAD_FROM_MEM = 1 - data of file are already loaded in memory
1647
    * ecx = pointer to data of the cursor file
1648
    * the data format is the same as in the previous case
1649
  * dx = LOAD_INDIRECT = 2 - data in memory
1650
    * ecx = pointer to cursor image in the format ARGB 32*32 pixels
1651
    * edx = 0xXXYY0002, where
1652
      * XX = x-coordinate of cursor hotspot
1653
      * YY = y-coordinate
1654
      * 0 <= XX, YY <= 31
1655
Returned value:
1656
  * eax = 0 - failed
1657
  * otherwise eax = cursor handle
1658
 
1659
--------------------- Subfunction 5 - set cursor ---------------------
1660
Sets new cursor for the window of the current thread.
1661
Parameters:
1662
  * eax = 37 - function number
1663
  * ebx = 5 - subfunction number
1664
  * ecx = cursor handle
1665
Returned value:
1666
  * eax = handle of previous cursor
1667
Remarks:
1668
  * If the handle is incorrect, the function restores the default
1669
    cursor (standard arrow). In particular, ecx=0 restores it.
1670
 
1671
------------------- Subfunction 6 - delete cursor --------------------
1672
Parameters:
1673
  * eax = 37 - function number
1674
  * ebx = 6 - subfunction number
1675
  * ecx = cursor handle
1676
Returned value:
1677
  * eax destroyed
1678
Remarks:
1679
  * The cursor must be loaded previously by the current thread
1680
    (with the call to subfunction 4). The function does not delete
1681
    system cursors and cursors, loaded by another applications.
1682
  * If the active cursor (set by subfunction 5) is deleted,
1683
    the system restores the default cursor (standard arrow).
1684
 
499 diamond 1685
------------------ Subfunction 7 - get scroll data -------------------
486 kastigar 1686
Parameters:
1687
  * eax = 37 - function number
1688
  * ebx = 7 - subfunction number
1689
Returned value:
499 diamond 1690
  * eax = [horizontal offset]*65536 + [vertical offset]
486 kastigar 1691
Remarks:
499 diamond 1692
  * Scroll data is available for active window only.
1693
  * Values are zeroed after reading.
1694
  * Values are signed.
486 kastigar 1695
 
114 mikedld 1696
======================================================================
1697
====================== Function 38 - draw line. ======================
1698
======================================================================
1699
Parameters:
118 diamond 1700
  * eax = 38 - function number
1701
  * ebx = [start coordinate on axis x]*65536 +
1702
              [end coordinate on axis x]
1703
  * ecx = [start coordinate on axis y]*65536 +
1704
              [end coordinate on axis y]
1705
  * edx = 0x00RRGGBB - color
133 diamond 1706
    edx = 0x01xxxxxx - draw inversed line
1707
          (low 24 bits are ignored)
114 mikedld 1708
Returned value:
1709
  * function does not return value
1710
Remarks:
118 diamond 1711
  * Coordinates are relative to the window.
1712
  * End point is also drawn.
114 mikedld 1713
 
1714
======================================================================
118 diamond 1715
== Function 39, subfunction 1 - get a size of the background image. ==
114 mikedld 1716
======================================================================
1717
Parameters:
118 diamond 1718
  * eax = 39 - function number
1719
  * ebx = 1 - subfunction number
114 mikedld 1720
Returned value:
1721
  * eax = [width]*65536 + [height]
1722
Remarks:
118 diamond 1723
  * There is a pair function to set sizes of background image -
1724
    subfunction 1 of function 15. After which it is necessary,
1725
    of course, anew to define image.
114 mikedld 1726
 
1727
======================================================================
118 diamond 1728
== Function 39, subfunction 2 - get pixel from the background image. =
114 mikedld 1729
======================================================================
1730
Parameters:
118 diamond 1731
  * eax = 39 - function number
1732
  * ebx = 2 - subfunction number
114 mikedld 1733
  * ecx = offset
1734
Returned value:
118 diamond 1735
  * eax = 0x00RRGGBB - pixel color, if offset is valid
1736
    (less than 0x160000-16)
1737
  * eax = 2 otherwise
114 mikedld 1738
Remarks:
118 diamond 1739
  * Do not rely on returned value for invalid offsets, it may be
1740
    changed in future kernel versions.
1741
  * Offset for pixel with coordinates (x,y)
1742
    is calculated as (x+y*xsize)*3.
2409 Serge 1743
  * There is a pair function to set pixel on the background image -
118 diamond 1744
    subfunction 2 of function 15.
114 mikedld 1745
 
1746
======================================================================
118 diamond 1747
== Function 39, subfunction 4 - get drawing mode for the background. =
114 mikedld 1748
======================================================================
1749
Parameters:
118 diamond 1750
  * eax = 39 - function number
1751
  * ebx = 4 - subfunction number
114 mikedld 1752
Returned value:
118 diamond 1753
  * eax = 1 - tile
1754
  * eax = 2 - stretch
114 mikedld 1755
Remarks:
2409 Serge 1756
  * There is a pair function to set drawing mode -
118 diamond 1757
    subfunction 4 of function 15.
114 mikedld 1758
 
1759
======================================================================
118 diamond 1760
=========== Function 40 - set the mask for expected events. ==========
114 mikedld 1761
======================================================================
118 diamond 1762
The mask for expected events affects function working with events
1763
10, 11, 23 - they notify only about events allowed by this mask.
114 mikedld 1764
Parameters:
118 diamond 1765
  * eax = 40 - function number
114 mikedld 1766
  * ebx = mask: bit i corresponds to event i+1 (see list of events)
118 diamond 1767
    (set bit permits notice on event)
3940 mario79 1768
    bit 31: mouse active/inactive filter
2414 Serge 1769
    bit 31 = 0 - inactive window receive mouse events
1770
    bit 31 = 1 - inactive window does not receive mouse events
1771
    bit 30: cursor position filter
1772
    bit 30 = 0 = the window receive mouse events if cursor
1773
                 outside window
1774
    bit 30 = 1 - the window does not receive mouse events if cursor
1775
                 outside window
114 mikedld 1776
Returned value:
1153 clevermous 1777
  * eax = previous value of mask
114 mikedld 1778
Remarks:
118 diamond 1779
  * Default mask (7=111b) enables nofices about redraw,
1780
    keys and buttons. This is enough for many applications.
1781
  * Events prohibited in the mask are saved anyway, when come;
1782
    they are simply not informed with event functions.
1783
  * Event functions take into account the mask on moment of
1784
    function call, not on moment of event arrival.
114 mikedld 1785
 
1786
 
1787
======================================================================
118 diamond 1788
================ Function 43 - input/output to a port. ===============
114 mikedld 1789
======================================================================
1790
 
118 diamond 1791
------------------------ Output data to port -------------------------
114 mikedld 1792
Parameters:
118 diamond 1793
  * eax = 43 - function number
114 mikedld 1794
  * bl = byte for output
118 diamond 1795
  * ecx = port number 0xnnnn (from 0 to 0xFFFF)
114 mikedld 1796
Returned value:
118 diamond 1797
  * eax = 0 - success
1798
  * eax = 1 - the thread has not reserved the selected port
114 mikedld 1799
 
118 diamond 1800
------------------------ Input data from port ------------------------
114 mikedld 1801
Parameters:
118 diamond 1802
  * eax = 43 - function number
1803
  * ebx is ignored
1804
  * ecx = 0x8000nnnn, where nnnn = port number (from 0 to 0xFFFF)
114 mikedld 1805
Returned value:
118 diamond 1806
  * eax = 0 - success, thus ebx = entered byte
1807
  * eax = 1 - the thread has not reserved the selected port
114 mikedld 1808
Remarks:
118 diamond 1809
  * Previously the thread must reserve the selected port
1810
    for itself by function 46.
1811
  * Instead of call to this function it is better to use
1812
    processor instructions in/out - this is much
1813
    faster and a bit shorter and easier.
114 mikedld 1814
 
1815
 
1816
======================================================================
118 diamond 1817
====== Function 46 - reserve/free a group of input/output ports. =====
114 mikedld 1818
======================================================================
118 diamond 1819
To work with reserved ports an application can access directly by
1820
commands in/out (recommended way) and can use function 43
1821
(not recommended way).
114 mikedld 1822
Parameters:
118 diamond 1823
  * eax = 46 - function number
114 mikedld 1824
  * ebx = 0 - reserve, 1 - free
118 diamond 1825
  * ecx = start port number
1826
  * edx = end port number (inclusive)
114 mikedld 1827
Returned value:
118 diamond 1828
  * eax = 0 - success
114 mikedld 1829
  * eax = 1 - error
1830
Remarks:
118 diamond 1831
  * For ports reservation: an error occurs if and only if
1832
    one from the following condition satisfies:
1833
    * start port is more than end port;
1834
    * the selected range contains incorrect port number
1835
      (correct are from 0 to 0xFFFF);
1836
    * limit for the total number of reserved areas is exceeded
1837
      (maximum 255 are allowed);
1838
    * the selected range intersects with any of earlier reserved
1839
  * For ports free: an error is an attempt to free range,
1840
    that was not earlier reserved by this function
1841
    (with same ecx,edx).
1842
  * If an error occurs (for both cases) function performs no action.
277 diamond 1843
  * At booting the system reserves for itself ports
1844
    0..0x2d, 0x30..0x4d, 0x50..0xdf, 0xe5..0xff (inclusively).
118 diamond 1845
  * When a thread terminates, all reserved by it ports
1846
    are freed automatically.
114 mikedld 1847
 
1848
======================================================================
118 diamond 1849
============= Function 47 - draw a number in the window. =============
114 mikedld 1850
======================================================================
1851
Parameters:
118 diamond 1852
  * eax = 47 - function number
1853
  * ebx = parameters of conversion number to text:
114 mikedld 1854
    * bl = 0 - ecx contains number
665 diamond 1855
    * bl = 1 - ecx contains pointer to dword/qword-number
118 diamond 1856
    * bh = 0 - display in decimal number system
1857
    * bh = 1 - display in hexadecimal system
1858
    * bh = 2 - display in binary system
499 diamond 1859
    * bits 16-21 = how many digits to display
655 mario79 1860
    * bits 22-29 reserved and must be set to 0
665 diamond 1861
    * bit 30 set = display qword (64-bit) number (must be bl=1)
1862
    * bit 31 set = do not display leading zeroes of the number
118 diamond 1863
  * ecx = number (if bl=0) or pointer (if bl=1)
114 mikedld 1864
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
139 diamond 1865
  * esi = 0xX0RRGGBB:
1866
    * RR, GG, BB specify the color
1867
    * X = ABnn (bits)
1868
    * nn = font (0/1)
1869
    * A is ignored
1870
    * B=1 - fill background with the color edi
114 mikedld 1871
Returned value:
1872
  * function does not return value
1873
Remarks:
118 diamond 1874
  * The given length must not exceed 60.
1875
  * The exactly given amount of digits is output. If number is small
1876
    and can be written by smaller amount of digits, it is supplemented
1877
    by leading zeroes; if the number is big and can not be written by
1878
    given amount of digits, extra digits are not drawn.
1879
  * Parameters of fonts are shown in the description of function 4
1880
    (text output).
114 mikedld 1881
 
1882
======================================================================
118 diamond 1883
========= Function 48, subfunction 0 - apply screen settings. ========
114 mikedld 1884
======================================================================
1885
Parameters:
118 diamond 1886
  * eax = 48 - function number
1887
  * ebx = 0 - subfunction number
114 mikedld 1888
  * ecx = 0 - reserved
1889
Returned value:
1890
  * function does not return value
1891
Remarks:
118 diamond 1892
  * Function redraws the screen after parameters change by
114 mikedld 1893
    subfunctions 1 and 2.
118 diamond 1894
  * Function call without prior call to one of indicated subfunctions
1895
    is ignored.
1896
  * Function call with nonzero ecx is ignored.
114 mikedld 1897
 
1898
======================================================================
118 diamond 1899
=========== Function 48, subfunction 1 - set button style. ===========
114 mikedld 1900
======================================================================
1901
Parameters:
118 diamond 1902
  * eax = 48 - function number
1903
  * ebx = 1 - subfunction number
1904
  * ecx = button style:
1905
    * 0 = flat
1906
    * 1 = 3d
114 mikedld 1907
Returned value:
1908
  * function does not return value
1909
Remarks:
118 diamond 1910
  * After call to this function one should redraw the screen by
1911
    subfunction 0.
1912
  * Button style influences only to their draw of function 8.
114 mikedld 1913
 
118 diamond 1914
======================================================================
1915
====== Function 48, subfunction 2 - set standard window colors. ======
1916
======================================================================
114 mikedld 1917
Parameters:
118 diamond 1918
  * eax = 48 - function number
1919
  * ebx = 2 - subfunction number
1920
  * ecx = pointer to the color table
114 mikedld 1921
  * edx = size of the color table
118 diamond 1922
    (must be 40 bytes for future compatibility)
1923
Format of the color table is shown in description of subfunction 3.
114 mikedld 1924
Returned value:
1925
  * function does not return value
1926
Remarks:
118 diamond 1927
  * After call to this function one should redraw the screen by
1928
    subfunction 0.
1929
  * Table of standard colors influences only to applications,
1930
    which receive this table obviously (by subfunction 3)
1931
    and use it (specifying colors from it to drawing functions).
1932
  * Table of standard colors is included in skin and is installed
1933
    anew with skin installation (by subfunction 8).
1934
  * Color table can be viewed/changed interactively with
1935
    the application 'desktop'.
114 mikedld 1936
 
1937
======================================================================
118 diamond 1938
====== Function 48, subfunction 3 - get standard window colors. ======
114 mikedld 1939
======================================================================
1940
Parameters:
118 diamond 1941
  * eax = 48 - function number
1942
  * ebx = 3 - subfunction number
1943
  * ecx = pointer to the buffer with size edx bytes,
1944
    where table will be written
1945
  * edx = size of color table
1946
    (must be 40 bytes for future compatibility)
114 mikedld 1947
Returned value:
1948
  * function does not return value
118 diamond 1949
Format of the color table:
1950
each item is dword-value for color 0x00RRGGBB
1951
  * +0: dword: frames - color of frame
1952
  * +4: dword: grab - color of header
1953
  * +8: dword: grab_button - color of button on header bar
1954
  * +12 = +0xC: dword: grab_button_text - color of text on button
1955
    on header bar
1956
  * +16 = +0x10: dword: grab_text - color of text on header
1957
  * +20 = +0x14: dword: work - color of working area
1958
  * +24 = +0x18: dword: work_button - color of button in working area
1959
  * +28 = +0x1C: dword: work_button_text - color of text on button
1960
    in working area
1961
  * +32 = +0x20: dword: work_text - color of text in working area
1962
  * +36 = +0x24: dword: work_graph - color of graphics in working area
114 mikedld 1963
Remarks:
118 diamond 1964
  * Structure of the color table is described in the standard
1965
    include file 'macros.inc' as 'system_colors'; for example,
1966
    it is possible to write:
1662 Nasarus 1967
    	sc	system_colors		; variable declaration
1968
    	...				; somewhere one must call
1969
    					; this function with ecx=sc
1970
    	mov	ecx, [sc.work_button_text]	; read text color on
1971
    					; buttin in working area
118 diamond 1972
  * A program itself desides to use or not to use color table.
1973
    For usage program must simply at calls to drawing functions select
1974
    color taken from the table.
1975
  * At change of the table of standard colors (by subfunction 2 with
1976
    the subsequent application of changes by subfunction 0 or
1977
    at skin set by subfunction 8) the system sends to all windows
1978
    redraw message (the event with code 1).
1979
  * Color table can be viewed/changed interactively with
1980
    the application 'desktop'.
114 mikedld 1981
 
1982
======================================================================
118 diamond 1983
============ Function 48, subfunction 4 - get skin height. ===========
114 mikedld 1984
======================================================================
1985
Parameters:
118 diamond 1986
  * eax = 48 - function number
1987
  * ebx = 4 - subfunction number
114 mikedld 1988
Returned value:
118 diamond 1989
  * eax = skin height
114 mikedld 1990
Remarks:
118 diamond 1991
  * Skin height is defined as the height of a header
1992
    of skinned windows.
1993
  * See also general structure of window in the description
1994
    of function 0.
114 mikedld 1995
 
1996
======================================================================
118 diamond 1997
======== Function 48, subfunction 5 - get screen working area. =======
114 mikedld 1998
======================================================================
1999
Parameters:
118 diamond 2000
  * eax = 48 - function number
2001
  * ebx = 5 - subfunction number
114 mikedld 2002
Returned value:
2003
  * eax = [left]*65536 + [right]
2004
  * ebx = [top]*65536 + [bottom]
2005
Remarks:
118 diamond 2006
  * The screen working area defines position and coordinates of
2007
    a maximized window.
2008
  * The screen working area in view of normal work is all screen
5452 leency 2009
    without taskbar ('@taskbar' application).
118 diamond 2010
  * (left,top) are coordinates of the left upper corner,
2011
    (right,bottom) are coordinates of the right lower one.
2012
    Thus the size of working area on x axis can be calculated by
2013
    formula right-left+1, on y axis - by formula bottom-right+1.
2014
  * See also function 14,
2015
    to get sizes of all screen.
2016
  * There is a pair function to set working area - subfunction 6.
114 mikedld 2017
 
2018
======================================================================
118 diamond 2019
======== Function 48, subfunction 6 - set screen working area. =======
114 mikedld 2020
======================================================================
2021
Parameters:
118 diamond 2022
  * eax = 48 - function number
2023
  * ebx = 6 - subfunction number
114 mikedld 2024
  * ecx = [left]*65536 + [right]
2025
  * edx = [top]*65536 + [bottom]
2026
Returned value:
2027
  * function does not return value
2028
Remarks:
118 diamond 2029
  * The screen working area defines position and coordinates of
2030
    a maximized window.
5452 leency 2031
  * This function is used only by the application '@taskbar',
2032
    which set working area to all screen without taskbar.
118 diamond 2033
  * (left,top) are coordinates of the left upper corner,
2034
    (right,bottom) are coordinates of the right lower one.
2035
    Thus the size of working area on x axis can be calculated by
2036
    formula right-left+1, on y axis - by formula bottom-right+1.
2037
  * If 'left'>='right', x-coordinate of working area is not changed.
2038
    If 'left'<0, 'left' will not be set. If 'right' is greater than or
2039
    equal to screen width, 'right' will not be set.
2040
    Similarly on y axis.
2041
  * See also function 14,
2042
    to get sizes of all screen.
2043
  * There is a pair function to get working area - subfunction 5.
2044
  * This function redraws the screen automatically,
2045
    updating coordinates and sizes of maximized windows.
2046
    The system sends to all windows redraw message (the event 1).
114 mikedld 2047
 
2048
======================================================================
118 diamond 2049
=========== Function 48, subfunction 7 - get skin margins. ===========
114 mikedld 2050
======================================================================
118 diamond 2051
Returns the area of a header of a skinned window, intended for
2052
a text of a header.
114 mikedld 2053
Parameters:
118 diamond 2054
  * eax = 48 - function number
2055
  * ebx = 7 - subfunction number
114 mikedld 2056
Returned value:
2057
  * eax = [left]*65536 + [right]
2058
  * ebx = [top]*65536 + [bottom]
2059
Remarks:
118 diamond 2060
  * An application decides itself to use or not to use this function.
2061
  * It is recommended to take into account returned value
2062
    of this function for choice of a place for drawing header text
2063
    (by function 4) or a substitute of header text
2064
    (at the discretion of an application).
114 mikedld 2065
 
2066
======================================================================
118 diamond 2067
============= Function 48, subfunction 8 - set used skin. ============
114 mikedld 2068
======================================================================
2069
Parameters:
118 diamond 2070
  * eax = 48 - function number
2071
  * ebx = 8 - subfunction number
4573 clevermous 2072
  * ecx = pointer to filename of the skin
114 mikedld 2073
Returned value:
118 diamond 2074
  * eax = 0 - success
2075
  * otherwise eax = file system error code; if file does not
2076
    contain valid skin, function returns error 3
2077
    (unknown file system).
114 mikedld 2078
Remarks:
118 diamond 2079
  * After successful skin loading the system sends to all windows
2080
    redraw message (the event 1).
2081
  * At booting the system reads skin from file 'default.skn'
2082
    on ramdisk.
2083
  * User can change the skin statically by creating hisself
2084
    'default.skn' or dynamically with the application 'desktop'.
114 mikedld 2085
 
2086
======================================================================
5682 leency 2087
======== Function 48, subfunction 9 - font smoothing setting. ========
2088
======================================================================
2089
Parameters:
2090
  * eax = 48 - function number
2091
  * ebx = 9 - subfunction number
2092
  * cl=0 - turn off font smoothing, else - turn on
2093
 
2094
======================================================================
118 diamond 2095
=========== Function 49 - Advanced Power Management (APM). ===========
114 mikedld 2096
======================================================================
2097
Parameters:
118 diamond 2098
  * eax = 49 - function number
2099
  * dx = number of the APM function
2100
    (analogue of ax in APM specification)
2101
  * bx, cx = parameters of the APM function
114 mikedld 2102
Returned value:
118 diamond 2103
  * 16-bit registers ax, bx, cx, dx, si, di and carry flag CF
2104
    are set according to the APM specification
2105
  * high halves of 32-bit registers eax, ebx, ecx,
2106
    edx, esi, edi are destroyed
114 mikedld 2107
Remarks:
118 diamond 2108
  * APM 1.2 specification is described in the document
2109
    "Advanced Power Management (APM) BIOS Specification"
2110
    (Revision 1.2), available at
114 mikedld 2111
    http://www.microsoft.com/whdc/archive/amp_12.mspx;
118 diamond 2112
    besides it is included in famous Interrupt List by Ralf Brown
114 mikedld 2113
    (http://www.pobox.com/~ralf/files.html,
2114
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/).
2115
 
2116
======================================================================
118 diamond 2117
=================== Function 50 - set window shape. ==================
114 mikedld 2118
======================================================================
118 diamond 2119
Normal windows have rectangular shape. This function can give to
2120
a window any shape. The shape is given by a set of points inside
2121
the base rectangle belonging to a window. Position and coordinates
2122
of the base rectangle are set by function 0
2123
and changed by function 67.
114 mikedld 2124
 
118 diamond 2125
--------------------------- Set shape data ---------------------------
114 mikedld 2126
Parameters:
118 diamond 2127
  * eax = 50 - function number
2128
  * ebx = 0 - subfunction number
2129
  * ecx = pointer to shape data (array of bytes 0/1)
114 mikedld 2130
Returned value:
2131
  * function does not return value
2132
 
118 diamond 2133
-------------------------- Set shape scale ---------------------------
114 mikedld 2134
Parameters:
118 diamond 2135
  * eax = 50 - function number
2136
  * ebx = 1 - subfunction number
2137
  * ecx sets a scale: each byte of data defines
2138
    (2^scale)*(2^scale) pixels
114 mikedld 2139
Returned value:
2140
  * function does not return value
2141
Remarks:
118 diamond 2142
  * Default scale is 0 (scale factor is 1). If in the shape data
2143
    one byte corresponds to one pixel, there is no necessity
2144
    to set scale.
2145
  * Let's designate xsize = window width (in pixels), ysize = height;
2146
    pay attention, that they are one pixel more than defined by
114 mikedld 2147
    functions 0, 67.
118 diamond 2148
  * On definition of scale xsize and ysize must be divisible
2149
    on 2^scale.
2150
  * Byte of data on offset 'a' must be 0/1 and defines belonging
2151
    to a window of square with the side 2^scale (if scale=0,
2152
    this is one pixel) and coordinates of the left upper corner
114 mikedld 2153
    (a mod (xsize shr scale), a div (xsize shr scale))
118 diamond 2154
  * Data size: (xsize shr scale)*(ysize shr scale).
2155
  * Data must be presented in the memory and not change
2156
    after set of shape.
2157
  * The system views the shape data at every window redraw by
2158
    function 0.
2159
  * The call of subfunction 0 with NULL pointer results in return
2160
    to the rectangular shape.
114 mikedld 2161
 
2162
======================================================================
2163
==================== Function 51 - create thread. ====================
2164
======================================================================
2165
Parameters:
118 diamond 2166
  * eax = 51 - function number
2167
  * ebx = 1 - unique subfunction
2168
  * ecx = address of thread entry point (starting eip)
2169
  * edx = pointer to thread stack (starting esp)
114 mikedld 2170
Returned value:
118 diamond 2171
  * eax = -1 - error (there is too many threads)
2172
  * otherwise eax = TID - thread identifier
2409 Serge 2173
    
114 mikedld 2174
 
2175
======================================================================
4199 mario79 2176
==================== Function 54, subfunction 0 ======================
2177
============== Get the number of slots in the clipboard. =============
2178
======================================================================
2179
Parameters:
2180
  * eax = 54 - function number
2181
  * ebx = 0 - subfunction number
2182
Returned value:
2183
  * eax = slots in the clipboard
2184
  * eax = -1 - main list area not found
2185
 
2186
======================================================================
2187
==================== Function 54, subfunction 1 ======================
2188
================= Read the data from the clipboard. ==================
2189
======================================================================
2190
Parameters:
2191
  * eax = 54 - function number
2192
  * ebx = 1 - subfunction number
2193
  * eсx = slot number
2194
Returned value:
2195
  * eax = if successful - pointer to a memory with data
2196
  * eax = 1 - error
2197
  * eax = -1 - main list area not found
2198
 
2199
======================================================================
2200
==================== Function 54, subfunction 2 ======================
2201
================= Write the data to the clipboard. ===================
2202
======================================================================
2203
Parameters:
2204
  * eax = 54 - function number
2205
  * ebx = 2 - subfunction number
2206
  * eсx = the number of bytes to be copied
2207
  * edx = a pointer to a buffer for data to be copied
2208
Returned value:
2209
  * eax = 0 - success
2210
  * eax = 1 - error
2211
  * eax = -1 - main list area not found
2212
 
2213
======================================================================
2214
===================== Function 54, subfunction 3 =====================
2215
================ Delete the last slot in the clipboard ===============
2216
======================================================================
2217
Parameters:
2218
  * eax = 54 - function number
2219
  * ebx = 3 - subfunction number
2220
Returned value:
2221
  * eax = 0 - success
2222
  * eax = 1 - error
2223
  * eax = -1 - main list area not found
2224
 
2225
======================================================================
2226
===================== Function 54, subfunction 4 =====================
2227
===================== Alarm reset the lock buffer ====================
2228
======================================================================
2229
Parameters:
2230
  * eax = 54 - function number
2231
  * ebx = 4 - subfunction number
2232
Returned value:
2233
  * eax = 0 - success
2234
  * eax = -1 - main list area not found or no blocking
2235
Remarks:
2236
  * Used in exceptional cases, where no responsible or killed
2237
    application blocked the clipboard operations.
2238
 
2239
======================================================================
2409 Serge 2240
 Function 55, subfunction 55 - begin to play data on built-in speaker.
114 mikedld 2241
======================================================================
2242
Parameters:
118 diamond 2243
  * eax = 55 - function number
2244
  * ebx = 55 - subfunction number
2245
  * esi = pointer to data
114 mikedld 2246
Returned value:
118 diamond 2247
  * eax = 0 - success
2248
  * eax = 55 - error (speaker is off or busy)
2249
Data is an array of items with variable length.
2250
Format of each item is defined by first byte:
114 mikedld 2251
  * 0 = end of data
118 diamond 2252
  * 1..0x80 = sets sound duration on 1/100 of second; sound note
2253
    is defined by immediate value of frequency
2254
    * following word (2 bytes) contains frequency divider;
2255
      frequency is defined as 1193180/divider
114 mikedld 2256
  * 0x81 = invalid
118 diamond 2257
  * 0x82..0xFF = note is defined by octave and number:
2258
    * duration in 1/100 of second = (first byte)-0x81
114 mikedld 2259
    * there is one more byte;
118 diamond 2260
    * (second byte)=0xFF - delay
2261
    * otherwise it looks like a*0x10+b, where b=number of the note in
2262
      an octave from 1 to 12, a=number of octave (beginning from 0)
114 mikedld 2263
Remarks:
118 diamond 2264
  * Speaker play can be disabled/enabled by
2265
    subfunction 8 of function 18.
2266
  * Function returns control, having informed the system
2267
    an information on request. Play itself goes independently from
2268
    the program.
2269
  * The data must be kept in the memory at least up to the end
2270
    of play.
114 mikedld 2271
 
2272
======================================================================
641 diamond 2273
======================= Function 57 - PCI BIOS. ======================
2274
======================================================================
2275
Parameters:
2276
  * eax = 57 - function number
2277
  * ebp corresponds to al in PCI BIOS specification
2278
  * other registers are set according to PCI BIOS specification
2279
Returned value:
2280
  * CF is undefined
2281
  * other registers are set according to PCI BIOS specification
2282
Remarks:
2283
  * Many effects of this function can be also achieved with
2284
    corresponding subfunctions of function 62.
2285
  * The function calls PCI32 BIOS extension, documented e.g. in
2286
    http://alpha1.dyns.net/files/PCI/bios21.pdf.
2287
  * If BIOS does not support this extension, its behavior is emulated
2288
    (through kernel-mode analogues of subfunctions of function 62).
2289
 
2290
======================================================================
118 diamond 2291
========== Function 60 - Inter Process Communication (IPC). ==========
114 mikedld 2292
======================================================================
118 diamond 2293
IPC is used for message dispatching from one process/thread to
2294
another. Previously it is necessary to agree how to interpret
114 mikedld 2295
the concrete message.
2296
 
118 diamond 2297
----------- Subfunction 1 - set the area for IPC receiving -----------
2298
Is called by process-receiver.
114 mikedld 2299
Parameters:
118 diamond 2300
  * eax = 60 - function number
2301
  * ebx = 1 - subfunction number
2302
  * ecx = pointer to the buffer
2303
  * edx = size of the buffer
114 mikedld 2304
Returned value:
118 diamond 2305
  * eax = 0 - always success
2306
Format of IPC-buffer:
2307
  * +0: dword: if nonzero, buffer is considered locked;
2308
    lock/unlock the buffer, when you work with it and need that
2309
    buffer data are not changed from outside (no new messages)
114 mikedld 2310
  * +4: dword: occupied place in the buffer (in bytes)
2311
  * +8: first message
2312
  * +8+n: second message
2313
  * ...
118 diamond 2314
Format of a message:
2315
  * +0: dword: PID of sender
2316
  * +4: dword: message length (not including this header)
2317
  * +8: n*byte: message data
114 mikedld 2318
 
118 diamond 2319
------------------ Subfunction 2 - send IPC message ------------------
2320
Is called by process-sender.
114 mikedld 2321
Parameters:
118 diamond 2322
  * eax = 60 - function number
2323
  * ebx = 2 - subfunction number
114 mikedld 2324
  * ecx = PID of receiver
118 diamond 2325
  * edx = pointer to the message data
2326
  * esi = message length (in bytes)
114 mikedld 2327
Returned value:
118 diamond 2328
  * eax = 0 - success
2329
  * eax = 1 - the receiver has not defined buffer for IPC messages
2330
    (can be, still have no time,
2331
    and can be, this is not right process)
2332
  * eax = 2 - the receiver has blocked IPC-buffer; try to wait a bit
2333
  * eax = 3 - overflow of IPC-buffer of the receiver
114 mikedld 2334
  * eax = 4 - process/thread with such PID does not exist
2335
Remarks:
118 diamond 2336
  * Immediately after writing of IPC-message to the buffer the system
2337
    sends to the receiver the event with code 7 (see event codes).
114 mikedld 2338
 
2339
======================================================================
118 diamond 2340
==== Function 61 - get parameters for the direct graphics access. ====
114 mikedld 2341
======================================================================
118 diamond 2342
The data of the graphics screen (the memory area which displays
2343
screen contents) are accessible to a program directly, without
2344
any system calls, through the selector gs:
1662 Nasarus 2345
	mov	eax, [gs:0]
118 diamond 2346
places in eax the first dword of the buffer, which contains
2347
information on color of the left upper point (and, possibly, colors
2348
of several following).
1662 Nasarus 2349
	mov	[gs:0], eax
118 diamond 2350
by work in VESA modes with LFB sets color of the left upper point
2351
(and, possibly, colors of several following).
2352
To interpret the data of graphics screen program needs to know
2353
some parameters, returning by this function.
114 mikedld 2354
Remarks:
118 diamond 2355
  * Graphics parameters changes very seldom at work,
2356
    namely, only in cases, when user works with the application VRR.
2357
  * At videomode change the system redraws all windows (event
2358
    with code 1) and redraws the background (event 5).
2359
    Same events occur in other cases too, which meet much more often,
2360
    than videomode change.
2361
  * By operation in videomodes with LFB the selector gs points to
2362
    LFB itself, so reading/writing on gs result directly in
2363
    change of screen contents. By operation in videomodes without
2364
    LFB gs points to some data area in the kernel, and all functions
2365
    of screen output fulfil honesty double operation on writing
2366
    directly to the screen and writing to this buffer. In result
2367
    at reading contents of this buffer the results correspond to
2368
    screen contents (with, generally speaking, large color
2369
    resolution), and writing is ignored.
2370
    One exception is the mode 320*200, for which main loop of the
2371
    system thread updates the screen according to mouse movements.
114 mikedld 2372
 
2373
------------------------- Screen resolution --------------------------
2374
Parameters:
118 diamond 2375
  * eax = 61 - function number
2376
  * ebx = 1 - subfunction number
114 mikedld 2377
Returned value:
118 diamond 2378
  * eax = [resolution on x axis]*65536 + [resolution on y axis]
114 mikedld 2379
Remarks:
118 diamond 2380
  * One can use function 14 paying attention that
2381
    it returns sizes on 1 pixel less. It is fully equivalent way.
114 mikedld 2382
 
118 diamond 2383
---------------------- Number of bits per pixel ----------------------
114 mikedld 2384
Parameters:
118 diamond 2385
  * eax = 61 - function number
2386
  * ebx = 2 - subfunction number
114 mikedld 2387
Returned value:
118 diamond 2388
  * eax = number of bits per pixel (24 or 32)
114 mikedld 2389
 
118 diamond 2390
-------------------- Number of bytes per scanline --------------------
114 mikedld 2391
Parameters:
118 diamond 2392
  * eax = 61 - function number
2393
  * ebx = 3 - subfunction number
114 mikedld 2394
Returned value:
118 diamond 2395
  * eax = number of bytes occupied by one scanline
114 mikedld 2396
    (horizontal line on the screen)
2397
 
2398
======================================================================
118 diamond 2399
===== Function 62, subfunction 0 - get version of PCI-interface. =====
114 mikedld 2400
======================================================================
2401
Parameters:
118 diamond 2402
  * eax = 62 - function number
2403
  * bl = 0 - subfunction number
114 mikedld 2404
Returned value:
118 diamond 2405
  * eax = -1 - PCI access is disabled; otherwise
2406
  * ah.al = version of PCI-interface (ah=version, al=subversion)
2407
  * high word of eax is zeroed
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 1 - get number of the last PCI-bus. ====
114 mikedld 2415
======================================================================
2416
Parameters:
118 diamond 2417
  * eax = 62 - function number
2418
  * bl = 1 - subfunction number
114 mikedld 2419
Returned value:
118 diamond 2420
  * eax = -1 - access to PCI is disabled; otherwise
2421
  * al = number of the last PCI-bus; other bytes of eax are destroyed
114 mikedld 2422
Remarks:
118 diamond 2423
  * Previously low-level access to PCI for applications must be
2424
    enabled by subfunction 12 of function 21.
2425
  * If PCI BIOS is not supported, the value of ax is undefined.
114 mikedld 2426
 
2427
======================================================================
118 diamond 2428
===================== Function 62, subfunction 2 =====================
2429
===== Get mechanism of addressing to the PCI configuration space. ====
114 mikedld 2430
======================================================================
2431
Parameters:
118 diamond 2432
  * eax = 62 - function number
2433
  * bl = 2 - subfunction number
114 mikedld 2434
Returned value:
118 diamond 2435
  * eax = -1 - access to PCI is disabled; otherwise
2436
  * al = mechanism (1 or 2); other bytes of eax are destroyed
114 mikedld 2437
Remarks:
118 diamond 2438
  * Previously low-level access to PCI for applications must be
2439
    enabled by subfunction 12 of function 21.
2440
  * Addressing mechanism is selected depending on
2441
    equipment characteristics.
2442
  * Subfunctions of read and write work automatically
2443
    with the selected mechanism.
114 mikedld 2444
 
2445
======================================================================
118 diamond 2446
======== Function 62, subfunctions 4,5,6 - read PCI-register. ========
114 mikedld 2447
======================================================================
2448
Parameters:
118 diamond 2449
  * eax = 62 - function number
2450
  * bl = 4 - read byte
2451
  * bl = 5 - read word
2452
  * bl = 6 - read dword
114 mikedld 2453
  * bh = number of PCI-bus
118 diamond 2454
  * ch = dddddfff, where ddddd = number of the device on the bus,
2455
    fff = function number of device
2456
  * cl = number of register (must be even for bl=5,
2457
    divisible by 4 for bl=6)
114 mikedld 2458
Returned value:
118 diamond 2459
  * eax = -1 - error (access to PCI is disabled or parameters
2460
    are not supported); otherwise
2461
  * al/ax/eax (depending on requested size) contains the data;
2462
    the other part of register eax is destroyed
114 mikedld 2463
Remarks:
118 diamond 2464
  * Previously low-level access to PCI for applications must be
2465
    enabled by subfunction 12 of function 21.
2466
  * Access mechanism 2 supports only 16 devices on a bus and ignores
2467
    function number. To get access mechanism use subfunction 2.
2468
  * Some registers are standard and exist for all devices, some are
2469
    defined by the concrete device. The list of registers of the
2470
    first type can be found e.g. in famous
114 mikedld 2471
    Interrupt List by Ralf Brown
2472
    (http://www.pobox.com/~ralf/files.html,
2473
    ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/);
118 diamond 2474
    registers of the second type must be listed
2475
    in the device documentation.
114 mikedld 2476
 
2477
======================================================================
118 diamond 2478
====== Function 62, subfunctions 8,9,10 - write to PCI-register. =====
114 mikedld 2479
======================================================================
2480
Parameters:
118 diamond 2481
  * eax = 62 - function number
2482
  * bl = 8 - write byte
2483
  * bl = 9 - write word
2484
  * bl = 10 - write dword
114 mikedld 2485
  * bh = number of PCI-bus
118 diamond 2486
  * ch = dddddfff, where ddddd = number of the device on the bus,
2487
    fff = function number of device
2488
  * cl = number of register (must be even for bl=9,
2489
    divisible by 4 for bl=10)
2490
  * dl/dx/edx (depending on requested size) contatins
2491
    the data to write
114 mikedld 2492
Returned value:
118 diamond 2493
  * eax = -1 - error (access to PCI is disabled or parameters
2494
    are not supported)
2495
  * eax = 0 - success
114 mikedld 2496
Remarks:
118 diamond 2497
  * Previously low-level access to PCI for applications must be
2498
    enabled by subfunction 12 of function 21.
2499
  * Access mechanism 2 supports only 16 devices on a bus and ignores
2500
    function number. To get access mechanism use subfunction 2.
2501
  * Some registers are standard and exist for all devices, some are
2502
    defined by the concrete device. The list of registers of the
2503
    first type can be found e.g. in famous Interrupt List by
2504
    Ralf Brown; registers of the second type must be listed
2505
    in the device documentation.
114 mikedld 2506
 
2507
======================================================================
118 diamond 2508
============== Function 63 - work with the debug board. ==============
114 mikedld 2509
======================================================================
118 diamond 2510
The debug board is the global system buffer (with the size
499 diamond 2511
1024 bytes), to which any program can write (generally speaking,
118 diamond 2512
arbitrary) data and from which other program can read these data.
2513
By the agreement written data are text strings interpreted as
2514
debug messages on a course of program execution. The kernel in
2515
some situations also writes to the debug board information on
2516
execution of some functions; by the agreement kernel messages
2517
begins from the prefix "K : ".
2518
For view of the debug board the application 'board' was created,
2519
which reads data from the buffer and displays them in its window.
2520
'board' interpretes the sequence of codes 13,10 as newline.
2521
A character with null code in an end of line is not necessary,
114 mikedld 2522
but also does not prevent.
118 diamond 2523
Because debugger has been written, the value of the debug board
2524
has decreased, as debugger allows to inspect completely a course of
2525
program execution without any efforts from the direction of program
2526
itself. Nevertheless in some cases the debug board is still useful.
114 mikedld 2527
 
118 diamond 2528
----------------------------- Write byte -----------------------------
114 mikedld 2529
Parameters:
118 diamond 2530
  * eax = 63 - function number
2531
  * ebx = 1 - subfunction number
2532
  * cl = data byte
114 mikedld 2533
Returned value:
2534
  * function does not return value
2535
Remarks:
118 diamond 2536
  * Byte is written to the buffer. Buffer size is 512 bytes.
2537
    At buffer overflow all obtained data are lost.
2538
  * For output to the debug board of more complicated objects
2539
    (strings, numbers) it is enough to call this function in cycle.
2540
    It is possible not to write the appropriate code manually and use
2541
    file 'debug.inc', which is included into the distributive.
114 mikedld 2542
 
118 diamond 2543
----------------------------- Read byte ------------------------------
2544
Takes away byte from the buffer.
114 mikedld 2545
Parameters:
118 diamond 2546
  * eax = 63 - function number
2547
  * ebx = 2 - subfunction number
114 mikedld 2548
Returned value:
118 diamond 2549
  * eax = ebx = 0 - the buffer is empty
2550
  * eax = byte, ebx = 1 - byte was successfully read
114 mikedld 2551
 
2552
======================================================================
118 diamond 2553
============== Function 64 - resize application memory. ==============
114 mikedld 2554
======================================================================
2555
Parameters:
118 diamond 2556
  * eax = 64 - function number
2557
  * ebx = 1 - unique subfunction
2558
  * ecx = new memory size
114 mikedld 2559
Returned value:
118 diamond 2560
  * eax = 0 - success
2561
  * eax = 1 - not enough memory
114 mikedld 2562
Remarks:
193 diamond 2563
  * There is another way to dynamically allocate/free memory -
2564
    subfunctions 11, 12, 13 of function 68.
2565
  * The function cannot be used together with 68.11, 68.12, 68.13.
2566
    The function call will be ignored after creation of process heap
2567
    with function 68.11.
114 mikedld 2568
 
2569
======================================================================
283 diamond 2570
======== Function 65 - draw image with palette in the window. ========
2571
======================================================================
2572
Parameters:
2573
  * eax = 65 - function number
2574
  * ebx = pointer to the image
2575
  * ecx = [size on axis x]*65536 + [size on axis y]
2576
  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]
2730 dunkaist 2577
  * esi = number of bits per pixel, must be 1,2,4,8,9,15,16,24 or 32;
1018 diamond 2578
  * edi = pointer to palette (2 to the power esi colors 0x00RRGGBB);
2579
          ignored when esi > 8
314 diamond 2580
  * ebp = offset of next row data relative to previous row data
283 diamond 2581
Returned value:
2582
  * function does not return value
2583
Remarks:
2584
  * Coordinates of the image are coordinates of the upper left corner
2585
    of the image relative to the window.
1018 diamond 2586
  * Format of image with 1 bit per pixel: each byte of image
2587
    (possibly excluding last bytes in rows), contains information on
2588
    the color of 8 pixels, MSB corresponds to first pixel.
2589
  * Format of image with 2 bits per pixel: each byte of image
2590
    (possibly excluding last bytes in rows), contains information on
2591
    the color of 4 pixels, two MSBs correspond to first pixel.
2592
  * Format of image with 4 bits per pixel: each byte of image
2593
    excluding last bytes in rows (if width is odd) contains
2594
    information on the color of 2 pixels, high-order tetrad
2595
    corresponds to first pixel.
2596
  * Format of image with 8 bits per pixel: each byte of image is
2597
    index in the palette.
2730 dunkaist 2598
  * Format of image with 9 bits per pixel: array of one byte values;
2599
    each byte (8 bit) represents the intensity of gray for one pixel;
2600
    this format is equal to 8bpp without palette.
1018 diamond 2601
  * Format of image with 15 bits per pixel: the color of each pixel
2602
    is coded as (bit representation) 0RRRRRGGGGGBBBBB - 5 bits per
2603
    each color.
2604
  * Format of image with 16 bits per pixel: the color of each pixel
2605
    is coded as RRRRRGGGGGGBBBBB (5+6+5).
2606
  * Format of image with 24 bits per pixel: the color of each pixel
2607
    is coded as 3 bytes - sequentially blue, green, red components.
2608
  * Format of image with 32 bits per pixel: similar to 24, but
2609
    one additional ignored byte is present.
314 diamond 2610
  * The call to function 7 is equivalent to call to this function
2611
    with esi=24, ebp=0.
283 diamond 2612
 
2613
======================================================================
118 diamond 2614
================== Function 66 - work with keyboard. =================
114 mikedld 2615
======================================================================
118 diamond 2616
The input mode influences results of reading keys by function 2.
2617
When a program loads, ASCII input mode is set for it.
114 mikedld 2618
 
118 diamond 2619
-------------- Subfunction 1 - set keyboard input mode. --------------
114 mikedld 2620
Parameters:
118 diamond 2621
  * eax = 66 - function number
2622
  * ebx = 1 - subfunction number
114 mikedld 2623
  * ecx = mode:
2624
    * 0 = normal (ASCII-characters)
2625
    * 1 = scancodes
2626
Returned value:
2627
  * function does not return value
2628
 
118 diamond 2629
-------------- Subfunction 2 - get keyboard input mode. --------------
114 mikedld 2630
Parameters:
118 diamond 2631
  * eax = 66 - function number
2632
  * ebx = 2 - subfunction number
114 mikedld 2633
Returned value:
2634
  * eax = current mode
2635
 
118 diamond 2636
------------ Subfunction 3 - get status of control keys. -------------
114 mikedld 2637
Parameters:
118 diamond 2638
  * eax = 66 - function number
2639
  * ebx = 3 - subfunction number
114 mikedld 2640
Returned value:
2641
  * eax = bit mask:
3355 mario79 2642
  * bit 0  (mask 1): left Shift is pressed
2643
  * bit 1  (mask 2): right Shift is pressed
2644
  * bit 2  (mask 4): left Ctrl is pressed
2645
  * bit 3  (mask 8): right Ctrl is pressed
2646
  * bit 4  (mask 0x10): left Alt is pressed
2647
  * bit 5  (mask 0x20): right Alt is pressed
2648
  * bit 6  (mask 0x40): CapsLock is on
2649
  * bit 7  (mask 0x80): NumLock is on
2650
  * bit 8  (mask 0x100): ScrollLock is on
2651
  * bit 9  (mask 0x200): left Win is pressed
2652
  * bit 10 (mask 0x400): right Win is pressed
118 diamond 2653
  * other bits are cleared
114 mikedld 2654
 
118 diamond 2655
-------------- Subfunction 4 - set system-wide hotkey. ---------------
2656
When hotkey is pressed, the system notifies only those applications,
2657
which have installed it; the active application (which receives
2658
all normal input) does not receive such keys.
2659
The notification consists in sending event with the code 2.
2660
Reading hotkey is the same as reading normal key - by function 2.
114 mikedld 2661
Parameters:
118 diamond 2662
  * eax = 66 - function number
2663
  * ebx = 4 - subfunction number
2664
  * cl determines key scancode;
2665
    use cl=0 to give combinations such as Ctrl+Shift
2666
  * edx = 0xXYZ determines possible states of control keys:
2667
    * Z (low 4 bits) determines state of LShift and RShift:
2668
      * 0 = no key must be pressed;
2669
      * 1 = exactly one key must be pressed;
2670
      * 2 = both keys must be pressed;
2671
      * 3 = must be pressed LShift, but not RShift;
2672
      * 4 = must be pressed RShift, but not LShift
2673
    * Y - similar for LCtrl and RCtrl;
2674
    * X - similar for LAlt and RAlt
114 mikedld 2675
Returned value:
118 diamond 2676
  * eax=0 - success
2677
  * eax=1 - too mant hotkeys (maximum 256 are allowed)
114 mikedld 2678
Remarks:
118 diamond 2679
  * Hotkey can work either at pressing or at release. Release
2680
    scancode of a key is more on 128 than pressing scancode
2681
    (i.e. high bit is set).
2682
  * Several applications can set the same combination;
2683
    all such applications will be informed on pressing
2684
    such combination.
114 mikedld 2685
 
118 diamond 2686
-------------- Subfunction 5 - delete installed hotkey. --------------
114 mikedld 2687
Parameters:
118 diamond 2688
  * eax = 66 - function number
2689
  * ebx = 5 - subfunction number
2690
  * cl = scancode of key and edx = 0xXYZ the same as in subfunction 4
114 mikedld 2691
Returned value:
118 diamond 2692
  * eax = 0 - success
114 mikedld 2693
  * eax = 1 - there is no such hotkey
2694
Remarks:
118 diamond 2695
  * When a process/thread terminates, all hotkey installed by it are
2696
    deleted.
2697
  * The call to this subfunction does not affect other applications.
2698
    If other application has defined the same combination, it will
2699
    still receive notices.
114 mikedld 2700
 
2709 mario79 2701
--------------- Subfunction 6 - block the normal input. --------------
2702
Parameters:
2703
  * eax = 66 - function number
2704
  * ebx = 6 - subfunction number
2705
Returned value:
2706
  * function does not return value
2707
Remarks:
2708
  * Blocking the normal keyboard input for installed hotkeys
2709
  * To emulate a mouse via the keyboard, the application MOUSEMUL
2710
 
2711
------------ Subfunction 7 - unlock the normal input. ----------------
2712
Parameters:
2713
  * eax = 66 - function number
2714
  * ebx = 7 - subfunction number
2715
Returned value:
2716
  * function does not return value
2717
Remarks:
2718
  * Unlocking the results of the f. 66.6
2719
  * To emulate a mouse via the keyboard, the application MOUSEMUL
2720
 
114 mikedld 2721
======================================================================
118 diamond 2722
========= Function 67 - change position/sizes of the window. =========
114 mikedld 2723
======================================================================
2724
Parameters:
118 diamond 2725
  * eax = 67 - function number
114 mikedld 2726
  * ebx = new x-coordinate of the window
2727
  * ecx = new y-coordinate of the window
2728
  * edx = new x-size of the window
2729
  * esi = new y-size of the window
2730
Returned value:
2731
  * function does not return value
2732
Remarks:
118 diamond 2733
  * The value -1 for a parameter means "do not change"; e.g. to move
2734
    the window without resizing it is possible to specify edx=esi=-1.
2735
  * Previously the window must be defined by function 0.
114 mikedld 2736
    It sets initial coordinates and sizes of the window.
118 diamond 2737
  * Sizes of the window are understood in sense of function 0,
2738
    that is one pixel less than real sizes.
2739
  * The function call for maximized windows is simply ignored.
2740
  * For windows of appropriate styles position and/or sizes can be
2741
    changed by user; current position and sizes can be obtained by
2742
    call to function 9.
2743
  * The function sends to the window redraw event (with the code 1).
114 mikedld 2744
 
2745
======================================================================
118 diamond 2746
====== Function 68, subfunction 0 - get the task switch counter. =====
114 mikedld 2747
======================================================================
2748
Parameters:
118 diamond 2749
  * eax = 68 - function number
2750
  * ebx = 0 - subfunction number
114 mikedld 2751
Returned value:
118 diamond 2752
  * eax = number of task switches from the system booting
2753
    (modulo 2^32)
114 mikedld 2754
 
2755
======================================================================
118 diamond 2756
======= Function 68, subfunction 1 - switch to the next thread. ======
114 mikedld 2757
======================================================================
118 diamond 2758
The function completes the current time slice allocated to the
2759
thread and switches to the next. (Which thread in which process
2760
will be next, is unpredictable). Later, when execution queue
2761
will reach the current thread, execution will be continued.
114 mikedld 2762
Parameters:
118 diamond 2763
  * eax = 68 - function number
2764
  * ebx = 1 - subfunction number
114 mikedld 2765
Returned value:
2766
  * function does not return value
2767
 
2768
======================================================================
118 diamond 2769
============= Function 68, subfunction 2 - cache + rdpmc. ============
114 mikedld 2770
======================================================================
2771
Parameters:
118 diamond 2772
  * eax = 68 - function number
2773
  * ebx = 2 - subfunction number
2774
  * ecx = required action:
2775
    * ecx = 0 - enable instruction 'rdpmc'
2776
      (ReaD Performance-Monitoring Counters) for applications
2777
    * ecx = 1 - find out whether cache is disabled/enabled
2778
    * ecx = 2 - enable cache
2779
    * ecx = 3 - disable cache
114 mikedld 2780
Returned value:
2781
  * for ecx=0:
118 diamond 2782
    * eax = the value of cr4
114 mikedld 2783
  * for ecx=1:
2784
    * eax = (cr0 and 0x60000000):
118 diamond 2785
    * eax = 0 - cache is on
2786
    * eax <> 0 - cache is off
114 mikedld 2787
  * for ecx=2 and ecx=3:
2788
    * function does not return value
2789
 
2790
======================================================================
2791
=========== Function 68, subfunction 3 - read MSR-register. ==========
2792
======================================================================
118 diamond 2793
MSR = Model Specific Register; the complete list of MSR-registers
2794
of a processor is included to the documentation on it (for example,
2795
IA-32 Intel Architecture Software Developer's Manual,
2796
Volume 3, Appendix B); each processor family has its own subset
2797
of the MSR-registers.
114 mikedld 2798
Parameters:
118 diamond 2799
  * eax = 68 - function number
2800
  * ebx = 3 - subfunction number
2801
  * ecx is ignored
2802
  * edx = MSR address
114 mikedld 2803
Returned value:
118 diamond 2804
  * ebx:eax = high:low dword of the result
114 mikedld 2805
Remarks:
118 diamond 2806
  * If ecx contains nonexistent or not implemented for this processor
2807
    MSR, processor will generate an exception in the kernel, which
2808
    will kill the thread.
2809
  * Previously it is necessary to check, whether MSRs are supported
2810
    as a whole, with the instruction 'cpuid'. Otherwise processor
2811
    will generate other exception in the kernel, which will anyway
2812
    kill the thread.
114 mikedld 2813
 
2814
======================================================================
118 diamond 2815
========= Function 68, subfunction 4 - write to MSR-register. ========
114 mikedld 2816
======================================================================
118 diamond 2817
MSR = Model Specific Register; the complete list of MSR-registers
2818
of a processor is included to the documentation on it (for example,
2819
IA-32 Intel Architecture Software Developer's Manual,
2820
Volume 3, Appendix B); each processor family has its own subset
2821
of the MSR-registers.
114 mikedld 2822
Parameters:
118 diamond 2823
  * eax = 68 - function number
2824
  * ebx = 4 - subfunction number
2825
  * ecx is ignored
2826
  * edx = MSR address
2827
  * esi:edi = high:low dword
114 mikedld 2828
Returned value:
499 diamond 2829
  * function does not return value
2830
Remarks:
118 diamond 2831
  * If ecx contains nonexistent or not implemented for this processor
2832
    MSR, processor will generate an exception in the kernel, which
2833
    will kill the thread.
2834
  * Previously it is necessary to check, whether MSRs are supported
2835
    as a whole, with the instruction 'cpuid'. Otherwise processor
2836
    will generate other exception in the kernel, which will anyway
2837
    kill the thread.
114 mikedld 2838
 
2839
======================================================================
193 diamond 2840
======= Function 68, subfunction 11 - initialize process heap. =======
114 mikedld 2841
======================================================================
2842
Parameters:
118 diamond 2843
  * eax = 68 - function number
193 diamond 2844
  * ebx = 11 - subfunction number
114 mikedld 2845
Returned value:
193 diamond 2846
  * eax = 0 - failed
2847
  * otherwise size of created heap
114 mikedld 2848
Remarks:
193 diamond 2849
  * The function call initializes heap, from which one can in future
2850
    allocate and free memory blocks with subfunctions 12 and 13.
2851
    Heap size is equal to total amount of free application memory.
2852
  * The second function call from the same process results in
2853
    returning the size of the existing heap.
2854
  * After creation of the heap calls to function 64 will be ignored.
114 mikedld 2855
 
2856
======================================================================
193 diamond 2857
======== Function 68, subfunction 12 - allocate memory block. ========
114 mikedld 2858
======================================================================
2859
Parameters:
118 diamond 2860
  * eax = 68 - function number
193 diamond 2861
  * ebx = 12 - subfunction number
2862
  * ecx = required size in bytes
114 mikedld 2863
Returned value:
193 diamond 2864
  * eax = pointer to the allocated block
114 mikedld 2865
Remarks:
193 diamond 2866
  * Before this call one must initialize process heap by call to
2867
    subfunction 11.
2868
  * The function allocates an integer number of pages (4 Kb) in such
2869
    way that the real size of allocated block is more than or equal to
2870
    requested size.
114 mikedld 2871
 
2872
======================================================================
193 diamond 2873
========== Function 68, subfunction 13 - free memory block. ==========
114 mikedld 2874
======================================================================
2875
Parameters:
118 diamond 2876
  * eax = 68 - function number
193 diamond 2877
  * ebx = 13 - subfunction number
2878
  * ecx = pointer to the memory block
114 mikedld 2879
Returned value:
193 diamond 2880
  * eax = 1 - success
2881
  * eax = 0 - failed
114 mikedld 2882
Remarks:
448 diamond 2883
  * The memory block must have been allocated by subfunction 12
2884
    or subfunction 20.
114 mikedld 2885
 
2886
======================================================================
1074 Galkov 2887
===================== Function 68, subfunction 14 ====================
1662 Nasarus 2888
============ Wait for signal from another program/driver. ============
114 mikedld 2889
======================================================================
2890
Parameters:
118 diamond 2891
  * eax = 68 - function number
193 diamond 2892
  * ebx = 14 - subfunction number
1074 Galkov 2893
  * ecx = pointer to the buffer for information (24 bytes)
114 mikedld 2894
Returned value:
193 diamond 2895
  * buffer pointed to by ecx contains the following information:
1662 Nasarus 2896
    * +0: dword: identifier for following data of signal
2897
    * +4: dword: data of signal (20 bytes), format of which is defined
2898
          by the first dword
114 mikedld 2899
 
2900
======================================================================
193 diamond 2901
============= Function 68, subfunction 16 - load driver. =============
2902
======================================================================
2903
Parameters:
2904
  * eax = 68 - function number
2905
  * ebx = 16 - subfunction number
2906
  * ecx = pointer to ASCIIZ-string with driver name
2907
Returned value:
2908
  * eax = 0 - failed
2909
  * otherwise eax = driver handle
2910
Remarks:
2911
  * If the driver was not loaded yet, it is loaded;
2912
    if the driver was loaded yet, nothing happens.
2913
  * Driver name is case-sensitive.
2914
    Maximum length of the name is 16 characters, including
2915
    terminating null character, the rest is ignored.
346 diamond 2916
  * Driver ABC is loaded from file /rd/1/drivers/ABC.obj.
193 diamond 2917
 
2918
======================================================================
2919
============ Function 68, subfunction 17 - driver control. ===========
2920
======================================================================
2921
Parameters:
2922
  * eax = 68 - function number
2923
  * ebx = 17 - subfunction number
2924
  * ecx = pointer to the control structure:
2925
    * +0: dword: handle of driver
2926
    * +4: dword: code of driver function
2927
    * +8: dword: pointer to input data
2928
    * +12 = +0xC: dword: size of input data
2929
    * +16 = +0x10: dword: pointer to output data
2930
    * +20 = +0x14: dword: size of output data
2931
Returned value:
1662 Nasarus 2932
  * eax = determined by driver
193 diamond 2933
Remarks:
2934
  * Function codes and the structure of input/output data
2935
    are defined by driver.
2936
  * Previously one must obtain driver handle by subfunction 16.
2937
 
2938
======================================================================
277 diamond 2939
=============== Function 68, subfunction 19 - load DLL. ==============
2940
======================================================================
2941
Parameters:
2942
  * eax = 68 - function number
2943
  * ebx = 19 - subfunction number
2944
  * ecx = pointer to ASCIIZ-string with the full path to DLL
2945
Returned value:
2946
  * eax = 0 - failed
2947
  * otherwise eax = pointer to DLL export table
2948
Remarks:
2949
  * Export table is an array of structures of 2 dword's, terminated
2950
    by zero. The first dword in structure points to function name,
2951
    the second dword contains address of function.
2952
 
2953
======================================================================
448 diamond 2954
======= Function 68, subfunction 20 - reallocate memory block. =======
2955
======================================================================
2956
Parameters:
2957
  * eax = 68 - function number
2958
  * ebx = 20 - subfunction number
2959
  * ecx = new size in bytes
2960
  * edx = pointer to already allocated block
2961
Returned value:
2962
  * eax = pointer to the reallocated block, 0 = error
2963
Remarks:
2964
  * Before this call one must initialize process heap by call to
2965
    subfunction 11.
2966
  * The function allocates an integer number of pages (4 Kb) in such
2967
    way that the real size of allocated block is more than or equal to
2968
    requested size.
2969
  * If edx=0, the function call is equivalent to memory allocation
2970
    with subfunction 12. Otherwise the block at edx
2971
    must be allocated earlier with subfunction 12 or this subfunction.
2972
  * If ecx=0, the function frees memory block at edx and returns 0.
2973
  * The contents of the block are unchanged up to the shorter of
2974
    the new and old sizes.
2975
 
2976
======================================================================
2646 mario79 2977
=========== Function 68, subfunction 21 - load driver PE. ============
2978
======================================================================
2979
Parameters:
2980
  * eax = 68 - function number
2981
  * ebx = 21 - subfunction number
2982
  * ecx = pointer to ASCIIZ-string with driver name
2647 mario79 2983
  * edx = pointer to command line
2646 mario79 2984
Returned value:
2985
  * eax = 0 - failed
2986
  * otherwise eax = driver handle
2987
Remarks:
2988
  * If the driver was not loaded yet, it is loaded;
2989
    if the driver was loaded yet, nothing happens.
2990
 
2991
======================================================================
1662 Nasarus 2992
======== Function 68, subfunction 22 - open named memory area. =======
1077 Galkov 2993
======================================================================
2994
Parameters:
2995
  * eax = 68 - function number
1662 Nasarus 2996
  * ebx = 22 - subfunction number
2997
  * ecx = area name. Maximum of 31 characters with terminating zero
2998
  * edx = area size in bytes for SHM_CREATE and SHM_OPEN_ALWAYS
2999
  * esi = flags for open and access:
3000
    * SHM_OPEN        = 0x00 - open existing memory area. If an area
3001
                          with such name does not exist, the function
3002
                          will return error code 5.
3003
    * SHM_OPEN_ALWAYS = 0x04 - open existing or create new
3004
                          memory area.
3005
    * SHM_CREATE      = 0x08 - create new memory area. If an area
3006
                          with such name already exists, the function
3007
                          will return error code 10.
3008
    * SHM_READ        = 0x00 - only read access
3009
    * SHM_WRITE       = 0x01 - read and write access
3010
Returned value:
3011
  * eax = pointer to memory area, 0 if error has occured
3012
  * if new area is created (SHM_CREATE or SHM_OPEN_ALWAYS):
3013
    edx = 0 - success, otherwise - error code
3014
  * if existing area is opened (SHM_OPEN or SHM_OPEN_ALWAYS):
3015
    edx = error code (if eax=0) or area size in bytes
3016
Error codes:
3017
  * E_NOTFOUND = 5
3018
  * E_ACCESS = 10
3019
  * E_NOMEM = 30
3020
  * E_PARAM = 33
3021
Remarks:
3022
  * Before this call one must initialize process heap by call to
3023
    subfunction 11.
3024
  * If a new area is created, access flags set maximal rights
3025
    for other processes. An attempt from other process to open
3026
    with denied rights will fail with error code E_ACCESS.
3027
  * The process which has created an area always has write access.
3028
 
3029
======================================================================
3030
======= Function 68, subfunction 23 - close named memory area. =======
3031
======================================================================
3032
Parameters:
3033
  * eax = 68 - function number
3034
  * ebx = 23 - subfunction number
3035
  * ecx = area name. Maximum of 31 characters with terminating zero
3036
Returned value:
3037
  * eax destroyed
3038
Remarks:
3039
  * A memory area is physically freed (with deleting all data and
3040
    freeing physical memory), when all threads which have opened
3041
    this area will close it.
3042
  * When thread is terminating, all opened by it areas are closed.
3043
 
3044
======================================================================
3045
======== Function 68, subfunction 24 - set exception handler. ========
3046
======================================================================
3047
Parameters:
3048
  * eax = 68 - function number
1077 Galkov 3049
  * ebx = 24 - subfunction number
3050
  * ecx = address of the new exception handler
1662 Nasarus 3051
  * edx = the mask of handled exceptions
1077 Galkov 3052
Returned value:
3053
  * eax = address of the old exception handler (0, if it was not set)
1662 Nasarus 3054
  * ebx = the old mask of handled exceptions
1077 Galkov 3055
Remarks:
1662 Nasarus 3056
  * Bit number in mask of exceptions corresponds to exception number
3057
    in CPU-specification (Intel-PC). For example, FPU exceptions have
3058
    number 16 (#MF), and SSE exceptions - 19 (#XF).
3059
  * The current implementation ignores the inquiry for hook of 7
3060
    exception - the system handles #NM by its own.
3061
  * The exception handler is called with exception number as first
3062
    (and only) stack parameter. So, correct exit from the handler is
3063
    RET 4. It returns to the instruction, that caused the exception,
3064
    for faults, and to the next instruction for traps (see
3065
    classification of exceptions in CPU specification).
3066
  * When user handler receives control, the corresponding bit in
3067
    the exception mask is cleared. Raising this exception
3068
    in consequence leads to default handling, that is,
3069
    terminating the application in absence of debugger or
3070
    suspend with notification of debugger otherwise.
3071
  * After user handler completes critical operations, it can set
3072
    the corresponding bit in the exception mask with subfunction 25.
3073
    Also user handler is responsible for clearing exceptions flags in
3074
    FPU and/or SSE.
1077 Galkov 3075
 
3076
======================================================================
1662 Nasarus 3077
====== Function 68, subfunction 25 - set FPU exception handler. ======
1077 Galkov 3078
======================================================================
3079
Parameters:
3080
  * eax = 68 - function number
3081
  * ebx = 25 - subfunction number
3082
  * ecx = signal number
3083
  * edx = value of activity (0/1)
3084
Returned value:
1662 Nasarus 3085
  * eax = -1 - invalid signal number
3086
  * otherwise eax = old value of activity for this signal (0/1)
1077 Galkov 3087
Remarks:
1662 Nasarus 3088
  * In current implementation only mask for user excepton handler,
3089
    which has been previously set by subfunction 24,
3090
    is changed. Signal number corresponds to exception number.
1077 Galkov 3091
 
3092
======================================================================
3787 Serge 3093
====== Function 68, subfunction 26 - release memory pages ============
3094
======================================================================
3095
Parameters:
3096
  * eax = 68 - function number
3097
  * ebx = 26 - subfunction number
3098
  * ecx = pointer to the memory block, allocated by subfunction 12
3099
  * edx = offset from the block beginnings
3100
  * esi = the size of the region of memory to release, in bytes
3101
Remarks:
3102
  * function release range of pages from ecx+edx to ecx+edx+esi
3103
    and set virtual memory into reserved state.
3104
 
3105
======================================================================
3106
========== Function 68, subfunction 27 - load file ===================
3107
======================================================================
3108
Parameters:
3109
  * eax = 68 - function number
3110
  * ebx = 27 - subfunction number
3111
  * ecx = pointer to ASCIIZ-string with the filename
3112
Returned value:
3113
  * eax = pointer to the loaded file, or zero
3114
  * edx = size of the loaded file, or zero
3115
Remarks:
3116
  * function loads file and unpacks, if necessary
3117
 
3118
======================================================================
1662 Nasarus 3119
====================== Function 69 - debugging. ======================
114 mikedld 3120
======================================================================
118 diamond 3121
A process can load other process as debugged by set of corresponding
193 diamond 3122
bit by call to subfunction 7 of function 70.
118 diamond 3123
A process can have only one debugger; one process can debug some
3124
others. The system notifies debugger on events occuring with
3125
debugged process. Messages are written to the buffer defined by
114 mikedld 3126
subfunction 0.
118 diamond 3127
Format of a message:
3128
  * +0: dword: message code
3129
  * +4: dword: PID of debugged process
3130
  * +8: there can be additional data depending on message code
3131
Message codes:
114 mikedld 3132
  * 1 = exception
118 diamond 3133
    * in addition dword-number of the exception is given
3134
    * process is suspended
3135
  * 2 = process has terminated
3136
    * comes at any termination: both through the system function -1,
3137
      and at "murder" by any other process (including debugger itself)
114 mikedld 3138
  * 3 = debug exception int 1 = #DB
118 diamond 3139
    * in addition dword-image of the register DR6 is given:
3140
      * bits 0-3: condition of the corresponding breakpoint (set by
3141
        subfunction 9) is satisfied
3539 clevermous 3142
      * bit 14: exception has occured because of the trace mode
118 diamond 3143
        (flag TF is set TF)
3144
    * process is suspended
3145
When debugger terminates, all debugged processes are killed.
3146
If debugger does not want this, it must previously detach by
114 mikedld 3147
subfunction 3.
3148
 
1018 diamond 3149
All subfunctions are applicable only to processes/threads started
3150
from the current by function 70 with set debugging flag.
118 diamond 3151
Debugging of multithreaded programs is not supported yet.
3152
The full list of subfunctions:
3153
  * subfunction 0 - define data area for debug messages
3154
  * subfunction 1 - get contents of registers of debugged thread
3155
  * subfunction 2 - set contents of registers of debugged thread
3156
  * subfunction 3 - detach from debugged process
3157
  * subfunction 4 - suspend debugged thread
3158
  * subfunction 5 - resume debugged thread
3159
  * subfunction 6 - read from the memory of debugged process
3160
  * subfunction 7 - write to the memory of debugged process
3161
  * subfunction 8 - terminate debugged thread
3162
  * subfunction 9 - set/clear hardware breakpoint
114 mikedld 3163
 
3164
======================================================================
118 diamond 3165
= Function 69, subfunction 0 - define data area fror debug messages. =
114 mikedld 3166
======================================================================
3167
Parameters:
118 diamond 3168
  * eax = 69 - function number
3169
  * ebx = 0 - subfunction number
114 mikedld 3170
  * ecx = pointer
3171
Format of data area:
118 diamond 3172
  * +0: dword: N = buffer size (not including this header)
3173
  * +4: dword: occupied place
114 mikedld 3174
  * +8: N*byte: buffer
3175
Returned value:
3176
  * function does not return value
3177
Remarks:
118 diamond 3178
  * If the size field is negative, the buffer is considered locked
3179
    and at arrival of new message the system will wait.
3180
    For synchronization frame all work with the buffer by operations
3181
    lock/unlock
1662 Nasarus 3182
    	neg	[bufsize]
118 diamond 3183
  * Data in the buffer are considered as array of items with variable
3184
    length - messages. Format of a message is explained in
3185
    general description.
114 mikedld 3186
 
3187
======================================================================
118 diamond 3188
===================== Function 69, subfunction 1 =====================
3189
============ Get contents of registers of debugged thread. ===========
114 mikedld 3190
======================================================================
3191
Parameters:
118 diamond 3192
  * eax = 69 - function number
3193
  * ebx = 1 - subfunction number
114 mikedld 3194
  * ecx = thread identifier
118 diamond 3195
  * edx = size of context structure, must be 0x28=40 bytes
3196
  * esi = pointer to context structure
114 mikedld 3197
Returned value:
3198
  * function does not return value
118 diamond 3199
Format of context structure: (FPU is not supported yet)
114 mikedld 3200
  * +0: dword: eip
3201
  * +4: dword: eflags
3202
  * +8: dword: eax
3203
  * +12 = +0xC: dword: ecx
3204
  * +16 = +0x10: dword: edx
3205
  * +20 = +0x14: dword: ebx
3206
  * +24 = +0x18: dword: esp
3207
  * +28 = +0x1C: dword: ebp
3208
  * +32 = +0x20: dword: esi
3209
  * +36 = +0x24: dword: edi
3210
Remarks:
118 diamond 3211
  * If the thread executes code of ring-0, the function returns
3212
    contents of registers of ring-3.
3213
  * Process must be loaded for debugging (as is shown in
3214
    general description).
114 mikedld 3215
 
3216
======================================================================
118 diamond 3217
===================== Function 69, subfunction 2 =====================
3218
============ Set contents of registers of debugged thread. ===========
114 mikedld 3219
======================================================================
3220
Parameters:
118 diamond 3221
  * eax = 69 - function number
3222
  * ebx = 2 - subfunction number
114 mikedld 3223
  * ecx = thread identifier
118 diamond 3224
  * edx = size of context structure, must be 0x28=40 bytes
114 mikedld 3225
Returned value:
3226
  * function does not return value
118 diamond 3227
Format of context structure is shown in the description of
3228
subfunction 1.
114 mikedld 3229
Remarks:
118 diamond 3230
  * If the thread executes code of ring-0, the function returns
3231
    contents of registers of ring-3.
3232
  * Process must be loaded for debugging (as is shown in
3233
    general description).
114 mikedld 3234
 
3235
======================================================================
118 diamond 3236
===== Function 69, subfunction 3 - detach from debugged process. =====
114 mikedld 3237
======================================================================
3238
Parameters:
118 diamond 3239
  * eax = 69 - function number
3240
  * ebx = 3 - subfunction number
114 mikedld 3241
  * ecx = identifier
3242
Returned value:
3243
  * function does not return value
3244
Remarks:
118 diamond 3245
  * If the process was suspended, it resumes execution.
114 mikedld 3246
 
3247
======================================================================
1018 diamond 3248
======== Function 69, subfunction 4 - suspend debugged thread. =======
114 mikedld 3249
======================================================================
3250
Parameters:
118 diamond 3251
  * eax = 69 - function number
3252
  * ebx = 4 - subfunction number
3253
  * ecx = thread identifier
114 mikedld 3254
Returned value:
3255
  * function does not return value
1018 diamond 3256
Remarks:
3257
  * Process must be loaded for debugging (as is shown in
3258
    general description).
114 mikedld 3259
 
3260
======================================================================
1018 diamond 3261
======== Function 69, subfunction 5 - resume debugged thread. ========
114 mikedld 3262
======================================================================
3263
Parameters:
118 diamond 3264
  * eax = 69 - function number
3265
  * ebx = 5 - subfunction number
3266
  * ecx = thread identifier
114 mikedld 3267
Returned value:
3268
  * function does not return value
1018 diamond 3269
Remarks:
3270
  * Process must be loaded for debugging (as is shown in
3271
    general description).
114 mikedld 3272
 
3273
======================================================================
118 diamond 3274
= Fucntion 69, subfunction 6 - read from memory of debugged process. =
114 mikedld 3275
======================================================================
3276
Parameters:
118 diamond 3277
  * eax = 69 - function number
3278
  * ebx = 6 - subfunction number
114 mikedld 3279
  * ecx = identifier
118 diamond 3280
  * edx = number of bytes to read
3281
  * esi = address in the memory of debugged process
3282
  * edi = pointer to buffer for data
114 mikedld 3283
Returned value:
118 diamond 3284
  * eax = -1 at an error (invalid PID or buffer)
3285
  * otherwise eax = number of read bytes (possibly, 0,
3286
    if esi is too large)
114 mikedld 3287
Remarks:
118 diamond 3288
  * Process must be loaded for debugging (as is shown in
3289
    general description).
114 mikedld 3290
 
3291
======================================================================
118 diamond 3292
== Function 69, subfunction 7 - write to memory of debugged process. =
114 mikedld 3293
======================================================================
3294
Parameters:
118 diamond 3295
  * eax = 69 - function number
3296
  * ebx = 7 - subfunction number
114 mikedld 3297
  * ecx = identifier
118 diamond 3298
  * edx = number of bytes to write
3299
  * esi = address of memory in debugged process
3300
  * edi = pointer to data
114 mikedld 3301
Returned value:
118 diamond 3302
  * eax = -1 at an error (invalid PID or buffer)
3303
  * otherwise eax = number of written bytes (possibly, 0,
3304
    if esi is too large)
114 mikedld 3305
Remarks:
118 diamond 3306
  * Process must be loaded for debugging (as is shown in
3307
    general description).
114 mikedld 3308
 
3309
======================================================================
118 diamond 3310
======= Function 69, subfunction 8 - terminate debugged thread. ======
114 mikedld 3311
======================================================================
3312
Parameters:
118 diamond 3313
  * eax = 69 - function number
3314
  * ebx = 8 - subfunction number
114 mikedld 3315
  * ecx = identifier
3316
Returned value:
3317
  * function does not return value
3318
Remarks:
118 diamond 3319
  * Process must be loaded for debugging (as is shown in
3320
    general description).
3321
  * The function is similar to subfunction 2 of function 18
3322
    with two differences: it requires first remark and
3323
    accepts PID rather than slot number.
114 mikedld 3324
 
3325
======================================================================
118 diamond 3326
===== Function 69, subfunction 9 - set/clear hardware breakpoint. ====
114 mikedld 3327
======================================================================
3328
Parameters:
118 diamond 3329
  * eax = 69 - function number
3330
  * ebx = 9 - subfunction number
114 mikedld 3331
  * ecx = thread identifier
118 diamond 3332
  * dl = index of breakpoint, from 0 to 3 inclusively
114 mikedld 3333
  * dh = flags:
118 diamond 3334
    * if high bit is cleared - set breakpoint:
114 mikedld 3335
      * bits 0-1 - condition:
3336
        * 00 = breakpoint on execution
118 diamond 3337
        * 01 = breakpoint on read
3338
        * 11 = breakpoint on read/write
3339
      * bits 2-3 - length; for breakpoints on exception it must be
3340
        00, otherwise one of
3341
        * 00 = byte
114 mikedld 3342
        * 01 = word
118 diamond 3343
        * 11 = dword
3344
      * esi = breakpoint address; must be aligned according to
3345
        the length (i.e. must be even for word breakpoints,
3346
        divisible by 4 for dword)
3347
    * if high bit is set - clear breakpoint
114 mikedld 3348
Returned value:
118 diamond 3349
  * eax = 0 - success
114 mikedld 3350
  * eax = 1 - error in the input data
118 diamond 3351
  * eax = 2 - (reserved, is never returned in the current
3352
    implementation) a global breakpoint with that index is already set
114 mikedld 3353
Remarks:
118 diamond 3354
  * Process must be loaded for debugging (as is shown in
3355
    general description).
3356
  * Hardware breakpoints are implemented through DRx-registers of
3357
    the processor, all limitations results from this.
3358
  * The function can reinstall the breakpoint, previously set
3359
    by it (and it does not inform on this).
3360
    Carry on the list of set breakpoints in the debugger.
3361
  * Breakpoints generate debug exception #DB, on which the system
3362
    notifies debugger.
3363
  * Breakpoints on write and read/write act after
3364
    execution of the caused it instruction.
114 mikedld 3365
 
3366
======================================================================
118 diamond 3367
==== Function 70 - work with file system with long names support. ====
114 mikedld 3368
======================================================================
3369
Parameters:
3370
  * eax = 70
118 diamond 3371
  * ebx = pointer to the information structure
114 mikedld 3372
Returned value:
118 diamond 3373
  * eax = 0 - success; otherwise file system error code
3374
  * some subfunctions return value in other registers too
3375
General format of the information structure:
3376
  * +0: dword: subfunction number
3377
  * +4: dword: file offset
3378
  * +8: dword: high dword of offset (must be 0) or flags field
114 mikedld 3379
  * +12 = +0xC: dword: size
118 diamond 3380
  * +16 = +0x10: dword: pointer to data
3381
  * +20 = +0x14: n db: ASCIIZ-string with the filename
114 mikedld 3382
    or
3383
  * +20 = +0x14: db 0
118 diamond 3384
  * +21 = +0x15: dd pointer to ASCIIZ-string with the filename
3385
Specifications - in documentation on the appropriate subfunction.
3386
Filename is case-insensitive. Russian letters must be written in
3387
the encoding cp866 (DOS).
3388
Format of filename:
114 mikedld 3389
/base/number/dir1/dir2/.../dirn/file,
118 diamond 3390
where /base/number identifies device, on which file is located:
114 mikedld 3391
one of
118 diamond 3392
  * /RD/1 = /RAMDISK/1 to access ramdisk
3393
  * /FD/1 = /FLOPPYDISK/1 to access first floppy drive,
3394
    /FD/2 = /FLOPPYDISK/2 to access second one
3395
  * /HD0/x, /HD1/x, /HD2/x, /HD3/x to access accordingly to devices
3396
    IDE0 (Primary Master), IDE1 (Primary Slave),
114 mikedld 3397
    IDE2 (Secondary Master), IDE3 (Secondary Slave);
118 diamond 3398
    x - partition number on the selected hard drive, varies from 1
3399
    to 255 (on each hard drive the indexing starts from 1)
3400
  * /CD0/1, /CD1/1, /CD2/1, /CD3/1 to access accordingly to
3401
    CD on IDE0 (Primary Master), IDE1 (Primary Slave),
3402
    IDE2 (Secondary Master), IDE3 (Secondary Slave)
546 diamond 3403
  * /SYS means system folder; with the usual boot (from floppy)
3404
    is equivalent to /RD/1
114 mikedld 3405
Examples:
3406
  * '/rd/1/kernel.asm',0
3407
  * '/HD0/1/kernel.asm',0
3408
  * '/hd0/2/menuet/pics/tanzania.bmp',0
3409
  * '/hd0/1/Program files/NameOfProgram/SomeFile.SomeExtension',0
546 diamond 3410
  * '/sys/MySuperApp.ini',0
3780 Serge 3411
Also function supports relative names.  If the path begins not
3412
with '/', it is considered relative to a current folder. To get or
1662 Nasarus 3413
set a current folder, use the function 30.
3414
 
118 diamond 3415
Available subfunctions:
114 mikedld 3416
  * subfunction 0 - read file
3417
  * subfunction 1 - read folder
3418
  * subfunction 2 - create/rewrite file
131 diamond 3419
  * subfunction 3 - write to existing file
133 diamond 3420
  * subfunction 4 - set file size
118 diamond 3421
  * subfunction 5 - get attributes of file/folder
3422
  * subfunction 6 - set attributes of file/folder
114 mikedld 3423
  * subfunction 7 - start application
193 diamond 3424
  * subfunction 8 - delete file/folder
321 diamond 3425
  * subfunction 9 - create folder
118 diamond 3426
For CD-drives due to hardware limitations only subfunctions
3427
0,1,5 and 7 are available, other subfunctions return error
3428
with code 2.
641 diamond 3429
At the first call of subfunctions 0,1,5,7 to ATAPI devices
3430
(CD and DVD) the manual control of tray is locked due to caching
3431
drive data. Unlocking is made when subfunction 4 of function 24
3432
is called for corresponding device.
114 mikedld 3433
 
3434
======================================================================
118 diamond 3435
=== Function 70, subfunction 0 - read file with long names support. ==
114 mikedld 3436
======================================================================
3437
Parameters:
118 diamond 3438
  * eax = 70 - function number
3439
  * ebx = pointer to the information structure
3440
Format of the information structure:
3441
  * +0: dword: 0 = subfunction number
3442
  * +4: dword: file offset (in bytes)
3443
  * +8: dword: 0 (reserved for high dword of offset)
3444
  * +12 = +0xC: dword: number of bytes to read
3445
  * +16 = +0x10: dword: pointer to buffer for data
3446
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3447
    given in the general description
114 mikedld 3448
    or
3449
  * +20 = +0x14: db 0
118 diamond 3450
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3451
Returned value:
118 diamond 3452
  * eax = 0 - success, otherwise file system error code
3453
  * ebx = number of read bytes or -1=0xffffffff if file was not found
114 mikedld 3454
Remarks:
118 diamond 3455
  * If file was ended before last requested block was read,
3456
    the function will read as many as it can, and after that return
3457
    eax=6 (EOF).
3458
  * The function does not allow to read folder (returns eax=10,
3459
    access denied).
114 mikedld 3460
 
118 diamond 3461
======================================================================
3462
== Function 70, subfunction 1 - read folder with long names support. =
3463
======================================================================
114 mikedld 3464
Parameters:
118 diamond 3465
  * eax = 70 - function number
3466
  * ebx = pointer to the information structure
3467
Format of the information structure:
3468
  * +0: dword: 1 = subfunction number
3469
  * +4: dword: index of starting block (beginning from 0)
3470
  * +8: dword: flags field:
114 mikedld 3471
    * bit 0 (mask 1): in what format to return names,
3472
      0=ANSI, 1=UNICODE
118 diamond 3473
    * other bits are reserved and must be set to 0 for the future
3474
      compatibility
3475
  * +12 = +0xC: dword: number of blocks to read
3476
  * +16 = +0x10: dword: pointer to buffer for data, buffer size
3477
    must be not less than 32 + [+12]*560 bytes
3478
  * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are
3479
    given in the general description
114 mikedld 3480
    or
3481
  * +20 = +0x14: db 0
118 diamond 3482
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3483
Returned value:
118 diamond 3484
  * eax = 0 - success, otherwise file system error code
3485
  * ebx = number of files, information on which was written to
3486
    the buffer, or -1=0xffffffff, if folder was not found
114 mikedld 3487
Structure of the buffer:
3488
  * +0: 32*byte: header
3489
  * +32 = +0x20: n1*byte: block with information on file 1
118 diamond 3490
  * +32+n1: n2*byte: block with information on file 2
114 mikedld 3491
  * ...
3492
Structure of header:
118 diamond 3493
  * +0: dword: version of structure (current is 1)
3494
  * +4: dword: number of placed blocks; is not greater than requested
3495
    in the field +12 of information structure; can be less, if
3496
    there are no more files in folder (the same as in ebx)
3497
  * +8: dword: total number of files in folder
3498
  * +12 = +0xC: 20*byte: reserved (zeroed)
3499
Structure of block of data for folder entry (BDFE):
3500
  * +0: dword: attributes of file:
3501
    * bit 0 (mask 1): file is read-only
3502
    * bit 1 (mask 2): file is hidden
3503
    * bit 2 (mask 4): file is system
3504
    * bit 3 (mask 8): this is not a file but volume label
3505
      (for one partition meets no more than once and
3506
      only in root folder)
3507
    * bit 4 (mask 0x10): this is a folder
3508
    * bit 5 (mask 0x20): file was not archived - many archivation
3509
      programs have an option to archive only files with this bit set,
3510
      and after archiving this bit is cleared - it can be useful
3511
      for automatically creating of backup-archives as at writing
3512
      this bit is usually set
3513
  * +4: byte: type of name data:
3514
    (coincides with bit 0 of flags in the information structure)
3515
    * 0 = ASCII = 1-byte representation of each character
3516
    * 1 = UNICODE = 2-byte representation of each character
114 mikedld 3517
  * +5: 3*byte: reserved (zero)
118 diamond 3518
  * +8: 4*byte: time of file creation
3519
  * +12 = +0xC: 4*byte: date of file creation
3520
  * +16 = +0x10: 4*byte: time of last access (read or write)
114 mikedld 3521
  * +20 = +0x14: 4*byte: date of last access
118 diamond 3522
  * +24 = +0x18: 4*byte: time of last modification
3523
  * +28 = +0x1C: 4*byte: date of last modification
3524
  * +32 = +0x20: qword: file size in bytes (up to 16777216 Tb)
114 mikedld 3525
  * +40 = +0x28: name
118 diamond 3526
    * for ASCII format: maximum length is 263 characters
3527
      (263 bytes), byte after the name has value 0
321 diamond 3528
    * for UNICODE format: maximum length is 259 characters
118 diamond 3529
      (518 bytes), 2 bytes after the name have value 0
3530
Time format:
114 mikedld 3531
  * +0: byte: seconds
3532
  * +1: byte: minutes
3533
  * +2: byte: hours
3534
  * +3: byte: reserved (0)
118 diamond 3535
  * for example, 23.59.59 is written as (in hex) 3B 3B 17 00
3536
Date format:
3537
  * +0: byte: day
3538
  * +1: byte: month
3539
  * +2: word: year
3540
  * for example, 25.11.1979 is written as (in hex) 19 0B BB 07
114 mikedld 3541
Remarks:
118 diamond 3542
  * If BDFE contains ASCII name, the length of BDFE is 304 bytes,
3543
    if UNICODE name - 560 bytes. Value of length is aligned
3544
    on 16-byte bound (to accelerate processing in CPU cache).
3545
  * First character after a name is zero (ASCIIZ-string). The further
3546
    data contain garbage.
3547
  * If files in folder were ended before requested number was read,
3548
    the function will read as many as it can, and after that return
3549
    eax=6 (EOF).
114 mikedld 3550
  * Any folder on the disk, except for root, contains two special
118 diamond 3551
    entries "." and "..", identifying accordingly the folder itself
3552
    and the parent folder.
3553
  * The function allows also to read virtual folders "/", "/rd",
3554
    "/fd", "/hd[n]", thus attributes of subfolders are set to 0x10,
3555
    and times and dates are zeroed. An alternative way to get the
3556
    equipment information - subfunction 11 of function 18.
114 mikedld 3557
 
3558
======================================================================
118 diamond 3559
===================== Function 70, subfunction 2 =====================
3560
============ Create/rewrite file with long names support. ============
114 mikedld 3561
======================================================================
3562
Parameters:
118 diamond 3563
  * eax = 70 - function number
3564
  * ebx = pointer to the information structure
3565
Format of the information structure:
3566
  * +0: dword: 2 = subfunction number
114 mikedld 3567
  * +4: dword: 0 (reserved)
3568
  * +8: dword: 0 (reserved)
4066 shikhin 3569
  * +12 = +0xC: dword: number of bytes to write
118 diamond 3570
  * +16 = +0x10: dword: pointer to data
3571
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3572
    given in the general description
114 mikedld 3573
    or
3574
  * +20 = +0x14: db 0
118 diamond 3575
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3576
Returned value:
118 diamond 3577
  * eax = 0 - success, otherwise file system error code
3578
  * ebx = number of written bytes (possibly 0)
114 mikedld 3579
Remarks:
118 diamond 3580
  * If a file with given name did not exist, it is created;
3581
    if it existed, it is rewritten.
3582
  * If there is not enough free space on disk, the function will
3583
    write as many as can and then return error code 8.
3584
  * The function is not supported for CD (returns error code 2).
114 mikedld 3585
 
3586
======================================================================
131 diamond 3587
===================== Function 70, subfunction 3 =====================
3588
=========== Write to existing file with long names support. ==========
3589
======================================================================
3590
Parameters:
3591
  * eax = 70 - function number
3592
  * ebx = pointer to the information structure
3593
Format of the information structure:
3594
  * +0: dword: 3 = subfunction number
3595
  * +4: dword: file offset (in bytes)
3596
  * +8: dword: high dword of offset (must be 0 for FAT)
3597
  * +12 = +0xC: dword: number of bytes to write
3598
  * +16 = +0x10: dword: pointer to data
3599
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3600
    given in the general description
3601
    or
3602
  * +20 = +0x14: db 0
3603
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
3604
Returned value:
3605
  * eax = 0 - success, otherwise file system error code
3606
  * ebx = number of written bytes (possibly 0)
3607
Remarks:
3608
  * The file must already exist, otherwise function returns eax=5.
3609
  * The only result of write 0 bytes is update in the file attributes
3610
    date/time of modification and access to the current date/time.
3611
  * If beginning and/or ending position is greater than file size
3612
    (except for the previous case), the file is expanded to needed
3613
    size with zero characters.
133 diamond 3614
  * The function is not supported for CD (returns error code 2).
131 diamond 3615
 
3616
======================================================================
133 diamond 3617
============ Function 70, subfunction 4 - set end of file. ===========
3618
======================================================================
3619
Parameters:
3620
  * eax = 70 - function number
3621
  * ebx = pointer to the information structure
3622
Format of the information structure:
3623
  * +0: dword: 4 = subfunction number
3624
  * +4: dword: low dword of new file size
3625
  * +8: dword: high dword of new file size (must be 0 for FAT)
3626
  * +12 = +0xC: dword: 0 (reserved)
3627
  * +16 = +0x10: dword: 0 (reserved)
3628
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3629
    given in the general description
3630
    or
3631
  * +20 = +0x14: db 0
3632
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
3633
Returned value:
3634
  * eax = 0 - success, otherwise file system error code
3635
  * ebx destroyed
3636
Remarks:
3637
  * If the new file size is less than old one, file is truncated.
3638
    If the new size is greater than old one, file is expanded with
3639
    characters with code 0. If the new size is equal to old one,
3640
    the only result of call is set date/time of modification and
3641
    access to the current date/time.
3642
  * If there is not enough free space on disk for expansion, the
3643
    function will expand to maximum possible size and then return
3644
    error code 8.
3645
  * The function is not supported for CD (returns error code 2).
3646
 
3647
======================================================================
118 diamond 3648
==== Function 70, subfunction 5 - get information on file/folder. ====
114 mikedld 3649
======================================================================
3650
Parameters:
118 diamond 3651
  * eax = 70 - function number
3652
  * ebx = pointer to the information structure
3653
Format of the information structure:
3654
  * +0: dword: 5 = subfunction number
114 mikedld 3655
  * +4: dword: 0 (reserved)
3656
  * +8: dword: 0 (reserved)
3657
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 3658
  * +16 = +0x10: dword: pointer to buffer for data (40 bytes)
3659
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3660
    given in the general description
114 mikedld 3661
    or
3662
  * +20 = +0x14: db 0
118 diamond 3663
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3664
Returned value:
118 diamond 3665
  * eax = 0 - success, otherwise file system error code
3666
  * ebx destroyed
3667
Information on file is returned in the BDFE format (block of data
3668
for folder entry), explained in the description of
3669
subfunction 1, but without filename
3670
(i.e. only first 40 = 0x28 bytes).
114 mikedld 3671
Remarks:
118 diamond 3672
  * The function does not support virtual folders such as /, /rd and
3673
    root folders like /rd/1.
114 mikedld 3674
 
3675
======================================================================
118 diamond 3676
===== Function 70, subfunction 6 - set attributes of file/folder. ====
114 mikedld 3677
======================================================================
3678
Parameters:
118 diamond 3679
  * eax = 70 - function number
3680
  * ebx = pointer to the information structure
3681
Format of the information structure:
3682
  * +0: dword: 6 = subfunction number
114 mikedld 3683
  * +4: dword: 0 (reserved)
3684
  * +8: dword: 0 (reserved)
3685
  * +12 = +0xC: dword: 0 (reserved)
118 diamond 3686
  * +16 = +0x10: dword: pointer to buffer with attributes (32 bytes)
3687
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3688
    given in the general description
114 mikedld 3689
    or
3690
  * +20 = +0x14: db 0
118 diamond 3691
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3692
Returned value:
118 diamond 3693
  * eax = 0 - success, otherwise file system error code
3694
  * ebx destroyed
3695
File attributes are first 32 bytes in BDFE (block of data
3696
for folder entry), explained in the description of subfunction 1
3697
(that is, without name and size of file). Attribute
3698
file/folder/volume label (bits 3,4 in dword +0) is not changed.
3699
Byte +4 (name format) is ignored.
114 mikedld 3700
Remarks:
118 diamond 3701
  * The function does not support virtual folders such as /, /rd and
3702
    root folders like /rd/1.
3703
  * The function is not supported for CD (returns error code 2).
114 mikedld 3704
 
3705
======================================================================
118 diamond 3706
=========== Function 70, subfunction 7 - start application. ==========
114 mikedld 3707
======================================================================
3708
Parameters:
118 diamond 3709
  * eax = 70 - function number
3710
  * ebx = pointer to the information structure
3711
Format of the information structure:
3712
  * +0: dword: 7 = subfunction number
3713
  * +4: dword: flags field:
3539 clevermous 3714
    * bit 0: start process as debugged
118 diamond 3715
    * other bits are reserved and must be set to 0
3716
  * +8: dword: 0 or pointer to ASCIIZ-string with parameters
114 mikedld 3717
  * +12 = +0xC: dword: 0 (reserved)
3718
  * +16 = +0x10: dword: 0 (reserved)
118 diamond 3719
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3720
    given in the general description
114 mikedld 3721
    or
3722
  * +20 = +0x14: db 0
118 diamond 3723
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
114 mikedld 3724
Returned value:
3725
  * eax > 0 - program is loaded, eax contains PID
118 diamond 3726
  * eax < 0 - an error has occured, -eax contains
3727
    file system error code
3728
  * ebx destroyed
114 mikedld 3729
Remarks:
118 diamond 3730
  * Command line must be terminated by the character with the code 0
3731
    (ASCIIZ-string); function takes into account either all characters
3732
    up to terminating zero inclusively or first 256 character
3733
    regarding what is less.
3734
  * If the process is started as debugged, it is created in
3735
    the suspended state; to run use subfunction 5 of function 69.
114 mikedld 3736
 
3737
======================================================================
193 diamond 3738
========== Function 70, subfunction 8 - delete file/folder. ==========
3739
======================================================================
3740
Parameters:
3741
  * eax = 70 - function number
3742
  * ebx = pointer to the information structure
3743
Format of the information structure:
3744
  * +0: dword: 8 = subfunction number
3745
  * +4: dword: 0 (reserved)
3746
  * +8: dword: 0 (reserved)
3747
  * +12 = +0xC: dword: 0 (reserved)
3748
  * +16 = +0x10: dword: 0 (reserved)
3749
  * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are
3750
    given in the general description
3751
    or
3752
  * +20 = +0x14: db 0
3753
  * +21 = +0x15: dd pointer to ASCIIZ-string with file name
3754
Returned value:
3755
  * eax = 0 - success, otherwise file system error code
3756
  * ebx destroyed
3757
Remarks:
3758
  * The function is not supported for CD (returns error code 2).
3759
  * The function can delete only empty folders (attempt to delete
3760
    nonempty folder results in error with code 10, "access denied").
3761
 
3762
======================================================================
321 diamond 3763
============= Function 70, subfunction 9 - create folder. ============
3764
======================================================================
3765
Parameters:
3766
  * eax = 70 - function number
3767
  * ebx = pointer to the information structure
3768
Format of the information structure:
3769
  * +0: dword: 9 = subfunction number
3770
  * +4: dword: 0 (reserved)
3771
  * +8: dword: 0 (reserved)
3772
  * +12 = +0xC: dword: 0 (reserved)
3773
  * +16 = +0x10: dword: 0 (reserved)
3774
  * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are
3775
    given in the general description
3776
    or
3777
  * +20 = +0x14: db 0
3778
  * +21 = +0x15: dd pointer to ASCIIZ-string with folder name
3779
Returned value:
3780
  * eax = 0 - success, otherwise file system error code
3781
  * ebx destroyed
3782
Remarks:
3783
  * The function is not supported for CD (returns error code 2).
3784
  * The parent folder must already exist.
3785
  * If target folder already exists, function returns success (eax=0).
3786
 
3787
======================================================================
118 diamond 3788
========== Function 71, subfunction 1 - set window caption. ==========
114 mikedld 3789
======================================================================
3790
Parameters:
3791
  * eax = 71 - function number
3792
  * ebx = 1 - subfunction number
118 diamond 3793
  * ecx = pointer to caption string
114 mikedld 3794
Returned value:
118 diamond 3795
  * function does not return value
114 mikedld 3796
Remarks:
118 diamond 3797
  * String must be in the ASCIIZ-format. Disregarding real string
3798
    length, no more than 255 characters are drawn.
3799
  * Pass NULL in ecx to remove caption.
114 mikedld 3800
 
3801
======================================================================
665 diamond 3802
=============== Function 72 - send message to a window. ==============
3803
======================================================================
3804
 
3805
- Subfunction 1 - send message with parameter to the active window. --
3806
Parameters:
3807
  * eax = 72 - function number
3808
  * ebx = 1 - subfunction number
3809
  * ecx = event code: 2 or 3
3810
  * edx = parameter: key code for ecx=2, button identifier for ecx=3
3811
Returned value:
3812
  * eax = 0 - success
3813
  * eax = 1 - buffer is full
3814
 
3815
======================================================================
3315 mario79 3816
===================== Function 73 - blit bitmap  =====================
3817
======================================================================
3818
 
3819
Parameters:
3820
  * eax = 73 - function number
3821
 
3822
  * ebx = ROP and optional flags
3823
     31           6 5  4 3   0
3824
     [  reserved  ][T][B][ROP]
3825
     ROP - raster operation code
3826
        0: Copy
3827
     1-15: reserved
3828
     B   - blit into the background surface
3829
     T   - transparent blit
3830
 
3831
  * ecx = pointer to the function parameters
3832
        destination offset and clipping
3833
     +0 signed dword: destination rectangle X offset from the window
3834
                      top-left corner
3835
     +4 signed dword: destination rectangle Y offset from the window
3836
                      top-left corner
3837
     +8 dword:        destination rectangle width
3838
    +12 dword:        destination rectangle height
3839
 
3840
        source offset and clipping
3841
    +16 signed dword: source rectangle X offset from the bitmap
3842
                      top-left corner
3843
    +20 signed dword: source rectangle Y offset from the bitmap
3844
                      top-left corner
3845
    +24 dword:        source rectangle width
3846
    +28 dword:        source rectangle height
3847
 
3338 mario79 3848
    +32: dword: bitmap data - must be 32bpp
3849
    +36: dword: size of the bitmap row in bytes
3315 mario79 3850
 
3851
Returned value:
3852
  * function does not return value
3853
 
3854
======================================================================
3571 hidnplayr 3855
= Function 74, Subfunction -1, Get number of active network devices. =
3856
======================================================================
3857
Parameters:
3858
  * eax = 74 - function number
3859
  * bl = -1 - subfunction number
3860
Returned value:
3861
  * eax = number of active network devices
3862
 
3863
======================================================================
3864
======== Function 74, Subfunction 0, Get network device type. ========
3865
======================================================================
3866
Parameters:
3867
  * eax = 74 - function number
3868
  * bl = 0 - subfunction number
3869
  * bh = device number
3870
Returned value:
3871
  * eax = device type
3872
 
3873
======================================================================
3874
======== Function 74, Subfunction 1, Get network device name. ========
3875
======================================================================
3876
Parameters:
3877
  * eax = 74 - function number
3878
  * bl = 1 - subfunction number
3879
  * bh = device number
3880
  * ecx = pointer to 64 byte buffer
3881
Returned value:
3882
  * eax = -1 on error
3883
  * The network device name is written into the buffer, on success
3884
 
3885
======================================================================
3886
========= Function 74, Subfunction 2, Reset network device. ==========
3887
======================================================================
3888
Parameters:
3889
  * eax = 74 - function number
3890
  * bl = 2 - subfunction number
3891
  * bh = device number
3892
Returned value:
3893
  * eax = -1 on error
3894
 
3895
======================================================================
3896
========== Function 74, Subfunction 3, Stop network device. ==========
3897
======================================================================
3898
Parameters:
3899
  * eax = 74 - function number
3900
  * bl = 3 - subfunction number
3901
  * bh = device number
3902
Returned value:
3903
  * eax = -1 on error
3904
 
3905
======================================================================
3906
============== Function 75, Subfunction 0, Open socket. ==============
3907
======================================================================
3908
Parameters:
3909
  * eax = 75 - function number
3910
  * bl = 0 - subfunction number
3911
  * ecx = domain
3912
  * edx = type
3913
  * esi = protocol
3914
Returned value:
3915
  * eax = socket number, -1 on error
3867 hidnplayr 3916
  * ebx = errorcode
3571 hidnplayr 3917
 
3918
======================================================================
3919
============= Function 75, Subfunction 1, Close socket. ==============
3920
======================================================================
3921
Parameters:
3922
  * eax = 75 - function number
3923
  * bl = 1 - subfunction number
3924
  * ecx = socket number
3925
Returned value:
3926
  * eax = -1 on error
3867 hidnplayr 3927
  * ebx = errorcode
3571 hidnplayr 3928
 
3929
======================================================================
3930
================== Function 75, Subfunction 2, Bind. =================
3931
======================================================================
3932
Parameters:
3933
  * eax = 75 - function number
3934
  * bl = 2 - subfunction number
3935
  * ecx = socket number
3936
  * edx = pointer to sockaddr structure
3937
  * esi = length of sockaddr structure
3938
Returned value:
3939
  * eax = -1 on error
3867 hidnplayr 3940
  * ebx = errorcode
3571 hidnplayr 3941
 
3942
======================================================================
3943
================= Function 75, Subfunction 3, Listen. ================
3944
======================================================================
3945
Parameters:
3946
  * eax = 75 - function number
3947
  * bl = 3 - subfunction number
3948
  * ecx = socket number
3949
  * edx = backlog
3950
Returned value:
3951
  * eax = -1 on error
3867 hidnplayr 3952
  * ebx = errorcode
3571 hidnplayr 3953
 
3954
======================================================================
3955
================ Function 75, Subfunction 4, Connect. ================
3956
======================================================================
3957
Parameters:
3958
  * eax = 75 - function number
3959
  * bl = 4 - subfunction number
3960
  * ecx = socket number
3961
  * edx = pointer to sockaddr structure
3962
  * esi = length of sockaddr structure
3963
Returned value:
3964
  * eax = -1 on error
3867 hidnplayr 3965
  * ebx = errorcode
3571 hidnplayr 3966
 
3967
======================================================================
3968
================= Function 75, Subfunction 5, Accept. ================
3969
======================================================================
3970
Parameters:
3971
  * eax = 75 - function number
3972
  * bl = 5 - subfunction number
3973
  * ecx = socket number
3974
  * edx = pointer to sockaddr structure
3975
  * esi = length of sockaddr structure
3976
Returned value:
3867 hidnplayr 3977
  * eax = socket number of accepted socket, -1 on error
3978
  * ebx = errorcode
3571 hidnplayr 3979
 
3980
======================================================================
3981
================== Function 75, Subfunction 6, Send. =================
3982
======================================================================
3983
Parameters:
3984
  * eax = 75 - function number
3985
  * bl = 6 - subfunction number
3986
  * ecx = socket number
3987
  * edx = pointer to buffer
3988
  * esi = length of buffer
3867 hidnplayr 3989
  * edi = flags
3571 hidnplayr 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 7, Receive. ================
3996
======================================================================
3997
Parameters:
3998
  * eax = 75 - function number
3999
  * bl = 7 - subfunction number
4000
  * ecx = socket number
4001
  * edx = pointer to buffer
4002
  * esi = length of buffer
4003
  * edi = flags
4004
Returned value:
4005
  * eax = number of bytes copied, -1 on error
3867 hidnplayr 4006
  * ebx = errorcode
3571 hidnplayr 4007
 
4008
======================================================================
4009
=========== Function 75, Subfunction 8, Set socket options. ==========
4010
======================================================================
4011
Parameters:
4012
  * eax = 75 - function number
4013
  * bl = 8 - subfunction number
4014
  * ecx = socket number
4015
  * edx = pointer to optstruct
4016
Returned value:
4017
  * eax = -1 on error
3867 hidnplayr 4018
  * ebx = errorcode
3571 hidnplayr 4019
Remarks:
4020
 
4021
  Optstruct: dd level
4022
             dd optionname
4023
             dd optlength
4024
             db options...
4025
 
4026
======================================================================
4027
=========== Function 75, Subfunction 9, Get socket options. ==========
4028
======================================================================
4029
Parameters:
4030
  * eax = 75 - function number
4031
  * bl = 9 - subfunction number
4032
  * ecx = socket number
4033
  * edx = pointer to optstruct
4034
Returned value:
4035
  * eax = -1 on error
3867 hidnplayr 4036
  * ebx = errorcode
3571 hidnplayr 4037
Remarks:
4038
 
4039
  Optstruct: dd level
4040
             dd optionname
4041
             dd optlength
4042
             db options...
4043
 
4044
======================================================================
4045
============ Function 75, Subfunction 10, Get socketpair. ===========
4046
======================================================================
4047
Parameters:
4048
  * eax = 75 - function number
4049
  * bl = 10 - subfunction number
4050
Returned value:
4051
  * eax = socketnum1, -1 on error
3867 hidnplayr 4052
  * ebx = socketnum2, errorcode on error
3571 hidnplayr 4053
 
4054
======================================================================
118 diamond 4055
=============== Function -1 - terminate thread/process ===============
114 mikedld 4056
======================================================================
4057
Parameters:
118 diamond 4058
  * eax = -1 - function number
114 mikedld 4059
Returned value:
118 diamond 4060
  * function does not return neither value nor control
114 mikedld 4061
Remarks:
118 diamond 4062
  * If the process did not create threads obviously, it has only
4063
    one thread, which termination results in process termination.
4064
  * If the current thread is last in the process, its termination
4065
    also results in process terminates.
4066
  * This function terminates the current thread. Other thread can be
4067
    killed by call to subfunction 2 of function 18.
114 mikedld 4068
 
4069
======================================================================
4070
=========================== List of events ===========================
4071
======================================================================
118 diamond 4072
Next event can be retrieved by the call of one from functions 10
4073
(to wait for event), 11 (to check without waiting), 23
4074
(to wait during the given time).
4075
These functions return only those events, which enter into a mask set
4076
by function 40. By default it is first three,
4077
there is enough for most applications.
114 mikedld 4078
Codes of events:
118 diamond 4079
  * 1 = redraw event (is reset by call to function 0)
4080
  * 2 = key on keyboard is pressed (acts, only when the window is
4081
    active) or hotkey is pressed; is reset, when all keys from
4082
    the buffer are read out by function 2
4083
  * 3 = button is pressed, defined earlier by function 8
4084
    (or close button, created implicitly by function 0;
4085
    minimize button is handled by the system and sends no message;
4086
    acts, only when the window is active;
4087
    is reset when all buttons from the buffer
4088
    are read out by function 17)
4089
  * 4 = reserved (in current implementation never comes even after
4090
    unmasking by function 40)
2513 mario79 4091
  * 5 = kernel finished redrawing of the desktop background
118 diamond 4092
  * 6 = mouse event (something happened - button pressing or moving;
4093
    is reset at reading)
4094
  * 7 = IPC event (see function 60 -
4095
    Inter Process Communication; is reset at reading)
4096
  * 8 = network event (is reset at reading)
4097
  * 9 = debug event (is reset at reading; see
4098
    debug subsystem)
4099
  * 16..31 = event with appropriate IRQ
4100
    (16=IRQ0, 31=IRQ15) (is reset after reading all IRQ data)
114 mikedld 4101
 
4102
======================================================================
118 diamond 4103
=================== Error codes of the file system ===================
114 mikedld 4104
======================================================================
118 diamond 4105
  * 0 = success
4106
  * 1 = base and/or partition of a hard disk is not defined
4107
    (by subfunctions 7, 8 of function 21)
4108
  * 2 = function is not supported for the given file system
4109
  * 3 = unknown file system
448 diamond 4110
  * 4 = reserved, is never returned in the current implementation
118 diamond 4111
  * 5 = file not found
4112
  * 6 = end of file, EOF
4113
  * 7 = pointer lies outside of application memory
4114
  * 8 = disk is full
4115
  * 9 = FAT table is destroyed
114 mikedld 4116
  * 10 = access denied
118 diamond 4117
  * 11 = device error
4118
Application start functions can return also following errors:
4119
  * 30 = 0x1E = not enough memory
4120
  * 31 = 0x1F = file is not executable
4121
  * 32 = 0x20 = too many processes