Subversion Repositories Kolibri OS

Rev

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

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