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