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