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