Subversion Repositories Kolibri OS

Rev

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

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