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