Rev 3571 | Rev 3780 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
2455 | mario79 | 1 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
2 | ;; ;; |
||
3 | ;; Copyright (C) KolibriOS team 2004-2012. All rights reserved. ;; |
||
4 | ;; Distributed under terms of the GNU General Public License ;; |
||
5 | ;; ;; |
||
6 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
||
7 | |||
1662 | Nasarus | 8 | SYSTEM FUNCTIONS of OS Kolibri 0.7.7.0 |
114 | mikedld | 9 | |
10 | Number of the function is located in the register eax. |
||
118 | diamond | 11 | The call of the system function is executed by "int 0x40" command. |
12 | All registers except explicitly declared in the returned value, |
||
13 | including eflags, are preserved. |
||
114 | mikedld | 14 | |
15 | |||
16 | ====================================================================== |
||
17 | ============== Function 0 - define and draw the window. ============== |
||
18 | ====================================================================== |
||
19 | Defines an application window. Draws a frame of the window, header and |
||
133 | diamond | 20 | working area. For skinned windows defines standard close and minimize |
21 | buttons. |
||
114 | mikedld | 22 | Parameters: |
118 | diamond | 23 | * eax = 0 - function number |
114 | mikedld | 24 | * ebx = [coordinate on axis x]*65536 + [size on axis x] |
25 | * ecx = [coordinate on axis y]*65536 + [size on axis y] |
||
26 | * edx = 0xXYRRGGBB, where: |
||
27 | * Y = style of the window: |
||
131 | diamond | 28 | * Y=0 - type I - fixed-size window |
118 | diamond | 29 | * Y=1 - only define window area, draw nothing |
131 | diamond | 30 | * Y=2 - type II - variable-size window |
31 | * Y=3 - skinned window |
||
641 | diamond | 32 | * Y=4 - skinned fixed-size window |
33 | * other possible values (from 5 up to 15) are reserved, |
||
114 | mikedld | 34 | function call with such Y is ignored |
118 | diamond | 35 | * RR, GG, BB = accordingly red, green, blue components of a color |
36 | of the working area of the window (are ignored for style Y=2) |
||
114 | mikedld | 37 | * X = DCBA (bits) |
641 | diamond | 38 | * A = 1 - window has caption; for styles Y=3,4 caption string |
118 | diamond | 39 | must be passed in edi, for other styles use |
40 | subfunction 1 of function 71 |
||
41 | * B = 1 - coordinates of all graphics primitives are relative to |
||
42 | window client area |
||
303 | mikedld | 43 | * C = 1 - don't fill working area on window draw |
118 | diamond | 44 | * D = 0 - normal filling of the working area, 1 - gradient |
45 | The following parameters are intended for windows |
||
46 | of a type I and II, and ignored for styles Y=1,3: |
||
47 | * esi = 0xXYRRGGBB - color of the header |
||
48 | * RR, GG, BB define color |
||
114 | mikedld | 49 | * Y=0 - usual window, Y=1 - unmovable window |
118 | diamond | 50 | * X defines a gradient of header: X=0 - no gradient, |
114 | mikedld | 51 | X=8 - usual gradient, |
52 | for windows of a type II X=4 - negative gradient |
||
118 | diamond | 53 | * other values of X and Y are reserved |
54 | * edi = 0x00RRGGBB - color of the frame |
||
114 | mikedld | 55 | Returned value: |
56 | * function does not return value |
||
57 | Remarks: |
||
118 | diamond | 58 | * Position and sizes of the window are installed by the first |
59 | call of this function and are ignored at subsequent; to change |
||
60 | position and/or sizes of already created window use function 67. |
||
641 | diamond | 61 | * For windows with styles Y=3,4 and caption (A=1) caption string |
62 | is set by the first call of this function and is ignored |
||
63 | at subsequent (strictly speaking, is ignored after a call to |
||
64 | subfunction 2 of function 12 - end redraw); to change caption of |
||
65 | already created window use subfunction 1 of function 71. |
||
118 | diamond | 66 | * If the window has appropriate styles, position and/or sizes can be |
67 | changed by user. Current position and sizes can be obtained |
||
68 | by function 9. |
||
69 | * The window must fit on the screen. If the transferred |
||
70 | coordinates and sizes do not satisfy to this condition, |
||
71 | appropriate coordinate (or, probably, both) is considered as zero, |
||
131 | diamond | 72 | and if it does not help too, the appropriate size |
118 | diamond | 73 | (or, probably, both) is installed in a size of the screen. |
2409 | Serge | 74 | |
131 | diamond | 75 | Further let us designate xpos,ypos,xsize,ysize - values passed |
76 | in ebx,ecx. The coordinates are resulted concerning |
||
118 | diamond | 77 | the left upper corner of the window, which, thus, is set as (0,0), |
78 | coordinates of the right lower corner essence (xsize,ysize). |
||
79 | * The sizes of the window are understood in sence of coordinates |
||
80 | of the right lower corner. This concerns all other functions too. |
||
81 | It means, that the real sizes are on 1 pixel more. |
||
82 | * The window of type I looks as follows: |
||
83 | * draw external frame of color indicated in edi, 1 pixel in width |
||
84 | * draw header - rectangle with the left upper corner (1,1) and |
||
85 | right lower (xsize-1,min(25,ysize)) color indicated in esi |
||
86 | (taking a gradient into account) |
||
87 | * if ysize>=26, fill the working area of the window - |
||
88 | rectangle with the left upper corner (1,21) and right lower |
||
89 | (xsize-1,ysize-1) (sizes (xsize-1)*(ysize-21)) with color |
||
90 | indicated in edx (taking a gradient into account) |
||
91 | * if A=1 and caption has been already set by subfunction 1 |
||
92 | of function 71, it is drawn in the corresponding place of header |
||
93 | * The window of style Y=1 looks as follows: |
||
114 | mikedld | 94 | * completely defined by the application |
118 | diamond | 95 | * The window of type II looks as follows: |
96 | * draw external frame of width 1 pixel with the "shaded" color |
||
97 | edi (all components of the color decrease twice) |
||
98 | * draw intermediate frame of width 3 pixels with color edi |
||
99 | * draw internal frame of width 1 pixel with the "shaded" color edi |
||
114 | mikedld | 100 | * draw header - rectangle with the left upper corner (4,4) |
118 | diamond | 101 | and right lower (xsize-4,min(20,ysize)) color, indicated in esi |
102 | (taking a gradient into account) |
||
103 | * if ysize>=26, fill the working area of the window - |
||
114 | mikedld | 104 | rectangle with the left upper corner (5,20) and right lower |
118 | diamond | 105 | (xsize-5,ysize-5) with color indicated in edx |
106 | (taking a gradient into account) |
||
107 | * if A=1 and caption has been already set by subfunction 1 |
||
108 | of function 71, it is drawn in the corresponding place of header |
||
109 | * The skinned window looks as follows: |
||
114 | mikedld | 110 | * draw external frame of width 1 pixel |
118 | diamond | 111 | with color 'outer' from the skin |
112 | * draw intermediate frame of width 3 pixel |
||
113 | with color 'frame' from the skin |
||
114 | * draw internal frame of width 1 pixel |
||
115 | with color 'inner' from the skin |
||
116 | * draw header (on bitmaps from the skin) in a rectangle |
||
114 | mikedld | 117 | (0,0) - (xsize,_skinh-1) |
118 | diamond | 118 | * if ysize>=26, fill the working area of the window - |
119 | rectangle with the left upper corner (5,_skinh) and right lower |
||
120 | (xsize-5,ysize-5) with color indicated in edx |
||
121 | (taking a gradient into account) |
||
133 | diamond | 122 | * define two standard buttons: close and minimize |
114 | mikedld | 123 | (see function 8) |
118 | diamond | 124 | * if A=1 and edi contains (nonzero) pointer to caption string, |
125 | it is drawn in place in header defined in the skin |
||
126 | * value _skinh is accessible as the result of call |
||
127 | subfunction 4 of function 48 |
||
114 | mikedld | 128 | |
129 | ====================================================================== |
||
118 | diamond | 130 | ================ Function 1 - put pixel in the window. =============== |
114 | mikedld | 131 | ====================================================================== |
132 | Parameters: |
||
118 | diamond | 133 | * eax = 1 - function number |
134 | * ebx = x-coordinate (relative to the window) |
||
135 | * ecx = y-coordinate (relative to the window) |
||
136 | * edx = 0x00RRGGBB - color of a pixel |
||
137 | edx = 0x01xxxxxx - invert color of a pixel |
||
138 | (low 24 bits are ignored) |
||
114 | mikedld | 139 | Returned value: |
140 | * function does not return value |
||
141 | |||
142 | ====================================================================== |
||
118 | diamond | 143 | ============ Function 2 - get the code of the pressed key. =========== |
114 | mikedld | 144 | ====================================================================== |
145 | Takes away the code of the pressed key from the buffer. |
||
146 | Parameters: |
||
118 | diamond | 147 | * eax = 2 - function number |
114 | mikedld | 148 | Returned value: |
118 | diamond | 149 | * if the buffer is empty, function returns eax=1 |
150 | * if the buffer is not empty, function returns al=0, |
||
151 | ah=code of the pressed key, high word of eax is zero |
||
152 | * if there is "hotkey", function returns al=2, |
||
153 | ah=scancode of the pressed key (0 for control keys), |
||
154 | high word of eax contains a status of control keys at the moment |
||
155 | of pressing a hotkey |
||
114 | mikedld | 156 | Remarks: |
118 | diamond | 157 | * There is a common system buffer of the pressed keys |
158 | by a size of 120 bytes, organized as queue. |
||
159 | * There is one more common system buffer on 120 "hotkeys". |
||
160 | * If the application with the inactive window calls this function, |
||
161 | the buffer of the pressed keys is considered to be empty. |
||
162 | * By default this function returns ASCII-codes; to switch |
||
163 | to the scancodes mode (and back) use function 66. |
||
164 | However, hotkeys are always notificated as scancodes. |
||
165 | * To find out, what keys correspond to what codes, start |
||
166 | the application keyascii and scancode. |
||
167 | * Scancodes come directly from keyboard and are fixed; |
||
168 | ASCII-codes turn out with usage of the conversion tables, |
||
169 | which can be set by subfunction 2 of function 21 |
||
170 | and get by subfunction 2 of function 26. |
||
171 | * As a consequence, ASCII-codes take into account current |
||
172 | keyboard layout (rus/en) as opposed to scancodes. |
||
173 | * This function notifies only about those hotkeys, which were |
||
174 | defined by this thread by subfunction 4 of function 66. |
||
114 | mikedld | 175 | |
176 | ====================================================================== |
||
118 | diamond | 177 | ==================== Function 3 - get system time. =================== |
114 | mikedld | 178 | ====================================================================== |
179 | Parameters: |
||
118 | diamond | 180 | * eax = 3 - function number |
114 | mikedld | 181 | Returned value: |
182 | * eax = 0x00SSMMHH, where HH:MM:SS = Hours:Minutes:Seconds |
||
118 | diamond | 183 | * each item is BCD-number, for example, |
184 | for time 23:59:59 function returns 0x00595923 |
||
114 | mikedld | 185 | Remarks: |
118 | diamond | 186 | * See also subfunction 9 of function 26 - get time from |
187 | the moment of start of the system; it is more convenient, because |
||
188 | returns simply DWORD-value of the time counter. |
||
189 | * System time can be set by function 22. |
||
114 | mikedld | 190 | |
191 | ====================================================================== |
||
118 | diamond | 192 | ============ Function 4 - draw text string in the window. ============ |
114 | mikedld | 193 | ====================================================================== |
194 | Parameters: |
||
118 | diamond | 195 | * eax = 4 - function number |
114 | mikedld | 196 | * ebx = [coordinate on axis x]*65536 + [coordinate on axis y] |
2536 | mario79 | 197 | * ecx = 0xXYRRGGBB, where |
118 | diamond | 198 | * RR, GG, BB specify text color |
139 | diamond | 199 | * X=ABnn (bits): |
2536 | mario79 | 200 | * nn specifies the used font: 0=system monospaced, |
201 | 1=system font of variable width |
||
202 | * A=0 - output esi characters, A=1 - output ASCIIZ-string |
||
203 | * B=1 - fill background with the color edi |
||
204 | * Y = Cnnn |
||
205 | * C=1 redirect the output to the user area, specified in edi |
||
206 | * nnn - not used in the current, must be 0 (zero) |
||
118 | diamond | 207 | * edx = pointer to the beginning of the string |
139 | diamond | 208 | * esi = for A=0 length of the string, must not exceed 255; |
209 | for A=1 is ignored |
||
2536 | mario79 | 210 | * edi = color to fill background, if B=1 |
211 | * edi = pointer to user area, for redirect, if C=1 |
||
212 | |||
114 | mikedld | 213 | Returned value: |
214 | * function does not return value |
||
215 | Remarks: |
||
118 | diamond | 216 | * First system font is read out at loading from the file char.mt, |
217 | second - from char2.mt. |
||
218 | * Both fonts have height 9 pixels, width of the monospaced font |
||
219 | is equal to 6 pixels. |
||
2536 | mario79 | 220 | * C=1, pixel depth = 32 bits, user area is as follows: |
221 | dword Xsize |
||
222 | dword Ysize |
||
223 | rest of the area = Xsize * Y size * 4 |
||
224 | * You can not use B = 1 and C = 1, at the same time. Since in both |
||
225 | cases, the register edi is used for different purposes. |
||
114 | mikedld | 226 | |
227 | ====================================================================== |
||
118 | diamond | 228 | ========================= Function 5 - delay. ======================== |
114 | mikedld | 229 | ====================================================================== |
230 | Delays execution of the program on the given time. |
||
231 | Parameters: |
||
118 | diamond | 232 | * eax = 5 - function number |
114 | mikedld | 233 | * ebx = time in the 1/100 of second |
234 | Returned value: |
||
235 | * function does not return value |
||
236 | Remarks: |
||
118 | diamond | 237 | * Passing ebx=0 does not transfer control to the next process |
238 | and does not make any operations at all. If it is really required |
||
239 | to transfer control to the next process (to complete a current |
||
240 | time slice), use subfunction 1 of function 68. |
||
114 | mikedld | 241 | |
242 | ====================================================================== |
||
118 | diamond | 243 | ============== Function 6 - read the file from ramdisk. ============== |
114 | mikedld | 244 | ====================================================================== |
245 | Parameters: |
||
118 | diamond | 246 | * eax = 6 - function number |
247 | * ebx = pointer to the filename |
||
248 | * ecx = number of start block, beginning from 1; |
||
249 | ecx=0 - read from the beginning of the file (same as ecx=1) |
||
250 | * edx = number of blocks to read; |
||
251 | edx=0 - read one block (same as edx=1) |
||
252 | * esi = pointer to memory area for the data |
||
114 | mikedld | 253 | Returned value: |
118 | diamond | 254 | * eax = file size in bytes, if the file was successfully read |
255 | * eax = -1, if the file was not found |
||
114 | mikedld | 256 | Remarks: |
118 | diamond | 257 | * This function is out-of-date; function 70 allows |
258 | to fulfil the same operations with the extended possibilities. |
||
114 | mikedld | 259 | * Block = 512 bytes. |
118 | diamond | 260 | * For reading all file you can specify the certainly large value |
261 | in edx, for example, edx = -1; but in this case be ready that |
||
262 | the program will "fall", if the file will appear too large and can |
||
263 | not be placed in the program memory. |
||
264 | * The filename must be either in the format 8+3 characters |
||
265 | (first 8 characters - name itself, last 3 - extension, |
||
266 | the short names and extensions are supplemented with spaces), |
||
267 | or in the format 8.3 characters "FILE.EXT"/"FILE.EX " |
||
268 | (name no more than 8 characters, dot, extension 3 characters |
||
269 | supplemented if necessary by spaces). |
||
270 | The filename must be written with capital letters. The terminating |
||
271 | character with code 0 is not necessary (not ASCIIZ-string). |
||
272 | * This function does not support folders on the ramdisk. |
||
114 | mikedld | 273 | |
274 | ====================================================================== |
||
275 | =============== Function 7 - draw image in the window. =============== |
||
276 | ====================================================================== |
||
118 | diamond | 277 | Paramters: |
278 | * eax = 7 - function number |
||
279 | * ebx = pointer to the image in the format BBGGRRBBGGRR... |
||
114 | mikedld | 280 | * ecx = [size on axis x]*65536 + [size on axis y] |
281 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
282 | Returned value: |
||
283 | * function does not return value |
||
284 | Remarks: |
||
118 | diamond | 285 | * Coordinates of the image are coordinates of the upper left corner |
286 | of the image relative to the window. |
||
114 | mikedld | 287 | * Size of the image in bytes is 3*xsize*ysize. |
288 | |||
289 | ====================================================================== |
||
290 | =============== Function 8 - define/delete the button. =============== |
||
291 | ====================================================================== |
||
118 | diamond | 292 | Parameters for button definition: |
293 | * eax = 8 - function number |
||
114 | mikedld | 294 | * ebx = [coordinate on axis x]*65536 + [size on axis x] |
295 | * ecx = [coordinate on axis y]*65536 + [size on axis y] |
||
296 | * edx = 0xXYnnnnnn, where: |
||
297 | * nnnnnn = identifier of the button |
||
118 | diamond | 298 | * high (31st) bit of edx is cleared |
299 | * if 30th bit of edx is set - do not draw the button |
||
300 | * if 29th bit of edx is set - do not draw a frame |
||
114 | mikedld | 301 | at pressing the button |
118 | diamond | 302 | * esi = 0x00RRGGBB - color of the button |
303 | Parameters for button deleting: |
||
304 | * eax = 8 - function number |
||
114 | mikedld | 305 | * edx = 0x80nnnnnn, where nnnnnn - identifier of the button |
306 | Returned value: |
||
307 | * function does not return value |
||
308 | Remarks: |
||
118 | diamond | 309 | * Sizes of the button must be more than 0 and less than 0x8000. |
131 | diamond | 310 | * For skinned windows definition of the window |
118 | diamond | 311 | (call of 0th function) creates two standard buttons - |
312 | for close of the window with identifier 1 and |
||
313 | for minimize of the window with identifier 0xffff. |
||
314 | * The creation of two buttons with same identifiers is admitted. |
||
315 | * The button with the identifier 0xffff at pressing is interpreted |
||
316 | by the system as the button of minimization, the system handles |
||
317 | such pressing independently, not accessing to the application. |
||
318 | In rest it is usual button. |
||
319 | * Total number of buttons for all applications is limited to 4095. |
||
114 | mikedld | 320 | |
321 | ====================================================================== |
||
118 | diamond | 322 | ============ Function 9 - information on execution thread. =========== |
114 | mikedld | 323 | ====================================================================== |
324 | Parameters: |
||
118 | diamond | 325 | * eax = 9 - function number |
326 | * ebx = pointer to 1-Kb buffer |
||
327 | * ecx = number of the slot of the thread |
||
328 | ecx = -1 - get information on the current thread |
||
114 | mikedld | 329 | Returned value: |
118 | diamond | 330 | * eax = maximum number of the slot of a thread |
331 | * buffer pointed to by ebx contains the following information: |
||
332 | * +0: dword: usage of the processor (how many time units |
||
333 | per second leaves on execution of this thread) |
||
114 | mikedld | 334 | * +4: word: position of the window of thread in the window stack |
118 | diamond | 335 | * +6: word: (has no relation to the specified thread) |
336 | number of the thread slot, which window has in the window stack |
||
337 | position ecx |
||
114 | mikedld | 338 | * +8: word: reserved |
339 | * +10 = +0xA: 11 bytes: name of the process |
||
2625 | mario79 | 340 | (name of the started file - executable file without extension) |
142 | diamond | 341 | * +21 = +0x15: byte: reserved, this byte is not changed |
114 | mikedld | 342 | * +22 = +0x16: dword: address of the process in memory |
343 | * +26 = +0x1A: dword: size of used memory - 1 |
||
344 | * +30 = +0x1E: dword: identifier (PID/TID) |
||
118 | diamond | 345 | * +34 = +0x22: dword: coordinate of the thread window on axis x |
346 | * +38 = +0x26: dword: coordinate of the thread window on axis y |
||
347 | * +42 = +0x2A: dword: size of the thread window on axis x |
||
348 | * +46 = +0x2E: dword: size of the thread window on axis y |
||
349 | * +50 = +0x32: word: status of the thread slot: |
||
350 | * 0 = thread is running |
||
351 | * 1 = thread is suspended |
||
352 | * 2 = thread is suspended while waiting for event |
||
353 | * 3 = thread is terminating as a result of call to function -1 |
||
354 | or under duress as a result of call to subfunction 2 |
||
355 | of function 18 or termination of the system |
||
356 | * 4 = thread is terminating as a result of exception |
||
357 | * 5 = thread waits for event |
||
358 | * 9 = requested slot is free, all other information on the slot |
||
359 | is not meaningful |
||
142 | diamond | 360 | * +52 = +0x34: word: reserved, this word is not changed |
361 | * +54 = +0x36: dword: coordinate of the client area on axis x |
||
362 | * +58 = +0x3A: dword: coordinate of the client area on axis y |
||
363 | * +62 = +0x3E: dword: width of the client area |
||
364 | * +66 = +0x42: dword: height of the client area |
||
365 | * +70 = +0x46: byte: state of the window - bitfield |
||
366 | * bit 0 (mask 1): window is maximized |
||
367 | * bit 1 (mask 2): window is minimized to panel |
||
368 | * bit 2 (mask 4): window is rolled up |
||
1663 | Nasarus | 369 | * +71 = +0x47: dword: event mask |
114 | mikedld | 370 | Remarks: |
118 | diamond | 371 | * Slots are numbered starting from 1. |
372 | * Returned value is not a total number of threads, because there |
||
373 | can be free slots. |
||
374 | * When process is starting, system automatically creates |
||
375 | execution thread. |
||
376 | * Function gives information on the thread. Each process has |
||
377 | at least one thread. One process can create many threads, |
||
378 | in this case each thread has its own slot and the fields |
||
379 | +10, +22, +26 in these slots coincide. |
||
380 | Applications have no common way to define whether two threads |
||
114 | mikedld | 381 | belong to one process. |
118 | diamond | 382 | * The active window - window on top of the window stack - |
383 | receives the messages on a keyboard input. For such window |
||
384 | the position in the window stack coincides with returned value. |
||
385 | * Slot 1 corresponds to special system thread, for which: |
||
386 | * the window is in the bottom of the window stack, the fields |
||
387 | +4 and +6 contain value 1 |
||
388 | * name of the process - "OS/IDLE" (supplemented by spaces) |
||
389 | * address of the process in memory is 0, size of used memory is |
||
114 | mikedld | 390 | 16 Mb (0x1000000) |
391 | * PID=1 |
||
142 | diamond | 392 | * coordinates and sizes of the window and the client area are by |
393 | convention set to 0 |
||
118 | diamond | 394 | * status of the slot is always 0 (running) |
395 | * the execution time adds of time leaving on operations itself |
||
396 | and idle time in waiting for interrupt (which can be got by call |
||
397 | to subfunction 4 of function 18). |
||
398 | * Beginning from slot 2, the normal applications are placed. |
||
1662 | Nasarus | 399 | * The normal applications are placed in memory at the address |
400 | |||
118 | diamond | 401 | There is no intersection, as each process has its own page table. |
402 | * At creation of the thread it is assigned the slot |
||
403 | in the system table and identifier (Process/Thread IDentifier = |
||
404 | PID/TID), which do not vary with time for given thread. |
||
405 | After completion of the thread its slot can be anew used |
||
406 | for another thread. The thread identifier can not be assigned |
||
407 | to other thread even after completion of this thread. |
||
408 | Identifiers, assigned to new threads, grow monotonously. |
||
409 | * If the thread has not yet defined the window by call to |
||
410 | function 0, the position and the sizes |
||
411 | of its window are considered to be zero. |
||
142 | diamond | 412 | * Coordinates of the client area are relative to the window. |
118 | diamond | 413 | * At the moment only the part of the buffer by a size |
142 | diamond | 414 | 71 = 0x37 bytes is used. Nevertheless it is recommended to use |
118 | diamond | 415 | 1-Kb buffer for the future compatibility, in the future |
416 | some fields can be added. |
||
114 | mikedld | 417 | |
418 | ====================================================================== |
||
118 | diamond | 419 | ==================== Function 10 - wait for event. =================== |
114 | mikedld | 420 | ====================================================================== |
118 | diamond | 421 | If the message queue is empty, waits for appearance of the message |
422 | in queue. In this state thread does not consume CPU time. |
||
114 | mikedld | 423 | Then reads out the message from queue. |
424 | |||
425 | Parameters: |
||
118 | diamond | 426 | * eax = 10 - function number |
114 | mikedld | 427 | Returned value: |
118 | diamond | 428 | * eax = event (see the list of events) |
114 | mikedld | 429 | Remarks: |
118 | diamond | 430 | * Those events are taken into account only which enter into |
431 | a mask set by function 40. By default it is |
||
432 | redraw, key and button events. |
||
433 | * To check, whether there is a message in queue, use function 11. |
||
434 | To wait for no more than given time, use function 23. |
||
114 | mikedld | 435 | |
118 | diamond | 436 | ====================================================================== |
437 | =============== Function 11 - check for event, no wait. ============== |
||
438 | ====================================================================== |
||
439 | If the message queue contains event, function reads out |
||
440 | and return it. If the queue is empty, function returns 0. |
||
114 | mikedld | 441 | Parameters: |
118 | diamond | 442 | * eax = 11 - function number |
114 | mikedld | 443 | Returned value: |
444 | * eax = 0 - message queue is empty |
||
118 | diamond | 445 | * else eax = event (see the list of events) |
114 | mikedld | 446 | Remarks: |
118 | diamond | 447 | * Those events are taken into account only, which enter into |
448 | a mask set by function 40. By default it is |
||
449 | redraw, key and button events. |
||
450 | * To wait for event, use function 10. |
||
451 | To wait for no more than given time, use function 23. |
||
114 | mikedld | 452 | |
453 | ====================================================================== |
||
118 | diamond | 454 | =============== Function 12 - begin/end window redraw. =============== |
114 | mikedld | 455 | ====================================================================== |
456 | |||
139 | diamond | 457 | ---------------- Subfunction 1 - begin window redraw. ---------------- |
114 | mikedld | 458 | Parameters: |
118 | diamond | 459 | * eax = 12 - function number |
460 | * ebx = 1 - subfunction number |
||
114 | mikedld | 461 | Returned value: |
462 | * function does not return value |
||
463 | |||
139 | diamond | 464 | ----------------- Subfunction 2 - end window redraw. ----------------- |
114 | mikedld | 465 | Parameters: |
118 | diamond | 466 | * eax = 12 - function number |
467 | * ebx = 2 - subfunction number |
||
114 | mikedld | 468 | Returned value: |
469 | * function does not return value |
||
470 | Remarks: |
||
118 | diamond | 471 | * Subfunction 1 deletes all buttons defined with |
472 | function 8, they must be defined again. |
||
114 | mikedld | 473 | |
474 | ====================================================================== |
||
475 | ============ Function 13 - draw a rectangle in the window. =========== |
||
476 | ====================================================================== |
||
477 | Parameters: |
||
118 | diamond | 478 | * eax = 13 - function number |
114 | mikedld | 479 | * ebx = [coordinate on axis x]*65536 + [size on axis x] |
480 | * ecx = [coordinate on axis y]*65536 + [size on axis y] |
||
118 | diamond | 481 | * edx = color 0xRRGGBB or 0x80RRGGBB for gradient fill |
114 | mikedld | 482 | Returned value: |
483 | * function does not return value |
||
484 | Remarks: |
||
485 | * Coordinates are understood as coordinates of the left upper corner |
||
118 | diamond | 486 | of a rectangle relative to the window. |
114 | mikedld | 487 | |
488 | ====================================================================== |
||
118 | diamond | 489 | =================== Function 14 - get screen size. =================== |
114 | mikedld | 490 | ====================================================================== |
491 | Parameters: |
||
118 | diamond | 492 | * eax = 14 - function number |
114 | mikedld | 493 | Returned value: |
494 | * eax = [xsize]*65536 + [ysize], where |
||
495 | * xsize = x-coordinate of the right lower corner of the screen = |
||
118 | diamond | 496 | horizontal size - 1 |
114 | mikedld | 497 | * ysize = y-coordinate of the right lower corner of the screen = |
118 | diamond | 498 | vertical size - 1 |
114 | mikedld | 499 | Remarks: |
118 | diamond | 500 | * See also subfunction 5 of function 48 - get sizes of |
501 | working area of the screen. |
||
114 | mikedld | 502 | |
118 | diamond | 503 | ====================================================================== |
504 | == Function 15, subfunction 1 - set a size of the background image. == |
||
505 | ====================================================================== |
||
114 | mikedld | 506 | Parameters: |
118 | diamond | 507 | * eax = 15 - function number |
508 | * ebx = 1 - subfunction number |
||
114 | mikedld | 509 | * ecx = width of the image |
510 | * edx = height of the image |
||
511 | Returned value: |
||
512 | * function does not return value |
||
513 | Remarks: |
||
499 | diamond | 514 | * Before calling subfunctions 2 and 5 you should call this function |
485 | heavyiron | 515 | to set image size! |
118 | diamond | 516 | * For update of the screen (after completion of a series of commands |
517 | working with a background) call subfunction 3. |
||
518 | * There is a pair function for get size of the background image - |
||
519 | subfunction 1 of function 39. |
||
114 | mikedld | 520 | |
521 | ====================================================================== |
||
118 | diamond | 522 | === Function 15, subfunction 2 - put pixel on the background image. == |
114 | mikedld | 523 | ====================================================================== |
524 | Parameters: |
||
118 | diamond | 525 | * eax = 15 - function number |
526 | * ebx = 2 - subfunction number |
||
114 | mikedld | 527 | * ecx = offset |
118 | diamond | 528 | * edx = color of a pixel 0xRRGGBB |
114 | mikedld | 529 | Returned value: |
530 | * function does not return value |
||
531 | Remarks: |
||
118 | diamond | 532 | * Offset for a pixel with coordinates (x,y) is calculated as |
114 | mikedld | 533 | (x+y*xsize)*3. |
499 | diamond | 534 | * If the given offset exceeds size set by subfunction 1, |
118 | diamond | 535 | the call is ignored. |
536 | * For update of the screen (after completion of a series of commands |
||
537 | working with a background) call subfunction 3. |
||
538 | * There is a pair function for get pixel on the background image - |
||
539 | subfunction 2 of function 39. |
||
114 | mikedld | 540 | |
541 | ====================================================================== |
||
542 | =========== Function 15, subfunction 3 - redraw background. ========== |
||
543 | ====================================================================== |
||
544 | Parameters: |
||
118 | diamond | 545 | * eax = 15 - function number |
546 | * ebx = 3 - subfunction number |
||
114 | mikedld | 547 | Returned value: |
548 | * function does not return value |
||
549 | |||
118 | diamond | 550 | ====================================================================== |
551 | == Function 15, subfunction 4 - set drawing mode for the background. = |
||
552 | ====================================================================== |
||
114 | mikedld | 553 | Parameters: |
118 | diamond | 554 | * eax = 15 - function number |
555 | * ebx = 4 - subfunction number |
||
556 | * ecx = drawing mode: |
||
114 | mikedld | 557 | * 1 = tile |
558 | * 2 = stretch |
||
559 | Returned value: |
||
560 | * function does not return value |
||
561 | Remarks: |
||
118 | diamond | 562 | * For update of the screen (after completion of a series of commands |
563 | working with a background) call subfunction 3. |
||
564 | * There is a pair function for get drawing mode of the background - |
||
565 | subfunction 4 of function 39. |
||
114 | mikedld | 566 | |
118 | diamond | 567 | ====================================================================== |
568 | ===================== Function 15, subfunction 5 ===================== |
||
569 | ============ Put block of pixels on the background image. ============ |
||
570 | ====================================================================== |
||
114 | mikedld | 571 | Parameters: |
118 | diamond | 572 | * eax = 15 - function number |
573 | * ebx = 5 - subfunction number |
||
574 | * ecx = pointer to the data in the format BBGGRRBBGGRR... |
||
114 | mikedld | 575 | * edx = offset in data of the background image |
118 | diamond | 576 | * esi = size of data in bytes = 3 * number of pixels |
114 | mikedld | 577 | Returned value: |
578 | * function does not return value |
||
579 | Remarks: |
||
499 | diamond | 580 | * Offset and size are not checked for correctness. |
118 | diamond | 581 | * Color of each pixel is stored as 3-bytes value BBGGRR. |
582 | * Pixels of the background image are written sequentially |
||
583 | from left to right, from up to down. |
||
584 | * Offset of pixel with coordinates (x,y) is (x+y*xsize)*3. |
||
585 | * For update of the screen (after completion of a series of commands |
||
586 | working with a background) call subfunction 3. |
||
114 | mikedld | 587 | |
588 | ====================================================================== |
||
546 | diamond | 589 | ===================== Function 15, subfunction 6 ===================== |
590 | ======== Map background data to the address space of process. ======== |
||
591 | ====================================================================== |
||
592 | Parameters: |
||
593 | * eax = 15 - function number |
||
594 | * ebx = 6 - subfunction number |
||
595 | Returned value: |
||
596 | * eax = pointer to background data, 0 if error |
||
597 | Remarks: |
||
598 | * Mapped data are available for read and write. |
||
599 | * Size of background data is 3*xsize*ysize. The system blocks |
||
600 | changes of background sizes while process works with mapped data. |
||
601 | * Color of each pixel is stored as 3-bytes value BBGGRR. |
||
602 | * Pixels of the background image are written sequentially |
||
603 | from left to right, from up to down. |
||
604 | |||
605 | ====================================================================== |
||
606 | ===== Function 15, subfunction 7 - close mapped background data. ===== |
||
607 | ====================================================================== |
||
608 | Parameters: |
||
609 | * eax = 15 - function number |
||
610 | * ebx = 7 - subfunction number |
||
611 | * ecx = pointer to mapped data |
||
612 | Returned value: |
||
613 | * eax = 1 - success, 0 - error |
||
614 | |||
615 | ====================================================================== |
||
2515 | mario79 | 616 | ===================== Function 15, subfunction 8 ===================== |
617 | ============= Get coordinates of last draw the background ============ |
||
618 | ====================================================================== |
||
619 | Parameters: |
||
620 | * eax = 15 - function number |
||
621 | * ebx = 8 - subfunction number |
||
622 | Returned value: |
||
623 | * eax = [left]*65536 + [right] |
||
624 | * ebx = [top]*65536 + [bottom] |
||
625 | Remarks: |
||
626 | * (left,top) are coordinates of the left upper corner, |
||
627 | (right,bottom) are coordinates of the right lower one. |
||
628 | * For receiving more reliable information, call the function |
||
629 | immediately after the event: |
||
630 | 5 = kernel finished redrawing of the desktop background |
||
631 | |||
632 | ====================================================================== |
||
2547 | mario79 | 633 | ===================== Function 15, subfunction 9 ===================== |
634 | ============= Redraws a rectangular part of the background =========== |
||
635 | ====================================================================== |
||
636 | Parameters: |
||
637 | * eax = 15 - function number |
||
638 | * ebx = 9 - subfunction number |
||
639 | * ecx = [left]*65536 + [right] |
||
640 | * edx = [top]*65536 + [bottom] |
||
641 | Returned value: |
||
642 | * function does not return value |
||
643 | Remarks: |
||
644 | * (left,top) are coordinates of the left upper corner, |
||
645 | (right,bottom) are coordinates of the right lower one. |
||
646 | * If parameters are set incorrectly then background is not redrawn. |
||
647 | |||
648 | ====================================================================== |
||
118 | diamond | 649 | =============== Function 16 - save ramdisk on a floppy. ============== |
114 | mikedld | 650 | ====================================================================== |
651 | Parameters: |
||
118 | diamond | 652 | * eax = 16 - function number |
653 | * ebx = 1 or ebx = 2 - on which floppy save |
||
114 | mikedld | 654 | Returned value: |
118 | diamond | 655 | * eax = 0 - success |
114 | mikedld | 656 | * eax = 1 - error |
657 | |||
658 | ====================================================================== |
||
118 | diamond | 659 | ======= Function 17 - get the identifier of the pressed button. ====== |
114 | mikedld | 660 | ====================================================================== |
661 | Takes away the code of the pressed button from the buffer. |
||
662 | Parameters: |
||
118 | diamond | 663 | * eax = 17 - function number |
114 | mikedld | 664 | Returned value: |
118 | diamond | 665 | * if the buffer is empty, function returns eax=1 |
1018 | diamond | 666 | * if the buffer is not empty: |
667 | * high 24 bits of eax contain button identifier (in particular, |
||
668 | ah contains low byte of the identifier; if all buttons have |
||
669 | the identifier less than 256, ah is enough to distinguish) |
||
670 | * al = 0 - the button was pressed with left mouse button |
||
671 | * al = bit corresponding to used mouse button otherwise |
||
114 | mikedld | 672 | Remarks: |
118 | diamond | 673 | * "Buffer" keeps only one button, at pressing the new button the |
674 | information about old is lost. |
||
675 | * The call of this function by an application with inactive window |
||
676 | will return answer "buffer is empty". |
||
1018 | diamond | 677 | * Returned value for al corresponds to the state of mouse buttons |
678 | as in subfunction 2 of function 37 at the beginning |
||
679 | of button press, excluding lower bit, which is cleared. |
||
114 | mikedld | 680 | |
681 | ====================================================================== |
||
2244 | mario79 | 682 | ===================== Function 18, subfunction 1 ===================== |
683 | ============= Make deactive the window of the given thread. ========== |
||
684 | ====================================================================== |
||
685 | Parameters: |
||
686 | * eax = 18 - function number |
||
687 | * ebx = 1 - subfunction number |
||
688 | * ecx = number of the thread slot |
||
689 | Returned value: |
||
690 | * function does not return value |
||
2409 | Serge | 691 | |
2244 | mario79 | 692 | ====================================================================== |
118 | diamond | 693 | = Function 18, subfunction 2 - terminate process/thread by the slot. = |
114 | mikedld | 694 | ====================================================================== |
695 | Parameters: |
||
118 | diamond | 696 | * eax = 18 - function number |
697 | * ebx = 2 - subfunction number |
||
114 | mikedld | 698 | * ecx = number of the slot of process/thread |
699 | Returned value: |
||
700 | * function does not return value |
||
701 | Remarks: |
||
118 | diamond | 702 | * It is impossible to terminate system thread OS/IDLE (with |
703 | number of the slot 1), |
||
704 | it is possible to terminate any normal process/thread. |
||
705 | * See also subfunction 18 - terminate |
||
706 | process/thread by the identifier. |
||
114 | mikedld | 707 | |
118 | diamond | 708 | ====================================================================== |
709 | ===================== Function 18, subfunction 3 ===================== |
||
710 | ============= Make active the window of the given thread. ============ |
||
711 | ====================================================================== |
||
114 | mikedld | 712 | Parameters: |
118 | diamond | 713 | * eax = 18 - function number |
714 | * ebx = 3 - subfunction number |
||
715 | * ecx = number of the thread slot |
||
114 | mikedld | 716 | Returned value: |
717 | * function does not return value |
||
718 | Remarks: |
||
118 | diamond | 719 | * If correct, but nonexistent slot is given, |
720 | some window is made active. |
||
721 | * To find out, which window is active, use subfunction 7. |
||
114 | mikedld | 722 | |
118 | diamond | 723 | ====================================================================== |
724 | ===================== Function 18, subfunction 4 ===================== |
||
725 | =========== Get counter of idle time units per one second. =========== |
||
726 | ====================================================================== |
||
727 | Idle time units are units, in which the processor stands idle |
||
728 | in waiting for interrupt (in the command 'hlt'). |
||
114 | mikedld | 729 | |
730 | Parameters: |
||
118 | diamond | 731 | * eax = 18 - function number |
732 | * ebx = 4 - subfunction number |
||
114 | mikedld | 733 | Returned value: |
118 | diamond | 734 | * eax = value of the counter of idle time units per one second |
114 | mikedld | 735 | |
736 | ====================================================================== |
||
118 | diamond | 737 | ========== Function 18, subfunction 5 - get CPU clock rate. ========== |
114 | mikedld | 738 | ====================================================================== |
739 | Parameters: |
||
118 | diamond | 740 | * eax = 18 - function number |
741 | * ebx = 5 - subfunction number |
||
114 | mikedld | 742 | Returned value: |
118 | diamond | 743 | * eax = clock rate (modulo 2^32 clock ticks = 4GHz) |
114 | mikedld | 744 | |
118 | diamond | 745 | ====================================================================== |
2409 | Serge | 746 | Function 18, subfunction 6 - save ramdisk to the file on hard drive. |
118 | diamond | 747 | ====================================================================== |
114 | mikedld | 748 | Parameters: |
118 | diamond | 749 | * eax = 18 - function number |
750 | * ebx = 6 - subfunction number |
||
341 | heavyiron | 751 | * ecx = pointer to the full path to file |
752 | (for example, "/hd0/1/kolibri/kolibri.img") |
||
114 | mikedld | 753 | Returned value: |
118 | diamond | 754 | * eax = 0 - success |
755 | * else eax = error code of the file system |
||
499 | diamond | 756 | Remarks: |
118 | diamond | 757 | * All folders in the given path must exist, otherwise function |
758 | returns value 5, "file not found". |
||
114 | mikedld | 759 | |
760 | ====================================================================== |
||
118 | diamond | 761 | =========== Function 18, subfunction 7 - get active window. ========== |
114 | mikedld | 762 | ====================================================================== |
763 | Parameters: |
||
118 | diamond | 764 | * eax = 18 - function number |
765 | * ebx = 7 - subfunction number |
||
114 | mikedld | 766 | Returned value: |
118 | diamond | 767 | * eax = number of the active window |
768 | (number of the slot of the thread with active window) |
||
114 | mikedld | 769 | Remarks: |
118 | diamond | 770 | * Active window is at the top of the window stack and receives |
771 | messages on all keyboard input. |
||
772 | * To make a window active, use subfunction 3. |
||
114 | mikedld | 773 | |
118 | diamond | 774 | ====================================================================== |
775 | == Function 18, subfunction 8 - disable/enable the internal speaker. = |
||
776 | ====================================================================== |
||
777 | If speaker sound is disabled, all calls to subfunction 55 of |
||
778 | function 55 are ignored. If speaker sound is enabled, |
||
779 | they are routed on builtin speaker. |
||
114 | mikedld | 780 | |
118 | diamond | 781 | ------------------- Subsubfunction 1 - get status. ------------------- |
114 | mikedld | 782 | Parameters: |
118 | diamond | 783 | * eax = 18 - function number |
784 | * ebx = 8 - subfunction number |
||
785 | * ecx = 1 - number of the subsubfunction |
||
114 | mikedld | 786 | Returned value: |
118 | diamond | 787 | * eax = 0 - speaker sound is enabled; 1 - disabled |
114 | mikedld | 788 | |
118 | diamond | 789 | ----------------- Subsubfunction 2 - toggle status. ------------------ |
790 | Toggles states of disable/enable. |
||
114 | mikedld | 791 | Parameters: |
118 | diamond | 792 | * eax = 18 - function number |
793 | * ebx = 8 - subfunction number |
||
794 | * ecx = 2 - number of the subsubfunction |
||
114 | mikedld | 795 | Returned value: |
796 | * function does not return value |
||
797 | |||
118 | diamond | 798 | ====================================================================== |
1018 | diamond | 799 | == Function 18, subfunction 9 - system shutdown with the parameter. == |
118 | diamond | 800 | ====================================================================== |
114 | mikedld | 801 | Parameters: |
118 | diamond | 802 | * eax = 18 - function number |
803 | * ebx = 9 - subfunction number |
||
114 | mikedld | 804 | * ecx = parameter: |
118 | diamond | 805 | * 2 = turn off computer |
806 | * 3 = reboot computer |
||
807 | * 4 = restart the kernel from the file 'kernel.mnt' on ramdisk |
||
114 | mikedld | 808 | Returned value: |
118 | diamond | 809 | * at incorrect ecx the registers do not change (i.e. eax=18) |
810 | * by correct call function always returns eax=0 |
||
811 | as the tag of success |
||
114 | mikedld | 812 | Remarks: |
118 | diamond | 813 | * Do not rely on returned value by incorrect call, it can be |
814 | changed in future versions of the kernel. |
||
1018 | diamond | 815 | |
118 | diamond | 816 | ====================================================================== |
817 | ===== Function 18, subfunction 10 - minimize application window. ===== |
||
818 | ====================================================================== |
||
819 | Minimizes the own window. |
||
114 | mikedld | 820 | Parameters: |
118 | diamond | 821 | * eax = 18 - function number |
822 | * ebx = 10 - subfunction number |
||
114 | mikedld | 823 | Returned value: |
824 | * function does not return value |
||
825 | Remarks: |
||
118 | diamond | 826 | * The minimized window from the point of view of function 9 |
827 | keeps position and sizes. |
||
2409 | Serge | 828 | * Restoring of an application window occurs at its activation by |
118 | diamond | 829 | subfunction 3. |
830 | * Usually there is no necessity to minimize/restire a window |
||
831 | obviously: minimization of a window is carried out by the system |
||
832 | at pressing the minimization button (for skinned windows |
||
833 | it is defined automatically by function 0, |
||
834 | for other windows it can be defined manually by function 8), |
||
835 | restore of a window is done by the application '@panel'. |
||
114 | mikedld | 836 | |
837 | ====================================================================== |
||
2409 | Serge | 838 | Function 18, subfunction 11 - get information on the disk subsystem. |
114 | mikedld | 839 | ====================================================================== |
840 | Parameters: |
||
118 | diamond | 841 | * eax = 18 - function number |
842 | * ebx = 11 - subfunction number |
||
114 | mikedld | 843 | * ecx = type of the table: |
844 | * 1 = short version, 10 bytes |
||
845 | * 2 = full version, 65536 bytes |
||
118 | diamond | 846 | * edx = pointer to the buffer (in the application) for the table |
114 | mikedld | 847 | Returned value: |
848 | * function does not return value |
||
118 | diamond | 849 | Format of the table: short version: |
850 | * +0: byte: information about FDD's (drives for floppies), |
||
851 | AAAABBBB, where AAAA gives type of the first drive, BBBB - |
||
852 | of the second regarding to the following list: |
||
114 | mikedld | 853 | * 0 = there is no drive |
854 | * 1 = 360Kb, 5.25'' |
||
855 | * 2 = 1.2Mb, 5.25'' |
||
856 | * 3 = 720Kb, 3.5'' |
||
857 | * 4 = 1.44Mb, 3.5'' |
||
118 | diamond | 858 | * 5 = 2.88Mb, 3.5'' (such drives are not used anymore) |
859 | For example, for the standard configuration from one 1.44-drive |
||
860 | here will be 40h, and for the case 1.2Mb on A: and 1.44Mb on B: |
||
861 | the value is 24h. |
||
862 | * +1: byte: information about hard disks and CD-drives, AABBCCDD, |
||
114 | mikedld | 863 | where AA corresponds to the controller IDE0, ..., DD - IDE3: |
864 | * 0 = device is absent |
||
118 | diamond | 865 | * 1 = hard drive |
866 | * 2 = CD-drive |
||
867 | For example, in the case HD on IDE0 and CD on IDE2 |
||
868 | this field contains 48h. |
||
869 | * +2: 4 db: number of the retrieved partitions on hard disks |
||
870 | at accordingly IDE0,...,IDE3. |
||
871 | If the hard disk on IDEx is absent, appropriate byte is zero, |
||
872 | otherwise it shows number of the recognized partitions, which |
||
873 | can be not presented (if the drive is not formatted or if |
||
874 | the file system is not supported). Current version of the kernel |
||
277 | diamond | 875 | supports only FAT16, FAT32 and NTFS for hard disks. |
114 | mikedld | 876 | * +6: 4 db: reserved |
118 | diamond | 877 | Format of the table: full version: |
878 | * +0: 10 db: same as for the short version |
||
114 | mikedld | 879 | * +10: 100 db: data for the first partition |
880 | * +110: 100 db: data for the second partition |
||
881 | * ... |
||
882 | * +10+100*(n-1): 100 db: data for the last partition |
||
118 | diamond | 883 | The partitions are located as follows: at first sequentially all |
884 | recoginzed partitions on HD on IDE0 (if present), |
||
885 | then on HD on IDE1 (if present) and so on up to IDE3. |
||
886 | Format of the information about partition |
||
887 | (at moment only FAT is supported): |
||
114 | mikedld | 888 | * +0: dword: first physical sector of the partition |
889 | * +4: dword: last physical sector of the partition |
||
118 | diamond | 890 | (belongs to the partition) |
277 | diamond | 891 | * +8: byte: file system type: |
892 | 16=FAT16, 32=FAT32, 1=NTFS |
||
893 | * other data are dependent on file system, are modified with |
||
894 | kernel modifications and therefore are not described |
||
114 | mikedld | 895 | Remarks: |
118 | diamond | 896 | * The short table can be used for obtaining the information about |
897 | available devices. |
||
114 | mikedld | 898 | |
899 | ====================================================================== |
||
118 | diamond | 900 | ========== Function 18, subfunction 13 - get kernel version. ========= |
114 | mikedld | 901 | ====================================================================== |
902 | Parameters: |
||
118 | diamond | 903 | * eax = 18 - function number |
904 | * ebx = 13 - subfunction number |
||
905 | * ecx = pointer to the buffer (not less than 16 bytes), where |
||
906 | the information will be placed |
||
114 | mikedld | 907 | Returned value: |
908 | * function does not return value |
||
909 | Structure of the buffer: |
||
910 | db a,b,c,d for version a.b.c.d |
||
1675 | Nasarus | 911 | db 0: reserved |
540 | victor | 912 | dd REV - kernel SVN revision number |
1675 | Nasarus | 913 | For Kolibri 0.7.7.0+ kernel: |
1662 | Nasarus | 914 | db 0,7,7,0 |
1675 | Nasarus | 915 | db 0 |
1676 | Nasarus | 916 | dd 1675 |
114 | mikedld | 917 | |
118 | diamond | 918 | ====================================================================== |
919 | ======= Function 18, subfunction 14 - wait for screen retrace. ======= |
||
920 | ====================================================================== |
||
921 | Waits for the beginning of retrace of the scanning ray of the screen |
||
922 | monitor. |
||
114 | mikedld | 923 | Parameters: |
118 | diamond | 924 | * eax = 18 - function number |
925 | * ebx = 14 - subfunction number |
||
114 | mikedld | 926 | Returned value: |
118 | diamond | 927 | * eax = 0 as the tag of success |
114 | mikedld | 928 | Remarks: |
118 | diamond | 929 | * Function is intended only for active high-efficiency graphics |
114 | mikedld | 930 | applications; is used for smooth output of a graphics. |
931 | |||
118 | diamond | 932 | ====================================================================== |
933 | == Function 18, subfunction 15 - center mouse cursor on the screen. == |
||
934 | ====================================================================== |
||
114 | mikedld | 935 | Parameters: |
118 | diamond | 936 | * eax = 18 - function number |
937 | * ebx = 15 - subfunction number |
||
114 | mikedld | 938 | Returned value: |
118 | diamond | 939 | * eax = 0 as the tag of success |
114 | mikedld | 940 | |
941 | ====================================================================== |
||
118 | diamond | 942 | ========= Function 18, subfunction 16 - get size of free RAM. ======== |
114 | mikedld | 943 | ====================================================================== |
944 | Parameters: |
||
118 | diamond | 945 | * eax = 18 - function number |
946 | * ebx = 16 - subfunction number |
||
114 | mikedld | 947 | Returned value: |
948 | * eax = size of free memory in kilobytes |
||
949 | |||
950 | ====================================================================== |
||
118 | diamond | 951 | ======== Function 18, subfunction 17 - get full amount of RAM. ======= |
114 | mikedld | 952 | ====================================================================== |
953 | Parameters: |
||
118 | diamond | 954 | * eax = 18 - function number |
955 | * ebx = 17 - subfunction number |
||
114 | mikedld | 956 | Returned value: |
118 | diamond | 957 | * eax = total size of existing memory in kilobytes |
114 | mikedld | 958 | |
959 | ====================================================================== |
||
118 | diamond | 960 | ===================== Function 18, subfunction 18 ==================== |
961 | ============= Terminate process/thread by the identifier. ============ |
||
114 | mikedld | 962 | ====================================================================== |
963 | Parameters: |
||
118 | diamond | 964 | * eax = 18 - function number |
965 | * ebx = 18 - subfunction number |
||
966 | * ecx = identifer of process/thread (PID/TID) |
||
114 | mikedld | 967 | Returned value: |
118 | diamond | 968 | * eax = 0 - success |
969 | * eax = -1 - error (process is not found or is system) |
||
114 | mikedld | 970 | Remarks: |
118 | diamond | 971 | * It is impossible to terminate system thread OS/IDLE (identifier |
972 | 1), it is possible to terminate any normal process/thread. |
||
973 | * See also subfunction 2 - terminate |
||
974 | process/thread by given slot. |
||
114 | mikedld | 975 | |
976 | ====================================================================== |
||
131 | diamond | 977 | ======== Function 18, subfunction 19 - get/set mouse features. ======= |
120 | mario79 | 978 | ====================================================================== |
131 | diamond | 979 | |
980 | ---------------- Subsubfunction 0 - get mouse speed. ----------------- |
||
120 | mario79 | 981 | Parameters: |
982 | * eax = 18 - function number |
||
983 | * ebx = 19 - subfunction number |
||
131 | diamond | 984 | * ecx = 0 - subsubfunction number |
985 | Returned value: |
||
986 | * eax = current mouse speed |
||
120 | mario79 | 987 | |
131 | diamond | 988 | ---------------- Subsubfunction 1 - set mouse speed. ----------------- |
989 | Parameters: |
||
990 | * eax = 18 - function number |
||
991 | * ebx = 19 - subfunction number |
||
992 | * ecx = 1 - subsubfunction number |
||
993 | * edx = new value for speed |
||
994 | Returned value: |
||
995 | * function does not return value |
||
120 | mario79 | 996 | |
131 | diamond | 997 | ---------------- Subsubfunction 2 - get mouse delay. ----------------- |
998 | Parameters: |
||
999 | * eax = 18 - function number |
||
1000 | * ebx = 19 - subfunction number |
||
1001 | * ecx = 2 - subsubfunction number |
||
1002 | Returned value: |
||
1003 | * eax = current mouse delay |
||
120 | mario79 | 1004 | |
131 | diamond | 1005 | ---------------- Subsubfunction 3 - set mouse delay. ----------------- |
1006 | Parameters: |
||
1007 | * eax = 18 - function number |
||
1008 | * ebx = 19 - subfunction number |
||
1009 | * ecx = 3 - subsubfunction number |
||
1010 | * edx = new value for mouse delay |
||
1011 | Returned value: |
||
1012 | * function does not return value |
||
120 | mario79 | 1013 | |
131 | diamond | 1014 | ----------- Subsubfunction 4 - set mouse pointer position. ----------- |
1015 | Parameters: |
||
1016 | * eax = 18 - function number |
||
1017 | * ebx = 19 - subfunction number |
||
1018 | * ecx = 4 - subsubfunction number |
||
1019 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
1020 | Returned value: |
||
1021 | * function does not return value |
||
621 | mario79 | 1022 | |
641 | diamond | 1023 | -------- Subsubfunction 5 - simulate state of mouse buttons. --------- |
621 | mario79 | 1024 | Parameters: |
1025 | * eax = 18 - function number |
||
1026 | * ebx = 19 - subfunction number |
||
1027 | * ecx = 5 - subsubfunction number |
||
641 | diamond | 1028 | * edx = information about emulated state of mouse buttons: |
1029 | (same as return value in subfunction 2 of function 37) |
||
621 | mario79 | 1030 | * bit 0 is set = left button is pressed |
1031 | * bit 1 is set = right button is pressed |
||
1032 | * bit 2 is set = middle button is pressed |
||
1033 | * bit 3 is set = 4th button is pressed |
||
1034 | * bit 4 is set = 5th button is pressed |
||
1035 | Returned value: |
||
1036 | * function does not return value |
||
120 | mario79 | 1037 | Remarks: |
131 | diamond | 1038 | * It is recommended to set speed of the mouse (in subsubfunction 1) |
1039 | from 1 up to 9. The installed value is not inspected by the kernel |
||
1040 | code, so set it carefully, at incorrect value the cursor |
||
1041 | can "freeze". Speed of the mouse can be regulated through the |
||
1042 | application SETUP. |
||
1043 | * Recommended delay of the mouse (in subsubfunction 3) = 10. Lower |
||
1044 | value is not handled by COM mice. At the very large values the |
||
1045 | movement of the mouse on 1 pixel is impossible and the cursor will |
||
1046 | jump on the value of installed speed (subsubfunction 1). The |
||
1047 | installed value is not inspected by the kernel code. |
||
133 | diamond | 1048 | Mouse delay can be regulated through the application SETUP. |
131 | diamond | 1049 | * The subsubfunction 4 does not check the passed value. Before |
1050 | its call find out current screen resolution (with function 14) |
||
1051 | and check that the value of position is inside the limits of the |
||
1052 | screen. |
||
120 | mario79 | 1053 | |
1054 | ====================================================================== |
||
193 | diamond | 1055 | ======== Function 18, subfunction 20 - get information on RAM. ======= |
1056 | ====================================================================== |
||
1057 | Parameters: |
||
1058 | * eax = 18 - function number |
||
1059 | * ebx = 20 - subfunction number |
||
1060 | * ecx = pointer to the buffer for information (36 bytes) |
||
1061 | Returned value: |
||
1062 | * eax = total size of existing RAM in pages |
||
1063 | or -1 if error has occured |
||
1064 | * buffer pointed to by ecx contains the following information: |
||
1065 | * +0: dword: total size of existing RAM in pages |
||
1066 | * +4: dword: size of free RAM in pages |
||
1067 | * +8: dword: number of page faults (exceptions #PF) |
||
1068 | in applications |
||
1069 | * +12: dword: size of kernel heap in bytes |
||
1070 | * +16: dword: free in kernel heap in bytes |
||
1071 | * +20: dword: total number of memory blocks in kernel heap |
||
1072 | * +24: dword: number of free memory blocks in kernel heap |
||
1073 | * +28: dword: size of maximum free block in kernel heap |
||
1074 | (reserved) |
||
1075 | * +32: dword: size of maximum allocated block in kernel heap |
||
1076 | (reserved) |
||
1077 | |||
1078 | ====================================================================== |
||
641 | diamond | 1079 | ===================== Function 18, subfunction 21 ==================== |
1080 | ======== Get slot number of process/thread by the identifier. ======== |
||
608 | alver | 1081 | ====================================================================== |
1082 | Parameters: |
||
1083 | * eax = 18 - function number |
||
1084 | * ebx = 21 - subfunction number |
||
641 | diamond | 1085 | * ecx = identifer of process/thread (PID/TID) |
608 | alver | 1086 | Returned value: |
641 | diamond | 1087 | * eax = 0 - error (invalid identifier) |
1088 | * otherwise eax = slot number |
||
608 | alver | 1089 | |
1090 | ====================================================================== |
||
641 | diamond | 1091 | ===================== Function 18, subfunction 22 ==================== |
1092 | ============== Operations with window of another thread. ============= |
||
608 | alver | 1093 | ====================================================================== |
1094 | Parameters: |
||
1095 | * eax = 18 - function number |
||
1096 | * ebx = 22 - subfunction number |
||
641 | diamond | 1097 | * ecx = operation type: |
1098 | * 0 = minimize window of the thread with given slot number |
||
1099 | * 1 = minimize window of the thread with given identifier |
||
1100 | * 2 = restore window of the thread with given slot number |
||
1101 | * 3 = restore window of the thread with given identifier |
||
1102 | * edx = parameter (slot number or PID/TID) |
||
608 | alver | 1103 | Returned value: |
641 | diamond | 1104 | * eax = 0 - success |
1105 | * eax = -1 - error (invalid identifier) |
||
1106 | Remarks: |
||
1107 | * The thread can minimize its window with subfunction 10. |
||
1108 | * One can restore and activate window simultaneously with |
||
1109 | subfunction 3 (which requires slot number). |
||
608 | alver | 1110 | |
1111 | ====================================================================== |
||
2648 | mario79 | 1112 | ======== Function 18, subfunction 23 - minimize all windows. ========== |
1113 | ====================================================================== |
||
1114 | Parameters: |
||
1115 | * eax = 18 - function number |
||
1116 | * ebx = 23 - subfunction number |
||
1117 | Returned value: |
||
1118 | * eax = 0 - all windows have been minimized before a function call |
||
1119 | * eax = N - number of windows minimized from function |
||
1120 | Remarks: |
||
1121 | * Window of special thread (name begin to symbol @) is not minimize. |
||
2654 | mario79 | 1122 | |
2648 | mario79 | 1123 | ====================================================================== |
2654 | mario79 | 1124 | ======= Function 18, subfunction 24 - set limits of screen. ========== |
1125 | ====================================================================== |
||
1126 | Parameters: |
||
1127 | * eax = 18 - function number |
||
1128 | * ebx = 24 - subfunction number |
||
1129 | * ecx = new X size |
||
1130 | * edx = new Y size |
||
1131 | Returned value: |
||
1132 | * function does not return value |
||
1133 | Remarks: |
||
1134 | * The function does not change the physical size of the video mode. |
||
1135 | It is designed for non-standard displays which display the image |
||
1136 | partially. |
||
1137 | * The sizes specified in the function should not exceed the sizes |
||
1138 | of the current video mode, otherwise the function will not change |
||
1139 | anything. |
||
1140 | |||
1141 | ====================================================================== |
||
118 | diamond | 1142 | ==================== Function 20 - MIDI interface. =================== |
114 | mikedld | 1143 | ====================================================================== |
1144 | |||
118 | diamond | 1145 | ----------------------- Subfunction 1 - reset ------------------------ |
114 | mikedld | 1146 | Parameters: |
118 | diamond | 1147 | * eax = 20 - function number |
1148 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1149 | |
1150 | -------------------- Subfunction 2 - output byte --------------------- |
||
1151 | Parameters: |
||
118 | diamond | 1152 | * eax = 20 - function number |
1153 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1154 | * cl = byte for output |
118 | diamond | 1155 | Returned value (is the same for both subfunctions): |
1156 | * eax = 0 - success |
||
114 | mikedld | 1157 | * eax = 1 - base port is not defined |
1158 | Remarks: |
||
2409 | Serge | 1159 | * Previously the base port must be defined by |
118 | diamond | 1160 | subfunction 1 of function 21. |
114 | mikedld | 1161 | |
1162 | ====================================================================== |
||
118 | diamond | 1163 | ======== Function 21, subfunction 1 - set MPU MIDI base port. ======== |
114 | mikedld | 1164 | ====================================================================== |
1165 | Parameters: |
||
118 | diamond | 1166 | * eax = 21 - function number |
1167 | * ebx = 1 - subfunction number |
||
1168 | * ecx = number of base port |
||
1169 | Returned value |
||
1170 | * eax = 0 - success |
||
114 | mikedld | 1171 | * eax = -1 - erratic number of a port |
1172 | Remarks: |
||
118 | diamond | 1173 | * Number of a port must satisfy to conditions 0x100<=ecx<=0xFFFF. |
1174 | * The installation of base is necessary for function 20. |
||
1175 | * To get base port use subfunction 1 of function 26. |
||
114 | mikedld | 1176 | |
1177 | ====================================================================== |
||
118 | diamond | 1178 | ========== Function 21, subfunction 2 - set keyboard layout. ========= |
114 | mikedld | 1179 | ====================================================================== |
118 | diamond | 1180 | Keyboard layout is used to convert keyboard scancodes to ASCII-codes, |
1181 | which will be read by function 2. |
||
114 | mikedld | 1182 | Parameters: |
118 | diamond | 1183 | * eax = 21 - function number |
1184 | * ebx = 2 - subfunction number |
||
1185 | * ecx = which layout to set: |
||
114 | mikedld | 1186 | * 1 = normal layout |
1187 | * 2 = layout at pressed Shift |
||
1188 | * 3 = layout at pressed Alt |
||
118 | diamond | 1189 | * edx = pointer to layout - table of length 128 bytes |
114 | mikedld | 1190 | Or: |
1191 | * ecx = 9 |
||
118 | diamond | 1192 | * dx = country identifier (1=eng, 2=fi, 3=ger, 4=rus) |
114 | mikedld | 1193 | Returned value: |
118 | diamond | 1194 | * eax = 0 - success |
1195 | * eax = 1 - incorrect parameter |
||
114 | mikedld | 1196 | Remarks: |
118 | diamond | 1197 | * If Alt is pressed, the layout with Alt is used; |
1198 | if Alt is not pressed, but Shift is pressed, |
||
1199 | the layout with Shift is used; |
||
1200 | if Alt and Shift are not pressed, but Ctrl is pressed, the normal |
||
1201 | layout is used and then from the code is subtracted 0x60; |
||
1202 | if no control key is pressed, the normal layout is used. |
||
2409 | Serge | 1203 | * To get layout and country identifier use |
118 | diamond | 1204 | subfunction 2 of function 26. |
1205 | * Country identifier is global system variable, which is not used |
||
1206 | by the kernel itself; however the application '@panel' displays |
||
1207 | the corresponding icon. |
||
1208 | * The application @panel switches layouts on user request. |
||
114 | mikedld | 1209 | |
1210 | ====================================================================== |
||
118 | diamond | 1211 | ============== Function 21, subfunction 3 - set CD base. ============= |
114 | mikedld | 1212 | ====================================================================== |
1213 | Parameters: |
||
118 | diamond | 1214 | * eax = 21 - function number |
1215 | * ebx = 3 - subfunction number |
||
1216 | * ecx = CD base: 1=IDE0, 2=IDE1, 3=IDE2, 4=IDE3 |
||
114 | mikedld | 1217 | Returned value: |
1218 | * eax = 0 |
||
1219 | Remarks: |
||
118 | diamond | 1220 | * CD base is used by function 24. |
1221 | * To get CD base use subfunction 3 of function 26. |
||
114 | mikedld | 1222 | |
1223 | ====================================================================== |
||
118 | diamond | 1224 | ========== Function 21, subfunction 5 - set system language. ========= |
114 | mikedld | 1225 | ====================================================================== |
1226 | Parameters: |
||
118 | diamond | 1227 | * eax = 21 - function number |
1228 | * ebx = 5 - subfunction number |
||
1229 | * ecx = system language (1=eng, 2=fi, 3=ger, 4=rus) |
||
114 | mikedld | 1230 | Returned value: |
1231 | * eax = 0 |
||
1232 | Remarks: |
||
118 | diamond | 1233 | * System language is global system variable and is not used |
1234 | by the kernel itself, however application @panel draws the |
||
1235 | appropriate icon. |
||
1236 | * Function does not check for correctness, as the kernel does not |
||
1237 | use this variable. |
||
1238 | * To get system language use subfunction 5 of function 26. |
||
114 | mikedld | 1239 | |
1240 | ====================================================================== |
||
118 | diamond | 1241 | ============== Function 21, subfunction 7 - set HD base. ============= |
114 | mikedld | 1242 | ====================================================================== |
118 | diamond | 1243 | The HD base defines hard disk to write with usage of obsolete |
346 | diamond | 1244 | syntax /HD in obsolete function 58; at usage of modern syntax |
1245 | /HD0,/HD1,/HD2,/HD3 base is set automatically. |
||
114 | mikedld | 1246 | Parameters: |
118 | diamond | 1247 | * eax = 21 - function number |
1248 | * ebx = 7 - subfunction number |
||
1249 | * ecx = HD base: 1=IDE0, 2=IDE1, 3=IDE2, 4=IDE3 |
||
114 | mikedld | 1250 | Returned value: |
1251 | * eax = 0 |
||
1252 | Remarks: |
||
118 | diamond | 1253 | * Any application at any time can change the base. |
1254 | * Do not change base, when any application works with hard disk. |
||
1255 | If you do not want system bugs. |
||
1256 | * To get HD base use subfunction 7 of function 26. |
||
2409 | Serge | 1257 | * It is also necessary to define used partition of hard disk by |
118 | diamond | 1258 | subfunction 8. |
114 | mikedld | 1259 | |
1260 | ====================================================================== |
||
118 | diamond | 1261 | ========= Function 21, subfunction 8 - set used HD partition. ======== |
114 | mikedld | 1262 | ====================================================================== |
118 | diamond | 1263 | The HD partition defines partition of the hard disk to write with |
346 | diamond | 1264 | usage of obsolete syntax /HD and obsolete function 58; |
118 | diamond | 1265 | at usage of functions 58 and 70 and modern syntax /HD0,/HD1,/HD2,/HD3 |
346 | diamond | 1266 | base and partition are set automatically. |
114 | mikedld | 1267 | Parameters: |
118 | diamond | 1268 | * eax = 21 - function number |
1269 | * ebx = 8 - subfunction number |
||
1270 | * ecx = HD partition (beginning from 1) |
||
1271 | Return value: |
||
114 | mikedld | 1272 | * eax = 0 |
1273 | Remarks: |
||
118 | diamond | 1274 | * Any application at any time can change partition. |
1275 | * Do not change partition when any application works with hard disk. |
||
1276 | If you do not want system bugs. |
||
1277 | * To get used partition use subfunction 8 of function 26. |
||
1278 | * There is no correctness checks. |
||
2409 | Serge | 1279 | * To get the number of partitions of a hard disk use |
118 | diamond | 1280 | subfunction 11 of function 18. |
1281 | * It is also necessary to define used HD base by subfunction 7. |
||
114 | mikedld | 1282 | |
1283 | ====================================================================== |
||
2409 | Serge | 1284 | Function 21, subfunction 11 - enable/disable low-level access to HD. |
114 | mikedld | 1285 | ====================================================================== |
1286 | Parameters: |
||
118 | diamond | 1287 | * eax = 21 - function number |
1288 | * ebx = 11 - subfunction number |
||
1289 | * ecx = 0/1 - disable/enable |
||
114 | mikedld | 1290 | Returned value: |
1291 | * eax = 0 |
||
1292 | Remarks: |
||
118 | diamond | 1293 | * Is used in LBA-read (subfunction 8 of function 58). |
1294 | * The current implementation uses only low bit of ecx. |
||
1295 | * To get current status use subfunction 11 of function 26. |
||
114 | mikedld | 1296 | |
1297 | ====================================================================== |
||
2409 | Serge | 1298 | Function 21, subfunction 12 - enable/disable low-level access to PCI. |
114 | mikedld | 1299 | ====================================================================== |
1300 | Parameters: |
||
118 | diamond | 1301 | * eax = 21 - function number |
1302 | * ebx = 12 - subfunction number |
||
1303 | * ecx = 0/1 - disable/enable |
||
114 | mikedld | 1304 | Returned value: |
1305 | * eax = 0 |
||
1306 | Remarks: |
||
118 | diamond | 1307 | * Is used in operations with PCI bus (function 62). |
1308 | * The current implementation uses only low bit of ecx. |
||
1309 | * To get current status use subfunction 12 of function 26. |
||
114 | mikedld | 1310 | |
1311 | ====================================================================== |
||
118 | diamond | 1312 | ============ Function 21, subfunction 13, subsubfunction 1 =========== |
1313 | ======== Initialize + get information on the driver vmode.mdr. ======= |
||
114 | mikedld | 1314 | ====================================================================== |
1315 | Parameters: |
||
118 | diamond | 1316 | * eax = 21 - function number |
1317 | * ebx = 13 - subfunction number |
||
1318 | * ecx = 1 - number of the driver function |
||
1319 | * edx = pointer to 512-bytes buffer |
||
114 | mikedld | 1320 | Returned value: |
118 | diamond | 1321 | * if driver is not loaded |
1322 | (never happens in the current implementation): |
||
114 | mikedld | 1323 | * eax = -1 |
118 | diamond | 1324 | * ebx, ecx destroyed |
1325 | * if driver is loaded: |
||
1326 | * eax = 'MDAZ' (in fasm style, that is 'M' - low byte, 'Z' - high) |
||
1327 | - signature |
||
1328 | * ebx = current frequency of the scanning (in Hz) |
||
1329 | * ecx destroyed |
||
1330 | * buffer pointed to by edx is filled |
||
114 | mikedld | 1331 | Format of the buffer: |
118 | diamond | 1332 | * +0: 32*byte: driver name, "Trans VideoDriver" |
1333 | (without quotes, supplemented by spaces) |
||
1334 | * +32 = +0x20: dword: driver version (version x.y is encoded as |
||
1335 | y*65536+x), for the current implementation is 1 (1.0) |
||
1336 | * +36 = +0x24: 7*dword: reserved (0 in the current implementation) |
||
1337 | * +64 = +0x40: 32*word: list of supported videomodes (each word |
||
1338 | is number of a videomode, after list itself there are zeroes) |
||
1339 | * +128 = +0x80: 32*(5*word): list of supported frequences of the |
||
1340 | scannings for videomodes: for each videomode listed in the |
||
1341 | previous field up to 5 supported frequences are given |
||
1342 | (unused positions contain zeroes) |
||
114 | mikedld | 1343 | Remarks: |
118 | diamond | 1344 | * Function initializes the driver (if it is not initialized yet) |
1345 | and must be called first, before others (otherwise they will do |
||
1346 | nothing and return -1). |
||
1347 | * The current implementation supports only one frequency |
||
1348 | of the scanning on videomode. |
||
114 | mikedld | 1349 | |
1350 | ====================================================================== |
||
118 | diamond | 1351 | ============ Function 21, subfunction 13, subsubfunction 2 =========== |
1352 | ================ Get information on current videomode. =============== |
||
114 | mikedld | 1353 | ====================================================================== |
1354 | Parameters: |
||
118 | diamond | 1355 | * eax = 21 - function number |
1356 | * ebx = 13 - subfunction number |
||
1357 | * ecx = 2 - number of the driver function |
||
114 | mikedld | 1358 | Returned value: |
118 | diamond | 1359 | * eax = -1 - driver is not loaded or not initialized; |
1360 | ebx,ecx are destroyed |
||
114 | mikedld | 1361 | * eax = [width]*65536 + [height] |
118 | diamond | 1362 | * ebx = frequency of the vertical scanning (in Hz) |
114 | mikedld | 1363 | * ecx = number of current videomode |
1364 | Remarks: |
||
2409 | Serge | 1365 | * Driver must be initialized by call to |
118 | diamond | 1366 | driver function 1. |
1367 | * If only screen sizes are required, it is more expedient to use |
||
1368 | function 14 taking into account that it |
||
1369 | returns sizes on 1 less. |
||
114 | mikedld | 1370 | |
1371 | ====================================================================== |
||
118 | diamond | 1372 | === Function 21, subfunction 13, subsubfunction 3 - set videomode. === |
114 | mikedld | 1373 | ====================================================================== |
1374 | Parameters: |
||
118 | diamond | 1375 | * eax = 21 - function number |
1376 | * ebx = 13 - subfunction number |
||
1377 | * ecx = 3 - number of the driver function |
||
1378 | * edx = [scanning frequency]*65536 + [videomode number] |
||
114 | mikedld | 1379 | Returned value: |
118 | diamond | 1380 | * eax = -1 - driver is not loaded, not initialized or |
1381 | an error has occured |
||
1382 | * eax = 0 - success |
||
1383 | * ebx, ecx destroyed |
||
114 | mikedld | 1384 | Remarks: |
118 | diamond | 1385 | * Driver must be initialized by driver function 1. |
1386 | * The videomode number and frequency must be in the table |
||
1387 | returned by driver function 1. |
||
114 | mikedld | 1388 | |
1389 | ====================================================================== |
||
118 | diamond | 1390 | ============ Function 21, subfunction 13, subsubfunction 4 =========== |
1391 | ================== Return to the initial videomode. ================== |
||
114 | mikedld | 1392 | ====================================================================== |
118 | diamond | 1393 | Returns the screen to the videomode set at system boot. |
114 | mikedld | 1394 | Parameters: |
118 | diamond | 1395 | * eax = 21 - function number |
1396 | * ebx = 13 - subfunction number |
||
1397 | * ecx = 4 - number of the driver function |
||
114 | mikedld | 1398 | Returned value: |
118 | diamond | 1399 | * eax = -1 - driver is not loaded or not initialized |
1400 | * eax = 0 - success |
||
1401 | * ebx, ecx destroyed |
||
114 | mikedld | 1402 | Remarks: |
118 | diamond | 1403 | * Driver must be initialized by call to driver function 1. |
114 | mikedld | 1404 | |
118 | diamond | 1405 | ====================================================================== |
1406 | ============ Function 21, subfunction 13, subsubfunction 5 =========== |
||
1407 | ===== Increase/decrease the size of the visible area of monitor. ===== |
||
1408 | ====================================================================== |
||
114 | mikedld | 1409 | Parameters: |
118 | diamond | 1410 | * eax = 21 - function number |
1411 | * ebx = 13 - subfunction number |
||
1412 | * ecx = 5 - number of the driver function |
||
1413 | * edx = 0/1 - decrease/increase horizontal size on 1 position |
||
1414 | * edx = 2/3 - is not supported in the current implementation; |
||
1415 | is planned as decrease/increase vertical size on 1 position |
||
114 | mikedld | 1416 | Returned value: |
118 | diamond | 1417 | * eax = -1 - driver is not loaded or not initialized |
1418 | * eax = 0 - success |
||
1419 | * ebx, ecx destroyed |
||
114 | mikedld | 1420 | Remarks: |
118 | diamond | 1421 | * Driver must be initialized by call to driver function 1. |
1422 | * Function influences only the physical size of the screen image; |
||
1423 | the logical size (number of pixels) does not change. |
||
114 | mikedld | 1424 | |
1425 | ====================================================================== |
||
118 | diamond | 1426 | ================= Function 22 - set system date/time. ================ |
114 | mikedld | 1427 | ====================================================================== |
1428 | Parameters: |
||
118 | diamond | 1429 | * eax = 22 - function number |
1430 | * ebx = 0 - set time |
||
1431 | * ecx = 0x00SSMMHH - time in the binary-decimal code (BCD): |
||
114 | mikedld | 1432 | * HH=hour 00..23 |
1433 | * MM=minute 00..59 |
||
1434 | * SS=second 00..59 |
||
118 | diamond | 1435 | * ebx = 1 - set date |
1436 | * ecx = 0x00DDMMYY - date in the binary-decimal code (BCD): |
||
114 | mikedld | 1437 | * DD=day 01..31 |
1438 | * MM=month 01..12 |
||
1439 | * YY=year 00..99 |
||
118 | diamond | 1440 | * ebx = 2 - set day of week |
114 | mikedld | 1441 | * ecx = 1 for Sunday, ..., 7 for Saturday |
118 | diamond | 1442 | * ebx = 3 - set alarm clock |
114 | mikedld | 1443 | * ecx = 0x00SSMMHH |
1444 | Returned value: |
||
118 | diamond | 1445 | * eax = 0 - success |
1446 | * eax = 1 - incorrect parameter |
||
114 | mikedld | 1447 | * eax = 2 - CMOS-battery was unloaded |
1448 | Remarks: |
||
118 | diamond | 1449 | * Value of installation of day of week seems to be doubtful, |
1450 | as it a little where is used |
||
1451 | (day of week can be calculated by date). |
||
1452 | * Alarm clock can be set on operation in the given time every day. |
||
1453 | But there is no existing system function to disable it. |
||
1454 | * Operation of alarm clock consists in generation IRQ8. |
||
1455 | * Generally CMOS supports for alarm clock set of value 0xFF |
||
1456 | as one of parameters and it means that the appropriate parameter |
||
1457 | is ignored. But current implementation does not allow this |
||
1458 | (will return 1). |
||
1459 | * Alarm clock is a global system resource; the set of |
||
1460 | an alarm clock cancels automatically the previous set. |
||
1461 | However, at moment no program uses it. |
||
114 | mikedld | 1462 | |
1463 | ====================================================================== |
||
118 | diamond | 1464 | ============= Function 23 - wait for event with timeout. ============= |
114 | mikedld | 1465 | ====================================================================== |
118 | diamond | 1466 | If the message queue is empty, waits for new message in the queue, |
1467 | but no more than given time. Then reads out a message from the queue. |
||
114 | mikedld | 1468 | |
1469 | Parameters: |
||
118 | diamond | 1470 | * eax = 23 - function number |
114 | mikedld | 1471 | * ebx = timeout (in 1/100 of second) |
1472 | Returned value: |
||
118 | diamond | 1473 | * eax = 0 - the message queue is empty |
1474 | * otherwise eax = event (see the list of events) |
||
114 | mikedld | 1475 | Remarks: |
118 | diamond | 1476 | * Only those events are taken into account, which enter into |
1477 | the mask set by function 40. By default it is |
||
1478 | redraw, key and button events. |
||
1479 | * To check for presence of a message in the queue use function 11. |
||
1480 | To wait without timeout use function 10. |
||
1481 | * Transmission ebx=0 results in immediate returning eax=0. |
||
1482 | * Current implementation returns immediately with eax=0, |
||
1483 | if the addition of ebx with the current value of time counter |
||
1484 | makes 32-bit overflow. |
||
114 | mikedld | 1485 | |
1486 | ====================================================================== |
||
118 | diamond | 1487 | ======== Function 24, subfunction 1 - begin to play CD-audio. ======== |
114 | mikedld | 1488 | ====================================================================== |
1489 | Parameters: |
||
118 | diamond | 1490 | * eax = 24 - function number |
1491 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1492 | * ecx = 0x00FRSSMM, where |
118 | diamond | 1493 | * MM = starting minute |
1494 | * SS = starting second |
||
1495 | * FR = starting frame |
||
114 | mikedld | 1496 | Returned value: |
118 | diamond | 1497 | * eax = 0 - success |
1498 | * eax = 1 - CD base is not defined |
||
114 | mikedld | 1499 | Remarks: |
2409 | Serge | 1500 | * Previously CD base must be defined by the call to |
118 | diamond | 1501 | subfunction 3 of function 21. |
1502 | * One second includes 75 frames, one minute includes 60 seconds. |
||
1503 | * The function is asynchronous (returns control, when play begins). |
||
114 | mikedld | 1504 | |
1505 | ====================================================================== |
||
118 | diamond | 1506 | ======= Function 24, subfunction 2 - get information on tracks. ====== |
114 | mikedld | 1507 | ====================================================================== |
1508 | Parameters: |
||
118 | diamond | 1509 | * eax = 24 - function number |
1510 | * ebx = 2 - subfunction number |
||
1511 | * ecx = pointer to the buffer for the table |
||
1512 | (maximum 8*64h+4 bytes=100 tracks) |
||
114 | mikedld | 1513 | Returned value: |
118 | diamond | 1514 | * eax = 0 - success |
1515 | * eax = 1 - CD base is not defined |
||
114 | mikedld | 1516 | Remarks: |
118 | diamond | 1517 | * The format of the table with tracks information is the same as |
1518 | for ATAPI-CD command 43h (READ TOC), usual table (subcommand 00h). |
||
1519 | Function returns addresses in MSF. |
||
2409 | Serge | 1520 | * Previously CD base port must be set by call to |
118 | diamond | 1521 | subfunction 3 of function 21. |
1522 | * Function returns information only about no more than 100 |
||
1523 | first tracks. In most cases it is enough. |
||
114 | mikedld | 1524 | |
1525 | ====================================================================== |
||
118 | diamond | 1526 | ========== Function 24, subfunction 3 - stop play CD-audio. ========== |
114 | mikedld | 1527 | ====================================================================== |
1528 | Parameters: |
||
118 | diamond | 1529 | * eax = 24 - function number |
1530 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1531 | Returned value: |
118 | diamond | 1532 | * eax = 0 - success |
1533 | * eax = 1 - CD base is not defined |
||
499 | diamond | 1534 | Remarks: |
2409 | Serge | 1535 | * Previously CD base port must be defined by call to |
118 | diamond | 1536 | subfunction 3 of function 21. |
114 | mikedld | 1537 | |
1538 | ====================================================================== |
||
641 | diamond | 1539 | ======= Function 24, subfunction 4 - eject tray of disk drive. ======= |
588 | diamond | 1540 | ====================================================================== |
1541 | Parameters: |
||
1542 | * eax = 24 - function number |
||
1543 | * ebx = 4 - subfunction number |
||
641 | diamond | 1544 | * ecx = position of CD/DVD-drive |
1545 | (from 0=Primary Master to 3=Secondary Slave) |
||
588 | diamond | 1546 | Returned value: |
641 | diamond | 1547 | * function does not return value |
588 | diamond | 1548 | Remarks: |
1549 | * The function is supported only for ATAPI devices (CD and DVD). |
||
641 | diamond | 1550 | * When the tray is being ejected, |
1551 | manual control of tray is unlocked. |
||
1552 | * When the tray is being ejected, the code clears the cache for |
||
1553 | corresponding device. |
||
588 | diamond | 1554 | * An example of usage of the function is the application CD_tray. |
1555 | |||
1556 | ====================================================================== |
||
641 | diamond | 1557 | ======== Function 24, subfunction 5 - load tray of disk drive. ======= |
588 | diamond | 1558 | ====================================================================== |
1559 | Parameters: |
||
1560 | * eax = 24 - function number |
||
1561 | * ebx = 5 - subfunction number |
||
641 | diamond | 1562 | * ecx = position of CD/DVD-drive |
1563 | (from 0=Primary Master to 3=Secondary Slave) |
||
588 | diamond | 1564 | Returned value: |
641 | diamond | 1565 | * function does not return value |
588 | diamond | 1566 | Remarks: |
1567 | * The function is supported only for ATAPI devices (CD and DVD). |
||
1568 | * An example of usage of the function is the application CD_tray. |
||
2509 | mario79 | 1569 | |
1570 | ====================================================================== |
||
1571 | ======= Function 25 - put image area on the background layer. ======== |
||
1572 | ====================================================================== |
||
1573 | Paramters: |
||
1574 | * eax = 25 - function number |
||
1575 | * ebx = pointer to the previously allocated memory area, |
||
1576 | where placed the source images in a format BBGGRRTTBBGGRRTT... |
||
1577 | * ecx = [size on axis x]*65536 + [size on axis y] |
||
1578 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
1579 | Returned value: |
||
1580 | * function does not return value |
||
1581 | Remarks: |
||
1582 | * Coordinates of the image are coordinates of the upper left corner |
||
1583 | of the image relative to the screen. |
||
1584 | * Size of the image in bytes is 4*xsize*ysize |
||
1585 | * TT - byte pointer of transparency, at current version: |
||
1586 | 1 to FF - opaque, 0 - transparent. |
||
1587 | * The function places the image directly to LFB. It is not for |
||
1588 | background image f.15. Options f.15 to f.25 does not make sense. |
||
588 | diamond | 1589 | |
1590 | ====================================================================== |
||
118 | diamond | 1591 | ======== Function 26, subfunction 1 - get MPU MIDI base port. ======== |
114 | mikedld | 1592 | ====================================================================== |
1593 | Parameters: |
||
118 | diamond | 1594 | * eax = 26 - function number |
1595 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1596 | Returned value: |
118 | diamond | 1597 | * eax = port number |
1598 | Parameters: |
||
1599 | * To set base port use subfunction 1 of function 21. |
||
114 | mikedld | 1600 | |
1601 | ====================================================================== |
||
1602 | ========== Function 26, subfunction 2 - get keyboard layout. ========= |
||
1603 | ====================================================================== |
||
118 | diamond | 1604 | The keyboard layout is used to convert keyboard scancodes to |
1605 | ASCII-codes for function 2. |
||
114 | mikedld | 1606 | Parameters: |
118 | diamond | 1607 | * eax = 26 - function number |
1608 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1609 | * ecx = what layout to get: |
1610 | * 1 = normal layout |
||
118 | diamond | 1611 | * 2 = layout with pressed Shift |
1612 | * 3 = layout with pressed Alt |
||
1613 | * edx = pointer to the 128-bytes buffer, where the layout will be |
||
1614 | copied |
||
114 | mikedld | 1615 | Returned value: |
1616 | * function does not return value |
||
118 | diamond | 1617 | Or: |
1618 | * eax = 26 - function number |
||
1619 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1620 | * ecx = 9 |
1621 | Returned value: |
||
118 | diamond | 1622 | * eax = country identifier (1=eng, 2=fi, 3=ger, 4=rus) |
114 | mikedld | 1623 | Remarks: |
118 | diamond | 1624 | * If Alt is pressed, the layout with Alt is used; |
1625 | if Alt is not pressed, but Shift is pressed, |
||
1626 | the layout with Shift is used; |
||
1627 | if Alt and Shift are not pressed, but Ctrl is pressed, the normal |
||
1628 | layout is used and then from the code is subtracted 0x60; |
||
1629 | if no control key is pressed, the normal layout is used. |
||
2409 | Serge | 1630 | * To set layout and country identifier use |
118 | diamond | 1631 | subfunction 2 of function 21. |
1632 | * Country identifier is global system variable, which is not used |
||
1633 | by the kernel itself; however the application '@panel' displays |
||
1634 | the corresponding icon (using this function). |
||
1635 | * The application @panel switches layouts on user request. |
||
114 | mikedld | 1636 | |
1637 | ====================================================================== |
||
118 | diamond | 1638 | ============== Function 26, subfunction 3 - get CD base. ============= |
114 | mikedld | 1639 | ====================================================================== |
1640 | Parameters: |
||
118 | diamond | 1641 | * eax = 26 - function number |
1642 | * ebx = 3 - subfunction number |
||
114 | mikedld | 1643 | Returned value: |
118 | diamond | 1644 | * eax = CD base: 1=IDE0, 2=IDE1, 3=IDE2, 4=IDE3 |
114 | mikedld | 1645 | Remarks: |
118 | diamond | 1646 | * CD base is used by function 24. |
1647 | * To set CD base use subfunction 3 of function 21. |
||
114 | mikedld | 1648 | |
1649 | ====================================================================== |
||
118 | diamond | 1650 | ========== Function 26, subfunction 5 - get system language. ========= |
114 | mikedld | 1651 | ====================================================================== |
1652 | Parameters: |
||
118 | diamond | 1653 | * eax = 26 - function number |
1654 | * ebx = 5 - subfunction number |
||
114 | mikedld | 1655 | Returned value: |
118 | diamond | 1656 | * eax = system language (1=eng, 2=fi, 3=ger, 4=rus) |
114 | mikedld | 1657 | Remarks: |
118 | diamond | 1658 | * System language is global system variable and is not used |
1659 | by the kernel itself, however application @panel draws the |
||
1660 | appropriate icon (using this function). |
||
1661 | * To set system language use subfunction 5 of function 21. |
||
114 | mikedld | 1662 | |
1663 | ====================================================================== |
||
118 | diamond | 1664 | ============== Function 26, subfunction 7 - get HD base. ============= |
114 | mikedld | 1665 | ====================================================================== |
118 | diamond | 1666 | The HD base defines hard disk to write with usage of obsolete |
346 | diamond | 1667 | syntax /HD in obsolete function 58; at usage of modern syntax |
1668 | /HD0,/HD1,/HD2,/HD3 base is set automatically. |
||
114 | mikedld | 1669 | Parameters: |
118 | diamond | 1670 | * eax = 26 - function number |
1671 | * ebx = 7 - subfunction number |
||
114 | mikedld | 1672 | Returned value: |
118 | diamond | 1673 | * eax = HD base: 1=IDE0, 2=IDE1, 3=IDE2, 4=IDE3 |
114 | mikedld | 1674 | Remarks: |
118 | diamond | 1675 | * Any application in any time can change HD base. |
1676 | * To set base use subfunction 7 of function 21. |
||
1677 | * To get used partition of hard disk use subfunction 8. |
||
114 | mikedld | 1678 | |
1679 | ====================================================================== |
||
118 | diamond | 1680 | ========= Function 26, subfunction 8 - get used HD partition. ======== |
114 | mikedld | 1681 | ====================================================================== |
118 | diamond | 1682 | The HD partition defines partition of the hard disk to write with |
346 | diamond | 1683 | usage of obsolete syntax /HD in obsolete function 58; |
118 | diamond | 1684 | at usage of functions 58 and 70 and modern syntax /HD0,/HD1,/HD2,/HD3 |
346 | diamond | 1685 | base and partition are set automatically. |
114 | mikedld | 1686 | Parameters: |
118 | diamond | 1687 | * eax = 26 - function number |
1688 | * ebx = 8 - subfunction number |
||
114 | mikedld | 1689 | Returned value: |
118 | diamond | 1690 | * eax = HD partition (beginning from 1) |
114 | mikedld | 1691 | Remarks: |
118 | diamond | 1692 | * Any application in any time can change partition. |
1693 | * To set partition use subfunction 8 of function 21. |
||
1694 | * To get number of partitions on a hard disk use |
||
1695 | subfunction 11 of function 18. |
||
1696 | * To get base of used hard disk, use subfunction 7. |
||
114 | mikedld | 1697 | |
1698 | ====================================================================== |
||
118 | diamond | 1699 | === Function 26, subfunction 9 - get the value of the time counter. == |
114 | mikedld | 1700 | ====================================================================== |
1701 | Parameters: |
||
118 | diamond | 1702 | * eax = 26 - function number |
1703 | * ebx = 9 - subfunction number |
||
114 | mikedld | 1704 | Returned value: |
118 | diamond | 1705 | * eax = number of 1/100s of second, past from the system boot time |
114 | mikedld | 1706 | Remarks: |
118 | diamond | 1707 | * Counter takes modulo 2^32, that correspond to a little more |
1708 | than 497 days. |
||
1709 | * To get system time use function 3. |
||
114 | mikedld | 1710 | |
1711 | ====================================================================== |
||
118 | diamond | 1712 | ===================== Function 26, subfunction 11 ==================== |
1713 | ========== Find out whether low-level HD access is enabled. ========== |
||
114 | mikedld | 1714 | ====================================================================== |
1715 | Parameters: |
||
118 | diamond | 1716 | * eax = 26 - function number |
1717 | * ebx = 11 - subfunction number |
||
114 | mikedld | 1718 | Returned value: |
118 | diamond | 1719 | * eax = 0/1 - disabled/enabled |
114 | mikedld | 1720 | Remarks: |
118 | diamond | 1721 | * Is used in LBA read (subfunction 8 of function 58). |
1722 | * To set current state use subfunction 11 of function 21. |
||
114 | mikedld | 1723 | |
1724 | ====================================================================== |
||
118 | diamond | 1725 | ===================== Function 26, subfunction 12 ==================== |
1726 | ========== Find out whether low-level PCI access is enabled. ========= |
||
114 | mikedld | 1727 | ====================================================================== |
1728 | Parameters: |
||
118 | diamond | 1729 | * eax = 26 - function number |
1730 | * ebx = 12 - subfunction number |
||
114 | mikedld | 1731 | Returned value: |
118 | diamond | 1732 | * eax = 0/1 - disabled/enabled |
114 | mikedld | 1733 | Remarks: |
118 | diamond | 1734 | * Is used by operations with PCI bus (function 62). |
1735 | * The current implementation uses only low bit of ecx. |
||
1736 | * To set the current state use subfunction 12 of function 21. |
||
114 | mikedld | 1737 | |
1738 | ====================================================================== |
||
118 | diamond | 1739 | =================== Function 29 - get system date. =================== |
114 | mikedld | 1740 | ====================================================================== |
1741 | Parameters: |
||
118 | diamond | 1742 | * eax = 29 - function number |
114 | mikedld | 1743 | Returned value: |
1744 | * eax = 0x00DDMMYY, where |
||
118 | diamond | 1745 | (binary-decimal coding, BCD, is used) |
1746 | * YY = two low digits of year (00..99) |
||
1747 | * MM = month (01..12) |
||
1748 | * DD = day (01..31) |
||
114 | mikedld | 1749 | Remarks: |
118 | diamond | 1750 | * To set system date use function 22. |
114 | mikedld | 1751 | |
1752 | ====================================================================== |
||
521 | diamond | 1753 | ============= Function 30 - work with the current folder. ============ |
1754 | ====================================================================== |
||
1755 | |||
1756 | --------- Subfunction 1 - set current folder for the thread. --------- |
||
1757 | Parameters: |
||
1758 | * eax = 30 - function number |
||
1759 | * ebx = 1 - subfunction number |
||
1760 | * ecx = pointer to ASCIIZ-string with the path to new current folder |
||
1761 | Returned value: |
||
1762 | * function does not return value |
||
1763 | |||
1764 | --------- Subfunction 2 - get current folder for the thread. --------- |
||
1765 | Parameters: |
||
1766 | * eax = 30 - function number |
||
1767 | * ebx = 2 - subfunction number |
||
1768 | * ecx = pointer to buffer |
||
1769 | * edx = size of buffer |
||
1770 | Returned value: |
||
1771 | * eax = size of the current folder's name (including terminating 0) |
||
1772 | Remarks: |
||
1773 | * If the buffer is too small to hold all data, only first (edx-1) |
||
1774 | bytes are copied and than terminating 0 is inserted. |
||
1662 | Nasarus | 1775 | * By default, current folder for the thread is "/rd/1". |
2409 | Serge | 1776 | * At process/thread creation the current folder will be inherited |
1662 | Nasarus | 1777 | from the parent. |
521 | diamond | 1778 | |
3663 | mario79 | 1779 | --- Subfunction 3 - install the add.system directory for the kernel -- |
1780 | Parameters: |
||
1781 | * eax = 30 - function number |
||
1782 | * ebx = 3 - subfunction number |
||
1783 | * ecx = pointer to a block of data: |
||
1784 | sysdir_name rb 64 |
||
1785 | sysdir_path rb 64 |
||
1786 | For example: |
||
1787 | dir_name1 db 'addappl',0 |
||
1788 | rb 64-8 |
||
1789 | dir_path1 db 'HD0/1',0 |
||
1790 | rb 64-6 |
||
1791 | Returned value: |
||
1792 | * function does not return value |
||
1793 | Remarks: |
||
1794 | * The function can be called only 1 time for 1 session of the OS. |
||
1795 | |||
521 | diamond | 1796 | ====================================================================== |
2511 | mario79 | 1797 | ========= Function 34 - who owner the pixel on the screen. =========== |
1798 | ====================================================================== |
||
1799 | Parameters: |
||
1800 | * eax = 34 - function number |
||
1801 | * ebx = x-coordinate (relative to the display) |
||
1802 | * ecx = y-coordinate (relative to the display) |
||
1803 | |||
1804 | Returned value: |
||
1805 | * eax = 0x000000XX - owner of pixel the slot window N |
||
1806 | If incorrect values ebx and ecx then function returns 0 |
||
1807 | * The function takes the value from the area [_WinMapAddress] |
||
1808 | |||
1809 | ====================================================================== |
||
118 | diamond | 1810 | ======= Function 35 - read the color of a pixel on the screen. ======= |
114 | mikedld | 1811 | ====================================================================== |
1812 | Parameters: |
||
1813 | * eax = 35 |
||
1814 | * ebx = y*xsize+x, where |
||
118 | diamond | 1815 | * (x,y) = coordinates of a pixel (beginning from 0) |
1816 | * xsize = horizontal screen size |
||
114 | mikedld | 1817 | Returned value: |
118 | diamond | 1818 | * eax = color 0x00RRGGBB |
114 | mikedld | 1819 | Remarks: |
118 | diamond | 1820 | * To get screen sizes use function 14. Pay attention, |
1821 | that it subtracts 1 from both sizes. |
||
1822 | * There is also direct access (without any system calls) |
||
1823 | to videomemory through the selector gs. To get parameters of |
||
1824 | the current videomode, use function 61. |
||
114 | mikedld | 1825 | |
1826 | ====================================================================== |
||
1018 | diamond | 1827 | =================== Function 36 - read screen area. ================== |
921 | mario79 | 1828 | ====================================================================== |
1829 | Paramters: |
||
1830 | * eax = 36 - function number |
||
1018 | diamond | 1831 | * ebx = pointer to the previously allocated memory area, |
1832 | where will be placed the image in the format BBGGRRBBGGRR... |
||
921 | mario79 | 1833 | * ecx = [size on axis x]*65536 + [size on axis y] |
1834 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
1835 | Returned value: |
||
1836 | * function does not return value |
||
1837 | Remarks: |
||
1838 | * Coordinates of the image are coordinates of the upper left corner |
||
923 | mario79 | 1839 | of the image relative to the screen. |
921 | mario79 | 1840 | * Size of the image in bytes is 3*xsize*ysize. |
1841 | |||
1842 | ====================================================================== |
||
277 | diamond | 1843 | =================== Function 37 - work with mouse. =================== |
114 | mikedld | 1844 | ====================================================================== |
1845 | |||
118 | diamond | 1846 | ---------- Subfunction 0 - screen coordinates of the mouse ----------- |
114 | mikedld | 1847 | Parameters: |
118 | diamond | 1848 | * eax = 37 - function number |
1849 | * ebx = 0 - subfunction number |
||
114 | mikedld | 1850 | Returned value: |
118 | diamond | 1851 | * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer |
1852 | (beginning from 0) |
||
114 | mikedld | 1853 | |
118 | diamond | 1854 | -- Subfunction 1 - coordinates of the mouse relative to the window --- |
114 | mikedld | 1855 | Parameters: |
118 | diamond | 1856 | * eax = 37 - function number |
1857 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1858 | Returned value: |
118 | diamond | 1859 | * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer |
1860 | relative to the application window (beginning from 0) |
||
114 | mikedld | 1861 | Remarks: |
118 | diamond | 1862 | * The value is calculated by formula (x-xwnd)*65536 + (y-ywnd). |
1863 | If y>=ywnd, the low word is non-negative and contains |
||
1864 | relative y-coordinate, and the high word - relative x-coordinate |
||
1865 | (with correct sign). Otherwise the low word is negative and still |
||
1866 | contains relative y-coordinate, and to the high word |
||
1867 | 1 should be added. |
||
114 | mikedld | 1868 | |
118 | diamond | 1869 | ------------ Subfunction 2 - pressed buttons of the mouse ------------ |
114 | mikedld | 1870 | Parameters: |
118 | diamond | 1871 | * eax = 37 - function number |
1872 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1873 | Returned value: |
118 | diamond | 1874 | * eax contains information on the pressed mouse buttons: |
1875 | * bit 0 is set = left button is pressed |
||
1876 | * bit 1 is set = right button is pressed |
||
486 | kastigar | 1877 | * bit 2 is set = middle button is pressed |
1878 | * bit 3 is set = 4th button is pressed |
||
1879 | * bit 4 is set = 5th button is pressed |
||
118 | diamond | 1880 | * other bits are cleared |
114 | mikedld | 1881 | |
277 | diamond | 1882 | -------------------- Subfunction 4 - load cursor --------------------- |
1883 | Parameters: |
||
1884 | * eax = 37 - function number |
||
1885 | * ebx = 4 - subfunction number |
||
1886 | * dx = data source: |
||
1887 | * dx = LOAD_FROM_FILE = 0 - data in a file |
||
1888 | * ecx = pointer to full path to the cursor file |
||
1889 | * the file must be in the format .cur, which is standard for |
||
1890 | MS Windows, at that of the size 32*32 pixels |
||
1891 | * dx = LOAD_FROM_MEM = 1 - data of file are already loaded in memory |
||
1892 | * ecx = pointer to data of the cursor file |
||
1893 | * the data format is the same as in the previous case |
||
1894 | * dx = LOAD_INDIRECT = 2 - data in memory |
||
1895 | * ecx = pointer to cursor image in the format ARGB 32*32 pixels |
||
1896 | * edx = 0xXXYY0002, where |
||
1897 | * XX = x-coordinate of cursor hotspot |
||
1898 | * YY = y-coordinate |
||
1899 | * 0 <= XX, YY <= 31 |
||
1900 | Returned value: |
||
1901 | * eax = 0 - failed |
||
1902 | * otherwise eax = cursor handle |
||
1903 | |||
1904 | --------------------- Subfunction 5 - set cursor --------------------- |
||
1905 | Sets new cursor for the window of the current thread. |
||
1906 | Parameters: |
||
1907 | * eax = 37 - function number |
||
1908 | * ebx = 5 - subfunction number |
||
1909 | * ecx = cursor handle |
||
1910 | Returned value: |
||
1911 | * eax = handle of previous cursor |
||
1912 | Remarks: |
||
1913 | * If the handle is incorrect, the function restores the default |
||
1914 | cursor (standard arrow). In particular, ecx=0 restores it. |
||
1915 | |||
1916 | ------------------- Subfunction 6 - delete cursor -------------------- |
||
1917 | Parameters: |
||
1918 | * eax = 37 - function number |
||
1919 | * ebx = 6 - subfunction number |
||
1920 | * ecx = cursor handle |
||
1921 | Returned value: |
||
1922 | * eax destroyed |
||
1923 | Remarks: |
||
1924 | * The cursor must be loaded previously by the current thread |
||
1925 | (with the call to subfunction 4). The function does not delete |
||
1926 | system cursors and cursors, loaded by another applications. |
||
1927 | * If the active cursor (set by subfunction 5) is deleted, |
||
1928 | the system restores the default cursor (standard arrow). |
||
1929 | |||
499 | diamond | 1930 | ------------------ Subfunction 7 - get scroll data ------------------- |
486 | kastigar | 1931 | Parameters: |
1932 | * eax = 37 - function number |
||
1933 | * ebx = 7 - subfunction number |
||
1934 | Returned value: |
||
499 | diamond | 1935 | * eax = [horizontal offset]*65536 + [vertical offset] |
486 | kastigar | 1936 | Remarks: |
499 | diamond | 1937 | * Scroll data is available for active window only. |
1938 | * Values are zeroed after reading. |
||
1939 | * Values are signed. |
||
486 | kastigar | 1940 | |
114 | mikedld | 1941 | ====================================================================== |
1942 | ====================== Function 38 - draw line. ====================== |
||
1943 | ====================================================================== |
||
1944 | Parameters: |
||
118 | diamond | 1945 | * eax = 38 - function number |
1946 | * ebx = [start coordinate on axis x]*65536 + |
||
1947 | [end coordinate on axis x] |
||
1948 | * ecx = [start coordinate on axis y]*65536 + |
||
1949 | [end coordinate on axis y] |
||
1950 | * edx = 0x00RRGGBB - color |
||
133 | diamond | 1951 | edx = 0x01xxxxxx - draw inversed line |
1952 | (low 24 bits are ignored) |
||
114 | mikedld | 1953 | Returned value: |
1954 | * function does not return value |
||
1955 | Remarks: |
||
118 | diamond | 1956 | * Coordinates are relative to the window. |
1957 | * End point is also drawn. |
||
114 | mikedld | 1958 | |
1959 | ====================================================================== |
||
118 | diamond | 1960 | == Function 39, subfunction 1 - get a size of the background image. == |
114 | mikedld | 1961 | ====================================================================== |
1962 | Parameters: |
||
118 | diamond | 1963 | * eax = 39 - function number |
1964 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1965 | Returned value: |
1966 | * eax = [width]*65536 + [height] |
||
1967 | Remarks: |
||
118 | diamond | 1968 | * There is a pair function to set sizes of background image - |
1969 | subfunction 1 of function 15. After which it is necessary, |
||
1970 | of course, anew to define image. |
||
114 | mikedld | 1971 | |
1972 | ====================================================================== |
||
118 | diamond | 1973 | == Function 39, subfunction 2 - get pixel from the background image. = |
114 | mikedld | 1974 | ====================================================================== |
1975 | Parameters: |
||
118 | diamond | 1976 | * eax = 39 - function number |
1977 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1978 | * ecx = offset |
1979 | Returned value: |
||
118 | diamond | 1980 | * eax = 0x00RRGGBB - pixel color, if offset is valid |
1981 | (less than 0x160000-16) |
||
1982 | * eax = 2 otherwise |
||
114 | mikedld | 1983 | Remarks: |
118 | diamond | 1984 | * Do not rely on returned value for invalid offsets, it may be |
1985 | changed in future kernel versions. |
||
1986 | * Offset for pixel with coordinates (x,y) |
||
1987 | is calculated as (x+y*xsize)*3. |
||
2409 | Serge | 1988 | * There is a pair function to set pixel on the background image - |
118 | diamond | 1989 | subfunction 2 of function 15. |
114 | mikedld | 1990 | |
1991 | ====================================================================== |
||
118 | diamond | 1992 | == Function 39, subfunction 4 - get drawing mode for the background. = |
114 | mikedld | 1993 | ====================================================================== |
1994 | Parameters: |
||
118 | diamond | 1995 | * eax = 39 - function number |
1996 | * ebx = 4 - subfunction number |
||
114 | mikedld | 1997 | Returned value: |
118 | diamond | 1998 | * eax = 1 - tile |
1999 | * eax = 2 - stretch |
||
114 | mikedld | 2000 | Remarks: |
2409 | Serge | 2001 | * There is a pair function to set drawing mode - |
118 | diamond | 2002 | subfunction 4 of function 15. |
114 | mikedld | 2003 | |
2004 | ====================================================================== |
||
118 | diamond | 2005 | =========== Function 40 - set the mask for expected events. ========== |
114 | mikedld | 2006 | ====================================================================== |
118 | diamond | 2007 | The mask for expected events affects function working with events |
2008 | 10, 11, 23 - they notify only about events allowed by this mask. |
||
114 | mikedld | 2009 | Parameters: |
118 | diamond | 2010 | * eax = 40 - function number |
114 | mikedld | 2011 | * ebx = mask: bit i corresponds to event i+1 (see list of events) |
118 | diamond | 2012 | (set bit permits notice on event) |
2414 | Serge | 2013 | bit 31: active/inactive filter |
2014 | bit 31 = 0 - inactive window receive mouse events |
||
2015 | bit 31 = 1 - inactive window does not receive mouse events |
||
2016 | bit 30: cursor position filter |
||
2017 | bit 30 = 0 = the window receive mouse events if cursor |
||
2018 | outside window |
||
2019 | bit 30 = 1 - the window does not receive mouse events if cursor |
||
2020 | outside window |
||
114 | mikedld | 2021 | Returned value: |
1153 | clevermous | 2022 | * eax = previous value of mask |
114 | mikedld | 2023 | Remarks: |
118 | diamond | 2024 | * Default mask (7=111b) enables nofices about redraw, |
2025 | keys and buttons. This is enough for many applications. |
||
2026 | * Events prohibited in the mask are saved anyway, when come; |
||
2027 | they are simply not informed with event functions. |
||
2028 | * Event functions take into account the mask on moment of |
||
2029 | function call, not on moment of event arrival. |
||
114 | mikedld | 2030 | |
2031 | |||
2032 | ====================================================================== |
||
118 | diamond | 2033 | ================ Function 43 - input/output to a port. =============== |
114 | mikedld | 2034 | ====================================================================== |
2035 | |||
118 | diamond | 2036 | ------------------------ Output data to port ------------------------- |
114 | mikedld | 2037 | Parameters: |
118 | diamond | 2038 | * eax = 43 - function number |
114 | mikedld | 2039 | * bl = byte for output |
118 | diamond | 2040 | * ecx = port number 0xnnnn (from 0 to 0xFFFF) |
114 | mikedld | 2041 | Returned value: |
118 | diamond | 2042 | * eax = 0 - success |
2043 | * eax = 1 - the thread has not reserved the selected port |
||
114 | mikedld | 2044 | |
118 | diamond | 2045 | ------------------------ Input data from port ------------------------ |
114 | mikedld | 2046 | Parameters: |
118 | diamond | 2047 | * eax = 43 - function number |
2048 | * ebx is ignored |
||
2049 | * ecx = 0x8000nnnn, where nnnn = port number (from 0 to 0xFFFF) |
||
114 | mikedld | 2050 | Returned value: |
118 | diamond | 2051 | * eax = 0 - success, thus ebx = entered byte |
2052 | * eax = 1 - the thread has not reserved the selected port |
||
114 | mikedld | 2053 | Remarks: |
118 | diamond | 2054 | * Previously the thread must reserve the selected port |
2055 | for itself by function 46. |
||
2056 | * Instead of call to this function it is better to use |
||
2057 | processor instructions in/out - this is much |
||
2058 | faster and a bit shorter and easier. |
||
114 | mikedld | 2059 | |
2060 | |||
2061 | ====================================================================== |
||
118 | diamond | 2062 | ====== Function 46 - reserve/free a group of input/output ports. ===== |
114 | mikedld | 2063 | ====================================================================== |
118 | diamond | 2064 | To work with reserved ports an application can access directly by |
2065 | commands in/out (recommended way) and can use function 43 |
||
2066 | (not recommended way). |
||
114 | mikedld | 2067 | Parameters: |
118 | diamond | 2068 | * eax = 46 - function number |
114 | mikedld | 2069 | * ebx = 0 - reserve, 1 - free |
118 | diamond | 2070 | * ecx = start port number |
2071 | * edx = end port number (inclusive) |
||
114 | mikedld | 2072 | Returned value: |
118 | diamond | 2073 | * eax = 0 - success |
114 | mikedld | 2074 | * eax = 1 - error |
2075 | Remarks: |
||
118 | diamond | 2076 | * For ports reservation: an error occurs if and only if |
2077 | one from the following condition satisfies: |
||
2078 | * start port is more than end port; |
||
2079 | * the selected range contains incorrect port number |
||
2080 | (correct are from 0 to 0xFFFF); |
||
2081 | * limit for the total number of reserved areas is exceeded |
||
2082 | (maximum 255 are allowed); |
||
2083 | * the selected range intersects with any of earlier reserved |
||
2084 | * For ports free: an error is an attempt to free range, |
||
2085 | that was not earlier reserved by this function |
||
2086 | (with same ecx,edx). |
||
2087 | * If an error occurs (for both cases) function performs no action. |
||
277 | diamond | 2088 | * At booting the system reserves for itself ports |
2089 | 0..0x2d, 0x30..0x4d, 0x50..0xdf, 0xe5..0xff (inclusively). |
||
118 | diamond | 2090 | * When a thread terminates, all reserved by it ports |
2091 | are freed automatically. |
||
114 | mikedld | 2092 | |
2093 | ====================================================================== |
||
118 | diamond | 2094 | ============= Function 47 - draw a number in the window. ============= |
114 | mikedld | 2095 | ====================================================================== |
2096 | Parameters: |
||
118 | diamond | 2097 | * eax = 47 - function number |
2098 | * ebx = parameters of conversion number to text: |
||
114 | mikedld | 2099 | * bl = 0 - ecx contains number |
665 | diamond | 2100 | * bl = 1 - ecx contains pointer to dword/qword-number |
118 | diamond | 2101 | * bh = 0 - display in decimal number system |
2102 | * bh = 1 - display in hexadecimal system |
||
2103 | * bh = 2 - display in binary system |
||
499 | diamond | 2104 | * bits 16-21 = how many digits to display |
655 | mario79 | 2105 | * bits 22-29 reserved and must be set to 0 |
665 | diamond | 2106 | * bit 30 set = display qword (64-bit) number (must be bl=1) |
2107 | * bit 31 set = do not display leading zeroes of the number |
||
118 | diamond | 2108 | * ecx = number (if bl=0) or pointer (if bl=1) |
114 | mikedld | 2109 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
139 | diamond | 2110 | * esi = 0xX0RRGGBB: |
2111 | * RR, GG, BB specify the color |
||
2112 | * X = ABnn (bits) |
||
2113 | * nn = font (0/1) |
||
2114 | * A is ignored |
||
2115 | * B=1 - fill background with the color edi |
||
114 | mikedld | 2116 | Returned value: |
2117 | * function does not return value |
||
2118 | Remarks: |
||
118 | diamond | 2119 | * The given length must not exceed 60. |
2120 | * The exactly given amount of digits is output. If number is small |
||
2121 | and can be written by smaller amount of digits, it is supplemented |
||
2122 | by leading zeroes; if the number is big and can not be written by |
||
2123 | given amount of digits, extra digits are not drawn. |
||
2124 | * Parameters of fonts are shown in the description of function 4 |
||
2125 | (text output). |
||
114 | mikedld | 2126 | |
2127 | ====================================================================== |
||
118 | diamond | 2128 | ========= Function 48, subfunction 0 - apply screen settings. ======== |
114 | mikedld | 2129 | ====================================================================== |
2130 | Parameters: |
||
118 | diamond | 2131 | * eax = 48 - function number |
2132 | * ebx = 0 - subfunction number |
||
114 | mikedld | 2133 | * ecx = 0 - reserved |
2134 | Returned value: |
||
2135 | * function does not return value |
||
2136 | Remarks: |
||
118 | diamond | 2137 | * Function redraws the screen after parameters change by |
114 | mikedld | 2138 | subfunctions 1 and 2. |
118 | diamond | 2139 | * Function call without prior call to one of indicated subfunctions |
2140 | is ignored. |
||
2141 | * Function call with nonzero ecx is ignored. |
||
114 | mikedld | 2142 | |
2143 | ====================================================================== |
||
118 | diamond | 2144 | =========== Function 48, subfunction 1 - set button style. =========== |
114 | mikedld | 2145 | ====================================================================== |
2146 | Parameters: |
||
118 | diamond | 2147 | * eax = 48 - function number |
2148 | * ebx = 1 - subfunction number |
||
2149 | * ecx = button style: |
||
2150 | * 0 = flat |
||
2151 | * 1 = 3d |
||
114 | mikedld | 2152 | Returned value: |
2153 | * function does not return value |
||
2154 | Remarks: |
||
118 | diamond | 2155 | * After call to this function one should redraw the screen by |
2156 | subfunction 0. |
||
2157 | * Button style influences only to their draw of function 8. |
||
114 | mikedld | 2158 | |
118 | diamond | 2159 | ====================================================================== |
2160 | ====== Function 48, subfunction 2 - set standard window colors. ====== |
||
2161 | ====================================================================== |
||
114 | mikedld | 2162 | Parameters: |
118 | diamond | 2163 | * eax = 48 - function number |
2164 | * ebx = 2 - subfunction number |
||
2165 | * ecx = pointer to the color table |
||
114 | mikedld | 2166 | * edx = size of the color table |
118 | diamond | 2167 | (must be 40 bytes for future compatibility) |
2168 | Format of the color table is shown in description of subfunction 3. |
||
114 | mikedld | 2169 | Returned value: |
2170 | * function does not return value |
||
2171 | Remarks: |
||
118 | diamond | 2172 | * After call to this function one should redraw the screen by |
2173 | subfunction 0. |
||
2174 | * Table of standard colors influences only to applications, |
||
2175 | which receive this table obviously (by subfunction 3) |
||
2176 | and use it (specifying colors from it to drawing functions). |
||
2177 | * Table of standard colors is included in skin and is installed |
||
2178 | anew with skin installation (by subfunction 8). |
||
2179 | * Color table can be viewed/changed interactively with |
||
2180 | the application 'desktop'. |
||
114 | mikedld | 2181 | |
2182 | ====================================================================== |
||
118 | diamond | 2183 | ====== Function 48, subfunction 3 - get standard window colors. ====== |
114 | mikedld | 2184 | ====================================================================== |
2185 | Parameters: |
||
118 | diamond | 2186 | * eax = 48 - function number |
2187 | * ebx = 3 - subfunction number |
||
2188 | * ecx = pointer to the buffer with size edx bytes, |
||
2189 | where table will be written |
||
2190 | * edx = size of color table |
||
2191 | (must be 40 bytes for future compatibility) |
||
114 | mikedld | 2192 | Returned value: |
2193 | * function does not return value |
||
118 | diamond | 2194 | Format of the color table: |
2195 | each item is dword-value for color 0x00RRGGBB |
||
2196 | * +0: dword: frames - color of frame |
||
2197 | * +4: dword: grab - color of header |
||
2198 | * +8: dword: grab_button - color of button on header bar |
||
2199 | * +12 = +0xC: dword: grab_button_text - color of text on button |
||
2200 | on header bar |
||
2201 | * +16 = +0x10: dword: grab_text - color of text on header |
||
2202 | * +20 = +0x14: dword: work - color of working area |
||
2203 | * +24 = +0x18: dword: work_button - color of button in working area |
||
2204 | * +28 = +0x1C: dword: work_button_text - color of text on button |
||
2205 | in working area |
||
2206 | * +32 = +0x20: dword: work_text - color of text in working area |
||
2207 | * +36 = +0x24: dword: work_graph - color of graphics in working area |
||
114 | mikedld | 2208 | Remarks: |
118 | diamond | 2209 | * Structure of the color table is described in the standard |
2210 | include file 'macros.inc' as 'system_colors'; for example, |
||
2211 | it is possible to write: |
||
1662 | Nasarus | 2212 | sc system_colors ; variable declaration |
2213 | ... ; somewhere one must call |
||
2214 | ; this function with ecx=sc |
||
2215 | mov ecx, [sc.work_button_text] ; read text color on |
||
2216 | ; buttin in working area |
||
118 | diamond | 2217 | * A program itself desides to use or not to use color table. |
2218 | For usage program must simply at calls to drawing functions select |
||
2219 | color taken from the table. |
||
2220 | * At change of the table of standard colors (by subfunction 2 with |
||
2221 | the subsequent application of changes by subfunction 0 or |
||
2222 | at skin set by subfunction 8) the system sends to all windows |
||
2223 | redraw message (the event with code 1). |
||
2224 | * Color table can be viewed/changed interactively with |
||
2225 | the application 'desktop'. |
||
114 | mikedld | 2226 | |
2227 | ====================================================================== |
||
118 | diamond | 2228 | ============ Function 48, subfunction 4 - get skin height. =========== |
114 | mikedld | 2229 | ====================================================================== |
2230 | Parameters: |
||
118 | diamond | 2231 | * eax = 48 - function number |
2232 | * ebx = 4 - subfunction number |
||
114 | mikedld | 2233 | Returned value: |
118 | diamond | 2234 | * eax = skin height |
114 | mikedld | 2235 | Remarks: |
118 | diamond | 2236 | * Skin height is defined as the height of a header |
2237 | of skinned windows. |
||
2238 | * See also general structure of window in the description |
||
2239 | of function 0. |
||
114 | mikedld | 2240 | |
2241 | ====================================================================== |
||
118 | diamond | 2242 | ======== Function 48, subfunction 5 - get screen working area. ======= |
114 | mikedld | 2243 | ====================================================================== |
2244 | Parameters: |
||
118 | diamond | 2245 | * eax = 48 - function number |
2246 | * ebx = 5 - subfunction number |
||
114 | mikedld | 2247 | Returned value: |
2248 | * eax = [left]*65536 + [right] |
||
2249 | * ebx = [top]*65536 + [bottom] |
||
2250 | Remarks: |
||
118 | diamond | 2251 | * The screen working area defines position and coordinates of |
2252 | a maximized window. |
||
2253 | * The screen working area in view of normal work is all screen |
||
2254 | without system panel (the application '@panel'). |
||
2255 | * (left,top) are coordinates of the left upper corner, |
||
2256 | (right,bottom) are coordinates of the right lower one. |
||
2257 | Thus the size of working area on x axis can be calculated by |
||
2258 | formula right-left+1, on y axis - by formula bottom-right+1. |
||
2259 | * See also function 14, |
||
2260 | to get sizes of all screen. |
||
2261 | * There is a pair function to set working area - subfunction 6. |
||
114 | mikedld | 2262 | |
2263 | ====================================================================== |
||
118 | diamond | 2264 | ======== Function 48, subfunction 6 - set screen working area. ======= |
114 | mikedld | 2265 | ====================================================================== |
2266 | Parameters: |
||
118 | diamond | 2267 | * eax = 48 - function number |
2268 | * ebx = 6 - subfunction number |
||
114 | mikedld | 2269 | * ecx = [left]*65536 + [right] |
2270 | * edx = [top]*65536 + [bottom] |
||
2271 | Returned value: |
||
2272 | * function does not return value |
||
2273 | Remarks: |
||
118 | diamond | 2274 | * The screen working area defines position and coordinates of |
2275 | a maximized window. |
||
2276 | * This function is used only by the application '@panel', |
||
2277 | which set working area to all screen without system panel. |
||
2278 | * (left,top) are coordinates of the left upper corner, |
||
2279 | (right,bottom) are coordinates of the right lower one. |
||
2280 | Thus the size of working area on x axis can be calculated by |
||
2281 | formula right-left+1, on y axis - by formula bottom-right+1. |
||
2282 | * If 'left'>='right', x-coordinate of working area is not changed. |
||
2283 | If 'left'<0, 'left' will not be set. If 'right' is greater than or |
||
2284 | equal to screen width, 'right' will not be set. |
||
2285 | Similarly on y axis. |
||
2286 | * See also function 14, |
||
2287 | to get sizes of all screen. |
||
2288 | * There is a pair function to get working area - subfunction 5. |
||
2289 | * This function redraws the screen automatically, |
||
2290 | updating coordinates and sizes of maximized windows. |
||
2291 | The system sends to all windows redraw message (the event 1). |
||
114 | mikedld | 2292 | |
2293 | ====================================================================== |
||
118 | diamond | 2294 | =========== Function 48, subfunction 7 - get skin margins. =========== |
114 | mikedld | 2295 | ====================================================================== |
118 | diamond | 2296 | Returns the area of a header of a skinned window, intended for |
2297 | a text of a header. |
||
114 | mikedld | 2298 | Parameters: |
118 | diamond | 2299 | * eax = 48 - function number |
2300 | * ebx = 7 - subfunction number |
||
114 | mikedld | 2301 | Returned value: |
2302 | * eax = [left]*65536 + [right] |
||
2303 | * ebx = [top]*65536 + [bottom] |
||
2304 | Remarks: |
||
118 | diamond | 2305 | * An application decides itself to use or not to use this function. |
2306 | * It is recommended to take into account returned value |
||
2307 | of this function for choice of a place for drawing header text |
||
2308 | (by function 4) or a substitute of header text |
||
2309 | (at the discretion of an application). |
||
114 | mikedld | 2310 | |
2311 | ====================================================================== |
||
118 | diamond | 2312 | ============= Function 48, subfunction 8 - set used skin. ============ |
114 | mikedld | 2313 | ====================================================================== |
2314 | Parameters: |
||
118 | diamond | 2315 | * eax = 48 - function number |
2316 | * ebx = 8 - subfunction number |
||
2317 | * ecx = pointer to a block for function 58, in |
||
2318 | which the fields of intermediate buffer and file name are filled |
||
114 | mikedld | 2319 | Returned value: |
118 | diamond | 2320 | * eax = 0 - success |
2321 | * otherwise eax = file system error code; if file does not |
||
2322 | contain valid skin, function returns error 3 |
||
2323 | (unknown file system). |
||
114 | mikedld | 2324 | Remarks: |
118 | diamond | 2325 | * After successful skin loading the system sends to all windows |
2326 | redraw message (the event 1). |
||
2327 | * At booting the system reads skin from file 'default.skn' |
||
2328 | on ramdisk. |
||
2329 | * User can change the skin statically by creating hisself |
||
2330 | 'default.skn' or dynamically with the application 'desktop'. |
||
114 | mikedld | 2331 | |
2332 | ====================================================================== |
||
118 | diamond | 2333 | =========== Function 49 - Advanced Power Management (APM). =========== |
114 | mikedld | 2334 | ====================================================================== |
2335 | Parameters: |
||
118 | diamond | 2336 | * eax = 49 - function number |
2337 | * dx = number of the APM function |
||
2338 | (analogue of ax in APM specification) |
||
2339 | * bx, cx = parameters of the APM function |
||
114 | mikedld | 2340 | Returned value: |
118 | diamond | 2341 | * 16-bit registers ax, bx, cx, dx, si, di and carry flag CF |
2342 | are set according to the APM specification |
||
2343 | * high halves of 32-bit registers eax, ebx, ecx, |
||
2344 | edx, esi, edi are destroyed |
||
114 | mikedld | 2345 | Remarks: |
118 | diamond | 2346 | * APM 1.2 specification is described in the document |
2347 | "Advanced Power Management (APM) BIOS Specification" |
||
2348 | (Revision 1.2), available at |
||
114 | mikedld | 2349 | http://www.microsoft.com/whdc/archive/amp_12.mspx; |
118 | diamond | 2350 | besides it is included in famous Interrupt List by Ralf Brown |
114 | mikedld | 2351 | (http://www.pobox.com/~ralf/files.html, |
2352 | ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/). |
||
2353 | |||
2354 | ====================================================================== |
||
118 | diamond | 2355 | =================== Function 50 - set window shape. ================== |
114 | mikedld | 2356 | ====================================================================== |
118 | diamond | 2357 | Normal windows have rectangular shape. This function can give to |
2358 | a window any shape. The shape is given by a set of points inside |
||
2359 | the base rectangle belonging to a window. Position and coordinates |
||
2360 | of the base rectangle are set by function 0 |
||
2361 | and changed by function 67. |
||
114 | mikedld | 2362 | |
118 | diamond | 2363 | --------------------------- Set shape data --------------------------- |
114 | mikedld | 2364 | Parameters: |
118 | diamond | 2365 | * eax = 50 - function number |
2366 | * ebx = 0 - subfunction number |
||
2367 | * ecx = pointer to shape data (array of bytes 0/1) |
||
114 | mikedld | 2368 | Returned value: |
2369 | * function does not return value |
||
2370 | |||
118 | diamond | 2371 | -------------------------- Set shape scale --------------------------- |
114 | mikedld | 2372 | Parameters: |
118 | diamond | 2373 | * eax = 50 - function number |
2374 | * ebx = 1 - subfunction number |
||
2375 | * ecx sets a scale: each byte of data defines |
||
2376 | (2^scale)*(2^scale) pixels |
||
114 | mikedld | 2377 | Returned value: |
2378 | * function does not return value |
||
2379 | Remarks: |
||
118 | diamond | 2380 | * Default scale is 0 (scale factor is 1). If in the shape data |
2381 | one byte corresponds to one pixel, there is no necessity |
||
2382 | to set scale. |
||
2383 | * Let's designate xsize = window width (in pixels), ysize = height; |
||
2384 | pay attention, that they are one pixel more than defined by |
||
114 | mikedld | 2385 | functions 0, 67. |
118 | diamond | 2386 | * On definition of scale xsize and ysize must be divisible |
2387 | on 2^scale. |
||
2388 | * Byte of data on offset 'a' must be 0/1 and defines belonging |
||
2389 | to a window of square with the side 2^scale (if scale=0, |
||
2390 | this is one pixel) and coordinates of the left upper corner |
||
114 | mikedld | 2391 | (a mod (xsize shr scale), a div (xsize shr scale)) |
118 | diamond | 2392 | * Data size: (xsize shr scale)*(ysize shr scale). |
2393 | * Data must be presented in the memory and not change |
||
2394 | after set of shape. |
||
2395 | * The system views the shape data at every window redraw by |
||
2396 | function 0. |
||
2397 | * The call of subfunction 0 with NULL pointer results in return |
||
2398 | to the rectangular shape. |
||
114 | mikedld | 2399 | |
2400 | ====================================================================== |
||
2401 | ==================== Function 51 - create thread. ==================== |
||
2402 | ====================================================================== |
||
2403 | Parameters: |
||
118 | diamond | 2404 | * eax = 51 - function number |
2405 | * ebx = 1 - unique subfunction |
||
2406 | * ecx = address of thread entry point (starting eip) |
||
2407 | * edx = pointer to thread stack (starting esp) |
||
114 | mikedld | 2408 | Returned value: |
118 | diamond | 2409 | * eax = -1 - error (there is too many threads) |
2410 | * otherwise eax = TID - thread identifier |
||
2409 | Serge | 2411 | |
114 | mikedld | 2412 | |
2413 | ====================================================================== |
||
3571 | hidnplayr | 2414 | =========================== Function 52 ============================== |
2415 | ====================================================================== |
||
2416 | |||
2417 | WARNING: This function is obsolete and is only present in the |
||
2418 | documentation as a guide to understand/port the older network |
||
2419 | applications. For new programs, use function 74 |
||
2420 | |||
2421 | ====================================================================== |
||
118 | diamond | 2422 | === Function 52, subfunction 0 - get network driver configuration. === |
114 | mikedld | 2423 | ====================================================================== |
3571 | hidnplayr | 2424 | |
114 | mikedld | 2425 | Parameters: |
118 | diamond | 2426 | * eax = 52 - function number |
2427 | * ebx = 0 - subfunction number |
||
114 | mikedld | 2428 | Returned value: |
118 | diamond | 2429 | * eax = configuration dword |
114 | mikedld | 2430 | Remarks: |
118 | diamond | 2431 | * Configuration dword can be set by subfunction 2. |
2432 | * The kernel does not use this variable. The value of this |
||
2433 | variable and working with it subfunctions 0 and 2 is represented |
||
2434 | doubtful. |
||
114 | mikedld | 2435 | |
2436 | ====================================================================== |
||
118 | diamond | 2437 | ========= Function 52, subfunction 1 - get local IP-address. ========= |
114 | mikedld | 2438 | ====================================================================== |
2439 | Parameters: |
||
118 | diamond | 2440 | * eax = 52 - function number |
2441 | * ebx = 1 - subfunction number |
||
114 | mikedld | 2442 | Returned value: |
2443 | * eax = IP-address (4 bytes) |
||
2444 | Remarks: |
||
118 | diamond | 2445 | * Local IP-address is set by subfunction 3. |
114 | mikedld | 2446 | |
2447 | ====================================================================== |
||
118 | diamond | 2448 | === Function 52, subfunction 2 - set network driver configuration. === |
114 | mikedld | 2449 | ====================================================================== |
2450 | Parameters: |
||
118 | diamond | 2451 | * eax = 52 - function number |
2452 | * ebx = 2 - subfunction number |
||
2453 | * ecx = configuration dword; if low 7 bits derivate the number 3, |
||
2454 | function [re-]initializes Ethernet-card, otherwise |
||
2455 | Ethernet turns off |
||
114 | mikedld | 2456 | Returned value: |
118 | diamond | 2457 | * if Ethernet-interface is not requested, function returns eax=2, |
2458 | but this can be changed in future kernel versions |
||
2459 | * if Ethernet-interface is requested, eax=0 means error |
||
2460 | (absence of Ethernet-card), and nonzero value - success |
||
114 | mikedld | 2461 | Remarks: |
118 | diamond | 2462 | * Configuration dword can be read by subfunction 0. |
2463 | * The kernel does not use this variable. The value of this |
||
2464 | variable, subfunction 0 and part of subfunction 2, which set it, |
||
114 | mikedld | 2465 | is represented doubtful. |
2466 | |||
2467 | ====================================================================== |
||
2468 | ========= Function 52, subfunction 3 - set local IP-address. ========= |
||
2469 | ====================================================================== |
||
2470 | Parameters: |
||
118 | diamond | 2471 | * eax = 52 - function number |
2472 | * ebx = 3 - subfunction number |
||
114 | mikedld | 2473 | * ecx = IP-address (4 bytes) |
2474 | Returned value: |
||
118 | diamond | 2475 | * the current implementation returns eax=3, but this can be changed |
2476 | in future versions |
||
114 | mikedld | 2477 | Remarks: |
118 | diamond | 2478 | * Local IP-address can be get by subfunction 1. |
114 | mikedld | 2479 | |
2480 | ====================================================================== |
||
118 | diamond | 2481 | = Function 52, subfunction 6 - add data to the stack of input queue. = |
114 | mikedld | 2482 | ====================================================================== |
2483 | Parameters: |
||
118 | diamond | 2484 | * eax = 52 - function number |
2485 | * ebx = 6 - subfunction number |
||
2486 | * edx = data size |
||
2487 | * esi = data pointer |
||
114 | mikedld | 2488 | Returned value: |
2489 | * eax = -1 - error |
||
118 | diamond | 2490 | * eax = 0 - success |
114 | mikedld | 2491 | Remarks: |
118 | diamond | 2492 | * This function is intended only for slow network drivers |
2493 | (PPP, SLIP). |
||
2494 | * Data size must not exceed 1500 bytes, though function |
||
2495 | performs no checks on correctness. |
||
114 | mikedld | 2496 | |
2497 | ====================================================================== |
||
2409 | Serge | 2498 | Function 52, subfunction 8 - read data from the network output queue. |
114 | mikedld | 2499 | ====================================================================== |
2500 | Parameters: |
||
118 | diamond | 2501 | * eax = 52 - function number |
2502 | * ebx = 8 - subfunction number |
||
2503 | * esi = pointer to 1500-byte buffer |
||
114 | mikedld | 2504 | Returned value: |
118 | diamond | 2505 | * eax = number of read bytes (in the current implementation |
2506 | either 0 = no data or 1500) |
||
2507 | * data was copied in buffer |
||
114 | mikedld | 2508 | Remarks: |
118 | diamond | 2509 | * This function is intended only for slow network drivers |
2510 | (PPP, SLIP). |
||
114 | mikedld | 2511 | |
2512 | ====================================================================== |
||
118 | diamond | 2513 | ============ Function 52, subfunction 9 - get gateway IP. ============ |
114 | mikedld | 2514 | ====================================================================== |
2515 | Parameters: |
||
118 | diamond | 2516 | * eax = 52 - function number |
2517 | * ebx = 9 - subfunction number |
||
114 | mikedld | 2518 | Returned value: |
2519 | * eax = gateway IP (4 bytes) |
||
2520 | |||
2521 | ====================================================================== |
||
118 | diamond | 2522 | =========== Function 52, subfunction 10 - get subnet mask. =========== |
114 | mikedld | 2523 | ====================================================================== |
2524 | Parameters: |
||
118 | diamond | 2525 | * eax = 52 - function number |
2526 | * ebx = 10 - subfunction number |
||
114 | mikedld | 2527 | Returned value: |
118 | diamond | 2528 | * eax = subnet mask |
114 | mikedld | 2529 | |
2530 | ====================================================================== |
||
118 | diamond | 2531 | ============ Function 52, subfunction 11 - set gateway IP. =========== |
114 | mikedld | 2532 | ====================================================================== |
2533 | Parameters: |
||
118 | diamond | 2534 | * eax = 52 - function number |
2535 | * ebx = 11 - subfunction number |
||
114 | mikedld | 2536 | * ecx = gateway IP (4 bytes) |
2537 | Returned value: |
||
118 | diamond | 2538 | * the current implementation returns eax=11, but this can be changed |
2539 | in future versions |
||
114 | mikedld | 2540 | |
2541 | ====================================================================== |
||
118 | diamond | 2542 | =========== Function 52, subfunction 12 - set subnet mask. =========== |
114 | mikedld | 2543 | ====================================================================== |
2544 | Parameters: |
||
118 | diamond | 2545 | * eax = 52 - function number |
2546 | * ebx = 12 - subfunction number |
||
2547 | * ecx = subnet mask |
||
114 | mikedld | 2548 | Returned value: |
118 | diamond | 2549 | * the current implementation returns eax=12, but this can be changed |
2550 | in future versions |
||
114 | mikedld | 2551 | |
2552 | ====================================================================== |
||
118 | diamond | 2553 | ============== Function 52, subfunction 13 - get DNS IP. ============= |
114 | mikedld | 2554 | ====================================================================== |
2555 | Parameters: |
||
118 | diamond | 2556 | * eax = 52 - function number |
2557 | * ebx = 13 - subfunction number |
||
114 | mikedld | 2558 | Returned value: |
2559 | * eax = DNS IP (4 bytes) |
||
2560 | |||
2561 | ====================================================================== |
||
118 | diamond | 2562 | ============== Function 52, subfunction 14 - set DNS IP. ============= |
114 | mikedld | 2563 | ====================================================================== |
2564 | Parameters: |
||
118 | diamond | 2565 | * eax = 52 - function number |
2566 | * ebx = 14 - subfunction number |
||
114 | mikedld | 2567 | * ecx = DNS IP (4 bytes) |
2568 | Returned value: |
||
118 | diamond | 2569 | * the current implementation returns eax=14, but this can be changed |
2570 | in future versions |
||
114 | mikedld | 2571 | |
2572 | ====================================================================== |
||
277 | diamond | 2573 | ======== Function 52, subfunction 15 - get local MAC address. ======== |
2574 | ====================================================================== |
||
2575 | Parameters: |
||
2576 | * eax = 52 - function number |
||
2577 | * ebx = 15 - subfunction number |
||
2578 | * ecx = 0 - read first 4 bytes, |
||
2579 | ecx = 4 - read last 2 bytes |
||
2580 | Returned value: |
||
2581 | * for ecx=0: eax = first 4 bytes of MAC address |
||
2582 | * for ecx=4: ax = last 2 bytes of MAC address, |
||
2583 | high half of eax is destroyed |
||
2584 | * for other ecx: eax = -1 indicates an error |
||
2585 | |||
2586 | ====================================================================== |
||
3571 | hidnplayr | 2587 | =========================== Function 53 ============================== |
2588 | ====================================================================== |
||
2589 | |||
2590 | WARNING: This function is obsolete and is only present in the |
||
2591 | documentation as a guide to understand/port the older network |
||
2592 | applications. For new programs, use function 75. |
||
2593 | |||
2594 | ====================================================================== |
||
118 | diamond | 2595 | ============ Function 53, subfunction 0 - open UDP-socket. =========== |
114 | mikedld | 2596 | ====================================================================== |
2597 | Parameters: |
||
118 | diamond | 2598 | * eax = 53 - function number |
2599 | * ebx = 0 - subfunction number |
||
1154 | clevermous | 2600 | * ecx = local port (only low word is taken into account), |
2601 | ecx = 0 - let the system choose a port |
||
118 | diamond | 2602 | * edx = remote port (only low word is taken into account) |
114 | mikedld | 2603 | * esi = remote IP |
2604 | Returned value: |
||
118 | diamond | 2605 | * eax = -1 = 0xFFFFFFFF - error; ebx destroyed |
2606 | * eax = socket handle (some number which unambiguously identifies |
||
2607 | socket and have sense only for the system) - success; |
||
2608 | ebx destroyed |
||
114 | mikedld | 2609 | |
2610 | ====================================================================== |
||
118 | diamond | 2611 | =========== Function 53, subfunction 1 - close UDP-socket. =========== |
114 | mikedld | 2612 | ====================================================================== |
2613 | Parameters: |
||
118 | diamond | 2614 | * eax = 53 - function number |
2615 | * ebx = 1 - subfunction number |
||
2616 | * ecx = socket handle |
||
114 | mikedld | 2617 | Returned value: |
118 | diamond | 2618 | * eax = -1 - incorrect handle |
2619 | * eax = 0 - success |
||
2620 | * ebx destroyed |
||
114 | mikedld | 2621 | Remarks: |
118 | diamond | 2622 | * The current implementation does not close automatically all |
2623 | sockets of a thread at termination. In particular, one should not |
||
2624 | kill a thread with many opened sockets - there will be an outflow |
||
2625 | of resources. |
||
114 | mikedld | 2626 | |
2627 | ====================================================================== |
||
2628 | ============== Function 53, subfunction 2 - poll socket. ============= |
||
2629 | ====================================================================== |
||
2630 | Parameters: |
||
118 | diamond | 2631 | * eax = 53 - function number |
2632 | * ebx = 2 - subfunction number |
||
2633 | * ecx = socket handle |
||
114 | mikedld | 2634 | Returned value: |
1018 | diamond | 2635 | * eax = number of read bytes, 0 for incorrect handle |
118 | diamond | 2636 | * ebx destroyed |
114 | mikedld | 2637 | |
2638 | ====================================================================== |
||
118 | diamond | 2639 | ========= Function 53, subfunction 3 - read byte from socket. ======== |
114 | mikedld | 2640 | ====================================================================== |
2641 | Parameters: |
||
118 | diamond | 2642 | * eax = 53 - function number |
2643 | * ebx = 3 - subfunction number |
||
2644 | * ecx = socket handle |
||
114 | mikedld | 2645 | Returned value: |
1018 | diamond | 2646 | * if there is no read data or handle is incorrect: eax=0, bl=0, |
118 | diamond | 2647 | other bytes of ebx are destroyed |
2648 | * if there are read data: eax=number of rest bytes |
||
2649 | (possibly 0), bl=read byte, other bytes of ebx are destroyed |
||
114 | mikedld | 2650 | |
2651 | ====================================================================== |
||
118 | diamond | 2652 | ========== Function 53, subfunction 4 - write to UDP-socket. ========= |
114 | mikedld | 2653 | ====================================================================== |
2654 | Parameters: |
||
118 | diamond | 2655 | * eax = 53 - function number |
2656 | * ebx = 4 - subfunction number |
||
2657 | * ecx = socket handle |
||
2658 | * edx = number of bytes to write |
||
2659 | * esi = pointer to data to write |
||
114 | mikedld | 2660 | Returned value: |
1018 | diamond | 2661 | * eax = 0xffffffff - error (invalid handle or not enough memory) |
118 | diamond | 2662 | * eax = 0 - success |
2663 | * ebx destroyed |
||
114 | mikedld | 2664 | Remarks: |
118 | diamond | 2665 | * Number of bytes to write must not exceed 1500-28, though |
2666 | the appropriate check is not made. |
||
114 | mikedld | 2667 | |
2668 | ====================================================================== |
||
2669 | ============ Function 53, subfunction 5 - open TCP-socket. =========== |
||
2670 | ====================================================================== |
||
2671 | Parameters: |
||
118 | diamond | 2672 | * eax = 53 - function number |
2673 | * ebx = 5 - subfunction number |
||
1154 | clevermous | 2674 | * ecx = local port (only low word is taken into account), |
2675 | ecx = 0 - let the system choose a port |
||
118 | diamond | 2676 | * edx = remote port (only low word is taken into account) |
114 | mikedld | 2677 | * esi = remote IP |
118 | diamond | 2678 | * edi = open mode: SOCKET_PASSIVE=0 or SOCKET_ACTIVE=1 |
114 | mikedld | 2679 | Returned value: |
118 | diamond | 2680 | * eax = -1 = 0xFFFFFFFF - error; ebx destroys |
2681 | * eax = socket handle (some number which unambiguously identifies |
||
2682 | socket and have sense only for the system) - success; |
||
2683 | ebx destroyed |
||
114 | mikedld | 2684 | |
2685 | ====================================================================== |
||
118 | diamond | 2686 | ========= Function 53, subfunction 6 - get TCP-socket status. ======== |
114 | mikedld | 2687 | ====================================================================== |
2688 | Parameters: |
||
118 | diamond | 2689 | * eax = 53 - function number |
2690 | * ebx = 6 - subfunction number |
||
2691 | * ecx = socket handle |
||
114 | mikedld | 2692 | Returned value: |
1018 | diamond | 2693 | * eax = 0 for incorrect handle or socket status: one of |
114 | mikedld | 2694 | * TCB_LISTEN = 1 |
2695 | * TCB_SYN_SENT = 2 |
||
2696 | * TCB_SYN_RECEIVED = 3 |
||
2697 | * TCB_ESTABLISHED = 4 |
||
2698 | * TCB_FIN_WAIT_1 = 5 |
||
2699 | * TCB_FIN_WAIT_2 = 6 |
||
2700 | * TCB_CLOSE_WAIT = 7 |
||
2701 | * TCB_CLOSING = 8 |
||
2702 | * TCB_LAST_ASK = 9 |
||
2703 | * TCB_TIME_WAIT = 10 |
||
2704 | * TCB_CLOSED = 11 |
||
1018 | diamond | 2705 | * ebx destroyed |
114 | mikedld | 2706 | |
2707 | ====================================================================== |
||
118 | diamond | 2708 | ========== Function 53, subfunction 7 - write to TCP-socket. ========= |
114 | mikedld | 2709 | ====================================================================== |
2710 | Parameters: |
||
118 | diamond | 2711 | * eax = 53 - function number |
2712 | * ebx = 7 - subfunction number |
||
2713 | * ecx = socket handle |
||
2714 | * edx = number of bytes to write |
||
2715 | * esi = pointer to data to write |
||
114 | mikedld | 2716 | Returned value: |
1018 | diamond | 2717 | * eax = 0xffffffff - error (invalid handle or not enough memory) |
118 | diamond | 2718 | * eax = 0 - success |
2719 | * ebx destroyed |
||
114 | mikedld | 2720 | Remarks: |
118 | diamond | 2721 | * Number of bytes to write must not exceed 1500-40, though |
2722 | the appropriate check is not made. |
||
114 | mikedld | 2723 | |
2724 | ====================================================================== |
||
118 | diamond | 2725 | =========== Function 53, subfunction 8 - close TCP-socket. =========== |
114 | mikedld | 2726 | ====================================================================== |
2727 | Parameters: |
||
118 | diamond | 2728 | * eax = 53 - function number |
2729 | * ebx = 8 - subfunction number |
||
2730 | * ecx = socket handle |
||
114 | mikedld | 2731 | Returned value: |
1018 | diamond | 2732 | * eax = -1 - error (invalid handle or |
2733 | not enough memory for socket close packet) |
||
118 | diamond | 2734 | * eax = 0 - success |
2735 | * ebx destroyed |
||
114 | mikedld | 2736 | Remarks: |
118 | diamond | 2737 | * The current implementation does not close automatically all |
2738 | sockets of a thread at termination. In particular, one should not |
||
2739 | kill a thread with many opened sockets - there will be an outflow |
||
2740 | of resources. |
||
114 | mikedld | 2741 | |
2742 | ====================================================================== |
||
118 | diamond | 2743 | === Function 53, subfunction 9 - check whether local port is free. === |
114 | mikedld | 2744 | ====================================================================== |
2745 | Parameters: |
||
118 | diamond | 2746 | * eax = 53 - function number |
2747 | * ebx = 9 - subfunction number |
||
2748 | * ecx = local port number (low 16 bits are used only) |
||
114 | mikedld | 2749 | Returned value: |
2750 | * eax = 0 - port is used |
||
2751 | * eax = 1 - port is free |
||
118 | diamond | 2752 | * ebx destroyed |
114 | mikedld | 2753 | |
2754 | ====================================================================== |
||
314 | diamond | 2755 | ===== Function 53, subfunction 10 - query Ethernet cable status. ===== |
2756 | ====================================================================== |
||
2757 | Parameters: |
||
2758 | * eax = 53 - function number |
||
2759 | * ebx = 10 - subfunction number |
||
2760 | Returned value: |
||
2761 | * al = -1 - a network driver is not loaded or |
||
2762 | does not support this function |
||
2763 | * al = 0 - Ethernet cable is unplugged |
||
2764 | * al = 1 - Ethernet cable is plugged |
||
346 | diamond | 2765 | * ebx destroyed |
314 | diamond | 2766 | Remarks: |
2767 | * The current kernel implementation supports this function |
||
2768 | only for RTL8139 network cards. |
||
2769 | |||
2770 | ====================================================================== |
||
346 | diamond | 2771 | ======= Function 53, subfunction 11 - read network stack data. ======= |
340 | heavyiron | 2772 | ====================================================================== |
346 | diamond | 2773 | Paramters: |
2774 | * eax = 53 - function number |
||
2775 | * ebx = 11 - subfunction number |
||
2776 | * ecx = socket handle |
||
2777 | * edx = pointer to buffer |
||
2778 | * esi = number of bytes to read; |
||
2779 | * esi = 0 - read all data (maximum 4096 bytes) |
||
2780 | Returned value: |
||
1018 | diamond | 2781 | * eax = number of bytes read (0 for incorrect handle) |
346 | diamond | 2782 | * ebx destroyed |
340 | heavyiron | 2783 | |
2784 | ====================================================================== |
||
2409 | Serge | 2785 | = Function 53, subfunction 255 - debug information of network driver. |
114 | mikedld | 2786 | ====================================================================== |
2787 | Parameters: |
||
118 | diamond | 2788 | * eax = 53 - function number |
2789 | * ebx = 255 - subfunction number |
||
114 | mikedld | 2790 | * ecx = type of requested information (see below) |
2791 | Returned value: |
||
2792 | * eax = requested information |
||
118 | diamond | 2793 | * ebx destroyed |
2794 | Possible values for ecx: |
||
114 | mikedld | 2795 | * 100: length of queue 0 (empty queue) |
2796 | * 101: length of queue 1 (ip-out queue) |
||
2797 | * 102: length of queue 2 (ip-in queue) |
||
2798 | * 103: length of queue 3 (net1out queue) |
||
118 | diamond | 2799 | * 200: number of items in the ARP table |
2800 | * 201: size of the ARP table (in items) (20 for current version) |
||
2801 | * 202: read item at edx of the ARP table to the temporary buffer, |
||
2802 | whence 5 following types take information; |
||
114 | mikedld | 2803 | in this case eax is not defined |
118 | diamond | 2804 | * 203: IP-address saved by type 202 |
2805 | * 204: high dword of MAC-address saved by type 202 |
||
2806 | * 205: low word of MAC-address saved by type 202 |
||
2807 | * 206: status word saved by type 202 |
||
2808 | * 207: ttl word saved by type 202 |
||
2809 | * 2: total number of received IP-packets |
||
2810 | * 3: total number of transferred IP-packets |
||
2811 | * 4: total number of dumped received packets |
||
2812 | * 5: total number of received ARP-packets |
||
2813 | * 6: status of packet driver, 0=inactive, nonzero=active |
||
114 | mikedld | 2814 | |
2815 | ====================================================================== |
||
2409 | Serge | 2816 | Function 55, subfunction 55 - begin to play data on built-in speaker. |
114 | mikedld | 2817 | ====================================================================== |
2818 | Parameters: |
||
118 | diamond | 2819 | * eax = 55 - function number |
2820 | * ebx = 55 - subfunction number |
||
2821 | * esi = pointer to data |
||
114 | mikedld | 2822 | Returned value: |
118 | diamond | 2823 | * eax = 0 - success |
2824 | * eax = 55 - error (speaker is off or busy) |
||
2825 | Data is an array of items with variable length. |
||
2826 | Format of each item is defined by first byte: |
||
114 | mikedld | 2827 | * 0 = end of data |
118 | diamond | 2828 | * 1..0x80 = sets sound duration on 1/100 of second; sound note |
2829 | is defined by immediate value of frequency |
||
2830 | * following word (2 bytes) contains frequency divider; |
||
2831 | frequency is defined as 1193180/divider |
||
114 | mikedld | 2832 | * 0x81 = invalid |
118 | diamond | 2833 | * 0x82..0xFF = note is defined by octave and number: |
2834 | * duration in 1/100 of second = (first byte)-0x81 |
||
114 | mikedld | 2835 | * there is one more byte; |
118 | diamond | 2836 | * (second byte)=0xFF - delay |
2837 | * otherwise it looks like a*0x10+b, where b=number of the note in |
||
2838 | an octave from 1 to 12, a=number of octave (beginning from 0) |
||
114 | mikedld | 2839 | Remarks: |
118 | diamond | 2840 | * Speaker play can be disabled/enabled by |
2841 | subfunction 8 of function 18. |
||
2842 | * Function returns control, having informed the system |
||
2843 | an information on request. Play itself goes independently from |
||
2844 | the program. |
||
2845 | * The data must be kept in the memory at least up to the end |
||
2846 | of play. |
||
114 | mikedld | 2847 | |
2848 | ====================================================================== |
||
641 | diamond | 2849 | ======================= Function 57 - PCI BIOS. ====================== |
2850 | ====================================================================== |
||
2851 | Parameters: |
||
2852 | * eax = 57 - function number |
||
2853 | * ebp corresponds to al in PCI BIOS specification |
||
2854 | * other registers are set according to PCI BIOS specification |
||
2855 | Returned value: |
||
2856 | * CF is undefined |
||
2857 | * other registers are set according to PCI BIOS specification |
||
2858 | Remarks: |
||
2859 | * Many effects of this function can be also achieved with |
||
2860 | corresponding subfunctions of function 62. |
||
2861 | * The function calls PCI32 BIOS extension, documented e.g. in |
||
2862 | http://alpha1.dyns.net/files/PCI/bios21.pdf. |
||
2863 | * If BIOS does not support this extension, its behavior is emulated |
||
2864 | (through kernel-mode analogues of subfunctions of function 62). |
||
2865 | |||
2866 | ====================================================================== |
||
118 | diamond | 2867 | ================ Function 58 - work with file system. ================ |
114 | mikedld | 2868 | ====================================================================== |
2869 | Parameters: |
||
2870 | * eax = 58 |
||
118 | diamond | 2871 | * ebx = pointer to the information structure |
114 | mikedld | 2872 | Returned value: |
118 | diamond | 2873 | * eax = 0 - success; otherwise file system error code |
2874 | * some subfunctions return value in other registers too |
||
2875 | General format of the information structure: |
||
2876 | * +0: dword: subfunction number |
||
114 | mikedld | 2877 | * +4: dword: number of block |
2878 | * +8: dword: size |
||
118 | diamond | 2879 | * +12 = +0xC: dword: pointer to data |
2880 | * +16 = +0x10: dword: pointer to a memory for system operations |
||
114 | mikedld | 2881 | (4096 bytes) |
118 | diamond | 2882 | * +20 = +0x14: n db: ASCIIZ-string with the file name |
2883 | Specifications - in documentation on the appropriate subfunction. |
||
2884 | Filename is case-insensitive for latin letters, russian letters |
||
2885 | must be capital. |
||
2886 | Format of filename: |
||
114 | mikedld | 2887 | /base/number/dir1/dir2/.../dirn/file, |
118 | diamond | 2888 | where /base/number identifies device, on which file is located: |
114 | mikedld | 2889 | one of |
118 | diamond | 2890 | * /RD/1 = /RAMDISK/1 to access ramdisk |
2891 | * /FD/1 = /FLOPPYDISK/1 to access first floppy drive, |
||
2892 | /FD/2 = /FLOPPYDISK/2 to access second one |
||
2893 | * /HD/x = /HARDDISK/x - obsolete variant of access to hard disk |
||
2894 | (in this case base is defined by subfunction 7 of function 21), |
||
2895 | x - partition number (beginning from 1) |
||
2896 | * /HD0/x, /HD1/x, /HD2/x, /HD3/x to access accordingly to devices |
||
2897 | IDE0 (Primary Master), IDE1 (Primary Slave), |
||
114 | mikedld | 2898 | IDE2 (Secondary Master), IDE3 (Secondary Slave); |
118 | diamond | 2899 | x - partition number on the selected hard drive, varies from 1 |
2900 | to 255 (on each hard drive the indexing starts from 1) |
||
114 | mikedld | 2901 | Remarks: |
118 | diamond | 2902 | * In the first two cases it is also possible to use FIRST |
2903 | instead of 1, SECOND instead of 2, but it is not recommended |
||
2904 | for convenience of transition to the future extensions. |
||
2905 | * Limitation n<=39 is imposed. |
||
2906 | * Names of folders and file dir1,...,dirn,file must have the |
||
2907 | format 8.3: name no more than 8 characters, dot, extension no |
||
2908 | more than 3 characters. Trailing spaces are ignored, no other |
||
2909 | spaces is allowed. If name occupies equally 8 characters, |
||
2910 | dot may be omitted (though it is not recommended to use this |
||
2911 | feature for convenience of transition to the future extensions). |
||
2912 | * This function does not support folders on ramdisk. |
||
114 | mikedld | 2913 | Examples: |
2914 | * '/RAMDISK/FIRST/KERNEL.ASM',0 |
||
2915 | '/rd/1/kernel.asm',0 |
||
2916 | * '/HD0/1/kernel.asm',0 |
||
2917 | * '/hd0/1/menuet/pics/tanzania.bmp',0 |
||
118 | diamond | 2918 | Existing subfunctions: |
2919 | * subfunction 0 - read file/folder |
||
2920 | * subfunction 8 - LBA-read from device |
||
2921 | * subfunction 15 - get file system information |
||
114 | mikedld | 2922 | |
2923 | ====================================================================== |
||
118 | diamond | 2924 | =========== Function 58, subfunction 0 - read file/folder. =========== |
114 | mikedld | 2925 | ====================================================================== |
2926 | Parameters: |
||
2927 | * eax = 58 |
||
118 | diamond | 2928 | * ebx = pointer to the information structure |
2929 | Format of the information structure: |
||
2930 | * +0: dword: 0 = subfunction number |
||
2931 | * +4: dword: first block to read (beginning from 0) |
||
2932 | * +8: dword: amount of blocks to read |
||
2933 | * +12 = +0xC: dword: pointer to buffer for data |
||
2934 | * +16 = +0x10: dword: pointer to buffer for system operations |
||
114 | mikedld | 2935 | (4096 bytes) |
118 | diamond | 2936 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
2937 | given in the general description |
||
114 | mikedld | 2938 | Returned value: |
118 | diamond | 2939 | * eax = 0 - success, otherwise file system error code |
2940 | * ebx = file size (in bytes) or -1=0xffffffff, if file was not found |
||
114 | mikedld | 2941 | Remarks: |
118 | diamond | 2942 | * Block size is 512 bytes. |
114 | mikedld | 2943 | * This function is obsolete, for reading files use subfunction 0 |
118 | diamond | 2944 | of function 70, for reading folders - subfunction 1 of |
2945 | function 70. |
||
2946 | * Function can read contents of a folder. Only FAT file system is |
||
2947 | supported. The format of FAT-folder is described |
||
2948 | in any FAT documentation. |
||
2949 | * Size of a folder is determined by size of FAT clusters chain. |
||
2950 | * If file was ended before last requested block was read, |
||
2951 | the function will read as many as it can, and after that return |
||
2952 | eax=6 (EOF). |
||
2953 | * Function can read root folders /rd/1,/fd/x,/hd[n]/x, but |
||
2954 | in the first two cases the current implementation does not follow |
||
2955 | to the declared rules: |
||
114 | mikedld | 2956 | for /rd/1: |
118 | diamond | 2957 | * if one want to read 0 blocks, function considers, |
2958 | that he requested 1; |
||
2959 | * if one requests more than 14 blocks or starting block is |
||
3539 | clevermous | 2960 | not less than 14, function returns eax=5 (not found) and ebx=-1; |
2409 | Serge | 2961 | * size of ramdisk root folder is 14 blocks, |
3539 | clevermous | 2962 | 0x1C00=7168 bytes; but function returns ebx=0 |
118 | diamond | 2963 | (except of the case of previous item); |
2964 | * strangely enough, it is possible to read 14th block (which |
||
2965 | generally contains a garbage - I remind, the indexing begins |
||
2966 | from 0); |
||
2967 | * if some block with the number not less than 14 was requested, |
||
2968 | function returns eax=6(EOF); otherwise eax=0. |
||
2969 | For /fd/x: |
||
2970 | * if the start block is not less than 14, function returns |
||
2971 | eax=5 (not found) and ebx=0; |
||
2972 | * note that format of FAT12 allows floppies with the root size |
||
2973 | more or less than 14 blocks; |
||
2974 | * check for length is not performed; |
||
2975 | * if data was successful read, function returns |
||
2976 | eax=0,ebx=0; otherwise eax=10 (access denied), ebx=-1. |
||
2977 | * The function handles reading of special folders /,/rd,/fd,/hd[n]; |
||
2978 | but the result does not correspond to expected (on operations with |
||
2979 | normal files/folders), does not follow the declared rules, |
||
2980 | may be changed in future versions of the kernel and consequently |
||
2981 | is not described. To obtain the information about the equipment |
||
2982 | use subfunction 11 of function 18 or |
||
2983 | read corresponding folder with subfunction 1 of function 70. |
||
114 | mikedld | 2984 | |
2985 | ====================================================================== |
||
118 | diamond | 2986 | ========= Function 58, subfunction 8 - LBA-read from device. ========= |
114 | mikedld | 2987 | ====================================================================== |
2988 | Parameters: |
||
118 | diamond | 2989 | * eax = 58 - function number |
2990 | * ebx = pointer to the information structure |
||
2991 | Format of the information structure: |
||
2992 | * +0: dword: 8 = subfunction number |
||
2993 | * +4: dword: number of block to read (beginning from 0) |
||
2994 | * +8: dword: ignored (set to 1) |
||
2995 | * +12 = +0xC: dword: pointer to buffer for data (512 bytes) |
||
2996 | * +16 = +0x10: dword: pointer to buffer for system operations |
||
114 | mikedld | 2997 | (4096 bytes) |
118 | diamond | 2998 | * +20 = +0x14: ASCIIZ-name of device: case-insensitive, one of |
2999 | /rd/1 = /RamDisk/1, /hd/n = /HardDisk/n, |
||
114 | mikedld | 3000 | 1<=n<=4 - number of device: 1=IDE0, ..., 4=IDE3. |
118 | diamond | 3001 | Instead of digits it is allowed, though not recommended for |
3002 | convenience of transition to future extensions, to use |
||
3003 | 'first','second','third','fourth'. |
||
114 | mikedld | 3004 | Returned value: |
118 | diamond | 3005 | * for device name /hd/xxx, where xxx is not in the list above: |
114 | mikedld | 3006 | * eax = ebx = 1 |
118 | diamond | 3007 | * for invalid device name (except for the previous case): |
114 | mikedld | 3008 | * eax = 5 |
118 | diamond | 3009 | * ebx does not change |
3010 | * if LBA-access is disabled by subfunction 11 of function 21: |
||
114 | mikedld | 3011 | * eax = 2 |
118 | diamond | 3012 | * ebx destroyed |
3013 | * for ramdisk: attempt to read block outside ramdisk |
||
3014 | (18*2*80 blocks) results in |
||
114 | mikedld | 3015 | * eax = 3 |
3016 | * ebx = 0 |
||
118 | diamond | 3017 | * for successful read: |
114 | mikedld | 3018 | * eax = ebx = 0 |
3019 | Remarks: |
||
118 | diamond | 3020 | * Block size is 512 bytes; function reads one block. |
3021 | * Do not depend on returned value, it can be changed |
||
3022 | in future versions. |
||
2409 | Serge | 3023 | * Function requires that LBA-access to devices is enabled by |
3024 | subfunction 11 of function 21. To check this one can use |
||
118 | diamond | 3025 | subfunction 11 of function 26. |
3026 | * LBA-read of floppy is not supported. |
||
3027 | * Function reads data on physical hard drive; if for any reason |
||
3028 | data of the concrete partition are required, application must |
||
3029 | define starting sector of this partition (either directly |
||
3030 | through MBR, or from the full structure returned by |
||
3539 | clevermous | 3031 | subfunction 11 of function 18). |
118 | diamond | 3032 | * Function does not check error code of hard disk, so request of |
3033 | nonexisting sector reads something (most probably it will be |
||
3034 | zeroes, but this is defined by device) and this is considered |
||
3035 | as success (eax=0). |
||
114 | mikedld | 3036 | |
118 | diamond | 3037 | ====================================================================== |
3038 | ==== Function 58, subfunction 15 - get information on file system. === |
||
3039 | ====================================================================== |
||
114 | mikedld | 3040 | Parameters: |
118 | diamond | 3041 | * eax = 58 - function number |
3042 | * ebx = pointer to the information structure |
||
3043 | Format of the information structure: |
||
3044 | * +0: dword: 15 = subfunction number |
||
114 | mikedld | 3045 | * +4: dword: ignored |
3046 | * +8: dword: ignored |
||
3047 | * +12 = +0xC: dword: ignored |
||
3048 | * +16 = +0x10: dword: ignored |
||
118 | diamond | 3049 | * +20 = +0x14: (only second character is checked) |
114 | mikedld | 3050 | /rd=/RAMDISK or /hd=/HARDDISK |
3051 | Returned value: |
||
118 | diamond | 3052 | * if the second character does not belong to set {'r','R','h','H'}: |
114 | mikedld | 3053 | * eax = 3 |
3054 | * ebx = ecx = dword [fileinfo] = 0 |
||
3055 | * for ramdisk: |
||
3056 | * eax = 0 (success) |
||
3057 | * ebx = total number of clusters = 2847 |
||
3058 | * ecx = number of free clusters |
||
3059 | * dword [fileinfo] = cluster size = 512 |
||
118 | diamond | 3060 | * for hard disk: base and partition are defined by subfunctions |
3061 | 7 and 8 of function 21: |
||
114 | mikedld | 3062 | * eax = 0 (success) |
3063 | * ebx = total number of clusters |
||
3064 | * ecx = number of free clusters |
||
3065 | * dword [fileinfo] = cluster size (in bytes) |
||
3066 | Remarks: |
||
118 | diamond | 3067 | * Be not surprised to strange layout of 4th returned parameter |
3068 | - when this code was writing, at system calls application got |
||
3069 | only registers eax,ebx,ecx (from pushad-structure transmitted |
||
3070 | as argument to the system function). Now it is corrected, so, |
||
3071 | probably, it is meaningful to return cluster size in edx, while |
||
3072 | this function is not used yet. |
||
3073 | * There exists also subfunction 11 of function 18, |
||
3074 | which returns information on file system. From the full table |
||
3075 | of disk subsystem it is possible to deduce cluster size (there |
||
3076 | it is stored in sectors) and total number of clusters |
||
3077 | for hard disks. |
||
114 | mikedld | 3078 | |
3079 | ====================================================================== |
||
118 | diamond | 3080 | ========== Function 60 - Inter Process Communication (IPC). ========== |
114 | mikedld | 3081 | ====================================================================== |
118 | diamond | 3082 | IPC is used for message dispatching from one process/thread to |
3083 | another. Previously it is necessary to agree how to interpret |
||
114 | mikedld | 3084 | the concrete message. |
3085 | |||
118 | diamond | 3086 | ----------- Subfunction 1 - set the area for IPC receiving ----------- |
3087 | Is called by process-receiver. |
||
114 | mikedld | 3088 | Parameters: |
118 | diamond | 3089 | * eax = 60 - function number |
3090 | * ebx = 1 - subfunction number |
||
3091 | * ecx = pointer to the buffer |
||
3092 | * edx = size of the buffer |
||
114 | mikedld | 3093 | Returned value: |
118 | diamond | 3094 | * eax = 0 - always success |
3095 | Format of IPC-buffer: |
||
3096 | * +0: dword: if nonzero, buffer is considered locked; |
||
3097 | lock/unlock the buffer, when you work with it and need that |
||
3098 | buffer data are not changed from outside (no new messages) |
||
114 | mikedld | 3099 | * +4: dword: occupied place in the buffer (in bytes) |
3100 | * +8: first message |
||
3101 | * +8+n: second message |
||
3102 | * ... |
||
118 | diamond | 3103 | Format of a message: |
3104 | * +0: dword: PID of sender |
||
3105 | * +4: dword: message length (not including this header) |
||
3106 | * +8: n*byte: message data |
||
114 | mikedld | 3107 | |
118 | diamond | 3108 | ------------------ Subfunction 2 - send IPC message ------------------ |
3109 | Is called by process-sender. |
||
114 | mikedld | 3110 | Parameters: |
118 | diamond | 3111 | * eax = 60 - function number |
3112 | * ebx = 2 - subfunction number |
||
114 | mikedld | 3113 | * ecx = PID of receiver |
118 | diamond | 3114 | * edx = pointer to the message data |
3115 | * esi = message length (in bytes) |
||
114 | mikedld | 3116 | Returned value: |
118 | diamond | 3117 | * eax = 0 - success |
3118 | * eax = 1 - the receiver has not defined buffer for IPC messages |
||
3119 | (can be, still have no time, |
||
3120 | and can be, this is not right process) |
||
3121 | * eax = 2 - the receiver has blocked IPC-buffer; try to wait a bit |
||
3122 | * eax = 3 - overflow of IPC-buffer of the receiver |
||
114 | mikedld | 3123 | * eax = 4 - process/thread with such PID does not exist |
3124 | Remarks: |
||
118 | diamond | 3125 | * Immediately after writing of IPC-message to the buffer the system |
3126 | sends to the receiver the event with code 7 (see event codes). |
||
114 | mikedld | 3127 | |
3128 | ====================================================================== |
||
118 | diamond | 3129 | ==== Function 61 - get parameters for the direct graphics access. ==== |
114 | mikedld | 3130 | ====================================================================== |
118 | diamond | 3131 | The data of the graphics screen (the memory area which displays |
3132 | screen contents) are accessible to a program directly, without |
||
3133 | any system calls, through the selector gs: |
||
1662 | Nasarus | 3134 | mov eax, [gs:0] |
118 | diamond | 3135 | places in eax the first dword of the buffer, which contains |
3136 | information on color of the left upper point (and, possibly, colors |
||
3137 | of several following). |
||
1662 | Nasarus | 3138 | mov [gs:0], eax |
118 | diamond | 3139 | by work in VESA modes with LFB sets color of the left upper point |
3140 | (and, possibly, colors of several following). |
||
3141 | To interpret the data of graphics screen program needs to know |
||
3142 | some parameters, returning by this function. |
||
114 | mikedld | 3143 | Remarks: |
118 | diamond | 3144 | * Graphics parameters changes very seldom at work, |
3145 | namely, only in cases, when user works with the application VRR. |
||
3146 | * At videomode change the system redraws all windows (event |
||
3147 | with code 1) and redraws the background (event 5). |
||
3148 | Same events occur in other cases too, which meet much more often, |
||
3149 | than videomode change. |
||
3150 | * By operation in videomodes with LFB the selector gs points to |
||
3151 | LFB itself, so reading/writing on gs result directly in |
||
3152 | change of screen contents. By operation in videomodes without |
||
3153 | LFB gs points to some data area in the kernel, and all functions |
||
3154 | of screen output fulfil honesty double operation on writing |
||
3155 | directly to the screen and writing to this buffer. In result |
||
3156 | at reading contents of this buffer the results correspond to |
||
3157 | screen contents (with, generally speaking, large color |
||
3158 | resolution), and writing is ignored. |
||
3159 | One exception is the mode 320*200, for which main loop of the |
||
3160 | system thread updates the screen according to mouse movements. |
||
114 | mikedld | 3161 | |
3162 | ------------------------- Screen resolution -------------------------- |
||
3163 | Parameters: |
||
118 | diamond | 3164 | * eax = 61 - function number |
3165 | * ebx = 1 - subfunction number |
||
114 | mikedld | 3166 | Returned value: |
118 | diamond | 3167 | * eax = [resolution on x axis]*65536 + [resolution on y axis] |
114 | mikedld | 3168 | Remarks: |
118 | diamond | 3169 | * One can use function 14 paying attention that |
3170 | it returns sizes on 1 pixel less. It is fully equivalent way. |
||
114 | mikedld | 3171 | |
118 | diamond | 3172 | ---------------------- Number of bits per pixel ---------------------- |
114 | mikedld | 3173 | Parameters: |
118 | diamond | 3174 | * eax = 61 - function number |
3175 | * ebx = 2 - subfunction number |
||
114 | mikedld | 3176 | Returned value: |
118 | diamond | 3177 | * eax = number of bits per pixel (24 or 32) |
114 | mikedld | 3178 | |
118 | diamond | 3179 | -------------------- Number of bytes per scanline -------------------- |
114 | mikedld | 3180 | Parameters: |
118 | diamond | 3181 | * eax = 61 - function number |
3182 | * ebx = 3 - subfunction number |
||
114 | mikedld | 3183 | Returned value: |
118 | diamond | 3184 | * eax = number of bytes occupied by one scanline |
114 | mikedld | 3185 | (horizontal line on the screen) |
3186 | |||
3187 | ====================================================================== |
||
118 | diamond | 3188 | ===== Function 62, subfunction 0 - get version of PCI-interface. ===== |
114 | mikedld | 3189 | ====================================================================== |
3190 | Parameters: |
||
118 | diamond | 3191 | * eax = 62 - function number |
3192 | * bl = 0 - subfunction number |
||
114 | mikedld | 3193 | Returned value: |
118 | diamond | 3194 | * eax = -1 - PCI access is disabled; otherwise |
3195 | * ah.al = version of PCI-interface (ah=version, al=subversion) |
||
3196 | * high word of eax is zeroed |
||
114 | mikedld | 3197 | Remarks: |
118 | diamond | 3198 | * Previously low-level access to PCI for applications must be |
3199 | enabled by subfunction 12 of function 21. |
||
3200 | * If PCI BIOS is not supported, the value of ax is undefined. |
||
114 | mikedld | 3201 | |
3202 | ====================================================================== |
||
118 | diamond | 3203 | ==== Function 62, subfunction 1 - get number of the last PCI-bus. ==== |
114 | mikedld | 3204 | ====================================================================== |
3205 | Parameters: |
||
118 | diamond | 3206 | * eax = 62 - function number |
3207 | * bl = 1 - subfunction number |
||
114 | mikedld | 3208 | Returned value: |
118 | diamond | 3209 | * eax = -1 - access to PCI is disabled; otherwise |
3210 | * al = number of the last PCI-bus; other bytes of eax are destroyed |
||
114 | mikedld | 3211 | Remarks: |
118 | diamond | 3212 | * Previously low-level access to PCI for applications must be |
3213 | enabled by subfunction 12 of function 21. |
||
3214 | * If PCI BIOS is not supported, the value of ax is undefined. |
||
114 | mikedld | 3215 | |
3216 | ====================================================================== |
||
118 | diamond | 3217 | ===================== Function 62, subfunction 2 ===================== |
3218 | ===== Get mechanism of addressing to the PCI configuration space. ==== |
||
114 | mikedld | 3219 | ====================================================================== |
3220 | Parameters: |
||
118 | diamond | 3221 | * eax = 62 - function number |
3222 | * bl = 2 - subfunction number |
||
114 | mikedld | 3223 | Returned value: |
118 | diamond | 3224 | * eax = -1 - access to PCI is disabled; otherwise |
3225 | * al = mechanism (1 or 2); other bytes of eax are destroyed |
||
114 | mikedld | 3226 | Remarks: |
118 | diamond | 3227 | * Previously low-level access to PCI for applications must be |
3228 | enabled by subfunction 12 of function 21. |
||
3229 | * Addressing mechanism is selected depending on |
||
3230 | equipment characteristics. |
||
3231 | * Subfunctions of read and write work automatically |
||
3232 | with the selected mechanism. |
||
114 | mikedld | 3233 | |
3234 | ====================================================================== |
||
118 | diamond | 3235 | ======== Function 62, subfunctions 4,5,6 - read PCI-register. ======== |
114 | mikedld | 3236 | ====================================================================== |
3237 | Parameters: |
||
118 | diamond | 3238 | * eax = 62 - function number |
3239 | * bl = 4 - read byte |
||
3240 | * bl = 5 - read word |
||
3241 | * bl = 6 - read dword |
||
114 | mikedld | 3242 | * bh = number of PCI-bus |
118 | diamond | 3243 | * ch = dddddfff, where ddddd = number of the device on the bus, |
3244 | fff = function number of device |
||
3245 | * cl = number of register (must be even for bl=5, |
||
3246 | divisible by 4 for bl=6) |
||
114 | mikedld | 3247 | Returned value: |
118 | diamond | 3248 | * eax = -1 - error (access to PCI is disabled or parameters |
3249 | are not supported); otherwise |
||
3250 | * al/ax/eax (depending on requested size) contains the data; |
||
3251 | the other part of register eax is destroyed |
||
114 | mikedld | 3252 | Remarks: |
118 | diamond | 3253 | * Previously low-level access to PCI for applications must be |
3254 | enabled by subfunction 12 of function 21. |
||
3255 | * Access mechanism 2 supports only 16 devices on a bus and ignores |
||
3256 | function number. To get access mechanism use subfunction 2. |
||
3257 | * Some registers are standard and exist for all devices, some are |
||
3258 | defined by the concrete device. The list of registers of the |
||
3259 | first type can be found e.g. in famous |
||
114 | mikedld | 3260 | Interrupt List by Ralf Brown |
3261 | (http://www.pobox.com/~ralf/files.html, |
||
3262 | ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/); |
||
118 | diamond | 3263 | registers of the second type must be listed |
3264 | in the device documentation. |
||
114 | mikedld | 3265 | |
3266 | ====================================================================== |
||
118 | diamond | 3267 | ====== Function 62, subfunctions 8,9,10 - write to PCI-register. ===== |
114 | mikedld | 3268 | ====================================================================== |
3269 | Parameters: |
||
118 | diamond | 3270 | * eax = 62 - function number |
3271 | * bl = 8 - write byte |
||
3272 | * bl = 9 - write word |
||
3273 | * bl = 10 - write dword |
||
114 | mikedld | 3274 | * bh = number of PCI-bus |
118 | diamond | 3275 | * ch = dddddfff, where ddddd = number of the device on the bus, |
3276 | fff = function number of device |
||
3277 | * cl = number of register (must be even for bl=9, |
||
3278 | divisible by 4 for bl=10) |
||
3279 | * dl/dx/edx (depending on requested size) contatins |
||
3280 | the data to write |
||
114 | mikedld | 3281 | Returned value: |
118 | diamond | 3282 | * eax = -1 - error (access to PCI is disabled or parameters |
3283 | are not supported) |
||
3284 | * eax = 0 - success |
||
114 | mikedld | 3285 | Remarks: |
118 | diamond | 3286 | * Previously low-level access to PCI for applications must be |
3287 | enabled by subfunction 12 of function 21. |
||
3288 | * Access mechanism 2 supports only 16 devices on a bus and ignores |
||
3289 | function number. To get access mechanism use subfunction 2. |
||
3290 | * Some registers are standard and exist for all devices, some are |
||
3291 | defined by the concrete device. The list of registers of the |
||
3292 | first type can be found e.g. in famous Interrupt List by |
||
3293 | Ralf Brown; registers of the second type must be listed |
||
3294 | in the device documentation. |
||
114 | mikedld | 3295 | |
3296 | ====================================================================== |
||
118 | diamond | 3297 | ============== Function 63 - work with the debug board. ============== |
114 | mikedld | 3298 | ====================================================================== |
118 | diamond | 3299 | The debug board is the global system buffer (with the size |
499 | diamond | 3300 | 1024 bytes), to which any program can write (generally speaking, |
118 | diamond | 3301 | arbitrary) data and from which other program can read these data. |
3302 | By the agreement written data are text strings interpreted as |
||
3303 | debug messages on a course of program execution. The kernel in |
||
3304 | some situations also writes to the debug board information on |
||
3305 | execution of some functions; by the agreement kernel messages |
||
3306 | begins from the prefix "K : ". |
||
3307 | For view of the debug board the application 'board' was created, |
||
3308 | which reads data from the buffer and displays them in its window. |
||
3309 | 'board' interpretes the sequence of codes 13,10 as newline. |
||
3310 | A character with null code in an end of line is not necessary, |
||
114 | mikedld | 3311 | but also does not prevent. |
118 | diamond | 3312 | Because debugger has been written, the value of the debug board |
3313 | has decreased, as debugger allows to inspect completely a course of |
||
3314 | program execution without any efforts from the direction of program |
||
3315 | itself. Nevertheless in some cases the debug board is still useful. |
||
114 | mikedld | 3316 | |
118 | diamond | 3317 | ----------------------------- Write byte ----------------------------- |
114 | mikedld | 3318 | Parameters: |
118 | diamond | 3319 | * eax = 63 - function number |
3320 | * ebx = 1 - subfunction number |
||
3321 | * cl = data byte |
||
114 | mikedld | 3322 | Returned value: |
3323 | * function does not return value |
||
3324 | Remarks: |
||
118 | diamond | 3325 | * Byte is written to the buffer. Buffer size is 512 bytes. |
3326 | At buffer overflow all obtained data are lost. |
||
3327 | * For output to the debug board of more complicated objects |
||
3328 | (strings, numbers) it is enough to call this function in cycle. |
||
3329 | It is possible not to write the appropriate code manually and use |
||
3330 | file 'debug.inc', which is included into the distributive. |
||
114 | mikedld | 3331 | |
118 | diamond | 3332 | ----------------------------- Read byte ------------------------------ |
3333 | Takes away byte from the buffer. |
||
114 | mikedld | 3334 | Parameters: |
118 | diamond | 3335 | * eax = 63 - function number |
3336 | * ebx = 2 - subfunction number |
||
114 | mikedld | 3337 | Returned value: |
118 | diamond | 3338 | * eax = ebx = 0 - the buffer is empty |
3339 | * eax = byte, ebx = 1 - byte was successfully read |
||
114 | mikedld | 3340 | |
3341 | ====================================================================== |
||
118 | diamond | 3342 | ============== Function 64 - resize application memory. ============== |
114 | mikedld | 3343 | ====================================================================== |
3344 | Parameters: |
||
118 | diamond | 3345 | * eax = 64 - function number |
3346 | * ebx = 1 - unique subfunction |
||
3347 | * ecx = new memory size |
||
114 | mikedld | 3348 | Returned value: |
118 | diamond | 3349 | * eax = 0 - success |
3350 | * eax = 1 - not enough memory |
||
114 | mikedld | 3351 | Remarks: |
193 | diamond | 3352 | * There is another way to dynamically allocate/free memory - |
3353 | subfunctions 11, 12, 13 of function 68. |
||
3354 | * The function cannot be used together with 68.11, 68.12, 68.13. |
||
3355 | The function call will be ignored after creation of process heap |
||
3356 | with function 68.11. |
||
114 | mikedld | 3357 | |
3358 | ====================================================================== |
||
283 | diamond | 3359 | ======== Function 65 - draw image with palette in the window. ======== |
3360 | ====================================================================== |
||
3361 | Parameters: |
||
3362 | * eax = 65 - function number |
||
3363 | * ebx = pointer to the image |
||
3364 | * ecx = [size on axis x]*65536 + [size on axis y] |
||
3365 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
2730 | dunkaist | 3366 | * esi = number of bits per pixel, must be 1,2,4,8,9,15,16,24 or 32; |
1018 | diamond | 3367 | * edi = pointer to palette (2 to the power esi colors 0x00RRGGBB); |
3368 | ignored when esi > 8 |
||
314 | diamond | 3369 | * ebp = offset of next row data relative to previous row data |
283 | diamond | 3370 | Returned value: |
3371 | * function does not return value |
||
3372 | Remarks: |
||
3373 | * Coordinates of the image are coordinates of the upper left corner |
||
3374 | of the image relative to the window. |
||
1018 | diamond | 3375 | * Format of image with 1 bit per pixel: each byte of image |
3376 | (possibly excluding last bytes in rows), contains information on |
||
3377 | the color of 8 pixels, MSB corresponds to first pixel. |
||
3378 | * Format of image with 2 bits per pixel: each byte of image |
||
3379 | (possibly excluding last bytes in rows), contains information on |
||
3380 | the color of 4 pixels, two MSBs correspond to first pixel. |
||
3381 | * Format of image with 4 bits per pixel: each byte of image |
||
3382 | excluding last bytes in rows (if width is odd) contains |
||
3383 | information on the color of 2 pixels, high-order tetrad |
||
3384 | corresponds to first pixel. |
||
3385 | * Format of image with 8 bits per pixel: each byte of image is |
||
3386 | index in the palette. |
||
2730 | dunkaist | 3387 | * Format of image with 9 bits per pixel: array of one byte values; |
3388 | each byte (8 bit) represents the intensity of gray for one pixel; |
||
3389 | this format is equal to 8bpp without palette. |
||
1018 | diamond | 3390 | * Format of image with 15 bits per pixel: the color of each pixel |
3391 | is coded as (bit representation) 0RRRRRGGGGGBBBBB - 5 bits per |
||
3392 | each color. |
||
3393 | * Format of image with 16 bits per pixel: the color of each pixel |
||
3394 | is coded as RRRRRGGGGGGBBBBB (5+6+5). |
||
3395 | * Format of image with 24 bits per pixel: the color of each pixel |
||
3396 | is coded as 3 bytes - sequentially blue, green, red components. |
||
3397 | * Format of image with 32 bits per pixel: similar to 24, but |
||
3398 | one additional ignored byte is present. |
||
314 | diamond | 3399 | * The call to function 7 is equivalent to call to this function |
3400 | with esi=24, ebp=0. |
||
283 | diamond | 3401 | |
3402 | ====================================================================== |
||
118 | diamond | 3403 | ================== Function 66 - work with keyboard. ================= |
114 | mikedld | 3404 | ====================================================================== |
118 | diamond | 3405 | The input mode influences results of reading keys by function 2. |
3406 | When a program loads, ASCII input mode is set for it. |
||
114 | mikedld | 3407 | |
118 | diamond | 3408 | -------------- Subfunction 1 - set keyboard input mode. -------------- |
114 | mikedld | 3409 | Parameters: |
118 | diamond | 3410 | * eax = 66 - function number |
3411 | * ebx = 1 - subfunction number |
||
114 | mikedld | 3412 | * ecx = mode: |
3413 | * 0 = normal (ASCII-characters) |
||
3414 | * 1 = scancodes |
||
3415 | Returned value: |
||
3416 | * function does not return value |
||
3417 | |||
118 | diamond | 3418 | -------------- Subfunction 2 - get keyboard input mode. -------------- |
114 | mikedld | 3419 | Parameters: |
118 | diamond | 3420 | * eax = 66 - function number |
3421 | * ebx = 2 - subfunction number |
||
114 | mikedld | 3422 | Returned value: |
3423 | * eax = current mode |
||
3424 | |||
118 | diamond | 3425 | ------------ Subfunction 3 - get status of control keys. ------------- |
114 | mikedld | 3426 | Parameters: |
118 | diamond | 3427 | * eax = 66 - function number |
3428 | * ebx = 3 - subfunction number |
||
114 | mikedld | 3429 | Returned value: |
3430 | * eax = bit mask: |
||
3355 | mario79 | 3431 | * bit 0 (mask 1): left Shift is pressed |
3432 | * bit 1 (mask 2): right Shift is pressed |
||
3433 | * bit 2 (mask 4): left Ctrl is pressed |
||
3434 | * bit 3 (mask 8): right Ctrl is pressed |
||
3435 | * bit 4 (mask 0x10): left Alt is pressed |
||
3436 | * bit 5 (mask 0x20): right Alt is pressed |
||
3437 | * bit 6 (mask 0x40): CapsLock is on |
||
3438 | * bit 7 (mask 0x80): NumLock is on |
||
3439 | * bit 8 (mask 0x100): ScrollLock is on |
||
3440 | * bit 9 (mask 0x200): left Win is pressed |
||
3441 | * bit 10 (mask 0x400): right Win is pressed |
||
118 | diamond | 3442 | * other bits are cleared |
114 | mikedld | 3443 | |
118 | diamond | 3444 | -------------- Subfunction 4 - set system-wide hotkey. --------------- |
3445 | When hotkey is pressed, the system notifies only those applications, |
||
3446 | which have installed it; the active application (which receives |
||
3447 | all normal input) does not receive such keys. |
||
3448 | The notification consists in sending event with the code 2. |
||
3449 | Reading hotkey is the same as reading normal key - by function 2. |
||
114 | mikedld | 3450 | Parameters: |
118 | diamond | 3451 | * eax = 66 - function number |
3452 | * ebx = 4 - subfunction number |
||
3453 | * cl determines key scancode; |
||
3454 | use cl=0 to give combinations such as Ctrl+Shift |
||
3455 | * edx = 0xXYZ determines possible states of control keys: |
||
3456 | * Z (low 4 bits) determines state of LShift and RShift: |
||
3457 | * 0 = no key must be pressed; |
||
3458 | * 1 = exactly one key must be pressed; |
||
3459 | * 2 = both keys must be pressed; |
||
3460 | * 3 = must be pressed LShift, but not RShift; |
||
3461 | * 4 = must be pressed RShift, but not LShift |
||
3462 | * Y - similar for LCtrl and RCtrl; |
||
3463 | * X - similar for LAlt and RAlt |
||
114 | mikedld | 3464 | Returned value: |
118 | diamond | 3465 | * eax=0 - success |
3466 | * eax=1 - too mant hotkeys (maximum 256 are allowed) |
||
114 | mikedld | 3467 | Remarks: |
118 | diamond | 3468 | * Hotkey can work either at pressing or at release. Release |
3469 | scancode of a key is more on 128 than pressing scancode |
||
3470 | (i.e. high bit is set). |
||
3471 | * Several applications can set the same combination; |
||
3472 | all such applications will be informed on pressing |
||
3473 | such combination. |
||
114 | mikedld | 3474 | |
118 | diamond | 3475 | -------------- Subfunction 5 - delete installed hotkey. -------------- |
114 | mikedld | 3476 | Parameters: |
118 | diamond | 3477 | * eax = 66 - function number |
3478 | * ebx = 5 - subfunction number |
||
3479 | * cl = scancode of key and edx = 0xXYZ the same as in subfunction 4 |
||
114 | mikedld | 3480 | Returned value: |
118 | diamond | 3481 | * eax = 0 - success |
114 | mikedld | 3482 | * eax = 1 - there is no such hotkey |
3483 | Remarks: |
||
118 | diamond | 3484 | * When a process/thread terminates, all hotkey installed by it are |
3485 | deleted. |
||
3486 | * The call to this subfunction does not affect other applications. |
||
3487 | If other application has defined the same combination, it will |
||
3488 | still receive notices. |
||
114 | mikedld | 3489 | |
2709 | mario79 | 3490 | --------------- Subfunction 6 - block the normal input. -------------- |
3491 | Parameters: |
||
3492 | * eax = 66 - function number |
||
3493 | * ebx = 6 - subfunction number |
||
3494 | Returned value: |
||
3495 | * function does not return value |
||
3496 | Remarks: |
||
3497 | * Blocking the normal keyboard input for installed hotkeys |
||
3498 | * To emulate a mouse via the keyboard, the application MOUSEMUL |
||
3499 | |||
3500 | ------------ Subfunction 7 - unlock the normal input. ---------------- |
||
3501 | Parameters: |
||
3502 | * eax = 66 - function number |
||
3503 | * ebx = 7 - subfunction number |
||
3504 | Returned value: |
||
3505 | * function does not return value |
||
3506 | Remarks: |
||
3507 | * Unlocking the results of the f. 66.6 |
||
3508 | * To emulate a mouse via the keyboard, the application MOUSEMUL |
||
3509 | |||
114 | mikedld | 3510 | ====================================================================== |
118 | diamond | 3511 | ========= Function 67 - change position/sizes of the window. ========= |
114 | mikedld | 3512 | ====================================================================== |
3513 | Parameters: |
||
118 | diamond | 3514 | * eax = 67 - function number |
114 | mikedld | 3515 | * ebx = new x-coordinate of the window |
3516 | * ecx = new y-coordinate of the window |
||
3517 | * edx = new x-size of the window |
||
3518 | * esi = new y-size of the window |
||
3519 | Returned value: |
||
3520 | * function does not return value |
||
3521 | Remarks: |
||
118 | diamond | 3522 | * The value -1 for a parameter means "do not change"; e.g. to move |
3523 | the window without resizing it is possible to specify edx=esi=-1. |
||
3524 | * Previously the window must be defined by function 0. |
||
114 | mikedld | 3525 | It sets initial coordinates and sizes of the window. |
118 | diamond | 3526 | * Sizes of the window are understood in sense of function 0, |
3527 | that is one pixel less than real sizes. |
||
3528 | * The function call for maximized windows is simply ignored. |
||
3529 | * For windows of appropriate styles position and/or sizes can be |
||
3530 | changed by user; current position and sizes can be obtained by |
||
3531 | call to function 9. |
||
3532 | * The function sends to the window redraw event (with the code 1). |
||
114 | mikedld | 3533 | |
3534 | ====================================================================== |
||
118 | diamond | 3535 | ====== Function 68, subfunction 0 - get the task switch counter. ===== |
114 | mikedld | 3536 | ====================================================================== |
3537 | Parameters: |
||
118 | diamond | 3538 | * eax = 68 - function number |
3539 | * ebx = 0 - subfunction number |
||
114 | mikedld | 3540 | Returned value: |
118 | diamond | 3541 | * eax = number of task switches from the system booting |
3542 | (modulo 2^32) |
||
114 | mikedld | 3543 | |
3544 | ====================================================================== |
||
118 | diamond | 3545 | ======= Function 68, subfunction 1 - switch to the next thread. ====== |
114 | mikedld | 3546 | ====================================================================== |
118 | diamond | 3547 | The function completes the current time slice allocated to the |
3548 | thread and switches to the next. (Which thread in which process |
||
3549 | will be next, is unpredictable). Later, when execution queue |
||
3550 | will reach the current thread, execution will be continued. |
||
114 | mikedld | 3551 | Parameters: |
118 | diamond | 3552 | * eax = 68 - function number |
3553 | * ebx = 1 - subfunction number |
||
114 | mikedld | 3554 | Returned value: |
3555 | * function does not return value |
||
3556 | |||
3557 | ====================================================================== |
||
118 | diamond | 3558 | ============= Function 68, subfunction 2 - cache + rdpmc. ============ |
114 | mikedld | 3559 | ====================================================================== |
3560 | Parameters: |
||
118 | diamond | 3561 | * eax = 68 - function number |
3562 | * ebx = 2 - subfunction number |
||
3563 | * ecx = required action: |
||
3564 | * ecx = 0 - enable instruction 'rdpmc' |
||
3565 | (ReaD Performance-Monitoring Counters) for applications |
||
3566 | * ecx = 1 - find out whether cache is disabled/enabled |
||
3567 | * ecx = 2 - enable cache |
||
3568 | * ecx = 3 - disable cache |
||
114 | mikedld | 3569 | Returned value: |
3570 | * for ecx=0: |
||
118 | diamond | 3571 | * eax = the value of cr4 |
114 | mikedld | 3572 | * for ecx=1: |
3573 | * eax = (cr0 and 0x60000000): |
||
118 | diamond | 3574 | * eax = 0 - cache is on |
3575 | * eax <> 0 - cache is off |
||
114 | mikedld | 3576 | * for ecx=2 and ecx=3: |
3577 | * function does not return value |
||
3578 | |||
3579 | ====================================================================== |
||
3580 | =========== Function 68, subfunction 3 - read MSR-register. ========== |
||
3581 | ====================================================================== |
||
118 | diamond | 3582 | MSR = Model Specific Register; the complete list of MSR-registers |
3583 | of a processor is included to the documentation on it (for example, |
||
3584 | IA-32 Intel Architecture Software Developer's Manual, |
||
3585 | Volume 3, Appendix B); each processor family has its own subset |
||
3586 | of the MSR-registers. |
||
114 | mikedld | 3587 | Parameters: |
118 | diamond | 3588 | * eax = 68 - function number |
3589 | * ebx = 3 - subfunction number |
||
3590 | * ecx is ignored |
||
3591 | * edx = MSR address |
||
114 | mikedld | 3592 | Returned value: |
118 | diamond | 3593 | * ebx:eax = high:low dword of the result |
114 | mikedld | 3594 | Remarks: |
118 | diamond | 3595 | * If ecx contains nonexistent or not implemented for this processor |
3596 | MSR, processor will generate an exception in the kernel, which |
||
3597 | will kill the thread. |
||
3598 | * Previously it is necessary to check, whether MSRs are supported |
||
3599 | as a whole, with the instruction 'cpuid'. Otherwise processor |
||
3600 | will generate other exception in the kernel, which will anyway |
||
3601 | kill the thread. |
||
114 | mikedld | 3602 | |
3603 | ====================================================================== |
||
118 | diamond | 3604 | ========= Function 68, subfunction 4 - write to MSR-register. ======== |
114 | mikedld | 3605 | ====================================================================== |
118 | diamond | 3606 | MSR = Model Specific Register; the complete list of MSR-registers |
3607 | of a processor is included to the documentation on it (for example, |
||
3608 | IA-32 Intel Architecture Software Developer's Manual, |
||
3609 | Volume 3, Appendix B); each processor family has its own subset |
||
3610 | of the MSR-registers. |
||
114 | mikedld | 3611 | Parameters: |
118 | diamond | 3612 | * eax = 68 - function number |
3613 | * ebx = 4 - subfunction number |
||
3614 | * ecx is ignored |
||
3615 | * edx = MSR address |
||
3616 | * esi:edi = high:low dword |
||
114 | mikedld | 3617 | Returned value: |
499 | diamond | 3618 | * function does not return value |
3619 | Remarks: |
||
118 | diamond | 3620 | * If ecx contains nonexistent or not implemented for this processor |
3621 | MSR, processor will generate an exception in the kernel, which |
||
3622 | will kill the thread. |
||
3623 | * Previously it is necessary to check, whether MSRs are supported |
||
3624 | as a whole, with the instruction 'cpuid'. Otherwise processor |
||
3625 | will generate other exception in the kernel, which will anyway |
||
3626 | kill the thread. |
||
114 | mikedld | 3627 | |
3628 | ====================================================================== |
||
193 | diamond | 3629 | ======= Function 68, subfunction 11 - initialize process heap. ======= |
114 | mikedld | 3630 | ====================================================================== |
3631 | Parameters: |
||
118 | diamond | 3632 | * eax = 68 - function number |
193 | diamond | 3633 | * ebx = 11 - subfunction number |
114 | mikedld | 3634 | Returned value: |
193 | diamond | 3635 | * eax = 0 - failed |
3636 | * otherwise size of created heap |
||
114 | mikedld | 3637 | Remarks: |
193 | diamond | 3638 | * The function call initializes heap, from which one can in future |
3639 | allocate and free memory blocks with subfunctions 12 and 13. |
||
3640 | Heap size is equal to total amount of free application memory. |
||
3641 | * The second function call from the same process results in |
||
3642 | returning the size of the existing heap. |
||
3643 | * After creation of the heap calls to function 64 will be ignored. |
||
114 | mikedld | 3644 | |
3645 | ====================================================================== |
||
193 | diamond | 3646 | ======== Function 68, subfunction 12 - allocate memory block. ======== |
114 | mikedld | 3647 | ====================================================================== |
3648 | Parameters: |
||
118 | diamond | 3649 | * eax = 68 - function number |
193 | diamond | 3650 | * ebx = 12 - subfunction number |
3651 | * ecx = required size in bytes |
||
114 | mikedld | 3652 | Returned value: |
193 | diamond | 3653 | * eax = pointer to the allocated block |
114 | mikedld | 3654 | Remarks: |
193 | diamond | 3655 | * Before this call one must initialize process heap by call to |
3656 | subfunction 11. |
||
3657 | * The function allocates an integer number of pages (4 Kb) in such |
||
3658 | way that the real size of allocated block is more than or equal to |
||
3659 | requested size. |
||
114 | mikedld | 3660 | |
3661 | ====================================================================== |
||
193 | diamond | 3662 | ========== Function 68, subfunction 13 - free memory block. ========== |
114 | mikedld | 3663 | ====================================================================== |
3664 | Parameters: |
||
118 | diamond | 3665 | * eax = 68 - function number |
193 | diamond | 3666 | * ebx = 13 - subfunction number |
3667 | * ecx = pointer to the memory block |
||
114 | mikedld | 3668 | Returned value: |
193 | diamond | 3669 | * eax = 1 - success |
3670 | * eax = 0 - failed |
||
114 | mikedld | 3671 | Remarks: |
448 | diamond | 3672 | * The memory block must have been allocated by subfunction 12 |
3673 | or subfunction 20. |
||
114 | mikedld | 3674 | |
3675 | ====================================================================== |
||
1074 | Galkov | 3676 | ===================== Function 68, subfunction 14 ==================== |
1662 | Nasarus | 3677 | ============ Wait for signal from another program/driver. ============ |
114 | mikedld | 3678 | ====================================================================== |
3679 | Parameters: |
||
118 | diamond | 3680 | * eax = 68 - function number |
193 | diamond | 3681 | * ebx = 14 - subfunction number |
1074 | Galkov | 3682 | * ecx = pointer to the buffer for information (24 bytes) |
114 | mikedld | 3683 | Returned value: |
193 | diamond | 3684 | * buffer pointed to by ecx contains the following information: |
1662 | Nasarus | 3685 | * +0: dword: identifier for following data of signal |
3686 | * +4: dword: data of signal (20 bytes), format of which is defined |
||
3687 | by the first dword |
||
114 | mikedld | 3688 | |
3689 | ====================================================================== |
||
193 | diamond | 3690 | ============= Function 68, subfunction 16 - load driver. ============= |
3691 | ====================================================================== |
||
3692 | Parameters: |
||
3693 | * eax = 68 - function number |
||
3694 | * ebx = 16 - subfunction number |
||
3695 | * ecx = pointer to ASCIIZ-string with driver name |
||
3696 | Returned value: |
||
3697 | * eax = 0 - failed |
||
3698 | * otherwise eax = driver handle |
||
3699 | Remarks: |
||
3700 | * If the driver was not loaded yet, it is loaded; |
||
3701 | if the driver was loaded yet, nothing happens. |
||
3702 | * Driver name is case-sensitive. |
||
3703 | Maximum length of the name is 16 characters, including |
||
3704 | terminating null character, the rest is ignored. |
||
346 | diamond | 3705 | * Driver ABC is loaded from file /rd/1/drivers/ABC.obj. |
193 | diamond | 3706 | |
3707 | ====================================================================== |
||
3708 | ============ Function 68, subfunction 17 - driver control. =========== |
||
3709 | ====================================================================== |
||
3710 | Parameters: |
||
3711 | * eax = 68 - function number |
||
3712 | * ebx = 17 - subfunction number |
||
3713 | * ecx = pointer to the control structure: |
||
3714 | * +0: dword: handle of driver |
||
3715 | * +4: dword: code of driver function |
||
3716 | * +8: dword: pointer to input data |
||
3717 | * +12 = +0xC: dword: size of input data |
||
3718 | * +16 = +0x10: dword: pointer to output data |
||
3719 | * +20 = +0x14: dword: size of output data |
||
3720 | Returned value: |
||
1662 | Nasarus | 3721 | * eax = determined by driver |
193 | diamond | 3722 | Remarks: |
3723 | * Function codes and the structure of input/output data |
||
3724 | are defined by driver. |
||
3725 | * Previously one must obtain driver handle by subfunction 16. |
||
3726 | |||
3727 | ====================================================================== |
||
277 | diamond | 3728 | =============== Function 68, subfunction 19 - load DLL. ============== |
3729 | ====================================================================== |
||
3730 | Parameters: |
||
3731 | * eax = 68 - function number |
||
3732 | * ebx = 19 - subfunction number |
||
3733 | * ecx = pointer to ASCIIZ-string with the full path to DLL |
||
3734 | Returned value: |
||
3735 | * eax = 0 - failed |
||
3736 | * otherwise eax = pointer to DLL export table |
||
3737 | Remarks: |
||
3738 | * Export table is an array of structures of 2 dword's, terminated |
||
3739 | by zero. The first dword in structure points to function name, |
||
3740 | the second dword contains address of function. |
||
3741 | |||
3742 | ====================================================================== |
||
448 | diamond | 3743 | ======= Function 68, subfunction 20 - reallocate memory block. ======= |
3744 | ====================================================================== |
||
3745 | Parameters: |
||
3746 | * eax = 68 - function number |
||
3747 | * ebx = 20 - subfunction number |
||
3748 | * ecx = new size in bytes |
||
3749 | * edx = pointer to already allocated block |
||
3750 | Returned value: |
||
3751 | * eax = pointer to the reallocated block, 0 = error |
||
3752 | Remarks: |
||
3753 | * Before this call one must initialize process heap by call to |
||
3754 | subfunction 11. |
||
3755 | * The function allocates an integer number of pages (4 Kb) in such |
||
3756 | way that the real size of allocated block is more than or equal to |
||
3757 | requested size. |
||
3758 | * If edx=0, the function call is equivalent to memory allocation |
||
3759 | with subfunction 12. Otherwise the block at edx |
||
3760 | must be allocated earlier with subfunction 12 or this subfunction. |
||
3761 | * If ecx=0, the function frees memory block at edx and returns 0. |
||
3762 | * The contents of the block are unchanged up to the shorter of |
||
3763 | the new and old sizes. |
||
3764 | |||
3765 | ====================================================================== |
||
2646 | mario79 | 3766 | =========== Function 68, subfunction 21 - load driver PE. ============ |
3767 | ====================================================================== |
||
3768 | Parameters: |
||
3769 | * eax = 68 - function number |
||
3770 | * ebx = 21 - subfunction number |
||
3771 | * ecx = pointer to ASCIIZ-string with driver name |
||
2647 | mario79 | 3772 | * edx = pointer to command line |
2646 | mario79 | 3773 | Returned value: |
3774 | * eax = 0 - failed |
||
3775 | * otherwise eax = driver handle |
||
3776 | Remarks: |
||
3777 | * If the driver was not loaded yet, it is loaded; |
||
3778 | if the driver was loaded yet, nothing happens. |
||
3779 | |||
3780 | ====================================================================== |
||
1662 | Nasarus | 3781 | ======== Function 68, subfunction 22 - open named memory area. ======= |
1077 | Galkov | 3782 | ====================================================================== |
3783 | Parameters: |
||
3784 | * eax = 68 - function number |
||
1662 | Nasarus | 3785 | * ebx = 22 - subfunction number |
3786 | * ecx = area name. Maximum of 31 characters with terminating zero |
||
3787 | * edx = area size in bytes for SHM_CREATE and SHM_OPEN_ALWAYS |
||
3788 | * esi = flags for open and access: |
||
3789 | * SHM_OPEN = 0x00 - open existing memory area. If an area |
||
3790 | with such name does not exist, the function |
||
3791 | will return error code 5. |
||
3792 | * SHM_OPEN_ALWAYS = 0x04 - open existing or create new |
||
3793 | memory area. |
||
3794 | * SHM_CREATE = 0x08 - create new memory area. If an area |
||
3795 | with such name already exists, the function |
||
3796 | will return error code 10. |
||
3797 | * SHM_READ = 0x00 - only read access |
||
3798 | * SHM_WRITE = 0x01 - read and write access |
||
3799 | Returned value: |
||
3800 | * eax = pointer to memory area, 0 if error has occured |
||
3801 | * if new area is created (SHM_CREATE or SHM_OPEN_ALWAYS): |
||
3802 | edx = 0 - success, otherwise - error code |
||
3803 | * if existing area is opened (SHM_OPEN or SHM_OPEN_ALWAYS): |
||
3804 | edx = error code (if eax=0) or area size in bytes |
||
3805 | Error codes: |
||
3806 | * E_NOTFOUND = 5 |
||
3807 | * E_ACCESS = 10 |
||
3808 | * E_NOMEM = 30 |
||
3809 | * E_PARAM = 33 |
||
3810 | Remarks: |
||
3811 | * Before this call one must initialize process heap by call to |
||
3812 | subfunction 11. |
||
3813 | * If a new area is created, access flags set maximal rights |
||
3814 | for other processes. An attempt from other process to open |
||
3815 | with denied rights will fail with error code E_ACCESS. |
||
3816 | * The process which has created an area always has write access. |
||
3817 | |||
3818 | ====================================================================== |
||
3819 | ======= Function 68, subfunction 23 - close named memory area. ======= |
||
3820 | ====================================================================== |
||
3821 | Parameters: |
||
3822 | * eax = 68 - function number |
||
3823 | * ebx = 23 - subfunction number |
||
3824 | * ecx = area name. Maximum of 31 characters with terminating zero |
||
3825 | Returned value: |
||
3826 | * eax destroyed |
||
3827 | Remarks: |
||
3828 | * A memory area is physically freed (with deleting all data and |
||
3829 | freeing physical memory), when all threads which have opened |
||
3830 | this area will close it. |
||
3831 | * When thread is terminating, all opened by it areas are closed. |
||
3832 | |||
3833 | ====================================================================== |
||
3834 | ======== Function 68, subfunction 24 - set exception handler. ======== |
||
3835 | ====================================================================== |
||
3836 | Parameters: |
||
3837 | * eax = 68 - function number |
||
1077 | Galkov | 3838 | * ebx = 24 - subfunction number |
3839 | * ecx = address of the new exception handler |
||
1662 | Nasarus | 3840 | * edx = the mask of handled exceptions |
1077 | Galkov | 3841 | Returned value: |
3842 | * eax = address of the old exception handler (0, if it was not set) |
||
1662 | Nasarus | 3843 | * ebx = the old mask of handled exceptions |
1077 | Galkov | 3844 | Remarks: |
1662 | Nasarus | 3845 | * Bit number in mask of exceptions corresponds to exception number |
3846 | in CPU-specification (Intel-PC). For example, FPU exceptions have |
||
3847 | number 16 (#MF), and SSE exceptions - 19 (#XF). |
||
3848 | * The current implementation ignores the inquiry for hook of 7 |
||
3849 | exception - the system handles #NM by its own. |
||
3850 | * The exception handler is called with exception number as first |
||
3851 | (and only) stack parameter. So, correct exit from the handler is |
||
3852 | RET 4. It returns to the instruction, that caused the exception, |
||
3853 | for faults, and to the next instruction for traps (see |
||
3854 | classification of exceptions in CPU specification). |
||
3855 | * When user handler receives control, the corresponding bit in |
||
3856 | the exception mask is cleared. Raising this exception |
||
3857 | in consequence leads to default handling, that is, |
||
3858 | terminating the application in absence of debugger or |
||
3859 | suspend with notification of debugger otherwise. |
||
3860 | * After user handler completes critical operations, it can set |
||
3861 | the corresponding bit in the exception mask with subfunction 25. |
||
3862 | Also user handler is responsible for clearing exceptions flags in |
||
3863 | FPU and/or SSE. |
||
1077 | Galkov | 3864 | |
3865 | ====================================================================== |
||
1662 | Nasarus | 3866 | ====== Function 68, subfunction 25 - set FPU exception handler. ====== |
1077 | Galkov | 3867 | ====================================================================== |
3868 | Parameters: |
||
3869 | * eax = 68 - function number |
||
3870 | * ebx = 25 - subfunction number |
||
3871 | * ecx = signal number |
||
3872 | * edx = value of activity (0/1) |
||
3873 | Returned value: |
||
1662 | Nasarus | 3874 | * eax = -1 - invalid signal number |
3875 | * otherwise eax = old value of activity for this signal (0/1) |
||
1077 | Galkov | 3876 | Remarks: |
1662 | Nasarus | 3877 | * In current implementation only mask for user excepton handler, |
3878 | which has been previously set by subfunction 24, |
||
3879 | is changed. Signal number corresponds to exception number. |
||
1077 | Galkov | 3880 | |
3881 | ====================================================================== |
||
1662 | Nasarus | 3882 | ====================== Function 69 - debugging. ====================== |
114 | mikedld | 3883 | ====================================================================== |
118 | diamond | 3884 | A process can load other process as debugged by set of corresponding |
193 | diamond | 3885 | bit by call to subfunction 7 of function 70. |
118 | diamond | 3886 | A process can have only one debugger; one process can debug some |
3887 | others. The system notifies debugger on events occuring with |
||
3888 | debugged process. Messages are written to the buffer defined by |
||
114 | mikedld | 3889 | subfunction 0. |
118 | diamond | 3890 | Format of a message: |
3891 | * +0: dword: message code |
||
3892 | * +4: dword: PID of debugged process |
||
3893 | * +8: there can be additional data depending on message code |
||
3894 | Message codes: |
||
114 | mikedld | 3895 | * 1 = exception |
118 | diamond | 3896 | * in addition dword-number of the exception is given |
3897 | * process is suspended |
||
3898 | * 2 = process has terminated |
||
3899 | * comes at any termination: both through the system function -1, |
||
3900 | and at "murder" by any other process (including debugger itself) |
||
114 | mikedld | 3901 | * 3 = debug exception int 1 = #DB |
118 | diamond | 3902 | * in addition dword-image of the register DR6 is given: |
3903 | * bits 0-3: condition of the corresponding breakpoint (set by |
||
3904 | subfunction 9) is satisfied |
||
3539 | clevermous | 3905 | * bit 14: exception has occured because of the trace mode |
118 | diamond | 3906 | (flag TF is set TF) |
3907 | * process is suspended |
||
3908 | When debugger terminates, all debugged processes are killed. |
||
3909 | If debugger does not want this, it must previously detach by |
||
114 | mikedld | 3910 | subfunction 3. |
3911 | |||
1018 | diamond | 3912 | All subfunctions are applicable only to processes/threads started |
3913 | from the current by function 70 with set debugging flag. |
||
118 | diamond | 3914 | Debugging of multithreaded programs is not supported yet. |
3915 | The full list of subfunctions: |
||
3916 | * subfunction 0 - define data area for debug messages |
||
3917 | * subfunction 1 - get contents of registers of debugged thread |
||
3918 | * subfunction 2 - set contents of registers of debugged thread |
||
3919 | * subfunction 3 - detach from debugged process |
||
3920 | * subfunction 4 - suspend debugged thread |
||
3921 | * subfunction 5 - resume debugged thread |
||
3922 | * subfunction 6 - read from the memory of debugged process |
||
3923 | * subfunction 7 - write to the memory of debugged process |
||
3924 | * subfunction 8 - terminate debugged thread |
||
3925 | * subfunction 9 - set/clear hardware breakpoint |
||
114 | mikedld | 3926 | |
3927 | ====================================================================== |
||
118 | diamond | 3928 | = Function 69, subfunction 0 - define data area fror debug messages. = |
114 | mikedld | 3929 | ====================================================================== |
3930 | Parameters: |
||
118 | diamond | 3931 | * eax = 69 - function number |
3932 | * ebx = 0 - subfunction number |
||
114 | mikedld | 3933 | * ecx = pointer |
3934 | Format of data area: |
||
118 | diamond | 3935 | * +0: dword: N = buffer size (not including this header) |
3936 | * +4: dword: occupied place |
||
114 | mikedld | 3937 | * +8: N*byte: buffer |
3938 | Returned value: |
||
3939 | * function does not return value |
||
3940 | Remarks: |
||
118 | diamond | 3941 | * If the size field is negative, the buffer is considered locked |
3942 | and at arrival of new message the system will wait. |
||
3943 | For synchronization frame all work with the buffer by operations |
||
3944 | lock/unlock |
||
1662 | Nasarus | 3945 | neg [bufsize] |
118 | diamond | 3946 | * Data in the buffer are considered as array of items with variable |
3947 | length - messages. Format of a message is explained in |
||
3948 | general description. |
||
114 | mikedld | 3949 | |
3950 | ====================================================================== |
||
118 | diamond | 3951 | ===================== Function 69, subfunction 1 ===================== |
3952 | ============ Get contents of registers of debugged thread. =========== |
||
114 | mikedld | 3953 | ====================================================================== |
3954 | Parameters: |
||
118 | diamond | 3955 | * eax = 69 - function number |
3956 | * ebx = 1 - subfunction number |
||
114 | mikedld | 3957 | * ecx = thread identifier |
118 | diamond | 3958 | * edx = size of context structure, must be 0x28=40 bytes |
3959 | * esi = pointer to context structure |
||
114 | mikedld | 3960 | Returned value: |
3961 | * function does not return value |
||
118 | diamond | 3962 | Format of context structure: (FPU is not supported yet) |
114 | mikedld | 3963 | * +0: dword: eip |
3964 | * +4: dword: eflags |
||
3965 | * +8: dword: eax |
||
3966 | * +12 = +0xC: dword: ecx |
||
3967 | * +16 = +0x10: dword: edx |
||
3968 | * +20 = +0x14: dword: ebx |
||
3969 | * +24 = +0x18: dword: esp |
||
3970 | * +28 = +0x1C: dword: ebp |
||
3971 | * +32 = +0x20: dword: esi |
||
3972 | * +36 = +0x24: dword: edi |
||
3973 | Remarks: |
||
118 | diamond | 3974 | * If the thread executes code of ring-0, the function returns |
3975 | contents of registers of ring-3. |
||
3976 | * Process must be loaded for debugging (as is shown in |
||
3977 | general description). |
||
114 | mikedld | 3978 | |
3979 | ====================================================================== |
||
118 | diamond | 3980 | ===================== Function 69, subfunction 2 ===================== |
3981 | ============ Set contents of registers of debugged thread. =========== |
||
114 | mikedld | 3982 | ====================================================================== |
3983 | Parameters: |
||
118 | diamond | 3984 | * eax = 69 - function number |
3985 | * ebx = 2 - subfunction number |
||
114 | mikedld | 3986 | * ecx = thread identifier |
118 | diamond | 3987 | * edx = size of context structure, must be 0x28=40 bytes |
114 | mikedld | 3988 | Returned value: |
3989 | * function does not return value |
||
118 | diamond | 3990 | Format of context structure is shown in the description of |
3991 | subfunction 1. |
||
114 | mikedld | 3992 | Remarks: |
118 | diamond | 3993 | * If the thread executes code of ring-0, the function returns |
3994 | contents of registers of ring-3. |
||
3995 | * Process must be loaded for debugging (as is shown in |
||
3996 | general description). |
||
114 | mikedld | 3997 | |
3998 | ====================================================================== |
||
118 | diamond | 3999 | ===== Function 69, subfunction 3 - detach from debugged process. ===== |
114 | mikedld | 4000 | ====================================================================== |
4001 | Parameters: |
||
118 | diamond | 4002 | * eax = 69 - function number |
4003 | * ebx = 3 - subfunction number |
||
114 | mikedld | 4004 | * ecx = identifier |
4005 | Returned value: |
||
4006 | * function does not return value |
||
4007 | Remarks: |
||
118 | diamond | 4008 | * If the process was suspended, it resumes execution. |
114 | mikedld | 4009 | |
4010 | ====================================================================== |
||
1018 | diamond | 4011 | ======== Function 69, subfunction 4 - suspend debugged thread. ======= |
114 | mikedld | 4012 | ====================================================================== |
4013 | Parameters: |
||
118 | diamond | 4014 | * eax = 69 - function number |
4015 | * ebx = 4 - subfunction number |
||
4016 | * ecx = thread identifier |
||
114 | mikedld | 4017 | Returned value: |
4018 | * function does not return value |
||
1018 | diamond | 4019 | Remarks: |
4020 | * Process must be loaded for debugging (as is shown in |
||
4021 | general description). |
||
114 | mikedld | 4022 | |
4023 | ====================================================================== |
||
1018 | diamond | 4024 | ======== Function 69, subfunction 5 - resume debugged thread. ======== |
114 | mikedld | 4025 | ====================================================================== |
4026 | Parameters: |
||
118 | diamond | 4027 | * eax = 69 - function number |
4028 | * ebx = 5 - subfunction number |
||
4029 | * ecx = thread identifier |
||
114 | mikedld | 4030 | Returned value: |
4031 | * function does not return value |
||
1018 | diamond | 4032 | Remarks: |
4033 | * Process must be loaded for debugging (as is shown in |
||
4034 | general description). |
||
114 | mikedld | 4035 | |
4036 | ====================================================================== |
||
118 | diamond | 4037 | = Fucntion 69, subfunction 6 - read from memory of debugged process. = |
114 | mikedld | 4038 | ====================================================================== |
4039 | Parameters: |
||
118 | diamond | 4040 | * eax = 69 - function number |
4041 | * ebx = 6 - subfunction number |
||
114 | mikedld | 4042 | * ecx = identifier |
118 | diamond | 4043 | * edx = number of bytes to read |
4044 | * esi = address in the memory of debugged process |
||
4045 | * edi = pointer to buffer for data |
||
114 | mikedld | 4046 | Returned value: |
118 | diamond | 4047 | * eax = -1 at an error (invalid PID or buffer) |
4048 | * otherwise eax = number of read bytes (possibly, 0, |
||
4049 | if esi is too large) |
||
114 | mikedld | 4050 | Remarks: |
118 | diamond | 4051 | * Process must be loaded for debugging (as is shown in |
4052 | general description). |
||
114 | mikedld | 4053 | |
4054 | ====================================================================== |
||
118 | diamond | 4055 | == Function 69, subfunction 7 - write to memory of debugged process. = |
114 | mikedld | 4056 | ====================================================================== |
4057 | Parameters: |
||
118 | diamond | 4058 | * eax = 69 - function number |
4059 | * ebx = 7 - subfunction number |
||
114 | mikedld | 4060 | * ecx = identifier |
118 | diamond | 4061 | * edx = number of bytes to write |
4062 | * esi = address of memory in debugged process |
||
4063 | * edi = pointer to data |
||
114 | mikedld | 4064 | Returned value: |
118 | diamond | 4065 | * eax = -1 at an error (invalid PID or buffer) |
4066 | * otherwise eax = number of written bytes (possibly, 0, |
||
4067 | if esi is too large) |
||
114 | mikedld | 4068 | Remarks: |
118 | diamond | 4069 | * Process must be loaded for debugging (as is shown in |
4070 | general description). |
||
114 | mikedld | 4071 | |
4072 | ====================================================================== |
||
118 | diamond | 4073 | ======= Function 69, subfunction 8 - terminate debugged thread. ====== |
114 | mikedld | 4074 | ====================================================================== |
4075 | Parameters: |
||
118 | diamond | 4076 | * eax = 69 - function number |
4077 | * ebx = 8 - subfunction number |
||
114 | mikedld | 4078 | * ecx = identifier |
4079 | Returned value: |
||
4080 | * function does not return value |
||
4081 | Remarks: |
||
118 | diamond | 4082 | * Process must be loaded for debugging (as is shown in |
4083 | general description). |
||
4084 | * The function is similar to subfunction 2 of function 18 |
||
4085 | with two differences: it requires first remark and |
||
4086 | accepts PID rather than slot number. |
||
114 | mikedld | 4087 | |
4088 | ====================================================================== |
||
118 | diamond | 4089 | ===== Function 69, subfunction 9 - set/clear hardware breakpoint. ==== |
114 | mikedld | 4090 | ====================================================================== |
4091 | Parameters: |
||
118 | diamond | 4092 | * eax = 69 - function number |
4093 | * ebx = 9 - subfunction number |
||
114 | mikedld | 4094 | * ecx = thread identifier |
118 | diamond | 4095 | * dl = index of breakpoint, from 0 to 3 inclusively |
114 | mikedld | 4096 | * dh = flags: |
118 | diamond | 4097 | * if high bit is cleared - set breakpoint: |
114 | mikedld | 4098 | * bits 0-1 - condition: |
4099 | * 00 = breakpoint on execution |
||
118 | diamond | 4100 | * 01 = breakpoint on read |
4101 | * 11 = breakpoint on read/write |
||
4102 | * bits 2-3 - length; for breakpoints on exception it must be |
||
4103 | 00, otherwise one of |
||
4104 | * 00 = byte |
||
114 | mikedld | 4105 | * 01 = word |
118 | diamond | 4106 | * 11 = dword |
4107 | * esi = breakpoint address; must be aligned according to |
||
4108 | the length (i.e. must be even for word breakpoints, |
||
4109 | divisible by 4 for dword) |
||
4110 | * if high bit is set - clear breakpoint |
||
114 | mikedld | 4111 | Returned value: |
118 | diamond | 4112 | * eax = 0 - success |
114 | mikedld | 4113 | * eax = 1 - error in the input data |
118 | diamond | 4114 | * eax = 2 - (reserved, is never returned in the current |
4115 | implementation) a global breakpoint with that index is already set |
||
114 | mikedld | 4116 | Remarks: |
118 | diamond | 4117 | * Process must be loaded for debugging (as is shown in |
4118 | general description). |
||
4119 | * Hardware breakpoints are implemented through DRx-registers of |
||
4120 | the processor, all limitations results from this. |
||
4121 | * The function can reinstall the breakpoint, previously set |
||
4122 | by it (and it does not inform on this). |
||
4123 | Carry on the list of set breakpoints in the debugger. |
||
4124 | * Breakpoints generate debug exception #DB, on which the system |
||
4125 | notifies debugger. |
||
4126 | * Breakpoints on write and read/write act after |
||
4127 | execution of the caused it instruction. |
||
114 | mikedld | 4128 | |
4129 | ====================================================================== |
||
118 | diamond | 4130 | ==== Function 70 - work with file system with long names support. ==== |
114 | mikedld | 4131 | ====================================================================== |
4132 | Parameters: |
||
4133 | * eax = 70 |
||
118 | diamond | 4134 | * ebx = pointer to the information structure |
114 | mikedld | 4135 | Returned value: |
118 | diamond | 4136 | * eax = 0 - success; otherwise file system error code |
4137 | * some subfunctions return value in other registers too |
||
4138 | General format of the information structure: |
||
4139 | * +0: dword: subfunction number |
||
4140 | * +4: dword: file offset |
||
4141 | * +8: dword: high dword of offset (must be 0) or flags field |
||
114 | mikedld | 4142 | * +12 = +0xC: dword: size |
118 | diamond | 4143 | * +16 = +0x10: dword: pointer to data |
4144 | * +20 = +0x14: n db: ASCIIZ-string with the filename |
||
114 | mikedld | 4145 | or |
4146 | * +20 = +0x14: db 0 |
||
118 | diamond | 4147 | * +21 = +0x15: dd pointer to ASCIIZ-string with the filename |
4148 | Specifications - in documentation on the appropriate subfunction. |
||
4149 | Filename is case-insensitive. Russian letters must be written in |
||
4150 | the encoding cp866 (DOS). |
||
4151 | Format of filename: |
||
114 | mikedld | 4152 | /base/number/dir1/dir2/.../dirn/file, |
118 | diamond | 4153 | where /base/number identifies device, on which file is located: |
114 | mikedld | 4154 | one of |
118 | diamond | 4155 | * /RD/1 = /RAMDISK/1 to access ramdisk |
4156 | * /FD/1 = /FLOPPYDISK/1 to access first floppy drive, |
||
4157 | /FD/2 = /FLOPPYDISK/2 to access second one |
||
4158 | * /HD0/x, /HD1/x, /HD2/x, /HD3/x to access accordingly to devices |
||
4159 | IDE0 (Primary Master), IDE1 (Primary Slave), |
||
114 | mikedld | 4160 | IDE2 (Secondary Master), IDE3 (Secondary Slave); |
118 | diamond | 4161 | x - partition number on the selected hard drive, varies from 1 |
4162 | to 255 (on each hard drive the indexing starts from 1) |
||
4163 | * /CD0/1, /CD1/1, /CD2/1, /CD3/1 to access accordingly to |
||
4164 | CD on IDE0 (Primary Master), IDE1 (Primary Slave), |
||
4165 | IDE2 (Secondary Master), IDE3 (Secondary Slave) |
||
546 | diamond | 4166 | * /SYS means system folder; with the usual boot (from floppy) |
4167 | is equivalent to /RD/1 |
||
114 | mikedld | 4168 | Examples: |
4169 | * '/rd/1/kernel.asm',0 |
||
4170 | * '/HD0/1/kernel.asm',0 |
||
4171 | * '/hd0/2/menuet/pics/tanzania.bmp',0 |
||
4172 | * '/hd0/1/Program files/NameOfProgram/SomeFile.SomeExtension',0 |
||
546 | diamond | 4173 | * '/sys/MySuperApp.ini',0 |
1662 | Nasarus | 4174 | Also function supports relative names. If the path begins not |
4175 | with '/', it is considered relative to a current folder. To get or |
||
4176 | set a current folder, use the function 30. |
||
4177 | |||
118 | diamond | 4178 | Available subfunctions: |
114 | mikedld | 4179 | * subfunction 0 - read file |
4180 | * subfunction 1 - read folder |
||
4181 | * subfunction 2 - create/rewrite file |
||
131 | diamond | 4182 | * subfunction 3 - write to existing file |
133 | diamond | 4183 | * subfunction 4 - set file size |
118 | diamond | 4184 | * subfunction 5 - get attributes of file/folder |
4185 | * subfunction 6 - set attributes of file/folder |
||
114 | mikedld | 4186 | * subfunction 7 - start application |
193 | diamond | 4187 | * subfunction 8 - delete file/folder |
321 | diamond | 4188 | * subfunction 9 - create folder |
118 | diamond | 4189 | For CD-drives due to hardware limitations only subfunctions |
4190 | 0,1,5 and 7 are available, other subfunctions return error |
||
4191 | with code 2. |
||
641 | diamond | 4192 | At the first call of subfunctions 0,1,5,7 to ATAPI devices |
4193 | (CD and DVD) the manual control of tray is locked due to caching |
||
4194 | drive data. Unlocking is made when subfunction 4 of function 24 |
||
4195 | is called for corresponding device. |
||
114 | mikedld | 4196 | |
4197 | ====================================================================== |
||
118 | diamond | 4198 | === Function 70, subfunction 0 - read file with long names support. == |
114 | mikedld | 4199 | ====================================================================== |
4200 | Parameters: |
||
118 | diamond | 4201 | * eax = 70 - function number |
4202 | * ebx = pointer to the information structure |
||
4203 | Format of the information structure: |
||
4204 | * +0: dword: 0 = subfunction number |
||
4205 | * +4: dword: file offset (in bytes) |
||
4206 | * +8: dword: 0 (reserved for high dword of offset) |
||
4207 | * +12 = +0xC: dword: number of bytes to read |
||
4208 | * +16 = +0x10: dword: pointer to buffer for data |
||
4209 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
||
4210 | given in the general description |
||
114 | mikedld | 4211 | or |
4212 | * +20 = +0x14: db 0 |
||
118 | diamond | 4213 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
114 | mikedld | 4214 | Returned value: |
118 | diamond | 4215 | * eax = 0 - success, otherwise file system error code |
4216 | * ebx = number of read bytes or -1=0xffffffff if file was not found |
||
114 | mikedld | 4217 | Remarks: |
118 | diamond | 4218 | * If file was ended before last requested block was read, |
4219 | the function will read as many as it can, and after that return |
||
4220 | eax=6 (EOF). |
||
4221 | * The function does not allow to read folder (returns eax=10, |
||
4222 | access denied). |
||
114 | mikedld | 4223 | |
118 | diamond | 4224 | ====================================================================== |
4225 | == Function 70, subfunction 1 - read folder with long names support. = |
||
4226 | ====================================================================== |
||
114 | mikedld | 4227 | Parameters: |
118 | diamond | 4228 | * eax = 70 - function number |
4229 | * ebx = pointer to the information structure |
||
4230 | Format of the information structure: |
||
4231 | * +0: dword: 1 = subfunction number |
||
4232 | * +4: dword: index of starting block (beginning from 0) |
||
4233 | * +8: dword: flags field: |
||
114 | mikedld | 4234 | * bit 0 (mask 1): in what format to return names, |
4235 | 0=ANSI, 1=UNICODE |
||
118 | diamond | 4236 | * other bits are reserved and must be set to 0 for the future |
4237 | compatibility |
||
4238 | * +12 = +0xC: dword: number of blocks to read |
||
4239 | * +16 = +0x10: dword: pointer to buffer for data, buffer size |
||
4240 | must be not less than 32 + [+12]*560 bytes |
||
4241 | * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are |
||
4242 | given in the general description |
||
114 | mikedld | 4243 | or |
4244 | * +20 = +0x14: db 0 |
||
118 | diamond | 4245 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
114 | mikedld | 4246 | Returned value: |
118 | diamond | 4247 | * eax = 0 - success, otherwise file system error code |
4248 | * ebx = number of files, information on which was written to |
||
4249 | the buffer, or -1=0xffffffff, if folder was not found |
||
114 | mikedld | 4250 | Structure of the buffer: |
4251 | * +0: 32*byte: header |
||
4252 | * +32 = +0x20: n1*byte: block with information on file 1 |
||
118 | diamond | 4253 | * +32+n1: n2*byte: block with information on file 2 |
114 | mikedld | 4254 | * ... |
4255 | Structure of header: |
||
118 | diamond | 4256 | * +0: dword: version of structure (current is 1) |
4257 | * +4: dword: number of placed blocks; is not greater than requested |
||
4258 | in the field +12 of information structure; can be less, if |
||
4259 | there are no more files in folder (the same as in ebx) |
||
4260 | * +8: dword: total number of files in folder |
||
4261 | * +12 = +0xC: 20*byte: reserved (zeroed) |
||
4262 | Structure of block of data for folder entry (BDFE): |
||
4263 | * +0: dword: attributes of file: |
||
4264 | * bit 0 (mask 1): file is read-only |
||
4265 | * bit 1 (mask 2): file is hidden |
||
4266 | * bit 2 (mask 4): file is system |
||
4267 | * bit 3 (mask 8): this is not a file but volume label |
||
4268 | (for one partition meets no more than once and |
||
4269 | only in root folder) |
||
4270 | * bit 4 (mask 0x10): this is a folder |
||
4271 | * bit 5 (mask 0x20): file was not archived - many archivation |
||
4272 | programs have an option to archive only files with this bit set, |
||
4273 | and after archiving this bit is cleared - it can be useful |
||
4274 | for automatically creating of backup-archives as at writing |
||
4275 | this bit is usually set |
||
4276 | * +4: byte: type of name data: |
||
4277 | (coincides with bit 0 of flags in the information structure) |
||
4278 | * 0 = ASCII = 1-byte representation of each character |
||
4279 | * 1 = UNICODE = 2-byte representation of each character |
||
114 | mikedld | 4280 | * +5: 3*byte: reserved (zero) |
118 | diamond | 4281 | * +8: 4*byte: time of file creation |
4282 | * +12 = +0xC: 4*byte: date of file creation |
||
4283 | * +16 = +0x10: 4*byte: time of last access (read or write) |
||
114 | mikedld | 4284 | * +20 = +0x14: 4*byte: date of last access |
118 | diamond | 4285 | * +24 = +0x18: 4*byte: time of last modification |
4286 | * +28 = +0x1C: 4*byte: date of last modification |
||
4287 | * +32 = +0x20: qword: file size in bytes (up to 16777216 Tb) |
||
114 | mikedld | 4288 | * +40 = +0x28: name |
118 | diamond | 4289 | * for ASCII format: maximum length is 263 characters |
4290 | (263 bytes), byte after the name has value 0 |
||
321 | diamond | 4291 | * for UNICODE format: maximum length is 259 characters |
118 | diamond | 4292 | (518 bytes), 2 bytes after the name have value 0 |
4293 | Time format: |
||
114 | mikedld | 4294 | * +0: byte: seconds |
4295 | * +1: byte: minutes |
||
4296 | * +2: byte: hours |
||
4297 | * +3: byte: reserved (0) |
||
118 | diamond | 4298 | * for example, 23.59.59 is written as (in hex) 3B 3B 17 00 |
4299 | Date format: |
||
4300 | * +0: byte: day |
||
4301 | * +1: byte: month |
||
4302 | * +2: word: year |
||
4303 | * for example, 25.11.1979 is written as (in hex) 19 0B BB 07 |
||
114 | mikedld | 4304 | Remarks: |
118 | diamond | 4305 | * If BDFE contains ASCII name, the length of BDFE is 304 bytes, |
4306 | if UNICODE name - 560 bytes. Value of length is aligned |
||
4307 | on 16-byte bound (to accelerate processing in CPU cache). |
||
4308 | * First character after a name is zero (ASCIIZ-string). The further |
||
4309 | data contain garbage. |
||
4310 | * If files in folder were ended before requested number was read, |
||
4311 | the function will read as many as it can, and after that return |
||
4312 | eax=6 (EOF). |
||
114 | mikedld | 4313 | * Any folder on the disk, except for root, contains two special |
118 | diamond | 4314 | entries "." and "..", identifying accordingly the folder itself |
4315 | and the parent folder. |
||
4316 | * The function allows also to read virtual folders "/", "/rd", |
||
4317 | "/fd", "/hd[n]", thus attributes of subfolders are set to 0x10, |
||
4318 | and times and dates are zeroed. An alternative way to get the |
||
4319 | equipment information - subfunction 11 of function 18. |
||
114 | mikedld | 4320 | |
4321 | ====================================================================== |
||
118 | diamond | 4322 | ===================== Function 70, subfunction 2 ===================== |
4323 | ============ Create/rewrite file with long names support. ============ |
||
114 | mikedld | 4324 | ====================================================================== |
4325 | Parameters: |
||
118 | diamond | 4326 | * eax = 70 - function number |
4327 | * ebx = pointer to the information structure |
||
4328 | Format of the information structure: |
||
4329 | * +0: dword: 2 = subfunction number |
||
114 | mikedld | 4330 | * +4: dword: 0 (reserved) |
4331 | * +8: dword: 0 (reserved) |
||
118 | diamond | 4332 | * +12 = +0xC: dword: number of bytes to read |
4333 | * +16 = +0x10: dword: pointer to data |
||
4334 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
||
4335 | given in the general description |
||
114 | mikedld | 4336 | or |
4337 | * +20 = +0x14: db 0 |
||
118 | diamond | 4338 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
114 | mikedld | 4339 | Returned value: |
118 | diamond | 4340 | * eax = 0 - success, otherwise file system error code |
4341 | * ebx = number of written bytes (possibly 0) |
||
114 | mikedld | 4342 | Remarks: |
118 | diamond | 4343 | * If a file with given name did not exist, it is created; |
4344 | if it existed, it is rewritten. |
||
4345 | * If there is not enough free space on disk, the function will |
||
4346 | write as many as can and then return error code 8. |
||
4347 | * The function is not supported for CD (returns error code 2). |
||
114 | mikedld | 4348 | |
4349 | ====================================================================== |
||
131 | diamond | 4350 | ===================== Function 70, subfunction 3 ===================== |
4351 | =========== Write to existing file with long names support. ========== |
||
4352 | ====================================================================== |
||
4353 | Parameters: |
||
4354 | * eax = 70 - function number |
||
4355 | * ebx = pointer to the information structure |
||
4356 | Format of the information structure: |
||
4357 | * +0: dword: 3 = subfunction number |
||
4358 | * +4: dword: file offset (in bytes) |
||
4359 | * +8: dword: high dword of offset (must be 0 for FAT) |
||
4360 | * +12 = +0xC: dword: number of bytes to write |
||
4361 | * +16 = +0x10: dword: pointer to data |
||
4362 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
||
4363 | given in the general description |
||
4364 | or |
||
4365 | * +20 = +0x14: db 0 |
||
4366 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
||
4367 | Returned value: |
||
4368 | * eax = 0 - success, otherwise file system error code |
||
4369 | * ebx = number of written bytes (possibly 0) |
||
4370 | Remarks: |
||
4371 | * The file must already exist, otherwise function returns eax=5. |
||
4372 | * The only result of write 0 bytes is update in the file attributes |
||
4373 | date/time of modification and access to the current date/time. |
||
4374 | * If beginning and/or ending position is greater than file size |
||
4375 | (except for the previous case), the file is expanded to needed |
||
4376 | size with zero characters. |
||
133 | diamond | 4377 | * The function is not supported for CD (returns error code 2). |
131 | diamond | 4378 | |
4379 | ====================================================================== |
||
133 | diamond | 4380 | ============ Function 70, subfunction 4 - set end of file. =========== |
4381 | ====================================================================== |
||
4382 | Parameters: |
||
4383 | * eax = 70 - function number |
||
4384 | * ebx = pointer to the information structure |
||
4385 | Format of the information structure: |
||
4386 | * +0: dword: 4 = subfunction number |
||
4387 | * +4: dword: low dword of new file size |
||
4388 | * +8: dword: high dword of new file size (must be 0 for FAT) |
||
4389 | * +12 = +0xC: dword: 0 (reserved) |
||
4390 | * +16 = +0x10: dword: 0 (reserved) |
||
4391 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
||
4392 | given in the general description |
||
4393 | or |
||
4394 | * +20 = +0x14: db 0 |
||
4395 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
||
4396 | Returned value: |
||
4397 | * eax = 0 - success, otherwise file system error code |
||
4398 | * ebx destroyed |
||
4399 | Remarks: |
||
4400 | * If the new file size is less than old one, file is truncated. |
||
4401 | If the new size is greater than old one, file is expanded with |
||
4402 | characters with code 0. If the new size is equal to old one, |
||
4403 | the only result of call is set date/time of modification and |
||
4404 | access to the current date/time. |
||
4405 | * If there is not enough free space on disk for expansion, the |
||
4406 | function will expand to maximum possible size and then return |
||
4407 | error code 8. |
||
4408 | * The function is not supported for CD (returns error code 2). |
||
4409 | |||
4410 | ====================================================================== |
||
118 | diamond | 4411 | ==== Function 70, subfunction 5 - get information on file/folder. ==== |
114 | mikedld | 4412 | ====================================================================== |
4413 | Parameters: |
||
118 | diamond | 4414 | * eax = 70 - function number |
4415 | * ebx = pointer to the information structure |
||
4416 | Format of the information structure: |
||
4417 | * +0: dword: 5 = subfunction number |
||
114 | mikedld | 4418 | * +4: dword: 0 (reserved) |
4419 | * +8: dword: 0 (reserved) |
||
4420 | * +12 = +0xC: dword: 0 (reserved) |
||
118 | diamond | 4421 | * +16 = +0x10: dword: pointer to buffer for data (40 bytes) |
4422 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
||
4423 | given in the general description |
||
114 | mikedld | 4424 | or |
4425 | * +20 = +0x14: db 0 |
||
118 | diamond | 4426 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
114 | mikedld | 4427 | Returned value: |
118 | diamond | 4428 | * eax = 0 - success, otherwise file system error code |
4429 | * ebx destroyed |
||
4430 | Information on file is returned in the BDFE format (block of data |
||
4431 | for folder entry), explained in the description of |
||
4432 | subfunction 1, but without filename |
||
4433 | (i.e. only first 40 = 0x28 bytes). |
||
114 | mikedld | 4434 | Remarks: |
118 | diamond | 4435 | * The function does not support virtual folders such as /, /rd and |
4436 | root folders like /rd/1. |
||
114 | mikedld | 4437 | |
4438 | ====================================================================== |
||
118 | diamond | 4439 | ===== Function 70, subfunction 6 - set attributes of file/folder. ==== |
114 | mikedld | 4440 | ====================================================================== |
4441 | Parameters: |
||
118 | diamond | 4442 | * eax = 70 - function number |
4443 | * ebx = pointer to the information structure |
||
4444 | Format of the information structure: |
||
4445 | * +0: dword: 6 = subfunction number |
||
114 | mikedld | 4446 | * +4: dword: 0 (reserved) |
4447 | * +8: dword: 0 (reserved) |
||
4448 | * +12 = +0xC: dword: 0 (reserved) |
||
118 | diamond | 4449 | * +16 = +0x10: dword: pointer to buffer with attributes (32 bytes) |
4450 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
||
4451 | given in the general description |
||
114 | mikedld | 4452 | or |
4453 | * +20 = +0x14: db 0 |
||
118 | diamond | 4454 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
114 | mikedld | 4455 | Returned value: |
118 | diamond | 4456 | * eax = 0 - success, otherwise file system error code |
4457 | * ebx destroyed |
||
4458 | File attributes are first 32 bytes in BDFE (block of data |
||
4459 | for folder entry), explained in the description of subfunction 1 |
||
4460 | (that is, without name and size of file). Attribute |
||
4461 | file/folder/volume label (bits 3,4 in dword +0) is not changed. |
||
4462 | Byte +4 (name format) is ignored. |
||
114 | mikedld | 4463 | Remarks: |
118 | diamond | 4464 | * The function does not support virtual folders such as /, /rd and |
4465 | root folders like /rd/1. |
||
4466 | * The function is not supported for CD (returns error code 2). |
||
114 | mikedld | 4467 | |
4468 | ====================================================================== |
||
118 | diamond | 4469 | =========== Function 70, subfunction 7 - start application. ========== |
114 | mikedld | 4470 | ====================================================================== |
4471 | Parameters: |
||
118 | diamond | 4472 | * eax = 70 - function number |
4473 | * ebx = pointer to the information structure |
||
4474 | Format of the information structure: |
||
4475 | * +0: dword: 7 = subfunction number |
||
4476 | * +4: dword: flags field: |
||
3539 | clevermous | 4477 | * bit 0: start process as debugged |
118 | diamond | 4478 | * other bits are reserved and must be set to 0 |
4479 | * +8: dword: 0 or pointer to ASCIIZ-string with parameters |
||
114 | mikedld | 4480 | * +12 = +0xC: dword: 0 (reserved) |
4481 | * +16 = +0x10: dword: 0 (reserved) |
||
118 | diamond | 4482 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
4483 | given in the general description |
||
114 | mikedld | 4484 | or |
4485 | * +20 = +0x14: db 0 |
||
118 | diamond | 4486 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
114 | mikedld | 4487 | Returned value: |
4488 | * eax > 0 - program is loaded, eax contains PID |
||
118 | diamond | 4489 | * eax < 0 - an error has occured, -eax contains |
4490 | file system error code |
||
4491 | * ebx destroyed |
||
114 | mikedld | 4492 | Remarks: |
118 | diamond | 4493 | * Command line must be terminated by the character with the code 0 |
4494 | (ASCIIZ-string); function takes into account either all characters |
||
4495 | up to terminating zero inclusively or first 256 character |
||
4496 | regarding what is less. |
||
4497 | * If the process is started as debugged, it is created in |
||
4498 | the suspended state; to run use subfunction 5 of function 69. |
||
114 | mikedld | 4499 | |
4500 | ====================================================================== |
||
193 | diamond | 4501 | ========== Function 70, subfunction 8 - delete file/folder. ========== |
4502 | ====================================================================== |
||
4503 | Parameters: |
||
4504 | * eax = 70 - function number |
||
4505 | * ebx = pointer to the information structure |
||
4506 | Format of the information structure: |
||
4507 | * +0: dword: 8 = subfunction number |
||
4508 | * +4: dword: 0 (reserved) |
||
4509 | * +8: dword: 0 (reserved) |
||
4510 | * +12 = +0xC: dword: 0 (reserved) |
||
4511 | * +16 = +0x10: dword: 0 (reserved) |
||
4512 | * +20 = +0x14: ASCIIZ-name of file, the rules of names forming are |
||
4513 | given in the general description |
||
4514 | or |
||
4515 | * +20 = +0x14: db 0 |
||
4516 | * +21 = +0x15: dd pointer to ASCIIZ-string with file name |
||
4517 | Returned value: |
||
4518 | * eax = 0 - success, otherwise file system error code |
||
4519 | * ebx destroyed |
||
4520 | Remarks: |
||
4521 | * The function is not supported for CD (returns error code 2). |
||
4522 | * The function can delete only empty folders (attempt to delete |
||
4523 | nonempty folder results in error with code 10, "access denied"). |
||
4524 | |||
4525 | ====================================================================== |
||
321 | diamond | 4526 | ============= Function 70, subfunction 9 - create folder. ============ |
4527 | ====================================================================== |
||
4528 | Parameters: |
||
4529 | * eax = 70 - function number |
||
4530 | * ebx = pointer to the information structure |
||
4531 | Format of the information structure: |
||
4532 | * +0: dword: 9 = subfunction number |
||
4533 | * +4: dword: 0 (reserved) |
||
4534 | * +8: dword: 0 (reserved) |
||
4535 | * +12 = +0xC: dword: 0 (reserved) |
||
4536 | * +16 = +0x10: dword: 0 (reserved) |
||
4537 | * +20 = +0x14: ASCIIZ-name of folder, the rules of names forming are |
||
4538 | given in the general description |
||
4539 | or |
||
4540 | * +20 = +0x14: db 0 |
||
4541 | * +21 = +0x15: dd pointer to ASCIIZ-string with folder name |
||
4542 | Returned value: |
||
4543 | * eax = 0 - success, otherwise file system error code |
||
4544 | * ebx destroyed |
||
4545 | Remarks: |
||
4546 | * The function is not supported for CD (returns error code 2). |
||
4547 | * The parent folder must already exist. |
||
4548 | * If target folder already exists, function returns success (eax=0). |
||
4549 | |||
4550 | ====================================================================== |
||
118 | diamond | 4551 | ========== Function 71, subfunction 1 - set window caption. ========== |
114 | mikedld | 4552 | ====================================================================== |
4553 | Parameters: |
||
4554 | * eax = 71 - function number |
||
4555 | * ebx = 1 - subfunction number |
||
118 | diamond | 4556 | * ecx = pointer to caption string |
114 | mikedld | 4557 | Returned value: |
118 | diamond | 4558 | * function does not return value |
114 | mikedld | 4559 | Remarks: |
118 | diamond | 4560 | * String must be in the ASCIIZ-format. Disregarding real string |
4561 | length, no more than 255 characters are drawn. |
||
4562 | * Pass NULL in ecx to remove caption. |
||
114 | mikedld | 4563 | |
4564 | ====================================================================== |
||
665 | diamond | 4565 | =============== Function 72 - send message to a window. ============== |
4566 | ====================================================================== |
||
4567 | |||
4568 | - Subfunction 1 - send message with parameter to the active window. -- |
||
4569 | Parameters: |
||
4570 | * eax = 72 - function number |
||
4571 | * ebx = 1 - subfunction number |
||
4572 | * ecx = event code: 2 or 3 |
||
4573 | * edx = parameter: key code for ecx=2, button identifier for ecx=3 |
||
4574 | Returned value: |
||
4575 | * eax = 0 - success |
||
4576 | * eax = 1 - buffer is full |
||
4577 | |||
4578 | ====================================================================== |
||
3315 | mario79 | 4579 | ===================== Function 73 - blit bitmap ===================== |
4580 | ====================================================================== |
||
4581 | |||
4582 | Parameters: |
||
4583 | * eax = 73 - function number |
||
4584 | |||
4585 | * ebx = ROP and optional flags |
||
4586 | 31 6 5 4 3 0 |
||
4587 | [ reserved ][T][B][ROP] |
||
4588 | ROP - raster operation code |
||
4589 | 0: Copy |
||
4590 | 1-15: reserved |
||
4591 | B - blit into the background surface |
||
4592 | T - transparent blit |
||
4593 | |||
4594 | * ecx = pointer to the function parameters |
||
4595 | destination offset and clipping |
||
4596 | +0 signed dword: destination rectangle X offset from the window |
||
4597 | top-left corner |
||
4598 | +4 signed dword: destination rectangle Y offset from the window |
||
4599 | top-left corner |
||
4600 | +8 dword: destination rectangle width |
||
4601 | +12 dword: destination rectangle height |
||
4602 | |||
4603 | source offset and clipping |
||
4604 | +16 signed dword: source rectangle X offset from the bitmap |
||
4605 | top-left corner |
||
4606 | +20 signed dword: source rectangle Y offset from the bitmap |
||
4607 | top-left corner |
||
4608 | +24 dword: source rectangle width |
||
4609 | +28 dword: source rectangle height |
||
4610 | |||
3338 | mario79 | 4611 | +32: dword: bitmap data - must be 32bpp |
4612 | +36: dword: size of the bitmap row in bytes |
||
3315 | mario79 | 4613 | |
4614 | Returned value: |
||
4615 | * function does not return value |
||
4616 | |||
4617 | ====================================================================== |
||
3571 | hidnplayr | 4618 | = Function 74, Subfunction -1, Get number of active network devices. = |
4619 | ====================================================================== |
||
4620 | Parameters: |
||
4621 | * eax = 74 - function number |
||
4622 | * bl = -1 - subfunction number |
||
4623 | Returned value: |
||
4624 | * eax = number of active network devices |
||
4625 | |||
4626 | ====================================================================== |
||
4627 | ======== Function 74, Subfunction 0, Get network device type. ======== |
||
4628 | ====================================================================== |
||
4629 | Parameters: |
||
4630 | * eax = 74 - function number |
||
4631 | * bl = 0 - subfunction number |
||
4632 | * bh = device number |
||
4633 | Returned value: |
||
4634 | * eax = device type |
||
4635 | |||
4636 | ====================================================================== |
||
4637 | ======== Function 74, Subfunction 1, Get network device name. ======== |
||
4638 | ====================================================================== |
||
4639 | Parameters: |
||
4640 | * eax = 74 - function number |
||
4641 | * bl = 1 - subfunction number |
||
4642 | * bh = device number |
||
4643 | * ecx = pointer to 64 byte buffer |
||
4644 | Returned value: |
||
4645 | * eax = -1 on error |
||
4646 | * The network device name is written into the buffer, on success |
||
4647 | |||
4648 | ====================================================================== |
||
4649 | ========= Function 74, Subfunction 2, Reset network device. ========== |
||
4650 | ====================================================================== |
||
4651 | Parameters: |
||
4652 | * eax = 74 - function number |
||
4653 | * bl = 2 - subfunction number |
||
4654 | * bh = device number |
||
4655 | Returned value: |
||
4656 | * eax = -1 on error |
||
4657 | |||
4658 | ====================================================================== |
||
4659 | ========== Function 74, Subfunction 3, Stop network device. ========== |
||
4660 | ====================================================================== |
||
4661 | Parameters: |
||
4662 | * eax = 74 - function number |
||
4663 | * bl = 3 - subfunction number |
||
4664 | * bh = device number |
||
4665 | Returned value: |
||
4666 | * eax = -1 on error |
||
4667 | |||
4668 | ====================================================================== |
||
4669 | ============== Function 75, Subfunction 0, Open socket. ============== |
||
4670 | ====================================================================== |
||
4671 | Parameters: |
||
4672 | * eax = 75 - function number |
||
4673 | * bl = 0 - subfunction number |
||
4674 | * ecx = domain |
||
4675 | * edx = type |
||
4676 | * esi = protocol |
||
4677 | Returned value: |
||
4678 | * eax = socket number, -1 on error |
||
4679 | |||
4680 | ====================================================================== |
||
4681 | ============= Function 75, Subfunction 1, Close socket. ============== |
||
4682 | ====================================================================== |
||
4683 | Parameters: |
||
4684 | * eax = 75 - function number |
||
4685 | * bl = 1 - subfunction number |
||
4686 | * ecx = socket number |
||
4687 | Returned value: |
||
4688 | * eax = -1 on error |
||
4689 | |||
4690 | ====================================================================== |
||
4691 | ================== Function 75, Subfunction 2, Bind. ================= |
||
4692 | ====================================================================== |
||
4693 | Parameters: |
||
4694 | * eax = 75 - function number |
||
4695 | * bl = 2 - subfunction number |
||
4696 | * ecx = socket number |
||
4697 | * edx = pointer to sockaddr structure |
||
4698 | * esi = length of sockaddr structure |
||
4699 | Returned value: |
||
4700 | * eax = -1 on error |
||
4701 | |||
4702 | ====================================================================== |
||
4703 | ================= Function 75, Subfunction 3, Listen. ================ |
||
4704 | ====================================================================== |
||
4705 | Parameters: |
||
4706 | * eax = 75 - function number |
||
4707 | * bl = 3 - subfunction number |
||
4708 | * ecx = socket number |
||
4709 | * edx = backlog |
||
4710 | Returned value: |
||
4711 | * eax = -1 on error |
||
4712 | |||
4713 | ====================================================================== |
||
4714 | ================ Function 75, Subfunction 4, Connect. ================ |
||
4715 | ====================================================================== |
||
4716 | Parameters: |
||
4717 | * eax = 75 - function number |
||
4718 | * bl = 4 - subfunction number |
||
4719 | * ecx = socket number |
||
4720 | * edx = pointer to sockaddr structure |
||
4721 | * esi = length of sockaddr structure |
||
4722 | Returned value: |
||
4723 | * eax = -1 on error |
||
4724 | |||
4725 | ====================================================================== |
||
4726 | ================= Function 75, Subfunction 5, Accept. ================ |
||
4727 | ====================================================================== |
||
4728 | Parameters: |
||
4729 | * eax = 75 - function number |
||
4730 | * bl = 5 - subfunction number |
||
4731 | * ecx = socket number |
||
4732 | * edx = pointer to sockaddr structure |
||
4733 | * esi = length of sockaddr structure |
||
4734 | Returned value: |
||
4735 | * eax = -1 on error |
||
4736 | |||
4737 | ====================================================================== |
||
4738 | ================== Function 75, Subfunction 6, Send. ================= |
||
4739 | ====================================================================== |
||
4740 | Parameters: |
||
4741 | * eax = 75 - function number |
||
4742 | * bl = 6 - subfunction number |
||
4743 | * ecx = socket number |
||
4744 | * edx = pointer to buffer |
||
4745 | * esi = length of buffer |
||
4746 | Returned value: |
||
4747 | * eax = number of bytes copied, -1 on error |
||
4748 | |||
4749 | ====================================================================== |
||
4750 | ================ Function 75, Subfunction 7, Receive. ================ |
||
4751 | ====================================================================== |
||
4752 | Parameters: |
||
4753 | * eax = 75 - function number |
||
4754 | * bl = 7 - subfunction number |
||
4755 | * ecx = socket number |
||
4756 | * edx = pointer to buffer |
||
4757 | * esi = length of buffer |
||
4758 | * edi = flags |
||
4759 | Returned value: |
||
4760 | * eax = number of bytes copied, -1 on error |
||
4761 | |||
4762 | ====================================================================== |
||
4763 | =========== Function 75, Subfunction 8, Set socket options. ========== |
||
4764 | ====================================================================== |
||
4765 | Parameters: |
||
4766 | * eax = 75 - function number |
||
4767 | * bl = 8 - subfunction number |
||
4768 | * ecx = socket number |
||
4769 | * edx = pointer to optstruct |
||
4770 | Returned value: |
||
4771 | * eax = -1 on error |
||
4772 | Remarks: |
||
4773 | |||
4774 | Optstruct: dd level |
||
4775 | dd optionname |
||
4776 | dd optlength |
||
4777 | db options... |
||
4778 | |||
4779 | ====================================================================== |
||
4780 | =========== Function 75, Subfunction 9, Get socket options. ========== |
||
4781 | ====================================================================== |
||
4782 | Parameters: |
||
4783 | * eax = 75 - function number |
||
4784 | * bl = 9 - subfunction number |
||
4785 | * ecx = socket number |
||
4786 | * edx = pointer to optstruct |
||
4787 | Returned value: |
||
4788 | * eax = -1 on error |
||
4789 | Remarks: |
||
4790 | |||
4791 | Optstruct: dd level |
||
4792 | dd optionname |
||
4793 | dd optlength |
||
4794 | db options... |
||
4795 | |||
4796 | ====================================================================== |
||
4797 | ============ Function 75, Subfunction 10, Get socketpair. =========== |
||
4798 | ====================================================================== |
||
4799 | Parameters: |
||
4800 | * eax = 75 - function number |
||
4801 | * bl = 10 - subfunction number |
||
4802 | Returned value: |
||
4803 | * eax = socketnum1, -1 on error |
||
4804 | * ebx = socketnum2 |
||
4805 | Remarks: |
||
4806 | |||
4807 | Optstruct: dd level |
||
4808 | dd optionname |
||
4809 | dd optlength |
||
4810 | db options... |
||
4811 | |||
4812 | ====================================================================== |
||
118 | diamond | 4813 | =============== Function -1 - terminate thread/process =============== |
114 | mikedld | 4814 | ====================================================================== |
4815 | Parameters: |
||
118 | diamond | 4816 | * eax = -1 - function number |
114 | mikedld | 4817 | Returned value: |
118 | diamond | 4818 | * function does not return neither value nor control |
114 | mikedld | 4819 | Remarks: |
118 | diamond | 4820 | * If the process did not create threads obviously, it has only |
4821 | one thread, which termination results in process termination. |
||
4822 | * If the current thread is last in the process, its termination |
||
4823 | also results in process terminates. |
||
4824 | * This function terminates the current thread. Other thread can be |
||
4825 | killed by call to subfunction 2 of function 18. |
||
114 | mikedld | 4826 | |
4827 | ====================================================================== |
||
4828 | =========================== List of events =========================== |
||
4829 | ====================================================================== |
||
118 | diamond | 4830 | Next event can be retrieved by the call of one from functions 10 |
4831 | (to wait for event), 11 (to check without waiting), 23 |
||
4832 | (to wait during the given time). |
||
4833 | These functions return only those events, which enter into a mask set |
||
4834 | by function 40. By default it is first three, |
||
4835 | there is enough for most applications. |
||
114 | mikedld | 4836 | Codes of events: |
118 | diamond | 4837 | * 1 = redraw event (is reset by call to function 0) |
4838 | * 2 = key on keyboard is pressed (acts, only when the window is |
||
4839 | active) or hotkey is pressed; is reset, when all keys from |
||
4840 | the buffer are read out by function 2 |
||
4841 | * 3 = button is pressed, defined earlier by function 8 |
||
4842 | (or close button, created implicitly by function 0; |
||
4843 | minimize button is handled by the system and sends no message; |
||
4844 | acts, only when the window is active; |
||
4845 | is reset when all buttons from the buffer |
||
4846 | are read out by function 17) |
||
4847 | * 4 = reserved (in current implementation never comes even after |
||
4848 | unmasking by function 40) |
||
2513 | mario79 | 4849 | * 5 = kernel finished redrawing of the desktop background |
118 | diamond | 4850 | * 6 = mouse event (something happened - button pressing or moving; |
4851 | is reset at reading) |
||
4852 | * 7 = IPC event (see function 60 - |
||
4853 | Inter Process Communication; is reset at reading) |
||
4854 | * 8 = network event (is reset at reading) |
||
4855 | * 9 = debug event (is reset at reading; see |
||
4856 | debug subsystem) |
||
4857 | * 16..31 = event with appropriate IRQ |
||
4858 | (16=IRQ0, 31=IRQ15) (is reset after reading all IRQ data) |
||
114 | mikedld | 4859 | |
4860 | ====================================================================== |
||
118 | diamond | 4861 | =================== Error codes of the file system =================== |
114 | mikedld | 4862 | ====================================================================== |
118 | diamond | 4863 | * 0 = success |
4864 | * 1 = base and/or partition of a hard disk is not defined |
||
4865 | (by subfunctions 7, 8 of function 21) |
||
4866 | * 2 = function is not supported for the given file system |
||
4867 | * 3 = unknown file system |
||
448 | diamond | 4868 | * 4 = reserved, is never returned in the current implementation |
118 | diamond | 4869 | * 5 = file not found |
4870 | * 6 = end of file, EOF |
||
4871 | * 7 = pointer lies outside of application memory |
||
4872 | * 8 = disk is full |
||
4873 | * 9 = FAT table is destroyed |
||
114 | mikedld | 4874 | * 10 = access denied |
118 | diamond | 4875 | * 11 = device error |
4876 | Application start functions can return also following errors: |
||
4877 | * 30 = 0x1E = not enough memory |
||
4878 | * 31 = 0x1F = file is not executable |
||
4879 | * 32 = 0x20 = too many processes>>=4>=n<=4>=39>0,>=>=>=0xFFFF. |