Subversion Repositories Kolibri OS

Rev

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

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