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