Subversion Repositories Kolibri OS

Rev

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

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