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