Subversion Repositories Kolibri OS

Rev

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