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