Subversion Repositories Kolibri OS

Rev

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