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