Subversion Repositories Kolibri OS

Rev

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

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