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