Subversion Repositories Kolibri OS

Rev

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