Rev 6712 | Rev 6790 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
2455 | mario79 | 1 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
2 | ;; ;; |
||
6272 | pathoswith | 3 | ;; Copyright (C) KolibriOS team 2004-2016. All rights reserved. ;; |
2455 | mario79 | 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: |
||
118 | diamond | 28 | * Y=1 - only define window area, draw nothing |
131 | diamond | 29 | * Y=3 - skinned window |
641 | diamond | 30 | * Y=4 - skinned fixed-size window |
6473 | pathoswith | 31 | * Y=0,2 window types are outdated and should not be used anymore, |
6171 | leency | 32 | they are retained for compatibility with old programs. |
33 | * other possible values (from 5 to 15) are reserved, |
||
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) |
6168 | leency | 38 | * A = 1 - window has caption |
118 | diamond | 39 | * B = 1 - coordinates of all graphics primitives are relative to |
40 | window client area |
||
303 | mikedld | 41 | * C = 1 - don't fill working area on window draw |
118 | diamond | 42 | * D = 0 - normal filling of the working area, 1 - gradient |
43 | The following parameters are intended for windows |
||
44 | of a type I and II, and ignored for styles Y=1,3: |
||
45 | * esi = 0xXYRRGGBB - color of the header |
||
46 | * RR, GG, BB define color |
||
4051 | heavyiron | 47 | * Y=0 - usual window, Y=1 - unmovable window (works for all window styles) |
6168 | leency | 48 | * X not used, other values of Y are reserved |
49 | * edi = caption string for styles Y=3,4 (also can be set by func 71.1) |
||
114 | mikedld | 50 | Returned value: |
51 | * function does not return value |
||
52 | Remarks: |
||
118 | diamond | 53 | * Position and sizes of the window are installed by the first |
54 | call of this function and are ignored at subsequent; to change |
||
55 | position and/or sizes of already created window use function 67. |
||
641 | diamond | 56 | * For windows with styles Y=3,4 and caption (A=1) caption string |
57 | is set by the first call of this function and is ignored |
||
58 | at subsequent (strictly speaking, is ignored after a call to |
||
59 | subfunction 2 of function 12 - end redraw); to change caption of |
||
60 | already created window use subfunction 1 of function 71. |
||
118 | diamond | 61 | * If the window has appropriate styles, position and/or sizes can be |
62 | changed by user. Current position and sizes can be obtained |
||
63 | by function 9. |
||
64 | * The window must fit on the screen. If the transferred |
||
65 | coordinates and sizes do not satisfy to this condition, |
||
66 | appropriate coordinate (or, probably, both) is considered as zero, |
||
131 | diamond | 67 | and if it does not help too, the appropriate size |
118 | diamond | 68 | (or, probably, both) is installed in a size of the screen. |
2409 | Serge | 69 | |
131 | diamond | 70 | Further let us designate xpos,ypos,xsize,ysize - values passed |
71 | in ebx,ecx. The coordinates are resulted concerning |
||
118 | diamond | 72 | the left upper corner of the window, which, thus, is set as (0,0), |
73 | coordinates of the right lower corner essence (xsize,ysize). |
||
74 | * The sizes of the window are understood in sence of coordinates |
||
75 | of the right lower corner. This concerns all other functions too. |
||
76 | It means, that the real sizes are on 1 pixel more. |
||
77 | * The window of style Y=1 looks as follows: |
||
114 | mikedld | 78 | * completely defined by the application |
6168 | leency | 79 | * The skinned window Y=3,4 looks as follows: |
114 | mikedld | 80 | * draw external frame of width 1 pixel |
118 | diamond | 81 | with color 'outer' from the skin |
82 | * draw intermediate frame of width 3 pixel |
||
83 | with color 'frame' from the skin |
||
84 | * draw internal frame of width 1 pixel |
||
85 | with color 'inner' from the skin |
||
86 | * draw header (on bitmaps from the skin) in a rectangle |
||
114 | mikedld | 87 | (0,0) - (xsize,_skinh-1) |
118 | diamond | 88 | * if ysize>=26, fill the working area of the window - |
89 | rectangle with the left upper corner (5,_skinh) and right lower |
||
90 | (xsize-5,ysize-5) with color indicated in edx |
||
91 | (taking a gradient into account) |
||
133 | diamond | 92 | * define two standard buttons: close and minimize |
114 | mikedld | 93 | (see function 8) |
118 | diamond | 94 | * if A=1 and edi contains (nonzero) pointer to caption string, |
95 | it is drawn in place in header defined in the skin |
||
96 | * value _skinh is accessible as the result of call |
||
97 | subfunction 4 of function 48 |
||
114 | mikedld | 98 | |
6057 | IgorA | 99 | ---------------------- Constants for registers: ---------------------- |
100 | eax - SF_CREATE_WINDOW (0) |
||
114 | mikedld | 101 | ====================================================================== |
118 | diamond | 102 | ================ Function 1 - put pixel in the window. =============== |
114 | mikedld | 103 | ====================================================================== |
104 | Parameters: |
||
118 | diamond | 105 | * eax = 1 - function number |
106 | * ebx = x-coordinate (relative to the window) |
||
107 | * ecx = y-coordinate (relative to the window) |
||
108 | * edx = 0x00RRGGBB - color of a pixel |
||
109 | edx = 0x01xxxxxx - invert color of a pixel |
||
110 | (low 24 bits are ignored) |
||
114 | mikedld | 111 | Returned value: |
112 | * function does not return value |
||
113 | |||
6057 | IgorA | 114 | ---------------------- Constants for registers: ---------------------- |
115 | eax - SF_PUT_PIXEL (1) |
||
114 | mikedld | 116 | ====================================================================== |
118 | diamond | 117 | ============ Function 2 - get the code of the pressed key. =========== |
114 | mikedld | 118 | ====================================================================== |
119 | Takes away the code of the pressed key from the buffer. |
||
120 | Parameters: |
||
118 | diamond | 121 | * eax = 2 - function number |
114 | mikedld | 122 | Returned value: |
118 | diamond | 123 | * if the buffer is empty, function returns eax=1 |
124 | * if the buffer is not empty, function returns al=0, |
||
4588 | mario79 | 125 | ah=code of the pressed key, |
4612 | mario79 | 126 | bits 16-23 = contain scancode for pressed key in ASCII mode, |
127 | in the scancodes mode this bits cleared. |
||
4588 | mario79 | 128 | bits 23-31 = zero |
118 | diamond | 129 | * if there is "hotkey", function returns al=2, |
130 | ah=scancode of the pressed key (0 for control keys), |
||
131 | high word of eax contains a status of control keys at the moment |
||
132 | of pressing a hotkey |
||
114 | mikedld | 133 | Remarks: |
118 | diamond | 134 | * There is a common system buffer of the pressed keys |
135 | by a size of 120 bytes, organized as queue. |
||
136 | * There is one more common system buffer on 120 "hotkeys". |
||
137 | * If the application with the inactive window calls this function, |
||
138 | the buffer of the pressed keys is considered to be empty. |
||
139 | * By default this function returns ASCII-codes; to switch |
||
140 | to the scancodes mode (and back) use function 66. |
||
141 | However, hotkeys are always notificated as scancodes. |
||
142 | * To find out, what keys correspond to what codes, start |
||
143 | the application keyascii and scancode. |
||
144 | * Scancodes come directly from keyboard and are fixed; |
||
145 | ASCII-codes turn out with usage of the conversion tables, |
||
146 | which can be set by subfunction 2 of function 21 |
||
147 | and get by subfunction 2 of function 26. |
||
148 | * As a consequence, ASCII-codes take into account current |
||
149 | keyboard layout (rus/en) as opposed to scancodes. |
||
150 | * This function notifies only about those hotkeys, which were |
||
151 | defined by this thread by subfunction 4 of function 66. |
||
114 | mikedld | 152 | |
6057 | IgorA | 153 | ---------------------- Constants for registers: ---------------------- |
154 | eax - SF_GET_KEY (2) |
||
114 | mikedld | 155 | ====================================================================== |
118 | diamond | 156 | ==================== Function 3 - get system time. =================== |
114 | mikedld | 157 | ====================================================================== |
158 | Parameters: |
||
118 | diamond | 159 | * eax = 3 - function number |
114 | mikedld | 160 | Returned value: |
161 | * eax = 0x00SSMMHH, where HH:MM:SS = Hours:Minutes:Seconds |
||
118 | diamond | 162 | * each item is BCD-number, for example, |
163 | for time 23:59:59 function returns 0x00595923 |
||
114 | mikedld | 164 | Remarks: |
118 | diamond | 165 | * See also subfunction 9 of function 26 - get time from |
166 | the moment of start of the system; it is more convenient, because |
||
167 | returns simply DWORD-value of the time counter. |
||
168 | * System time can be set by function 22. |
||
114 | mikedld | 169 | |
6057 | IgorA | 170 | ---------------------- Constants for registers: ---------------------- |
171 | eax - SF_GET_SYS_TIME (3) |
||
114 | mikedld | 172 | ====================================================================== |
5848 | pathoswith | 173 | =================== Function 4 - draw text string. =================== |
114 | mikedld | 174 | ====================================================================== |
175 | Parameters: |
||
118 | diamond | 176 | * eax = 4 - function number |
5848 | pathoswith | 177 | * ebx = X*65536+Y, coordinates in the window or buffer |
178 | * ecx = 0xXXRRGGBB, where |
||
118 | diamond | 179 | * RR, GG, BB specify text color |
5848 | pathoswith | 180 | * XX = ABFFCSSS (bits): |
5682 | leency | 181 | * A=1 - output zero terminated string |
5848 | pathoswith | 182 | * B=1 - fill background (color = edi) |
5682 | leency | 183 | * FF specifies the font and encoding: |
184 | |||
5867 | pathoswith | 185 | 1 = 8x16 cp866 |
5682 | leency | 186 | 2 = 8x16 UTF-16LE |
187 | 3 = 8x16 UTF-8 |
||
5848 | pathoswith | 188 | * C=0 - draw to the window, |
189 | C=1 - draw to the user buffer (edi) |
||
190 | * SSS = (size multiplier)-1, so 0 = x1, 7 = x8 |
||
118 | diamond | 191 | * edx = pointer to the beginning of the string |
5682 | leency | 192 | * esi = for A=0 length of the string, for A=1 is ignored |
193 | * edi = for B=1 color to fill background, |
||
5848 | pathoswith | 194 | for C=1 pointer to user buffer |
3780 | Serge | 195 | |
114 | mikedld | 196 | Returned value: |
197 | * function does not return value |
||
198 | Remarks: |
||
5682 | leency | 199 | * You can not use B=1 and C=1 at the same time, since both use edi. |
5848 | pathoswith | 200 | * When SSS=0, font may be smoothed, depending on system setting. |
201 | * User buffer structure: |
||
202 | Xsize dd |
||
203 | Ysize dd |
||
204 | picture rb Xsize*Ysize*4 ; 32 bpp |
||
114 | mikedld | 205 | |
6057 | IgorA | 206 | ---------------------- Constants for registers: ---------------------- |
207 | eax - SF_DRAW_TEXT (4) |
||
114 | mikedld | 208 | ====================================================================== |
118 | diamond | 209 | ========================= Function 5 - delay. ======================== |
114 | mikedld | 210 | ====================================================================== |
211 | Delays execution of the program on the given time. |
||
212 | Parameters: |
||
118 | diamond | 213 | * eax = 5 - function number |
114 | mikedld | 214 | * ebx = time in the 1/100 of second |
215 | Returned value: |
||
216 | * function does not return value |
||
217 | Remarks: |
||
118 | diamond | 218 | * Passing ebx=0 does not transfer control to the next process |
219 | and does not make any operations at all. If it is really required |
||
220 | to transfer control to the next process (to complete a current |
||
221 | time slice), use subfunction 1 of function 68. |
||
114 | mikedld | 222 | |
6057 | IgorA | 223 | ---------------------- Constants for registers: ---------------------- |
224 | eax - SF_SLEEP (5) |
||
114 | mikedld | 225 | ====================================================================== |
226 | =============== Function 7 - draw image in the window. =============== |
||
227 | ====================================================================== |
||
118 | diamond | 228 | Paramters: |
229 | * eax = 7 - function number |
||
230 | * ebx = pointer to the image in the format BBGGRRBBGGRR... |
||
114 | mikedld | 231 | * ecx = [size on axis x]*65536 + [size on axis y] |
232 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
233 | Returned value: |
||
234 | * function does not return value |
||
235 | Remarks: |
||
118 | diamond | 236 | * Coordinates of the image are coordinates of the upper left corner |
237 | of the image relative to the window. |
||
114 | mikedld | 238 | * Size of the image in bytes is 3*xsize*ysize. |
239 | |||
6057 | IgorA | 240 | ---------------------- Constants for registers: ---------------------- |
241 | eax - SF_PUT_IMAGE (7) |
||
114 | mikedld | 242 | ====================================================================== |
243 | =============== Function 8 - define/delete the button. =============== |
||
244 | ====================================================================== |
||
118 | diamond | 245 | Parameters for button definition: |
246 | * eax = 8 - function number |
||
114 | mikedld | 247 | * ebx = [coordinate on axis x]*65536 + [size on axis x] |
248 | * ecx = [coordinate on axis y]*65536 + [size on axis y] |
||
249 | * edx = 0xXYnnnnnn, where: |
||
250 | * nnnnnn = identifier of the button |
||
118 | diamond | 251 | * high (31st) bit of edx is cleared |
252 | * if 30th bit of edx is set - do not draw the button |
||
253 | * if 29th bit of edx is set - do not draw a frame |
||
114 | mikedld | 254 | at pressing the button |
118 | diamond | 255 | * esi = 0x00RRGGBB - color of the button |
256 | Parameters for button deleting: |
||
257 | * eax = 8 - function number |
||
114 | mikedld | 258 | * edx = 0x80nnnnnn, where nnnnnn - identifier of the button |
259 | Returned value: |
||
260 | * function does not return value |
||
261 | Remarks: |
||
118 | diamond | 262 | * Sizes of the button must be more than 0 and less than 0x8000. |
131 | diamond | 263 | * For skinned windows definition of the window |
118 | diamond | 264 | (call of 0th function) creates two standard buttons - |
265 | for close of the window with identifier 1 and |
||
266 | for minimize of the window with identifier 0xffff. |
||
267 | * The creation of two buttons with same identifiers is admitted. |
||
268 | * The button with the identifier 0xffff at pressing is interpreted |
||
269 | by the system as the button of minimization, the system handles |
||
270 | such pressing independently, not accessing to the application. |
||
271 | In rest it is usual button. |
||
272 | * Total number of buttons for all applications is limited to 4095. |
||
114 | mikedld | 273 | |
6057 | IgorA | 274 | ---------------------- Constants for registers: ---------------------- |
275 | eax - SF_DEFINE_BUTTON (8) |
||
114 | mikedld | 276 | ====================================================================== |
118 | diamond | 277 | ============ Function 9 - information on execution thread. =========== |
114 | mikedld | 278 | ====================================================================== |
279 | Parameters: |
||
118 | diamond | 280 | * eax = 9 - function number |
281 | * ebx = pointer to 1-Kb buffer |
||
282 | * ecx = number of the slot of the thread |
||
283 | ecx = -1 - get information on the current thread |
||
114 | mikedld | 284 | Returned value: |
118 | diamond | 285 | * eax = maximum number of the slot of a thread |
286 | * buffer pointed to by ebx contains the following information: |
||
287 | * +0: dword: usage of the processor (how many time units |
||
288 | per second leaves on execution of this thread) |
||
114 | mikedld | 289 | * +4: word: position of the window of thread in the window stack |
118 | diamond | 290 | * +6: word: (has no relation to the specified thread) |
291 | number of the thread slot, which window has in the window stack |
||
292 | position ecx |
||
114 | mikedld | 293 | * +8: word: reserved |
294 | * +10 = +0xA: 11 bytes: name of the process |
||
2625 | mario79 | 295 | (name of the started file - executable file without extension) |
142 | diamond | 296 | * +21 = +0x15: byte: reserved, this byte is not changed |
114 | mikedld | 297 | * +22 = +0x16: dword: address of the process in memory |
298 | * +26 = +0x1A: dword: size of used memory - 1 |
||
299 | * +30 = +0x1E: dword: identifier (PID/TID) |
||
118 | diamond | 300 | * +34 = +0x22: dword: coordinate of the thread window on axis x |
301 | * +38 = +0x26: dword: coordinate of the thread window on axis y |
||
302 | * +42 = +0x2A: dword: size of the thread window on axis x |
||
303 | * +46 = +0x2E: dword: size of the thread window on axis y |
||
304 | * +50 = +0x32: word: status of the thread slot: |
||
305 | * 0 = thread is running |
||
306 | * 1 = thread is suspended |
||
307 | * 2 = thread is suspended while waiting for event |
||
308 | * 3 = thread is terminating as a result of call to function -1 |
||
309 | or under duress as a result of call to subfunction 2 |
||
310 | of function 18 or termination of the system |
||
311 | * 4 = thread is terminating as a result of exception |
||
312 | * 5 = thread waits for event |
||
313 | * 9 = requested slot is free, all other information on the slot |
||
314 | is not meaningful |
||
142 | diamond | 315 | * +52 = +0x34: word: reserved, this word is not changed |
316 | * +54 = +0x36: dword: coordinate of the client area on axis x |
||
317 | * +58 = +0x3A: dword: coordinate of the client area on axis y |
||
318 | * +62 = +0x3E: dword: width of the client area |
||
319 | * +66 = +0x42: dword: height of the client area |
||
320 | * +70 = +0x46: byte: state of the window - bitfield |
||
321 | * bit 0 (mask 1): window is maximized |
||
322 | * bit 1 (mask 2): window is minimized to panel |
||
323 | * bit 2 (mask 4): window is rolled up |
||
1663 | Nasarus | 324 | * +71 = +0x47: dword: event mask |
4264 | 0CodErr | 325 | * +75 = +0x4B: byte: keyboard mode(ASCII = 0; SCAN = 1) |
114 | mikedld | 326 | Remarks: |
118 | diamond | 327 | * Slots are numbered starting from 1. |
328 | * Returned value is not a total number of threads, because there |
||
329 | can be free slots. |
||
330 | * When process is starting, system automatically creates |
||
331 | execution thread. |
||
332 | * Function gives information on the thread. Each process has |
||
333 | at least one thread. One process can create many threads, |
||
334 | in this case each thread has its own slot and the fields |
||
335 | +10, +22, +26 in these slots coincide. |
||
336 | Applications have no common way to define whether two threads |
||
114 | mikedld | 337 | belong to one process. |
118 | diamond | 338 | * The active window - window on top of the window stack - |
339 | receives the messages on a keyboard input. For such window |
||
340 | the position in the window stack coincides with returned value. |
||
341 | * Slot 1 corresponds to special system thread, for which: |
||
342 | * the window is in the bottom of the window stack, the fields |
||
343 | +4 and +6 contain value 1 |
||
344 | * name of the process - "OS/IDLE" (supplemented by spaces) |
||
345 | * address of the process in memory is 0, size of used memory is |
||
114 | mikedld | 346 | 16 Mb (0x1000000) |
347 | * PID=1 |
||
142 | diamond | 348 | * coordinates and sizes of the window and the client area are by |
349 | convention set to 0 |
||
118 | diamond | 350 | * status of the slot is always 0 (running) |
351 | * the execution time adds of time leaving on operations itself |
||
352 | and idle time in waiting for interrupt (which can be got by call |
||
353 | to subfunction 4 of function 18). |
||
354 | * Beginning from slot 2, the normal applications are placed. |
||
1662 | Nasarus | 355 | * The normal applications are placed in memory at the address |
356 | |||
118 | diamond | 357 | There is no intersection, as each process has its own page table. |
358 | * At creation of the thread it is assigned the slot |
||
359 | in the system table and identifier (Process/Thread IDentifier = |
||
360 | PID/TID), which do not vary with time for given thread. |
||
361 | After completion of the thread its slot can be anew used |
||
362 | for another thread. The thread identifier can not be assigned |
||
363 | to other thread even after completion of this thread. |
||
364 | Identifiers, assigned to new threads, grow monotonously. |
||
365 | * If the thread has not yet defined the window by call to |
||
366 | function 0, the position and the sizes |
||
367 | of its window are considered to be zero. |
||
142 | diamond | 368 | * Coordinates of the client area are relative to the window. |
118 | diamond | 369 | * At the moment only the part of the buffer by a size |
4264 | 0CodErr | 370 | 76 = 0x4C bytes is used. Nevertheless it is recommended to use |
118 | diamond | 371 | 1-Kb buffer for the future compatibility, in the future |
372 | some fields can be added. |
||
114 | mikedld | 373 | |
6057 | IgorA | 374 | ---------------------- Constants for registers: ---------------------- |
375 | eax - SF_THREAD_INFO (9) |
||
114 | mikedld | 376 | ====================================================================== |
118 | diamond | 377 | ==================== Function 10 - wait for event. =================== |
114 | mikedld | 378 | ====================================================================== |
118 | diamond | 379 | If the message queue is empty, waits for appearance of the message |
380 | in queue. In this state thread does not consume CPU time. |
||
114 | mikedld | 381 | Then reads out the message from queue. |
382 | |||
383 | Parameters: |
||
118 | diamond | 384 | * eax = 10 - function number |
114 | mikedld | 385 | Returned value: |
118 | diamond | 386 | * eax = event (see the list of events) |
114 | mikedld | 387 | Remarks: |
118 | diamond | 388 | * Those events are taken into account only which enter into |
389 | a mask set by function 40. By default it is |
||
390 | redraw, key and button events. |
||
391 | * To check, whether there is a message in queue, use function 11. |
||
392 | To wait for no more than given time, use function 23. |
||
114 | mikedld | 393 | |
6057 | IgorA | 394 | ---------------------- Constants for registers: ---------------------- |
395 | eax - SF_WAIT_EVENT (10) |
||
118 | diamond | 396 | ====================================================================== |
397 | =============== Function 11 - check for event, no wait. ============== |
||
398 | ====================================================================== |
||
399 | If the message queue contains event, function reads out |
||
400 | and return it. If the queue is empty, function returns 0. |
||
114 | mikedld | 401 | Parameters: |
118 | diamond | 402 | * eax = 11 - function number |
114 | mikedld | 403 | Returned value: |
404 | * eax = 0 - message queue is empty |
||
118 | diamond | 405 | * else eax = event (see the list of events) |
114 | mikedld | 406 | Remarks: |
118 | diamond | 407 | * Those events are taken into account only, which enter into |
408 | a mask set by function 40. By default it is |
||
409 | redraw, key and button events. |
||
410 | * To wait for event, use function 10. |
||
411 | To wait for no more than given time, use function 23. |
||
114 | mikedld | 412 | |
6057 | IgorA | 413 | ---------------------- Constants for registers: ---------------------- |
414 | eax - SF_CHECK_EVENT (11) |
||
114 | mikedld | 415 | ====================================================================== |
118 | diamond | 416 | =============== Function 12 - begin/end window redraw. =============== |
114 | mikedld | 417 | ====================================================================== |
418 | |||
139 | diamond | 419 | ---------------- Subfunction 1 - begin window redraw. ---------------- |
114 | mikedld | 420 | Parameters: |
118 | diamond | 421 | * eax = 12 - function number |
422 | * ebx = 1 - subfunction number |
||
114 | mikedld | 423 | Returned value: |
424 | * function does not return value |
||
425 | |||
139 | diamond | 426 | ----------------- Subfunction 2 - end window redraw. ----------------- |
114 | mikedld | 427 | Parameters: |
118 | diamond | 428 | * eax = 12 - function number |
429 | * ebx = 2 - subfunction number |
||
114 | mikedld | 430 | Returned value: |
431 | * function does not return value |
||
432 | Remarks: |
||
118 | diamond | 433 | * Subfunction 1 deletes all buttons defined with |
434 | function 8, they must be defined again. |
||
114 | mikedld | 435 | |
6057 | IgorA | 436 | ---------------------- Constants for registers: ---------------------- |
437 | eax - SF_REDRAW (12) |
||
438 | ebx - SSF_BEGIN_DRAW (1), SSF_END_DRAW (2) |
||
114 | mikedld | 439 | ====================================================================== |
440 | ============ Function 13 - draw a rectangle in the window. =========== |
||
441 | ====================================================================== |
||
442 | Parameters: |
||
118 | diamond | 443 | * eax = 13 - function number |
114 | mikedld | 444 | * ebx = [coordinate on axis x]*65536 + [size on axis x] |
445 | * ecx = [coordinate on axis y]*65536 + [size on axis y] |
||
118 | diamond | 446 | * edx = color 0xRRGGBB or 0x80RRGGBB for gradient fill |
114 | mikedld | 447 | Returned value: |
448 | * function does not return value |
||
449 | Remarks: |
||
450 | * Coordinates are understood as coordinates of the left upper corner |
||
118 | diamond | 451 | of a rectangle relative to the window. |
114 | mikedld | 452 | |
6057 | IgorA | 453 | ---------------------- Constants for registers: ---------------------- |
454 | eax - SF_DRAW_RECT (13) |
||
114 | mikedld | 455 | ====================================================================== |
118 | diamond | 456 | =================== Function 14 - get screen size. =================== |
114 | mikedld | 457 | ====================================================================== |
458 | Parameters: |
||
118 | diamond | 459 | * eax = 14 - function number |
114 | mikedld | 460 | Returned value: |
461 | * eax = [xsize]*65536 + [ysize], where |
||
462 | * xsize = x-coordinate of the right lower corner of the screen = |
||
118 | diamond | 463 | horizontal size - 1 |
114 | mikedld | 464 | * ysize = y-coordinate of the right lower corner of the screen = |
118 | diamond | 465 | vertical size - 1 |
114 | mikedld | 466 | Remarks: |
118 | diamond | 467 | * See also subfunction 5 of function 48 - get sizes of |
468 | working area of the screen. |
||
114 | mikedld | 469 | |
6057 | IgorA | 470 | ---------------------- Constants for registers: ---------------------- |
471 | eax - SF_GET_SCREEN_SIZE (14) |
||
118 | diamond | 472 | ====================================================================== |
473 | == Function 15, subfunction 1 - set a size of the background image. == |
||
474 | ====================================================================== |
||
114 | mikedld | 475 | Parameters: |
118 | diamond | 476 | * eax = 15 - function number |
477 | * ebx = 1 - subfunction number |
||
114 | mikedld | 478 | * ecx = width of the image |
479 | * edx = height of the image |
||
480 | Returned value: |
||
481 | * function does not return value |
||
482 | Remarks: |
||
499 | diamond | 483 | * Before calling subfunctions 2 and 5 you should call this function |
485 | heavyiron | 484 | to set image size! |
118 | diamond | 485 | * For update of the screen (after completion of a series of commands |
486 | working with a background) call subfunction 3. |
||
487 | * There is a pair function for get size of the background image - |
||
488 | subfunction 1 of function 39. |
||
114 | mikedld | 489 | |
6057 | IgorA | 490 | ---------------------- Constants for registers: ---------------------- |
491 | eax - SF_BACKGROUND_SET (15) |
||
492 | ebx - SSF_SIZE_BG (1) |
||
114 | mikedld | 493 | ====================================================================== |
118 | diamond | 494 | === Function 15, subfunction 2 - put pixel on the background image. == |
114 | mikedld | 495 | ====================================================================== |
496 | Parameters: |
||
118 | diamond | 497 | * eax = 15 - function number |
498 | * ebx = 2 - subfunction number |
||
114 | mikedld | 499 | * ecx = offset |
118 | diamond | 500 | * edx = color of a pixel 0xRRGGBB |
114 | mikedld | 501 | Returned value: |
502 | * function does not return value |
||
503 | Remarks: |
||
118 | diamond | 504 | * Offset for a pixel with coordinates (x,y) is calculated as |
114 | mikedld | 505 | (x+y*xsize)*3. |
499 | diamond | 506 | * If the given offset exceeds size set by subfunction 1, |
118 | diamond | 507 | the call is ignored. |
508 | * For update of the screen (after completion of a series of commands |
||
509 | working with a background) call subfunction 3. |
||
510 | * There is a pair function for get pixel on the background image - |
||
511 | subfunction 2 of function 39. |
||
114 | mikedld | 512 | |
6057 | IgorA | 513 | ---------------------- Constants for registers: ---------------------- |
514 | eax - SF_BACKGROUND_SET (15) |
||
515 | ebx - SSF_PIXEL_BG (2) |
||
114 | mikedld | 516 | ====================================================================== |
517 | =========== Function 15, subfunction 3 - redraw background. ========== |
||
518 | ====================================================================== |
||
519 | Parameters: |
||
118 | diamond | 520 | * eax = 15 - function number |
521 | * ebx = 3 - subfunction number |
||
114 | mikedld | 522 | Returned value: |
523 | * function does not return value |
||
524 | |||
6057 | IgorA | 525 | ---------------------- Constants for registers: ---------------------- |
526 | eax - SF_BACKGROUND_SET (15) |
||
527 | ebx - SSF_REDRAW_BG (3) |
||
118 | diamond | 528 | ====================================================================== |
529 | == Function 15, subfunction 4 - set drawing mode for the background. = |
||
530 | ====================================================================== |
||
114 | mikedld | 531 | Parameters: |
118 | diamond | 532 | * eax = 15 - function number |
533 | * ebx = 4 - subfunction number |
||
534 | * ecx = drawing mode: |
||
114 | mikedld | 535 | * 1 = tile |
536 | * 2 = stretch |
||
537 | Returned value: |
||
538 | * function does not return value |
||
539 | Remarks: |
||
118 | diamond | 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 drawing mode of the background - |
||
543 | subfunction 4 of function 39. |
||
114 | mikedld | 544 | |
6057 | IgorA | 545 | ---------------------- Constants for registers: ---------------------- |
546 | eax - SF_BACKGROUND_SET (15) |
||
547 | ebx - SSF_MODE_BG (4) |
||
118 | diamond | 548 | ====================================================================== |
549 | ===================== Function 15, subfunction 5 ===================== |
||
550 | ============ Put block of pixels on the background image. ============ |
||
551 | ====================================================================== |
||
114 | mikedld | 552 | Parameters: |
118 | diamond | 553 | * eax = 15 - function number |
554 | * ebx = 5 - subfunction number |
||
555 | * ecx = pointer to the data in the format BBGGRRBBGGRR... |
||
114 | mikedld | 556 | * edx = offset in data of the background image |
118 | diamond | 557 | * esi = size of data in bytes = 3 * number of pixels |
114 | mikedld | 558 | Returned value: |
559 | * function does not return value |
||
560 | Remarks: |
||
499 | diamond | 561 | * Offset and size are not checked for correctness. |
118 | diamond | 562 | * Color of each pixel is stored as 3-bytes value BBGGRR. |
563 | * Pixels of the background image are written sequentially |
||
564 | from left to right, from up to down. |
||
565 | * Offset of pixel with coordinates (x,y) is (x+y*xsize)*3. |
||
566 | * For update of the screen (after completion of a series of commands |
||
567 | working with a background) call subfunction 3. |
||
114 | mikedld | 568 | |
6057 | IgorA | 569 | ---------------------- Constants for registers: ---------------------- |
570 | eax - SF_BACKGROUND_SET (15) |
||
571 | ebx - SSF_IMAGE_BG (5) |
||
114 | mikedld | 572 | ====================================================================== |
546 | diamond | 573 | ===================== Function 15, subfunction 6 ===================== |
574 | ======== Map background data to the address space of process. ======== |
||
575 | ====================================================================== |
||
576 | Parameters: |
||
577 | * eax = 15 - function number |
||
578 | * ebx = 6 - subfunction number |
||
579 | Returned value: |
||
580 | * eax = pointer to background data, 0 if error |
||
581 | Remarks: |
||
582 | * Mapped data are available for read and write. |
||
583 | * Size of background data is 3*xsize*ysize. The system blocks |
||
584 | changes of background sizes while process works with mapped data. |
||
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 | |||
6057 | IgorA | 589 | ---------------------- Constants for registers: ---------------------- |
590 | eax - SF_BACKGROUND_SET (15) |
||
591 | ebx - SSF_MAP_BG (6) |
||
546 | diamond | 592 | ====================================================================== |
593 | ===== Function 15, subfunction 7 - close mapped background data. ===== |
||
594 | ====================================================================== |
||
595 | Parameters: |
||
596 | * eax = 15 - function number |
||
597 | * ebx = 7 - subfunction number |
||
598 | * ecx = pointer to mapped data |
||
599 | Returned value: |
||
600 | * eax = 1 - success, 0 - error |
||
601 | |||
6057 | IgorA | 602 | ---------------------- Constants for registers: ---------------------- |
603 | eax - SF_BACKGROUND_SET (15) |
||
604 | ebx - SSF_UNMAP_BG (7) |
||
546 | diamond | 605 | ====================================================================== |
2515 | mario79 | 606 | ===================== Function 15, subfunction 8 ===================== |
607 | ============= Get coordinates of last draw the background ============ |
||
608 | ====================================================================== |
||
609 | Parameters: |
||
610 | * eax = 15 - function number |
||
611 | * ebx = 8 - subfunction number |
||
612 | Returned value: |
||
613 | * eax = [left]*65536 + [right] |
||
614 | * ebx = [top]*65536 + [bottom] |
||
615 | Remarks: |
||
616 | * (left,top) are coordinates of the left upper corner, |
||
617 | (right,bottom) are coordinates of the right lower one. |
||
618 | * For receiving more reliable information, call the function |
||
619 | immediately after the event: |
||
620 | 5 = kernel finished redrawing of the desktop background |
||
621 | |||
6057 | IgorA | 622 | ---------------------- Constants for registers: ---------------------- |
623 | eax - SF_BACKGROUND_SET (15) |
||
624 | ebx - SSF_LAST_DRAW (8) |
||
2515 | mario79 | 625 | ====================================================================== |
2547 | mario79 | 626 | ===================== Function 15, subfunction 9 ===================== |
627 | ============= Redraws a rectangular part of the background =========== |
||
628 | ====================================================================== |
||
629 | Parameters: |
||
630 | * eax = 15 - function number |
||
631 | * ebx = 9 - subfunction number |
||
632 | * ecx = [left]*65536 + [right] |
||
633 | * edx = [top]*65536 + [bottom] |
||
634 | Returned value: |
||
635 | * function does not return value |
||
636 | Remarks: |
||
637 | * (left,top) are coordinates of the left upper corner, |
||
638 | (right,bottom) are coordinates of the right lower one. |
||
639 | * If parameters are set incorrectly then background is not redrawn. |
||
640 | |||
6057 | IgorA | 641 | ---------------------- Constants for registers: ---------------------- |
642 | eax - SF_BACKGROUND_SET (15) |
||
643 | ebx - SSF_REDRAW_RECT (9) |
||
2547 | mario79 | 644 | ====================================================================== |
118 | diamond | 645 | =============== Function 16 - save ramdisk on a floppy. ============== |
114 | mikedld | 646 | ====================================================================== |
647 | Parameters: |
||
118 | diamond | 648 | * eax = 16 - function number |
649 | * ebx = 1 or ebx = 2 - on which floppy save |
||
114 | mikedld | 650 | Returned value: |
118 | diamond | 651 | * eax = 0 - success |
114 | mikedld | 652 | * eax = 1 - error |
653 | |||
6057 | IgorA | 654 | ---------------------- Constants for registers: ---------------------- |
655 | eax - SF_RD_TO_FLOPPY (16) |
||
114 | mikedld | 656 | ====================================================================== |
118 | diamond | 657 | ======= Function 17 - get the identifier of the pressed button. ====== |
114 | mikedld | 658 | ====================================================================== |
659 | Takes away the code of the pressed button from the buffer. |
||
660 | Parameters: |
||
118 | diamond | 661 | * eax = 17 - function number |
114 | mikedld | 662 | Returned value: |
118 | diamond | 663 | * if the buffer is empty, function returns eax=1 |
1018 | diamond | 664 | * if the buffer is not empty: |
665 | * high 24 bits of eax contain button identifier (in particular, |
||
666 | ah contains low byte of the identifier; if all buttons have |
||
667 | the identifier less than 256, ah is enough to distinguish) |
||
668 | * al = 0 - the button was pressed with left mouse button |
||
669 | * al = bit corresponding to used mouse button otherwise |
||
114 | mikedld | 670 | Remarks: |
118 | diamond | 671 | * "Buffer" keeps only one button, at pressing the new button the |
672 | information about old is lost. |
||
673 | * The call of this function by an application with inactive window |
||
674 | will return answer "buffer is empty". |
||
1018 | diamond | 675 | * Returned value for al corresponds to the state of mouse buttons |
676 | as in subfunction 2 of function 37 at the beginning |
||
677 | of button press, excluding lower bit, which is cleared. |
||
114 | mikedld | 678 | |
6057 | IgorA | 679 | ---------------------- Constants for registers: ---------------------- |
680 | eax - SF_GET_BUTTON (17) |
||
114 | mikedld | 681 | ====================================================================== |
2244 | mario79 | 682 | ===================== Function 18, subfunction 1 ===================== |
683 | ============= Make deactive the window of the given thread. ========== |
||
684 | ====================================================================== |
||
685 | Parameters: |
||
686 | * eax = 18 - function number |
||
687 | * ebx = 1 - subfunction number |
||
688 | * ecx = number of the thread slot |
||
689 | Returned value: |
||
690 | * function does not return value |
||
2409 | Serge | 691 | |
6057 | IgorA | 692 | ---------------------- Constants for registers: ---------------------- |
693 | eax - SF_SYSTEM (18) |
||
694 | ebx - SSF_UNFOCUS_WINDOW (1) |
||
2244 | mario79 | 695 | ====================================================================== |
118 | diamond | 696 | = Function 18, subfunction 2 - terminate process/thread by the slot. = |
114 | mikedld | 697 | ====================================================================== |
698 | Parameters: |
||
118 | diamond | 699 | * eax = 18 - function number |
700 | * ebx = 2 - subfunction number |
||
114 | mikedld | 701 | * ecx = number of the slot of process/thread |
702 | Returned value: |
||
703 | * function does not return value |
||
704 | Remarks: |
||
118 | diamond | 705 | * It is impossible to terminate system thread OS/IDLE (with |
706 | number of the slot 1), |
||
707 | it is possible to terminate any normal process/thread. |
||
708 | * See also subfunction 18 - terminate |
||
709 | process/thread by the identifier. |
||
114 | mikedld | 710 | |
6057 | IgorA | 711 | ---------------------- Constants for registers: ---------------------- |
712 | eax - SF_SYSTEM (18) |
||
713 | ebx - SSF_TERMINATE_THREAD (2) |
||
118 | diamond | 714 | ====================================================================== |
715 | ===================== Function 18, subfunction 3 ===================== |
||
716 | ============= Make active the window of the given thread. ============ |
||
717 | ====================================================================== |
||
114 | mikedld | 718 | Parameters: |
118 | diamond | 719 | * eax = 18 - function number |
720 | * ebx = 3 - subfunction number |
||
721 | * ecx = number of the thread slot |
||
114 | mikedld | 722 | Returned value: |
723 | * function does not return value |
||
724 | Remarks: |
||
118 | diamond | 725 | * If correct, but nonexistent slot is given, |
726 | some window is made active. |
||
727 | * To find out, which window is active, use subfunction 7. |
||
114 | mikedld | 728 | |
6057 | IgorA | 729 | ---------------------- Constants for registers: ---------------------- |
730 | eax - SF_SYSTEM (18) |
||
731 | ebx - SSF_FOCUS_WINDOW (3) |
||
118 | diamond | 732 | ====================================================================== |
733 | ===================== Function 18, subfunction 4 ===================== |
||
734 | =========== Get counter of idle time units per one second. =========== |
||
735 | ====================================================================== |
||
736 | Idle time units are units, in which the processor stands idle |
||
737 | in waiting for interrupt (in the command 'hlt'). |
||
114 | mikedld | 738 | |
739 | Parameters: |
||
118 | diamond | 740 | * eax = 18 - function number |
741 | * ebx = 4 - subfunction number |
||
114 | mikedld | 742 | Returned value: |
118 | diamond | 743 | * eax = value of the counter of idle time units per one second |
114 | mikedld | 744 | |
6057 | IgorA | 745 | ---------------------- Constants for registers: ---------------------- |
746 | eax - SF_SYSTEM (18) |
||
747 | ebx - SSF_GET_IDLE_COUNT (4) |
||
114 | mikedld | 748 | ====================================================================== |
118 | diamond | 749 | ========== Function 18, subfunction 5 - get CPU clock rate. ========== |
114 | mikedld | 750 | ====================================================================== |
751 | Parameters: |
||
118 | diamond | 752 | * eax = 18 - function number |
753 | * ebx = 5 - subfunction number |
||
114 | mikedld | 754 | Returned value: |
118 | diamond | 755 | * eax = clock rate (modulo 2^32 clock ticks = 4GHz) |
114 | mikedld | 756 | |
6057 | IgorA | 757 | ---------------------- Constants for registers: ---------------------- |
758 | eax - SF_SYSTEM (18) |
||
6683 | leency | 759 | ebx - SSF_GET_CPU_FREQUENCY (5) |
118 | diamond | 760 | ====================================================================== |
2409 | Serge | 761 | Function 18, subfunction 6 - save ramdisk to the file on hard drive. |
118 | diamond | 762 | ====================================================================== |
114 | mikedld | 763 | Parameters: |
118 | diamond | 764 | * eax = 18 - function number |
765 | * ebx = 6 - subfunction number |
||
341 | heavyiron | 766 | * ecx = pointer to the full path to file |
767 | (for example, "/hd0/1/kolibri/kolibri.img") |
||
114 | mikedld | 768 | Returned value: |
118 | diamond | 769 | * eax = 0 - success |
770 | * else eax = error code of the file system |
||
499 | diamond | 771 | Remarks: |
118 | diamond | 772 | * All folders in the given path must exist, otherwise function |
773 | returns value 5, "file not found". |
||
114 | mikedld | 774 | |
6057 | IgorA | 775 | ---------------------- Constants for registers: ---------------------- |
776 | eax - SF_SYSTEM (18) |
||
777 | ebx - SSF_RD_TO_HDD (6) |
||
114 | mikedld | 778 | ====================================================================== |
118 | diamond | 779 | =========== Function 18, subfunction 7 - get active window. ========== |
114 | mikedld | 780 | ====================================================================== |
781 | Parameters: |
||
118 | diamond | 782 | * eax = 18 - function number |
783 | * ebx = 7 - subfunction number |
||
114 | mikedld | 784 | Returned value: |
118 | diamond | 785 | * eax = number of the active window |
786 | (number of the slot of the thread with active window) |
||
114 | mikedld | 787 | Remarks: |
118 | diamond | 788 | * Active window is at the top of the window stack and receives |
789 | messages on all keyboard input. |
||
790 | * To make a window active, use subfunction 3. |
||
114 | mikedld | 791 | |
6057 | IgorA | 792 | ---------------------- Constants for registers: ---------------------- |
793 | eax - SF_SYSTEM (18) |
||
794 | ebx - SSF_GET_ACTIVE_WINDOW (7) |
||
118 | diamond | 795 | ====================================================================== |
796 | == Function 18, subfunction 8 - disable/enable the internal speaker. = |
||
797 | ====================================================================== |
||
798 | If speaker sound is disabled, all calls to subfunction 55 of |
||
799 | function 55 are ignored. If speaker sound is enabled, |
||
800 | they are routed on builtin speaker. |
||
114 | mikedld | 801 | |
118 | diamond | 802 | ------------------- Subsubfunction 1 - get status. ------------------- |
114 | mikedld | 803 | Parameters: |
118 | diamond | 804 | * eax = 18 - function number |
805 | * ebx = 8 - subfunction number |
||
806 | * ecx = 1 - number of the subsubfunction |
||
114 | mikedld | 807 | Returned value: |
118 | diamond | 808 | * eax = 0 - speaker sound is enabled; 1 - disabled |
114 | mikedld | 809 | |
118 | diamond | 810 | ----------------- Subsubfunction 2 - toggle status. ------------------ |
811 | Toggles states of disable/enable. |
||
114 | mikedld | 812 | Parameters: |
118 | diamond | 813 | * eax = 18 - function number |
814 | * ebx = 8 - subfunction number |
||
815 | * ecx = 2 - number of the subsubfunction |
||
114 | mikedld | 816 | Returned value: |
817 | * function does not return value |
||
818 | |||
6057 | IgorA | 819 | ---------------------- Constants for registers: ---------------------- |
820 | eax - SF_SYSTEM (18) |
||
821 | ebx - SSF_SPEAKER (8) |
||
822 | ecx - SSSF_GET_STATE (1), SSSF_TOGGLE (2) |
||
118 | diamond | 823 | ====================================================================== |
1018 | diamond | 824 | == Function 18, subfunction 9 - system shutdown with the parameter. == |
118 | diamond | 825 | ====================================================================== |
114 | mikedld | 826 | Parameters: |
118 | diamond | 827 | * eax = 18 - function number |
828 | * ebx = 9 - subfunction number |
||
114 | mikedld | 829 | * ecx = parameter: |
118 | diamond | 830 | * 2 = turn off computer |
831 | * 3 = reboot computer |
||
832 | * 4 = restart the kernel from the file 'kernel.mnt' on ramdisk |
||
114 | mikedld | 833 | Returned value: |
118 | diamond | 834 | * at incorrect ecx the registers do not change (i.e. eax=18) |
835 | * by correct call function always returns eax=0 |
||
836 | as the tag of success |
||
114 | mikedld | 837 | Remarks: |
118 | diamond | 838 | * Do not rely on returned value by incorrect call, it can be |
839 | changed in future versions of the kernel. |
||
1018 | diamond | 840 | |
6057 | IgorA | 841 | ---------------------- Constants for registers: ---------------------- |
842 | eax - SF_SYSTEM (18) |
||
843 | ebx - SSF_SHUTDOWN (9) |
||
118 | diamond | 844 | ====================================================================== |
4573 | clevermous | 845 | ======= Function 18, subfunction 10 - minimize topmost window. ======= |
118 | diamond | 846 | ====================================================================== |
4573 | clevermous | 847 | Minimizes the topmost (active) window. |
114 | mikedld | 848 | Parameters: |
118 | diamond | 849 | * eax = 18 - function number |
850 | * ebx = 10 - subfunction number |
||
114 | mikedld | 851 | Returned value: |
852 | * function does not return value |
||
853 | Remarks: |
||
118 | diamond | 854 | * The minimized window from the point of view of function 9 |
855 | keeps position and sizes. |
||
2409 | Serge | 856 | * Restoring of an application window occurs at its activation by |
118 | diamond | 857 | subfunction 3. |
4573 | clevermous | 858 | * Usually there is no necessity to minimize/restore a window |
859 | explicitly: minimization of a window is carried out by the system |
||
118 | diamond | 860 | at pressing the minimization button (for skinned windows |
861 | it is defined automatically by function 0, |
||
862 | for other windows it can be defined manually by function 8), |
||
5452 | leency | 863 | restore of a window is done by the application '@taskbar'. |
114 | mikedld | 864 | |
6057 | IgorA | 865 | ---------------------- Constants for registers: ---------------------- |
866 | eax - SF_SYSTEM (18) |
||
867 | ebx - SSF_MINIMIZE_WINDOW (10) |
||
114 | mikedld | 868 | ====================================================================== |
2409 | Serge | 869 | Function 18, subfunction 11 - get information on the disk subsystem. |
114 | mikedld | 870 | ====================================================================== |
871 | Parameters: |
||
118 | diamond | 872 | * eax = 18 - function number |
873 | * ebx = 11 - subfunction number |
||
114 | mikedld | 874 | * ecx = type of the table: |
4700 | mario79 | 875 | * 1 = short version, 16 bytes |
118 | diamond | 876 | * edx = pointer to the buffer (in the application) for the table |
114 | mikedld | 877 | Returned value: |
878 | * function does not return value |
||
118 | diamond | 879 | Format of the table: short version: |
880 | * +0: byte: information about FDD's (drives for floppies), |
||
881 | AAAABBBB, where AAAA gives type of the first drive, BBBB - |
||
882 | of the second regarding to the following list: |
||
114 | mikedld | 883 | * 0 = there is no drive |
884 | * 1 = 360Kb, 5.25'' |
||
885 | * 2 = 1.2Mb, 5.25'' |
||
886 | * 3 = 720Kb, 3.5'' |
||
887 | * 4 = 1.44Mb, 3.5'' |
||
118 | diamond | 888 | * 5 = 2.88Mb, 3.5'' (such drives are not used anymore) |
889 | For example, for the standard configuration from one 1.44-drive |
||
890 | here will be 40h, and for the case 1.2Mb on A: and 1.44Mb on B: |
||
5452 | leency | 891 | the value is 24h. |
6079 | serge | 892 | |
4700 | mario79 | 893 | First IDE controller: |
118 | diamond | 894 | * +1: byte: information about hard disks and CD-drives, AABBCCDD, |
114 | mikedld | 895 | where AA corresponds to the controller IDE0, ..., DD - IDE3: |
4700 | mario79 | 896 | * 0 = device not found |
118 | diamond | 897 | * 1 = hard drive |
898 | * 2 = CD-drive |
||
899 | For example, in the case HD on IDE0 and CD on IDE2 |
||
900 | this field contains 48h. |
||
901 | * +2: 4 db: number of the retrieved partitions on hard disks |
||
5452 | leency | 902 | at accordingly IDE0,...,IDE3. |
6079 | serge | 903 | |
5452 | leency | 904 | Second IDE controller: |
905 | * +6: byte: information about hard disks and CD-drives, AABBCCDD, |
||
906 | where AA corresponds to the controller IDE4, ..., DD - IDE7: |
||
907 | * 0 = device not found |
||
908 | * 1 = hard drive |
||
909 | * 2 = CD-drive |
||
910 | For example, in the case HD on IDE4 and CD on IDE6 |
||
911 | this field contains 48h. |
||
912 | * +7: 4 db: number of the retrieved partitions on hard disks |
||
913 | at accordingly IDE4,...,IDE7. |
||
914 | |||
915 | Third IDE controller: |
||
916 | * +11: byte: information about hard disks and CD-drives, AABBCCDD, |
||
917 | where AA corresponds to the controller IDE8, ..., DD - IDE11: |
||
918 | * 0 = device not found |
||
919 | * 1 = hard drive |
||
920 | * 2 = CD-drive |
||
921 | For example, in the case HD on IDE8 and CD on IDE10 |
||
922 | this field contains 48h. |
||
923 | * +12: 4 db: number of the retrieved partitions on hard disks |
||
6079 | serge | 924 | at accordingly IDE8,...,IDE11. |
925 | |||
118 | diamond | 926 | If the hard disk on IDEx is absent, appropriate byte is zero, |
927 | otherwise it shows number of the recognized partitions, which |
||
928 | can be not presented (if the drive is not formatted or if |
||
929 | the file system is not supported). Current version of the kernel |
||
4700 | mario79 | 930 | supports only FAT12/16/32, NTFS, ext2/3/4 and XFS for hard disks. |
4641 | mario79 | 931 | |
114 | mikedld | 932 | Remarks: |
4700 | mario79 | 933 | * The table can be used for obtaining the information about |
118 | diamond | 934 | available devices. |
114 | mikedld | 935 | |
6057 | IgorA | 936 | ---------------------- Constants for registers: ---------------------- |
937 | eax - SF_SYSTEM (18) |
||
938 | ebx - SSF_INFO_DISC_SYS (11) |
||
114 | mikedld | 939 | ====================================================================== |
118 | diamond | 940 | ========== Function 18, subfunction 13 - get kernel version. ========= |
114 | mikedld | 941 | ====================================================================== |
942 | Parameters: |
||
118 | diamond | 943 | * eax = 18 - function number |
944 | * ebx = 13 - subfunction number |
||
945 | * ecx = pointer to the buffer (not less than 16 bytes), where |
||
946 | the information will be placed |
||
114 | mikedld | 947 | Returned value: |
948 | * function does not return value |
||
949 | Structure of the buffer: |
||
950 | db a,b,c,d for version a.b.c.d |
||
1675 | Nasarus | 951 | db 0: reserved |
540 | victor | 952 | dd REV - kernel SVN revision number |
1675 | Nasarus | 953 | For Kolibri 0.7.7.0+ kernel: |
1662 | Nasarus | 954 | db 0,7,7,0 |
1675 | Nasarus | 955 | db 0 |
1676 | Nasarus | 956 | dd 1675 |
114 | mikedld | 957 | |
6057 | IgorA | 958 | ---------------------- Constants for registers: ---------------------- |
959 | eax - SF_SYSTEM (18) |
||
960 | ebx - SSF_KERNEL_VERSION (13) |
||
118 | diamond | 961 | ====================================================================== |
962 | ======= Function 18, subfunction 14 - wait for screen retrace. ======= |
||
963 | ====================================================================== |
||
964 | Waits for the beginning of retrace of the scanning ray of the screen |
||
965 | monitor. |
||
114 | mikedld | 966 | Parameters: |
118 | diamond | 967 | * eax = 18 - function number |
968 | * ebx = 14 - subfunction number |
||
114 | mikedld | 969 | Returned value: |
118 | diamond | 970 | * eax = 0 as the tag of success |
114 | mikedld | 971 | Remarks: |
118 | diamond | 972 | * Function is intended only for active high-efficiency graphics |
114 | mikedld | 973 | applications; is used for smooth output of a graphics. |
974 | |||
6057 | IgorA | 975 | ---------------------- Constants for registers: ---------------------- |
976 | eax - SF_SYSTEM (18) |
||
977 | ebx - SSF_WAIT_RETRACE (14) |
||
118 | diamond | 978 | ====================================================================== |
979 | == Function 18, subfunction 15 - center mouse cursor on the screen. == |
||
980 | ====================================================================== |
||
114 | mikedld | 981 | Parameters: |
118 | diamond | 982 | * eax = 18 - function number |
983 | * ebx = 15 - subfunction number |
||
114 | mikedld | 984 | Returned value: |
118 | diamond | 985 | * eax = 0 as the tag of success |
114 | mikedld | 986 | |
6057 | IgorA | 987 | ---------------------- Constants for registers: ---------------------- |
988 | eax - SF_SYSTEM (18) |
||
989 | ebx - SSF_CURSOR_CENTER (15) |
||
114 | mikedld | 990 | ====================================================================== |
118 | diamond | 991 | ========= Function 18, subfunction 16 - get size of free RAM. ======== |
114 | mikedld | 992 | ====================================================================== |
993 | Parameters: |
||
118 | diamond | 994 | * eax = 18 - function number |
995 | * ebx = 16 - subfunction number |
||
114 | mikedld | 996 | Returned value: |
997 | * eax = size of free memory in kilobytes |
||
998 | |||
6057 | IgorA | 999 | ---------------------- Constants for registers: ---------------------- |
1000 | eax - SF_SYSTEM (18) |
||
1001 | ebx - SSF_GET_FREE_RAM (16) |
||
114 | mikedld | 1002 | ====================================================================== |
118 | diamond | 1003 | ======== Function 18, subfunction 17 - get full amount of RAM. ======= |
114 | mikedld | 1004 | ====================================================================== |
1005 | Parameters: |
||
118 | diamond | 1006 | * eax = 18 - function number |
1007 | * ebx = 17 - subfunction number |
||
114 | mikedld | 1008 | Returned value: |
118 | diamond | 1009 | * eax = total size of existing memory in kilobytes |
114 | mikedld | 1010 | |
6057 | IgorA | 1011 | ---------------------- Constants for registers: ---------------------- |
1012 | eax - SF_SYSTEM (18) |
||
1013 | ebx - SSF_GET_TOTAL_RAM (17) |
||
114 | mikedld | 1014 | ====================================================================== |
118 | diamond | 1015 | ===================== Function 18, subfunction 18 ==================== |
1016 | ============= Terminate process/thread by the identifier. ============ |
||
114 | mikedld | 1017 | ====================================================================== |
1018 | Parameters: |
||
118 | diamond | 1019 | * eax = 18 - function number |
1020 | * ebx = 18 - subfunction number |
||
1021 | * ecx = identifer of process/thread (PID/TID) |
||
114 | mikedld | 1022 | Returned value: |
118 | diamond | 1023 | * eax = 0 - success |
1024 | * eax = -1 - error (process is not found or is system) |
||
114 | mikedld | 1025 | Remarks: |
118 | diamond | 1026 | * It is impossible to terminate system thread OS/IDLE (identifier |
1027 | 1), it is possible to terminate any normal process/thread. |
||
1028 | * See also subfunction 2 - terminate |
||
1029 | process/thread by given slot. |
||
114 | mikedld | 1030 | |
6057 | IgorA | 1031 | ---------------------- Constants for registers: ---------------------- |
1032 | eax - SF_SYSTEM (18) |
||
1033 | ebx - SSF_TERMINATE_THREAD_ID (18) |
||
114 | mikedld | 1034 | ====================================================================== |
131 | diamond | 1035 | ======== Function 18, subfunction 19 - get/set mouse features. ======= |
120 | mario79 | 1036 | ====================================================================== |
131 | diamond | 1037 | |
1038 | ---------------- Subsubfunction 0 - get mouse speed. ----------------- |
||
120 | mario79 | 1039 | Parameters: |
1040 | * eax = 18 - function number |
||
1041 | * ebx = 19 - subfunction number |
||
131 | diamond | 1042 | * ecx = 0 - subsubfunction number |
1043 | Returned value: |
||
6235 | pathoswith | 1044 | * eax = current speed divider |
120 | mario79 | 1045 | |
131 | diamond | 1046 | ---------------- Subsubfunction 1 - set mouse speed. ----------------- |
1047 | Parameters: |
||
1048 | * eax = 18 - function number |
||
1049 | * ebx = 19 - subfunction number |
||
1050 | * ecx = 1 - subsubfunction number |
||
6235 | pathoswith | 1051 | * edx = new value for speed divider |
131 | diamond | 1052 | Returned value: |
1053 | * function does not return value |
||
120 | mario79 | 1054 | |
6235 | pathoswith | 1055 | Remark: recommended speed divider = 4 |
5956 | pathoswith | 1056 | |
6235 | pathoswith | 1057 | -------------- Subsubfunction 2 - get mouse sensitivity -------------- |
131 | diamond | 1058 | Parameters: |
1059 | * eax = 18 - function number |
||
1060 | * ebx = 19 - subfunction number |
||
1061 | * ecx = 2 - subsubfunction number |
||
1062 | Returned value: |
||
6235 | pathoswith | 1063 | * eax = current sensitivity |
120 | mario79 | 1064 | |
6235 | pathoswith | 1065 | -------------- Subsubfunction 3 - set mouse sensitivity -------------- |
131 | diamond | 1066 | Parameters: |
1067 | * eax = 18 - function number |
||
1068 | * ebx = 19 - subfunction number |
||
1069 | * ecx = 3 - subsubfunction number |
||
6235 | pathoswith | 1070 | * edx = new value for sensitivity |
131 | diamond | 1071 | Returned value: |
1072 | * function does not return value |
||
120 | mario79 | 1073 | |
6235 | pathoswith | 1074 | Remark: recommended sensitivity = 3 |
1075 | |||
131 | diamond | 1076 | ----------- Subsubfunction 4 - set mouse pointer position. ----------- |
1077 | Parameters: |
||
1078 | * eax = 18 - function number |
||
1079 | * ebx = 19 - subfunction number |
||
1080 | * ecx = 4 - subsubfunction number |
||
1081 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
1082 | Returned value: |
||
1083 | * function does not return value |
||
621 | mario79 | 1084 | |
641 | diamond | 1085 | -------- Subsubfunction 5 - simulate state of mouse buttons. --------- |
621 | mario79 | 1086 | Parameters: |
1087 | * eax = 18 - function number |
||
1088 | * ebx = 19 - subfunction number |
||
1089 | * ecx = 5 - subsubfunction number |
||
641 | diamond | 1090 | * edx = information about emulated state of mouse buttons: |
1091 | (same as return value in subfunction 2 of function 37) |
||
621 | mario79 | 1092 | * bit 0 is set = left button is pressed |
1093 | * bit 1 is set = right button is pressed |
||
1094 | * bit 2 is set = middle button is pressed |
||
1095 | * bit 3 is set = 4th button is pressed |
||
1096 | * bit 4 is set = 5th button is pressed |
||
1097 | Returned value: |
||
1098 | * function does not return value |
||
5851 | pathoswith | 1099 | |
1100 | -------------- Subsubfunction 6 - get doubleclick delay. ------------- |
||
1101 | Parameters: |
||
1102 | * eax = 18 - function number |
||
1103 | * ebx = 19 - subfunction number |
||
1104 | * ecx = 6 - subsubfunction number |
||
1105 | Returned value: |
||
1106 | * eax = current doubleclick delay (100 = 1 second) |
||
1107 | |||
1108 | -------------- Subsubfunction 7 - set doubleclick delay. ------------- |
||
1109 | Parameters: |
||
1110 | * eax = 18 - function number |
||
1111 | * ebx = 19 - subfunction number |
||
1112 | * ecx = 7 - subsubfunction number |
||
1113 | * dl = new value for doubleclick delay (100 = 1 second) |
||
1114 | Returned value: |
||
1115 | * function does not return value |
||
1116 | |||
5956 | pathoswith | 1117 | Remark: mouse settings can be modified in the application mouse_cfg. |
120 | mario79 | 1118 | |
6057 | IgorA | 1119 | ---------------------- Constants for registers: ---------------------- |
1120 | eax - SF_SYSTEM (18) |
||
1121 | ebx - SSF_MOUSE_SETTINGS (19) |
||
1122 | ecx - SSSF_GET_SPEED (0), SSSF_SET_SPEED (1), SSSF_GET_SPEEDUP (2), |
||
1123 | SSSF_SET_SPEEDUP (3), SSSF_SET_POS (4), SSSF_SET_BUTTON (5), |
||
1124 | SSSF_GET_DOUBLE_CLICK_DELAY (6), SSSF_SET_DOUBLE_CLICK_DELAY (7) |
||
120 | mario79 | 1125 | ====================================================================== |
193 | diamond | 1126 | ======== Function 18, subfunction 20 - get information on RAM. ======= |
1127 | ====================================================================== |
||
1128 | Parameters: |
||
1129 | * eax = 18 - function number |
||
1130 | * ebx = 20 - subfunction number |
||
1131 | * ecx = pointer to the buffer for information (36 bytes) |
||
1132 | Returned value: |
||
1133 | * eax = total size of existing RAM in pages |
||
1134 | or -1 if error has occured |
||
1135 | * buffer pointed to by ecx contains the following information: |
||
1136 | * +0: dword: total size of existing RAM in pages |
||
1137 | * +4: dword: size of free RAM in pages |
||
1138 | * +8: dword: number of page faults (exceptions #PF) |
||
1139 | in applications |
||
1140 | * +12: dword: size of kernel heap in bytes |
||
1141 | * +16: dword: free in kernel heap in bytes |
||
1142 | * +20: dword: total number of memory blocks in kernel heap |
||
1143 | * +24: dword: number of free memory blocks in kernel heap |
||
1144 | * +28: dword: size of maximum free block in kernel heap |
||
1145 | (reserved) |
||
1146 | * +32: dword: size of maximum allocated block in kernel heap |
||
1147 | (reserved) |
||
1148 | |||
6057 | IgorA | 1149 | ---------------------- Constants for registers: ---------------------- |
1150 | eax - SF_SYSTEM (18) |
||
1151 | ebx - SSF_GET_RAM_INFO (20) |
||
193 | diamond | 1152 | ====================================================================== |
641 | diamond | 1153 | ===================== Function 18, subfunction 21 ==================== |
1154 | ======== Get slot number of process/thread by the identifier. ======== |
||
608 | alver | 1155 | ====================================================================== |
1156 | Parameters: |
||
1157 | * eax = 18 - function number |
||
1158 | * ebx = 21 - subfunction number |
||
641 | diamond | 1159 | * ecx = identifer of process/thread (PID/TID) |
608 | alver | 1160 | Returned value: |
641 | diamond | 1161 | * eax = 0 - error (invalid identifier) |
1162 | * otherwise eax = slot number |
||
608 | alver | 1163 | |
6057 | IgorA | 1164 | ---------------------- Constants for registers: ---------------------- |
1165 | eax - SF_SYSTEM (18) |
||
1166 | ebx - SSF_GET_THREAD_SLOT (21) |
||
608 | alver | 1167 | ====================================================================== |
641 | diamond | 1168 | ===================== Function 18, subfunction 22 ==================== |
1169 | ============== Operations with window of another thread. ============= |
||
608 | alver | 1170 | ====================================================================== |
1171 | Parameters: |
||
1172 | * eax = 18 - function number |
||
1173 | * ebx = 22 - subfunction number |
||
641 | diamond | 1174 | * ecx = operation type: |
1175 | * 0 = minimize window of the thread with given slot number |
||
1176 | * 1 = minimize window of the thread with given identifier |
||
1177 | * 2 = restore window of the thread with given slot number |
||
1178 | * 3 = restore window of the thread with given identifier |
||
1179 | * edx = parameter (slot number or PID/TID) |
||
608 | alver | 1180 | Returned value: |
641 | diamond | 1181 | * eax = 0 - success |
1182 | * eax = -1 - error (invalid identifier) |
||
1183 | Remarks: |
||
1184 | * The thread can minimize its window with subfunction 10. |
||
1185 | * One can restore and activate window simultaneously with |
||
1186 | subfunction 3 (which requires slot number). |
||
608 | alver | 1187 | |
6057 | IgorA | 1188 | ---------------------- Constants for registers: ---------------------- |
1189 | eax - SF_SYSTEM (18) |
||
1190 | ebx - SSF_FOREIGN_WINDOW (22) |
||
1191 | ecx - SSSF_MINIMIZE (0), SSSF_MINIMIZE_ID (1), SSSF_RESTORE (2), |
||
1192 | SSSF_RESTORE_ID (3) |
||
608 | alver | 1193 | ====================================================================== |
2648 | mario79 | 1194 | ======== Function 18, subfunction 23 - minimize all windows. ========== |
1195 | ====================================================================== |
||
1196 | Parameters: |
||
1197 | * eax = 18 - function number |
||
1198 | * ebx = 23 - subfunction number |
||
1199 | Returned value: |
||
1200 | * eax = 0 - all windows have been minimized before a function call |
||
1201 | * eax = N - number of windows minimized from function |
||
1202 | Remarks: |
||
1203 | * Window of special thread (name begin to symbol @) is not minimize. |
||
2654 | mario79 | 1204 | |
6057 | IgorA | 1205 | ---------------------- Constants for registers: ---------------------- |
1206 | eax - SF_SYSTEM (18) |
||
1207 | ebx - SSF_MINIMIZE_ALL (23) |
||
2648 | mario79 | 1208 | ====================================================================== |
2654 | mario79 | 1209 | ======= Function 18, subfunction 24 - set limits of screen. ========== |
1210 | ====================================================================== |
||
1211 | Parameters: |
||
1212 | * eax = 18 - function number |
||
1213 | * ebx = 24 - subfunction number |
||
1214 | * ecx = new X size |
||
1215 | * edx = new Y size |
||
1216 | Returned value: |
||
1217 | * function does not return value |
||
1218 | Remarks: |
||
1219 | * The function does not change the physical size of the video mode. |
||
1220 | It is designed for non-standard displays which display the image |
||
1221 | partially. |
||
1222 | * The sizes specified in the function should not exceed the sizes |
||
1223 | of the current video mode, otherwise the function will not change |
||
1224 | anything. |
||
1225 | |||
6057 | IgorA | 1226 | ---------------------- Constants for registers: ---------------------- |
1227 | eax - SF_SYSTEM (18) |
||
1228 | ebx - SSF_SET_SCREEN_LIMITS (24) |
||
2654 | mario79 | 1229 | ====================================================================== |
5836 | GerdtR | 1230 | ===================== Function 18, subfunction 25 ==================== |
1231 | ===== Control position of the window relative to other windows. ====== |
||
1232 | ====================================================================== |
||
1233 | |||
1234 | ------------- Subsubfunction 1 - get position ----------------------- |
||
1235 | Parameters: |
||
1236 | * eax = 18 - function number |
||
1237 | * ebx = 25 - subfunction number |
||
1238 | * ecx = 1 - subsubfunction number |
||
1239 | * edx = -1(for current window) or PID application |
||
1240 | Returned value: |
||
1241 | * eax = one of the constants window position |
||
1242 | |||
1243 | ------------- Subsubfunction 2 - set position ----------------------- |
||
1244 | Parameters: |
||
1245 | * eax = 18 - function number |
||
1246 | * ebx = 25 - subfunction number |
||
1247 | * ecx = 2 - subsubfunction number |
||
1248 | * edx = -1(for current window) or PID application |
||
1249 | * esi = new window position (one of the constants below) |
||
1250 | Returned value: |
||
1251 | * eax = 0 - error |
||
1252 | * eax = 1 - success |
||
1253 | |||
1254 | Constant position of the window relative to other windows: |
||
5865 | GerdtR | 1255 | ZPOS_DESKTOP = -2 - on the background |
1256 | ZPOS_ALWAYS_BACK = -1 - behind all the windows |
||
1257 | ZPOS_NORMAL = 0 - normal |
||
1258 | ZPOS_ALWAYS_TOP = 1 - on top of all windows |
||
5836 | GerdtR | 1259 | |
6057 | IgorA | 1260 | ---------------------- Constants for registers: ---------------------- |
1261 | eax - SF_SYSTEM (18) |
||
1262 | ebx - SSF_WINDOW_BEHAVIOR (25) |
||
1263 | ecx - SSSF_GET_WB (1), SSSF_SET_WB (2) |
||
5836 | GerdtR | 1264 | ====================================================================== |
118 | diamond | 1265 | ==================== Function 20 - MIDI interface. =================== |
114 | mikedld | 1266 | ====================================================================== |
1267 | |||
118 | diamond | 1268 | ----------------------- Subfunction 1 - reset ------------------------ |
114 | mikedld | 1269 | Parameters: |
118 | diamond | 1270 | * eax = 20 - function number |
1271 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1272 | |
1273 | -------------------- Subfunction 2 - output byte --------------------- |
||
1274 | Parameters: |
||
118 | diamond | 1275 | * eax = 20 - function number |
1276 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1277 | * cl = byte for output |
118 | diamond | 1278 | Returned value (is the same for both subfunctions): |
1279 | * eax = 0 - success |
||
114 | mikedld | 1280 | * eax = 1 - base port is not defined |
1281 | Remarks: |
||
2409 | Serge | 1282 | * Previously the base port must be defined by |
118 | diamond | 1283 | subfunction 1 of function 21. |
114 | mikedld | 1284 | |
6057 | IgorA | 1285 | ---------------------- Constants for registers: ---------------------- |
1286 | eax - SF_MIDI (20) |
||
1287 | ebx - SSF_RESET (1), SSF_OUTPUT (2) |
||
114 | mikedld | 1288 | ====================================================================== |
118 | diamond | 1289 | ======== Function 21, subfunction 1 - set MPU MIDI base port. ======== |
114 | mikedld | 1290 | ====================================================================== |
1291 | Parameters: |
||
118 | diamond | 1292 | * eax = 21 - function number |
1293 | * ebx = 1 - subfunction number |
||
1294 | * ecx = number of base port |
||
1295 | Returned value |
||
1296 | * eax = 0 - success |
||
114 | mikedld | 1297 | * eax = -1 - erratic number of a port |
1298 | Remarks: |
||
118 | diamond | 1299 | * Number of a port must satisfy to conditions 0x100<=ecx<=0xFFFF. |
1300 | * The installation of base is necessary for function 20. |
||
1301 | * To get base port use subfunction 1 of function 26. |
||
114 | mikedld | 1302 | |
6057 | IgorA | 1303 | ---------------------- Constants for registers: ---------------------- |
1304 | eax - SF_SYSTEM_SET (21) |
||
1305 | ebx - SSF_MPU_MIDI_BASE (1) |
||
114 | mikedld | 1306 | ====================================================================== |
118 | diamond | 1307 | ========== Function 21, subfunction 2 - set keyboard layout. ========= |
114 | mikedld | 1308 | ====================================================================== |
118 | diamond | 1309 | Keyboard layout is used to convert keyboard scancodes to ASCII-codes, |
1310 | which will be read by function 2. |
||
114 | mikedld | 1311 | Parameters: |
118 | diamond | 1312 | * eax = 21 - function number |
1313 | * ebx = 2 - subfunction number |
||
1314 | * ecx = which layout to set: |
||
114 | mikedld | 1315 | * 1 = normal layout |
1316 | * 2 = layout at pressed Shift |
||
1317 | * 3 = layout at pressed Alt |
||
118 | diamond | 1318 | * edx = pointer to layout - table of length 128 bytes |
114 | mikedld | 1319 | Or: |
1320 | * ecx = 9 |
||
118 | diamond | 1321 | * dx = country identifier (1=eng, 2=fi, 3=ger, 4=rus) |
114 | mikedld | 1322 | Returned value: |
118 | diamond | 1323 | * eax = 0 - success |
1324 | * eax = 1 - incorrect parameter |
||
114 | mikedld | 1325 | Remarks: |
118 | diamond | 1326 | * If Alt is pressed, the layout with Alt is used; |
1327 | if Alt is not pressed, but Shift is pressed, |
||
1328 | the layout with Shift is used; |
||
1329 | if Alt and Shift are not pressed, but Ctrl is pressed, the normal |
||
1330 | layout is used and then from the code is subtracted 0x60; |
||
1331 | if no control key is pressed, the normal layout is used. |
||
2409 | Serge | 1332 | * To get layout and country identifier use |
118 | diamond | 1333 | subfunction 2 of function 26. |
1334 | * Country identifier is global system variable, which is not used |
||
5452 | leency | 1335 | by the kernel itself; however the application '@taskbar' displays |
118 | diamond | 1336 | the corresponding icon. |
5452 | leency | 1337 | * The application @taskbar switches layouts on user request. |
114 | mikedld | 1338 | |
6057 | IgorA | 1339 | ---------------------- Constants for registers: ---------------------- |
1340 | eax - SF_SYSTEM_SET (21) |
||
1341 | ebx - SSF_KEYBOARD_LAYOUT (2) |
||
114 | mikedld | 1342 | ====================================================================== |
118 | diamond | 1343 | ========== Function 21, subfunction 5 - set system language. ========= |
114 | mikedld | 1344 | ====================================================================== |
1345 | Parameters: |
||
118 | diamond | 1346 | * eax = 21 - function number |
1347 | * ebx = 5 - subfunction number |
||
1348 | * ecx = system language (1=eng, 2=fi, 3=ger, 4=rus) |
||
114 | mikedld | 1349 | Returned value: |
1350 | * eax = 0 |
||
1351 | Remarks: |
||
118 | diamond | 1352 | * System language is global system variable and is not used |
5452 | leency | 1353 | by the kernel itself, however application @taskbar draws the |
118 | diamond | 1354 | appropriate icon. |
1355 | * Function does not check for correctness, as the kernel does not |
||
1356 | use this variable. |
||
1357 | * To get system language use subfunction 5 of function 26. |
||
114 | mikedld | 1358 | |
6057 | IgorA | 1359 | ---------------------- Constants for registers: ---------------------- |
1360 | eax - SF_SYSTEM_SET (21) |
||
1361 | ebx - SSF_SYS_LANG (5) |
||
114 | mikedld | 1362 | ====================================================================== |
2409 | Serge | 1363 | Function 21, subfunction 11 - enable/disable low-level access to HD. |
114 | mikedld | 1364 | ====================================================================== |
1365 | Parameters: |
||
118 | diamond | 1366 | * eax = 21 - function number |
1367 | * ebx = 11 - subfunction number |
||
1368 | * ecx = 0/1 - disable/enable |
||
114 | mikedld | 1369 | Returned value: |
1370 | * eax = 0 |
||
1371 | Remarks: |
||
118 | diamond | 1372 | * Is used in LBA-read (subfunction 8 of function 58). |
1373 | * The current implementation uses only low bit of ecx. |
||
1374 | * To get current status use subfunction 11 of function 26. |
||
114 | mikedld | 1375 | |
6057 | IgorA | 1376 | ---------------------- Constants for registers: ---------------------- |
1377 | eax - SF_SYSTEM_SET (21) |
||
1378 | ebx - SSF_ACCESS_HD_LBA (11) |
||
114 | mikedld | 1379 | ====================================================================== |
2409 | Serge | 1380 | Function 21, subfunction 12 - enable/disable low-level access to PCI. |
114 | mikedld | 1381 | ====================================================================== |
1382 | Parameters: |
||
118 | diamond | 1383 | * eax = 21 - function number |
1384 | * ebx = 12 - subfunction number |
||
1385 | * ecx = 0/1 - disable/enable |
||
114 | mikedld | 1386 | Returned value: |
1387 | * eax = 0 |
||
1388 | Remarks: |
||
118 | diamond | 1389 | * Is used in operations with PCI bus (function 62). |
1390 | * The current implementation uses only low bit of ecx. |
||
1391 | * To get current status use subfunction 12 of function 26. |
||
114 | mikedld | 1392 | |
6057 | IgorA | 1393 | ---------------------- Constants for registers: ---------------------- |
1394 | eax - SF_SYSTEM_SET (21) |
||
1395 | ebx - SSF_ACCESS_PCI (12) |
||
114 | mikedld | 1396 | ====================================================================== |
118 | diamond | 1397 | ================= Function 22 - set system date/time. ================ |
114 | mikedld | 1398 | ====================================================================== |
1399 | Parameters: |
||
118 | diamond | 1400 | * eax = 22 - function number |
1401 | * ebx = 0 - set time |
||
1402 | * ecx = 0x00SSMMHH - time in the binary-decimal code (BCD): |
||
114 | mikedld | 1403 | * HH=hour 00..23 |
1404 | * MM=minute 00..59 |
||
1405 | * SS=second 00..59 |
||
118 | diamond | 1406 | * ebx = 1 - set date |
1407 | * ecx = 0x00DDMMYY - date in the binary-decimal code (BCD): |
||
114 | mikedld | 1408 | * DD=day 01..31 |
1409 | * MM=month 01..12 |
||
1410 | * YY=year 00..99 |
||
118 | diamond | 1411 | * ebx = 2 - set day of week |
114 | mikedld | 1412 | * ecx = 1 for Sunday, ..., 7 for Saturday |
118 | diamond | 1413 | * ebx = 3 - set alarm clock |
114 | mikedld | 1414 | * ecx = 0x00SSMMHH |
1415 | Returned value: |
||
118 | diamond | 1416 | * eax = 0 - success |
1417 | * eax = 1 - incorrect parameter |
||
114 | mikedld | 1418 | * eax = 2 - CMOS-battery was unloaded |
1419 | Remarks: |
||
118 | diamond | 1420 | * Value of installation of day of week seems to be doubtful, |
1421 | as it a little where is used |
||
1422 | (day of week can be calculated by date). |
||
1423 | * Alarm clock can be set on operation in the given time every day. |
||
1424 | But there is no existing system function to disable it. |
||
1425 | * Operation of alarm clock consists in generation IRQ8. |
||
1426 | * Generally CMOS supports for alarm clock set of value 0xFF |
||
1427 | as one of parameters and it means that the appropriate parameter |
||
1428 | is ignored. But current implementation does not allow this |
||
1429 | (will return 1). |
||
1430 | * Alarm clock is a global system resource; the set of |
||
1431 | an alarm clock cancels automatically the previous set. |
||
1432 | However, at moment no program uses it. |
||
114 | mikedld | 1433 | |
6057 | IgorA | 1434 | ---------------------- Constants for registers: ---------------------- |
1435 | eax - SF_SET_TIME_DATE (22) |
||
114 | mikedld | 1436 | ====================================================================== |
118 | diamond | 1437 | ============= Function 23 - wait for event with timeout. ============= |
114 | mikedld | 1438 | ====================================================================== |
118 | diamond | 1439 | If the message queue is empty, waits for new message in the queue, |
1440 | but no more than given time. Then reads out a message from the queue. |
||
114 | mikedld | 1441 | |
1442 | Parameters: |
||
118 | diamond | 1443 | * eax = 23 - function number |
114 | mikedld | 1444 | * ebx = timeout (in 1/100 of second) |
1445 | Returned value: |
||
118 | diamond | 1446 | * eax = 0 - the message queue is empty |
1447 | * otherwise eax = event (see the list of events) |
||
114 | mikedld | 1448 | Remarks: |
118 | diamond | 1449 | * Only those events are taken into account, which enter into |
1450 | the mask set by function 40. By default it is |
||
1451 | redraw, key and button events. |
||
1452 | * To check for presence of a message in the queue use function 11. |
||
1453 | To wait without timeout use function 10. |
||
1454 | * Transmission ebx=0 results in immediate returning eax=0. |
||
1455 | * Current implementation returns immediately with eax=0, |
||
1456 | if the addition of ebx with the current value of time counter |
||
1457 | makes 32-bit overflow. |
||
114 | mikedld | 1458 | |
6057 | IgorA | 1459 | ---------------------- Constants for registers: ---------------------- |
1460 | eax - SF_WAIT_EVENT_TIMEOUT (23) |
||
114 | mikedld | 1461 | ====================================================================== |
641 | diamond | 1462 | ======= Function 24, subfunction 4 - eject tray of disk drive. ======= |
588 | diamond | 1463 | ====================================================================== |
1464 | Parameters: |
||
1465 | * eax = 24 - function number |
||
1466 | * ebx = 4 - subfunction number |
||
641 | diamond | 1467 | * ecx = position of CD/DVD-drive |
4711 | mario79 | 1468 | from 0=Primary Master to 3=Secondary Slave for first IDE contr. |
1469 | from 4=Primary Master to 7=Secondary Slave for second IDE contr. |
||
1470 | from 8=Primary Master to 11=Secondary Slave for third IDE contr. |
||
588 | diamond | 1471 | Returned value: |
641 | diamond | 1472 | * function does not return value |
588 | diamond | 1473 | Remarks: |
1474 | * The function is supported only for ATAPI devices (CD and DVD). |
||
641 | diamond | 1475 | * When the tray is being ejected, |
1476 | manual control of tray is unlocked. |
||
1477 | * When the tray is being ejected, the code clears the cache for |
||
1478 | corresponding device. |
||
588 | diamond | 1479 | * An example of usage of the function is the application CD_tray. |
1480 | |||
6057 | IgorA | 1481 | ---------------------- Constants for registers: ---------------------- |
1482 | eax - SF_CD (24) |
||
1483 | ebx - SSF_EJECT_TRAY (4), SSF_INSERT_TRAY (5) |
||
588 | diamond | 1484 | ====================================================================== |
641 | diamond | 1485 | ======== Function 24, subfunction 5 - load tray of disk drive. ======= |
588 | diamond | 1486 | ====================================================================== |
1487 | Parameters: |
||
1488 | * eax = 24 - function number |
||
1489 | * ebx = 5 - subfunction number |
||
641 | diamond | 1490 | * ecx = position of CD/DVD-drive |
4711 | mario79 | 1491 | from 0=Primary Master to 3=Secondary Slave for first IDE contr. |
1492 | from 4=Primary Master to 7=Secondary Slave for second IDE contr. |
||
1493 | from 8=Primary Master to 11=Secondary Slave for third IDE contr. |
||
588 | diamond | 1494 | Returned value: |
641 | diamond | 1495 | * function does not return value |
588 | diamond | 1496 | Remarks: |
1497 | * The function is supported only for ATAPI devices (CD and DVD). |
||
1498 | * An example of usage of the function is the application CD_tray. |
||
1499 | |||
6057 | IgorA | 1500 | ---------------------- Constants for registers: ---------------------- |
1501 | eax - SF_CD (24) |
||
1502 | ebx - SSF_EJECT_TRAY (4), SSF_INSERT_TRAY (5) |
||
588 | diamond | 1503 | ====================================================================== |
4066 | shikhin | 1504 | ======= Function 25 - put image area on the background layer. ======== |
1505 | ====================================================================== |
||
1506 | Paramters: |
||
1507 | * eax = 25 - function number |
||
1508 | * ebx = pointer to the previously allocated memory area, |
||
1509 | where placed the source images in a format BBGGRRTTBBGGRRTT... |
||
1510 | * ecx = [size on axis x]*65536 + [size on axis y] |
||
1511 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
1512 | Returned value: |
||
1513 | * function does not return value |
||
1514 | Remarks: |
||
1515 | * Coordinates of the image are coordinates of the upper left corner |
||
1516 | of the image relative to the screen. |
||
1517 | * Size of the image in bytes is 4*xsize*ysize |
||
1518 | * TT - byte pointer of transparency, at current version: |
||
1519 | 1 to FF - opaque, 0 - transparent. |
||
1520 | * The function places the image directly to LFB. It is not for |
||
1521 | background image f.15. Options f.15 to f.25 does not make sense. |
||
1522 | |||
6057 | IgorA | 1523 | ---------------------- Constants for registers: ---------------------- |
1524 | eax - SF_SCREEN_PUT_IMAGE (25) |
||
4066 | shikhin | 1525 | ====================================================================== |
118 | diamond | 1526 | ======== Function 26, subfunction 1 - get MPU MIDI base port. ======== |
114 | mikedld | 1527 | ====================================================================== |
1528 | Parameters: |
||
118 | diamond | 1529 | * eax = 26 - function number |
1530 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1531 | Returned value: |
118 | diamond | 1532 | * eax = port number |
1533 | Parameters: |
||
1534 | * To set base port use subfunction 1 of function 21. |
||
114 | mikedld | 1535 | |
6057 | IgorA | 1536 | ---------------------- Constants for registers: ---------------------- |
1537 | eax - SF_SYSTEM_GET (26) |
||
1538 | ebx - SSF_MPU_MIDI_BASE (1) |
||
114 | mikedld | 1539 | ====================================================================== |
1540 | ========== Function 26, subfunction 2 - get keyboard layout. ========= |
||
1541 | ====================================================================== |
||
118 | diamond | 1542 | The keyboard layout is used to convert keyboard scancodes to |
1543 | ASCII-codes for function 2. |
||
114 | mikedld | 1544 | Parameters: |
118 | diamond | 1545 | * eax = 26 - function number |
1546 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1547 | * ecx = what layout to get: |
1548 | * 1 = normal layout |
||
118 | diamond | 1549 | * 2 = layout with pressed Shift |
1550 | * 3 = layout with pressed Alt |
||
1551 | * edx = pointer to the 128-bytes buffer, where the layout will be |
||
1552 | copied |
||
114 | mikedld | 1553 | Returned value: |
1554 | * function does not return value |
||
118 | diamond | 1555 | Or: |
1556 | * eax = 26 - function number |
||
1557 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1558 | * ecx = 9 |
1559 | Returned value: |
||
118 | diamond | 1560 | * eax = country identifier (1=eng, 2=fi, 3=ger, 4=rus) |
114 | mikedld | 1561 | Remarks: |
118 | diamond | 1562 | * If Alt is pressed, the layout with Alt is used; |
1563 | if Alt is not pressed, but Shift is pressed, |
||
1564 | the layout with Shift is used; |
||
1565 | if Alt and Shift are not pressed, but Ctrl is pressed, the normal |
||
1566 | layout is used and then from the code is subtracted 0x60; |
||
1567 | if no control key is pressed, the normal layout is used. |
||
2409 | Serge | 1568 | * To set layout and country identifier use |
118 | diamond | 1569 | subfunction 2 of function 21. |
1570 | * Country identifier is global system variable, which is not used |
||
5452 | leency | 1571 | by the kernel itself; however the application '@taskbar' displays |
118 | diamond | 1572 | the corresponding icon (using this function). |
5452 | leency | 1573 | * The application @taskbar switches layouts on user request. |
114 | mikedld | 1574 | |
6057 | IgorA | 1575 | ---------------------- Constants for registers: ---------------------- |
1576 | eax - SF_SYSTEM_GET (26) |
||
1577 | ebx - SSF_KEYBOARD_LAYOUT (2) |
||
114 | mikedld | 1578 | ====================================================================== |
118 | diamond | 1579 | ========== Function 26, subfunction 5 - get system language. ========= |
114 | mikedld | 1580 | ====================================================================== |
1581 | Parameters: |
||
118 | diamond | 1582 | * eax = 26 - function number |
1583 | * ebx = 5 - subfunction number |
||
114 | mikedld | 1584 | Returned value: |
118 | diamond | 1585 | * eax = system language (1=eng, 2=fi, 3=ger, 4=rus) |
114 | mikedld | 1586 | Remarks: |
118 | diamond | 1587 | * System language is global system variable and is not used |
5452 | leency | 1588 | by the kernel itself, however application @taskbar draws the |
118 | diamond | 1589 | appropriate icon (using this function). |
1590 | * To set system language use subfunction 5 of function 21. |
||
114 | mikedld | 1591 | |
6057 | IgorA | 1592 | ---------------------- Constants for registers: ---------------------- |
1593 | eax - SF_SYSTEM_GET (26) |
||
1594 | ebx - SSF_SYS_LANG (5) |
||
114 | mikedld | 1595 | ====================================================================== |
118 | diamond | 1596 | === Function 26, subfunction 9 - get the value of the time counter. == |
114 | mikedld | 1597 | ====================================================================== |
1598 | Parameters: |
||
118 | diamond | 1599 | * eax = 26 - function number |
1600 | * ebx = 9 - subfunction number |
||
114 | mikedld | 1601 | Returned value: |
118 | diamond | 1602 | * eax = number of 1/100s of second, past from the system boot time |
114 | mikedld | 1603 | Remarks: |
118 | diamond | 1604 | * Counter takes modulo 2^32, that correspond to a little more |
1605 | than 497 days. |
||
6079 | serge | 1606 | * To get system time use function 3. |
6057 | IgorA | 1607 | |
1608 | ---------------------- Constants for registers: ---------------------- |
||
1609 | eax - SF_SYSTEM_GET (26) |
||
1610 | ebx - SSF_TIME_COUNT (9) |
||
5810 | hidnplayr | 1611 | ====================================================================== |
1612 | ===================== Function 26, subfunction 10 ==================== |
||
1613 | ========== Get the value of the high precision time counter. ========= |
||
1614 | ====================================================================== |
||
1615 | Parameters: |
||
1616 | * eax = 26 - function number |
||
1617 | * ebx = 10 - subfunction number |
||
1618 | Returned value: |
||
1619 | * eax = number of nanoseconds since system boot time (lower DWORD) |
||
6079 | serge | 1620 | * edx = number of nanoseconds since system boot time (high DWORD) |
5810 | hidnplayr | 1621 | Remarks: |
1622 | * The counter is based on HPET, if HPET is not available, resolution |
||
1623 | will be reduced to 10 000 000 nanoseconds. |
||
114 | mikedld | 1624 | |
6057 | IgorA | 1625 | ---------------------- Constants for registers: ---------------------- |
1626 | eax - SF_SYSTEM_GET (26) |
||
1627 | ebx - SSF_TIME_COUNT_PRO (10) |
||
114 | mikedld | 1628 | ====================================================================== |
118 | diamond | 1629 | ===================== Function 26, subfunction 11 ==================== |
1630 | ========== Find out whether low-level HD access is enabled. ========== |
||
114 | mikedld | 1631 | ====================================================================== |
1632 | Parameters: |
||
118 | diamond | 1633 | * eax = 26 - function number |
1634 | * ebx = 11 - subfunction number |
||
114 | mikedld | 1635 | Returned value: |
118 | diamond | 1636 | * eax = 0/1 - disabled/enabled |
114 | mikedld | 1637 | Remarks: |
118 | diamond | 1638 | * Is used in LBA read (subfunction 8 of function 58). |
1639 | * To set current state use subfunction 11 of function 21. |
||
114 | mikedld | 1640 | |
6057 | IgorA | 1641 | ---------------------- Constants for registers: ---------------------- |
1642 | eax - SF_SYSTEM_GET (26) |
||
1643 | ebx - SSF_ACCESS_HD_LBA (11) |
||
114 | mikedld | 1644 | ====================================================================== |
118 | diamond | 1645 | ===================== Function 26, subfunction 12 ==================== |
1646 | ========== Find out whether low-level PCI access is enabled. ========= |
||
114 | mikedld | 1647 | ====================================================================== |
1648 | Parameters: |
||
118 | diamond | 1649 | * eax = 26 - function number |
1650 | * ebx = 12 - subfunction number |
||
114 | mikedld | 1651 | Returned value: |
118 | diamond | 1652 | * eax = 0/1 - disabled/enabled |
114 | mikedld | 1653 | Remarks: |
118 | diamond | 1654 | * Is used by operations with PCI bus (function 62). |
1655 | * The current implementation uses only low bit of ecx. |
||
1656 | * To set the current state use subfunction 12 of function 21. |
||
114 | mikedld | 1657 | |
6057 | IgorA | 1658 | ---------------------- Constants for registers: ---------------------- |
1659 | eax - SF_SYSTEM_GET (26) |
||
1660 | ebx - SSF_ACCESS_PCI (12) |
||
114 | mikedld | 1661 | ====================================================================== |
118 | diamond | 1662 | =================== Function 29 - get system date. =================== |
114 | mikedld | 1663 | ====================================================================== |
1664 | Parameters: |
||
118 | diamond | 1665 | * eax = 29 - function number |
114 | mikedld | 1666 | Returned value: |
1667 | * eax = 0x00DDMMYY, where |
||
118 | diamond | 1668 | (binary-decimal coding, BCD, is used) |
1669 | * YY = two low digits of year (00..99) |
||
1670 | * MM = month (01..12) |
||
1671 | * DD = day (01..31) |
||
114 | mikedld | 1672 | Remarks: |
118 | diamond | 1673 | * To set system date use function 22. |
114 | mikedld | 1674 | |
6057 | IgorA | 1675 | ---------------------- Constants for registers: ---------------------- |
1676 | eax - SF_GET_SYS_DATE (29) |
||
114 | mikedld | 1677 | ====================================================================== |
521 | diamond | 1678 | ============= Function 30 - work with the current folder. ============ |
1679 | ====================================================================== |
||
1680 | |||
1681 | --------- Subfunction 1 - set current folder for the thread. --------- |
||
1682 | Parameters: |
||
1683 | * eax = 30 - function number |
||
1684 | * ebx = 1 - subfunction number |
||
6473 | pathoswith | 1685 | * ecx = pointer to string with the path to new current folder, |
1686 | rules of path forming can be found in function 70 description. |
||
521 | diamond | 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: |
||
6473 | pathoswith | 1710 | for cp866 encoding: |
1711 | key rb 64 |
||
1712 | path rb 64 |
||
1713 | for UTF-16LE encoding: |
||
1714 | key rb 64 |
||
1715 | dw 2 |
||
1716 | path rw 31 |
||
1717 | Example: |
||
1718 | align 64 |
||
1719 | key db 'kolibrios',0 ; key must be in lower case |
||
1720 | align 64 |
||
1721 | path db 'HD0/1',0 |
||
1722 | |||
3663 | mario79 | 1723 | Returned value: |
1724 | * function does not return value |
||
1725 | Remarks: |
||
1726 | * The function can be called only 1 time for 1 session of the OS. |
||
6473 | pathoswith | 1727 | * The key is not affected by encoding. |
3663 | mario79 | 1728 | |
6473 | pathoswith | 1729 | ------ Subfunction 4 - get current folder in UTF-16LE encoding. ------ |
1730 | Parameters: |
||
1731 | * eax = 30 - function number |
||
1732 | * ebx = 4 - subfunction number |
||
1733 | * ecx = pointer to buffer |
||
1734 | * edx = size of buffer |
||
1735 | Returned value: |
||
1736 | * eax = number of chars in the buffer (including terminating 0) |
||
1737 | Remarks: |
||
1738 | * If the buffer is too small to hold all data, only first (edx-2) |
||
1739 | bytes are copied and than terminating 0 is inserted. |
||
1740 | * By default, current folder for the thread is "/rd/1". |
||
1741 | * At process/thread creation the current folder will be inherited |
||
1742 | from the parent. |
||
1743 | |||
6057 | IgorA | 1744 | ---------------------- Constants for registers: ---------------------- |
1745 | eax - SF_CURRENT_FOLDER (30) |
||
1746 | ebx - SSF_SET_CF (1), SSF_GET_CF (2), SSF_ADD_SYS_FOLDER (3) |
||
521 | diamond | 1747 | ====================================================================== |
2511 | mario79 | 1748 | ========= Function 34 - who owner the pixel on the screen. =========== |
1749 | ====================================================================== |
||
1750 | Parameters: |
||
1751 | * eax = 34 - function number |
||
1752 | * ebx = x-coordinate (relative to the display) |
||
1753 | * ecx = y-coordinate (relative to the display) |
||
1754 | |||
1755 | Returned value: |
||
1756 | * eax = 0x000000XX - owner of pixel the slot window N |
||
1757 | If incorrect values ebx and ecx then function returns 0 |
||
1758 | * The function takes the value from the area [_WinMapAddress] |
||
3780 | Serge | 1759 | |
6057 | IgorA | 1760 | ---------------------- Constants for registers: ---------------------- |
1761 | eax - SF_GET_PIXEL_OWNER (34) |
||
2511 | mario79 | 1762 | ====================================================================== |
118 | diamond | 1763 | ======= Function 35 - read the color of a pixel on the screen. ======= |
114 | mikedld | 1764 | ====================================================================== |
1765 | Parameters: |
||
1766 | * eax = 35 |
||
1767 | * ebx = y*xsize+x, where |
||
118 | diamond | 1768 | * (x,y) = coordinates of a pixel (beginning from 0) |
1769 | * xsize = horizontal screen size |
||
114 | mikedld | 1770 | Returned value: |
118 | diamond | 1771 | * eax = color 0x00RRGGBB |
114 | mikedld | 1772 | Remarks: |
118 | diamond | 1773 | * To get screen sizes use function 14. Pay attention, |
1774 | that it subtracts 1 from both sizes. |
||
1775 | * There is also direct access (without any system calls) |
||
1776 | to videomemory through the selector gs. To get parameters of |
||
1777 | the current videomode, use function 61. |
||
114 | mikedld | 1778 | |
6057 | IgorA | 1779 | ---------------------- Constants for registers: ---------------------- |
1780 | eax - SF_GET_PIXEL (35) |
||
114 | mikedld | 1781 | ====================================================================== |
1018 | diamond | 1782 | =================== Function 36 - read screen area. ================== |
921 | mario79 | 1783 | ====================================================================== |
1784 | Paramters: |
||
1785 | * eax = 36 - function number |
||
1018 | diamond | 1786 | * ebx = pointer to the previously allocated memory area, |
1787 | where will be placed the image in the format BBGGRRBBGGRR... |
||
921 | mario79 | 1788 | * ecx = [size on axis x]*65536 + [size on axis y] |
1789 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
1790 | Returned value: |
||
1791 | * function does not return value |
||
1792 | Remarks: |
||
1793 | * Coordinates of the image are coordinates of the upper left corner |
||
923 | mario79 | 1794 | of the image relative to the screen. |
921 | mario79 | 1795 | * Size of the image in bytes is 3*xsize*ysize. |
1796 | |||
6057 | IgorA | 1797 | ---------------------- Constants for registers: ---------------------- |
1798 | eax - SF_GET_IMAGE (36) |
||
921 | mario79 | 1799 | ====================================================================== |
277 | diamond | 1800 | =================== Function 37 - work with mouse. =================== |
114 | mikedld | 1801 | ====================================================================== |
1802 | |||
118 | diamond | 1803 | ---------- Subfunction 0 - screen coordinates of the mouse ----------- |
114 | mikedld | 1804 | Parameters: |
118 | diamond | 1805 | * eax = 37 - function number |
1806 | * ebx = 0 - subfunction number |
||
114 | mikedld | 1807 | Returned value: |
118 | diamond | 1808 | * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer |
1809 | (beginning from 0) |
||
114 | mikedld | 1810 | |
118 | diamond | 1811 | -- Subfunction 1 - coordinates of the mouse relative to the window --- |
114 | mikedld | 1812 | Parameters: |
118 | diamond | 1813 | * eax = 37 - function number |
1814 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1815 | Returned value: |
118 | diamond | 1816 | * eax = x*65536 + y, (x,y)=coordinates of the mouse pointer |
1817 | relative to the application window (beginning from 0) |
||
114 | mikedld | 1818 | Remarks: |
118 | diamond | 1819 | * The value is calculated by formula (x-xwnd)*65536 + (y-ywnd). |
1820 | If y>=ywnd, the low word is non-negative and contains |
||
1821 | relative y-coordinate, and the high word - relative x-coordinate |
||
1822 | (with correct sign). Otherwise the low word is negative and still |
||
1823 | contains relative y-coordinate, and to the high word |
||
1824 | 1 should be added. |
||
114 | mikedld | 1825 | |
5851 | pathoswith | 1826 | ------------- Subfunction 2 - states of the mouse buttons ------------ |
114 | mikedld | 1827 | Parameters: |
118 | diamond | 1828 | * eax = 37 - function number |
1829 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1830 | Returned value: |
5851 | pathoswith | 1831 | * eax = bits 0-4 equal to subfunction 3 |
114 | mikedld | 1832 | |
5851 | pathoswith | 1833 | ------- Subfunction 3 - states and events of the mouse buttons ------- |
1834 | Parameters: |
||
1835 | * eax = 37 - function number |
||
1836 | * ebx = 3 - subfunction number |
||
1837 | Returned value: |
||
1838 | * eax contains next information: |
||
1839 | |||
1840 | states: |
||
1841 | * bit 0 is set = left button is held |
||
1842 | * bit 1 is set = right button is held |
||
1843 | * bit 2 is set = middle button is held |
||
1844 | * bit 3 is set = 4th button is held |
||
1845 | * bit 4 is set = 5th button is held |
||
1846 | |||
1847 | events: |
||
1848 | * bit 8 is set = left button is pressed |
||
1849 | * bit 9 is set = right button is pressed |
||
1850 | * bit 10 is set = middle button is pressed |
||
1851 | |||
1852 | * bit 15 is set = vertical scroll is used |
||
1853 | |||
1854 | * bit 16 is set = left button is released |
||
1855 | * bit 17 is set = right button is released |
||
1856 | * bit 18 is set = middle button is released |
||
1857 | |||
1858 | * bit 23 is set = horisontal scroll is used |
||
1859 | |||
1860 | * bit 24 is set = doubleclick by left button |
||
1861 | |||
277 | diamond | 1862 | -------------------- Subfunction 4 - load cursor --------------------- |
1863 | Parameters: |
||
1864 | * eax = 37 - function number |
||
1865 | * ebx = 4 - subfunction number |
||
1866 | * dx = data source: |
||
1867 | * dx = LOAD_FROM_FILE = 0 - data in a file |
||
1868 | * ecx = pointer to full path to the cursor file |
||
1869 | * the file must be in the format .cur, which is standard for |
||
1870 | MS Windows, at that of the size 32*32 pixels |
||
1871 | * dx = LOAD_FROM_MEM = 1 - data of file are already loaded in memory |
||
1872 | * ecx = pointer to data of the cursor file |
||
1873 | * the data format is the same as in the previous case |
||
1874 | * dx = LOAD_INDIRECT = 2 - data in memory |
||
1875 | * ecx = pointer to cursor image in the format ARGB 32*32 pixels |
||
1876 | * edx = 0xXXYY0002, where |
||
1877 | * XX = x-coordinate of cursor hotspot |
||
1878 | * YY = y-coordinate |
||
1879 | * 0 <= XX, YY <= 31 |
||
1880 | Returned value: |
||
1881 | * eax = 0 - failed |
||
1882 | * otherwise eax = cursor handle |
||
1883 | |||
1884 | --------------------- Subfunction 5 - set cursor --------------------- |
||
1885 | Sets new cursor for the window of the current thread. |
||
1886 | Parameters: |
||
1887 | * eax = 37 - function number |
||
1888 | * ebx = 5 - subfunction number |
||
1889 | * ecx = cursor handle |
||
1890 | Returned value: |
||
1891 | * eax = handle of previous cursor |
||
1892 | Remarks: |
||
1893 | * If the handle is incorrect, the function restores the default |
||
1894 | cursor (standard arrow). In particular, ecx=0 restores it. |
||
1895 | |||
1896 | ------------------- Subfunction 6 - delete cursor -------------------- |
||
1897 | Parameters: |
||
1898 | * eax = 37 - function number |
||
1899 | * ebx = 6 - subfunction number |
||
1900 | * ecx = cursor handle |
||
1901 | Returned value: |
||
1902 | * eax destroyed |
||
1903 | Remarks: |
||
1904 | * The cursor must be loaded previously by the current thread |
||
1905 | (with the call to subfunction 4). The function does not delete |
||
1906 | system cursors and cursors, loaded by another applications. |
||
1907 | * If the active cursor (set by subfunction 5) is deleted, |
||
1908 | the system restores the default cursor (standard arrow). |
||
1909 | |||
499 | diamond | 1910 | ------------------ Subfunction 7 - get scroll data ------------------- |
486 | kastigar | 1911 | Parameters: |
1912 | * eax = 37 - function number |
||
1913 | * ebx = 7 - subfunction number |
||
1914 | Returned value: |
||
499 | diamond | 1915 | * eax = [horizontal offset]*65536 + [vertical offset] |
486 | kastigar | 1916 | Remarks: |
499 | diamond | 1917 | * Scroll data is available for active window only. |
1918 | * Values are zeroed after reading. |
||
1919 | * Values are signed. |
||
486 | kastigar | 1920 | |
6057 | IgorA | 1921 | ---------------------- Constants for registers: ---------------------- |
1922 | eax - SF_MOUSE_GET (37) |
||
1923 | ebx - SSF_SCREEN_POSITION (0), SSF_WINDOW_POSITION (1), |
||
1924 | SSF_BUTTON (2), SSF_BUTTON_EXT (3), SSF_LOAD_CURSOR (4), |
||
1925 | SSF_SET_CURSOR (5), SSF_DEL_CURSOR (6), SSF_SCROLL_DATA (7) |
||
114 | mikedld | 1926 | ====================================================================== |
1927 | ====================== Function 38 - draw line. ====================== |
||
1928 | ====================================================================== |
||
1929 | Parameters: |
||
118 | diamond | 1930 | * eax = 38 - function number |
1931 | * ebx = [start coordinate on axis x]*65536 + |
||
1932 | [end coordinate on axis x] |
||
1933 | * ecx = [start coordinate on axis y]*65536 + |
||
1934 | [end coordinate on axis y] |
||
1935 | * edx = 0x00RRGGBB - color |
||
133 | diamond | 1936 | edx = 0x01xxxxxx - draw inversed line |
1937 | (low 24 bits are ignored) |
||
114 | mikedld | 1938 | Returned value: |
1939 | * function does not return value |
||
1940 | Remarks: |
||
118 | diamond | 1941 | * Coordinates are relative to the window. |
1942 | * End point is also drawn. |
||
114 | mikedld | 1943 | |
6057 | IgorA | 1944 | ---------------------- Constants for registers: ---------------------- |
1945 | eax - SF_DRAW_LINE (38) |
||
114 | mikedld | 1946 | ====================================================================== |
118 | diamond | 1947 | == Function 39, subfunction 1 - get a size of the background image. == |
114 | mikedld | 1948 | ====================================================================== |
1949 | Parameters: |
||
118 | diamond | 1950 | * eax = 39 - function number |
1951 | * ebx = 1 - subfunction number |
||
114 | mikedld | 1952 | Returned value: |
1953 | * eax = [width]*65536 + [height] |
||
1954 | Remarks: |
||
118 | diamond | 1955 | * There is a pair function to set sizes of background image - |
1956 | subfunction 1 of function 15. After which it is necessary, |
||
1957 | of course, anew to define image. |
||
114 | mikedld | 1958 | |
6057 | IgorA | 1959 | ---------------------- Constants for registers: ---------------------- |
1960 | eax - SF_BACKGROUND_GET (39) |
||
114 | mikedld | 1961 | ====================================================================== |
118 | diamond | 1962 | == Function 39, subfunction 2 - get pixel from the background image. = |
114 | mikedld | 1963 | ====================================================================== |
1964 | Parameters: |
||
118 | diamond | 1965 | * eax = 39 - function number |
1966 | * ebx = 2 - subfunction number |
||
114 | mikedld | 1967 | * ecx = offset |
1968 | Returned value: |
||
118 | diamond | 1969 | * eax = 0x00RRGGBB - pixel color, if offset is valid |
1970 | (less than 0x160000-16) |
||
1971 | * eax = 2 otherwise |
||
114 | mikedld | 1972 | Remarks: |
118 | diamond | 1973 | * Do not rely on returned value for invalid offsets, it may be |
1974 | changed in future kernel versions. |
||
1975 | * Offset for pixel with coordinates (x,y) |
||
1976 | is calculated as (x+y*xsize)*3. |
||
2409 | Serge | 1977 | * There is a pair function to set pixel on the background image - |
118 | diamond | 1978 | subfunction 2 of function 15. |
114 | mikedld | 1979 | |
6057 | IgorA | 1980 | ---------------------- Constants for registers: ---------------------- |
1981 | eax - SF_BACKGROUND_GET (39) |
||
114 | mikedld | 1982 | ====================================================================== |
118 | diamond | 1983 | == Function 39, subfunction 4 - get drawing mode for the background. = |
114 | mikedld | 1984 | ====================================================================== |
1985 | Parameters: |
||
118 | diamond | 1986 | * eax = 39 - function number |
1987 | * ebx = 4 - subfunction number |
||
114 | mikedld | 1988 | Returned value: |
118 | diamond | 1989 | * eax = 1 - tile |
1990 | * eax = 2 - stretch |
||
114 | mikedld | 1991 | Remarks: |
2409 | Serge | 1992 | * There is a pair function to set drawing mode - |
118 | diamond | 1993 | subfunction 4 of function 15. |
114 | mikedld | 1994 | |
6057 | IgorA | 1995 | ---------------------- Constants for registers: ---------------------- |
1996 | eax - SF_BACKGROUND_GET (39) |
||
114 | mikedld | 1997 | ====================================================================== |
118 | diamond | 1998 | =========== Function 40 - set the mask for expected events. ========== |
114 | mikedld | 1999 | ====================================================================== |
118 | diamond | 2000 | The mask for expected events affects function working with events |
2001 | 10, 11, 23 - they notify only about events allowed by this mask. |
||
114 | mikedld | 2002 | Parameters: |
118 | diamond | 2003 | * eax = 40 - function number |
114 | mikedld | 2004 | * ebx = mask: bit i corresponds to event i+1 (see list of events) |
118 | diamond | 2005 | (set bit permits notice on event) |
3940 | mario79 | 2006 | bit 31: mouse active/inactive filter |
2414 | Serge | 2007 | bit 31 = 0 - inactive window receive mouse events |
2008 | bit 31 = 1 - inactive window does not receive mouse events |
||
2009 | bit 30: cursor position filter |
||
2010 | bit 30 = 0 = the window receive mouse events if cursor |
||
2011 | outside window |
||
2012 | bit 30 = 1 - the window does not receive mouse events if cursor |
||
2013 | outside window |
||
114 | mikedld | 2014 | Returned value: |
1153 | clevermous | 2015 | * eax = previous value of mask |
114 | mikedld | 2016 | Remarks: |
118 | diamond | 2017 | * Default mask (7=111b) enables nofices about redraw, |
2018 | keys and buttons. This is enough for many applications. |
||
2019 | * Events prohibited in the mask are saved anyway, when come; |
||
2020 | they are simply not informed with event functions. |
||
2021 | * Event functions take into account the mask on moment of |
||
2022 | function call, not on moment of event arrival. |
||
114 | mikedld | 2023 | |
6057 | IgorA | 2024 | ---------------------- Constants for registers: ---------------------- |
2025 | eax - SF_SET_EVENTS_MASK (40) |
||
114 | mikedld | 2026 | ====================================================================== |
118 | diamond | 2027 | ================ Function 43 - input/output to a port. =============== |
114 | mikedld | 2028 | ====================================================================== |
2029 | |||
118 | diamond | 2030 | ------------------------ Output data to port ------------------------- |
114 | mikedld | 2031 | Parameters: |
118 | diamond | 2032 | * eax = 43 - function number |
114 | mikedld | 2033 | * bl = byte for output |
118 | diamond | 2034 | * ecx = port number 0xnnnn (from 0 to 0xFFFF) |
114 | mikedld | 2035 | Returned value: |
118 | diamond | 2036 | * eax = 0 - success |
2037 | * eax = 1 - the thread has not reserved the selected port |
||
114 | mikedld | 2038 | |
118 | diamond | 2039 | ------------------------ Input data from port ------------------------ |
114 | mikedld | 2040 | Parameters: |
118 | diamond | 2041 | * eax = 43 - function number |
2042 | * ebx is ignored |
||
2043 | * ecx = 0x8000nnnn, where nnnn = port number (from 0 to 0xFFFF) |
||
114 | mikedld | 2044 | Returned value: |
118 | diamond | 2045 | * eax = 0 - success, thus ebx = entered byte |
2046 | * eax = 1 - the thread has not reserved the selected port |
||
114 | mikedld | 2047 | Remarks: |
118 | diamond | 2048 | * Previously the thread must reserve the selected port |
2049 | for itself by function 46. |
||
2050 | * Instead of call to this function it is better to use |
||
2051 | processor instructions in/out - this is much |
||
2052 | faster and a bit shorter and easier. |
||
114 | mikedld | 2053 | |
6057 | IgorA | 2054 | ---------------------- Constants for registers: ---------------------- |
2055 | eax - SF_PORT_IN_OUT (43) |
||
114 | mikedld | 2056 | ====================================================================== |
118 | diamond | 2057 | ====== Function 46 - reserve/free a group of input/output ports. ===== |
114 | mikedld | 2058 | ====================================================================== |
118 | diamond | 2059 | To work with reserved ports an application can access directly by |
2060 | commands in/out (recommended way) and can use function 43 |
||
2061 | (not recommended way). |
||
114 | mikedld | 2062 | Parameters: |
118 | diamond | 2063 | * eax = 46 - function number |
114 | mikedld | 2064 | * ebx = 0 - reserve, 1 - free |
118 | diamond | 2065 | * ecx = start port number |
2066 | * edx = end port number (inclusive) |
||
114 | mikedld | 2067 | Returned value: |
118 | diamond | 2068 | * eax = 0 - success |
114 | mikedld | 2069 | * eax = 1 - error |
2070 | Remarks: |
||
118 | diamond | 2071 | * For ports reservation: an error occurs if and only if |
2072 | one from the following condition satisfies: |
||
2073 | * start port is more than end port; |
||
2074 | * the selected range contains incorrect port number |
||
2075 | (correct are from 0 to 0xFFFF); |
||
2076 | * limit for the total number of reserved areas is exceeded |
||
2077 | (maximum 255 are allowed); |
||
2078 | * the selected range intersects with any of earlier reserved |
||
2079 | * For ports free: an error is an attempt to free range, |
||
2080 | that was not earlier reserved by this function |
||
2081 | (with same ecx,edx). |
||
2082 | * If an error occurs (for both cases) function performs no action. |
||
277 | diamond | 2083 | * At booting the system reserves for itself ports |
2084 | 0..0x2d, 0x30..0x4d, 0x50..0xdf, 0xe5..0xff (inclusively). |
||
118 | diamond | 2085 | * When a thread terminates, all reserved by it ports |
2086 | are freed automatically. |
||
114 | mikedld | 2087 | |
6057 | IgorA | 2088 | ---------------------- Constants for registers: ---------------------- |
2089 | eax - SF_SET_PORTS (46) |
||
114 | mikedld | 2090 | ====================================================================== |
118 | diamond | 2091 | ============= Function 47 - draw a number in the window. ============= |
114 | mikedld | 2092 | ====================================================================== |
2093 | Parameters: |
||
118 | diamond | 2094 | * eax = 47 - function number |
2095 | * ebx = parameters of conversion number to text: |
||
114 | mikedld | 2096 | * bl = 0 - ecx contains number |
665 | diamond | 2097 | * bl = 1 - ecx contains pointer to dword/qword-number |
118 | diamond | 2098 | * bh = 0 - display in decimal number system |
2099 | * bh = 1 - display in hexadecimal system |
||
2100 | * bh = 2 - display in binary system |
||
499 | diamond | 2101 | * bits 16-21 = how many digits to display |
655 | mario79 | 2102 | * bits 22-29 reserved and must be set to 0 |
665 | diamond | 2103 | * bit 30 set = display qword (64-bit) number (must be bl=1) |
2104 | * bit 31 set = do not display leading zeroes of the number |
||
118 | diamond | 2105 | * ecx = number (if bl=0) or pointer (if bl=1) |
114 | mikedld | 2106 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
6272 | pathoswith | 2107 | * esi = 0xXXRRGGBB, where |
2108 | * RR, GG, BB specify text color |
||
2109 | * XX = 0B0FCSSS (bits): |
||
2110 | * B=1 - fill background (color = edi) |
||
2111 | * F specifies the font: |
||
2112 | |||
2113 | 1 = 8x16 |
||
2114 | * C=0 - draw to the window, |
||
2115 | C=1 - draw to the user buffer (edi) |
||
2116 | * SSS = (size multiplier)-1, so 0 = x1, 7 = x8 |
||
114 | mikedld | 2117 | Returned value: |
2118 | * function does not return value |
||
2119 | Remarks: |
||
118 | diamond | 2120 | * The given length must not exceed 60. |
2121 | * The exactly given amount of digits is output. If number is small |
||
2122 | and can be written by smaller amount of digits, it is supplemented |
||
2123 | by leading zeroes; if the number is big and can not be written by |
||
2124 | given amount of digits, extra digits are not drawn. |
||
114 | mikedld | 2125 | |
6057 | IgorA | 2126 | ---------------------- Constants for registers: ---------------------- |
2127 | eax - SF_DRAW_NUMBER (47) |
||
114 | mikedld | 2128 | ====================================================================== |
118 | diamond | 2129 | ========= Function 48, subfunction 0 - apply screen settings. ======== |
114 | mikedld | 2130 | ====================================================================== |
2131 | Parameters: |
||
118 | diamond | 2132 | * eax = 48 - function number |
2133 | * ebx = 0 - subfunction number |
||
114 | mikedld | 2134 | * ecx = 0 - reserved |
2135 | Returned value: |
||
2136 | * function does not return value |
||
2137 | Remarks: |
||
118 | diamond | 2138 | * Function redraws the screen after parameters change by |
114 | mikedld | 2139 | subfunctions 1 and 2. |
118 | diamond | 2140 | * Function call without prior call to one of indicated subfunctions |
2141 | is ignored. |
||
2142 | * Function call with nonzero ecx is ignored. |
||
114 | mikedld | 2143 | |
6057 | IgorA | 2144 | ---------------------- Constants for registers: ---------------------- |
2145 | eax - SF_STYLE_SETTINGS (48) |
||
2146 | ebx - SSF_APPLY (0) |
||
114 | mikedld | 2147 | ====================================================================== |
118 | diamond | 2148 | =========== Function 48, subfunction 1 - set button style. =========== |
114 | mikedld | 2149 | ====================================================================== |
2150 | Parameters: |
||
118 | diamond | 2151 | * eax = 48 - function number |
2152 | * ebx = 1 - subfunction number |
||
2153 | * ecx = button style: |
||
2154 | * 0 = flat |
||
2155 | * 1 = 3d |
||
114 | mikedld | 2156 | Returned value: |
2157 | * function does not return value |
||
2158 | Remarks: |
||
118 | diamond | 2159 | * After call to this function one should redraw the screen by |
2160 | subfunction 0. |
||
2161 | * Button style influences only to their draw of function 8. |
||
114 | mikedld | 2162 | |
6057 | IgorA | 2163 | ---------------------- Constants for registers: ---------------------- |
2164 | eax - SF_STYLE_SETTINGS (48) |
||
2165 | ebx - SSF_SET_BUTTON_STYLE (1) |
||
118 | diamond | 2166 | ====================================================================== |
2167 | ====== Function 48, subfunction 2 - set standard window colors. ====== |
||
2168 | ====================================================================== |
||
114 | mikedld | 2169 | Parameters: |
118 | diamond | 2170 | * eax = 48 - function number |
2171 | * ebx = 2 - subfunction number |
||
2172 | * ecx = pointer to the color table |
||
114 | mikedld | 2173 | * edx = size of the color table |
118 | diamond | 2174 | (must be 40 bytes for future compatibility) |
2175 | Format of the color table is shown in description of subfunction 3. |
||
114 | mikedld | 2176 | Returned value: |
2177 | * function does not return value |
||
2178 | Remarks: |
||
118 | diamond | 2179 | * After call to this function one should redraw the screen by |
2180 | subfunction 0. |
||
2181 | * Table of standard colors influences only to applications, |
||
2182 | which receive this table obviously (by subfunction 3) |
||
2183 | and use it (specifying colors from it to drawing functions). |
||
2184 | * Table of standard colors is included in skin and is installed |
||
2185 | anew with skin installation (by subfunction 8). |
||
2186 | * Color table can be viewed/changed interactively with |
||
2187 | the application 'desktop'. |
||
114 | mikedld | 2188 | |
6057 | IgorA | 2189 | ---------------------- Constants for registers: ---------------------- |
2190 | eax - SF_STYLE_SETTINGS (48) |
||
2191 | ebx - SSF_SET_COLORS (2) |
||
114 | mikedld | 2192 | ====================================================================== |
118 | diamond | 2193 | ====== Function 48, subfunction 3 - get standard window colors. ====== |
114 | mikedld | 2194 | ====================================================================== |
2195 | Parameters: |
||
118 | diamond | 2196 | * eax = 48 - function number |
2197 | * ebx = 3 - subfunction number |
||
2198 | * ecx = pointer to the buffer with size edx bytes, |
||
2199 | where table will be written |
||
2200 | * edx = size of color table |
||
2201 | (must be 40 bytes for future compatibility) |
||
114 | mikedld | 2202 | Returned value: |
2203 | * function does not return value |
||
118 | diamond | 2204 | Format of the color table: |
2205 | each item is dword-value for color 0x00RRGGBB |
||
2206 | * +0: dword: frames - color of frame |
||
2207 | * +4: dword: grab - color of header |
||
2208 | * +8: dword: grab_button - color of button on header bar |
||
2209 | * +12 = +0xC: dword: grab_button_text - color of text on button |
||
2210 | on header bar |
||
2211 | * +16 = +0x10: dword: grab_text - color of text on header |
||
2212 | * +20 = +0x14: dword: work - color of working area |
||
2213 | * +24 = +0x18: dword: work_button - color of button in working area |
||
2214 | * +28 = +0x1C: dword: work_button_text - color of text on button |
||
2215 | in working area |
||
2216 | * +32 = +0x20: dword: work_text - color of text in working area |
||
2217 | * +36 = +0x24: dword: work_graph - color of graphics in working area |
||
114 | mikedld | 2218 | Remarks: |
118 | diamond | 2219 | * Structure of the color table is described in the standard |
2220 | include file 'macros.inc' as 'system_colors'; for example, |
||
2221 | it is possible to write: |
||
5871 | hidnplayr | 2222 | sc system_colors ; variable declaration |
2223 | ... ; somewhere one must call |
||
2224 | ; this function with ecx=sc |
||
2225 | mov ecx, [sc.work_button_text] ; read text color on |
||
2226 | ; buttin in working area |
||
118 | diamond | 2227 | * A program itself desides to use or not to use color table. |
2228 | For usage program must simply at calls to drawing functions select |
||
2229 | color taken from the table. |
||
2230 | * At change of the table of standard colors (by subfunction 2 with |
||
2231 | the subsequent application of changes by subfunction 0 or |
||
2232 | at skin set by subfunction 8) the system sends to all windows |
||
2233 | redraw message (the event with code 1). |
||
2234 | * Color table can be viewed/changed interactively with |
||
2235 | the application 'desktop'. |
||
114 | mikedld | 2236 | |
6057 | IgorA | 2237 | ---------------------- Constants for registers: ---------------------- |
2238 | eax - SF_STYLE_SETTINGS (48) |
||
2239 | ebx - SSF_GET_COLORS (3) |
||
114 | mikedld | 2240 | ====================================================================== |
118 | diamond | 2241 | ============ Function 48, subfunction 4 - get skin height. =========== |
114 | mikedld | 2242 | ====================================================================== |
2243 | Parameters: |
||
118 | diamond | 2244 | * eax = 48 - function number |
2245 | * ebx = 4 - subfunction number |
||
114 | mikedld | 2246 | Returned value: |
118 | diamond | 2247 | * eax = skin height |
114 | mikedld | 2248 | Remarks: |
118 | diamond | 2249 | * Skin height is defined as the height of a header |
2250 | of skinned windows. |
||
2251 | * See also general structure of window in the description |
||
2252 | of function 0. |
||
114 | mikedld | 2253 | |
6057 | IgorA | 2254 | ---------------------- Constants for registers: ---------------------- |
2255 | eax - SF_STYLE_SETTINGS (48) |
||
2256 | ebx - SSF_GET_SKIN_HEIGHT (4) |
||
114 | mikedld | 2257 | ====================================================================== |
118 | diamond | 2258 | ======== Function 48, subfunction 5 - get screen working area. ======= |
114 | mikedld | 2259 | ====================================================================== |
2260 | Parameters: |
||
118 | diamond | 2261 | * eax = 48 - function number |
2262 | * ebx = 5 - subfunction number |
||
114 | mikedld | 2263 | Returned value: |
2264 | * eax = [left]*65536 + [right] |
||
2265 | * ebx = [top]*65536 + [bottom] |
||
2266 | Remarks: |
||
118 | diamond | 2267 | * The screen working area defines position and coordinates of |
2268 | a maximized window. |
||
2269 | * The screen working area in view of normal work is all screen |
||
5452 | leency | 2270 | without taskbar ('@taskbar' application). |
118 | diamond | 2271 | * (left,top) are coordinates of the left upper corner, |
2272 | (right,bottom) are coordinates of the right lower one. |
||
2273 | Thus the size of working area on x axis can be calculated by |
||
2274 | formula right-left+1, on y axis - by formula bottom-right+1. |
||
2275 | * See also function 14, |
||
2276 | to get sizes of all screen. |
||
2277 | * There is a pair function to set working area - subfunction 6. |
||
114 | mikedld | 2278 | |
6057 | IgorA | 2279 | ---------------------- Constants for registers: ---------------------- |
2280 | eax - SF_STYLE_SETTINGS (48) |
||
2281 | ebx - SSF_GET_SCREEN_AREA (5) |
||
114 | mikedld | 2282 | ====================================================================== |
118 | diamond | 2283 | ======== Function 48, subfunction 6 - set screen working area. ======= |
114 | mikedld | 2284 | ====================================================================== |
2285 | Parameters: |
||
118 | diamond | 2286 | * eax = 48 - function number |
2287 | * ebx = 6 - subfunction number |
||
114 | mikedld | 2288 | * ecx = [left]*65536 + [right] |
2289 | * edx = [top]*65536 + [bottom] |
||
2290 | Returned value: |
||
2291 | * function does not return value |
||
2292 | Remarks: |
||
118 | diamond | 2293 | * The screen working area defines position and coordinates of |
2294 | a maximized window. |
||
5452 | leency | 2295 | * This function is used only by the application '@taskbar', |
2296 | which set working area to all screen without taskbar. |
||
118 | diamond | 2297 | * (left,top) are coordinates of the left upper corner, |
2298 | (right,bottom) are coordinates of the right lower one. |
||
2299 | Thus the size of working area on x axis can be calculated by |
||
2300 | formula right-left+1, on y axis - by formula bottom-right+1. |
||
2301 | * If 'left'>='right', x-coordinate of working area is not changed. |
||
2302 | If 'left'<0, 'left' will not be set. If 'right' is greater than or |
||
2303 | equal to screen width, 'right' will not be set. |
||
2304 | Similarly on y axis. |
||
2305 | * See also function 14, |
||
2306 | to get sizes of all screen. |
||
2307 | * There is a pair function to get working area - subfunction 5. |
||
2308 | * This function redraws the screen automatically, |
||
2309 | updating coordinates and sizes of maximized windows. |
||
2310 | The system sends to all windows redraw message (the event 1). |
||
114 | mikedld | 2311 | |
6057 | IgorA | 2312 | ---------------------- Constants for registers: ---------------------- |
2313 | eax - SF_STYLE_SETTINGS (48) |
||
2314 | ebx - SSF_SET_SCREEN_AREA (6) |
||
114 | mikedld | 2315 | ====================================================================== |
118 | diamond | 2316 | =========== Function 48, subfunction 7 - get skin margins. =========== |
114 | mikedld | 2317 | ====================================================================== |
118 | diamond | 2318 | Returns the area of a header of a skinned window, intended for |
2319 | a text of a header. |
||
114 | mikedld | 2320 | Parameters: |
118 | diamond | 2321 | * eax = 48 - function number |
2322 | * ebx = 7 - subfunction number |
||
114 | mikedld | 2323 | Returned value: |
2324 | * eax = [left]*65536 + [right] |
||
2325 | * ebx = [top]*65536 + [bottom] |
||
2326 | Remarks: |
||
118 | diamond | 2327 | * An application decides itself to use or not to use this function. |
2328 | * It is recommended to take into account returned value |
||
2329 | of this function for choice of a place for drawing header text |
||
2330 | (by function 4) or a substitute of header text |
||
2331 | (at the discretion of an application). |
||
114 | mikedld | 2332 | |
6057 | IgorA | 2333 | ---------------------- Constants for registers: ---------------------- |
2334 | eax - SF_STYLE_SETTINGS (48) |
||
2335 | ebx - SSF_GET_SKIN_MARGINS (7) |
||
114 | mikedld | 2336 | ====================================================================== |
118 | diamond | 2337 | ============= Function 48, subfunction 8 - set used skin. ============ |
114 | mikedld | 2338 | ====================================================================== |
2339 | Parameters: |
||
118 | diamond | 2340 | * eax = 48 - function number |
2341 | * ebx = 8 - subfunction number |
||
4573 | clevermous | 2342 | * ecx = pointer to filename of the skin |
114 | mikedld | 2343 | Returned value: |
118 | diamond | 2344 | * eax = 0 - success |
2345 | * otherwise eax = file system error code; if file does not |
||
2346 | contain valid skin, function returns error 3 |
||
2347 | (unknown file system). |
||
114 | mikedld | 2348 | Remarks: |
118 | diamond | 2349 | * After successful skin loading the system sends to all windows |
2350 | redraw message (the event 1). |
||
2351 | * At booting the system reads skin from file 'default.skn' |
||
2352 | on ramdisk. |
||
2353 | * User can change the skin statically by creating hisself |
||
2354 | 'default.skn' or dynamically with the application 'desktop'. |
||
114 | mikedld | 2355 | |
6057 | IgorA | 2356 | ---------------------- Constants for registers: ---------------------- |
2357 | eax - SF_STYLE_SETTINGS (48) |
||
2358 | ebx - SSF_SET_SKIN (8) |
||
114 | mikedld | 2359 | ====================================================================== |
5848 | pathoswith | 2360 | ====== Function 48, subfunction 9 - get font smoothing setting. ====== |
5682 | leency | 2361 | ====================================================================== |
2362 | Parameters: |
||
2363 | * eax = 48 - function number |
||
2364 | * ebx = 9 - subfunction number |
||
5848 | pathoswith | 2365 | Returned value: |
2366 | * eax = 2 - subpixel, 1 - anti-aliasing, 0 - off |
||
5682 | leency | 2367 | |
6057 | IgorA | 2368 | ---------------------- Constants for registers: ---------------------- |
2369 | eax - SF_STYLE_SETTINGS (48) |
||
2370 | ebx - SSF_GET_FONT_SMOOTH (9) |
||
5682 | leency | 2371 | ====================================================================== |
5848 | pathoswith | 2372 | ========== Function 48, subfunction 10 - set font smoothing. ========= |
2373 | ====================================================================== |
||
2374 | Parameters: |
||
2375 | * eax = 48 - function number |
||
2376 | * ebx = 10 - subfunction number |
||
2377 | * cl = 2 - subpixel, 1 - anti-aliasing, 0 - off |
||
2378 | |||
6057 | IgorA | 2379 | ---------------------- Constants for registers: ---------------------- |
2380 | eax - SF_STYLE_SETTINGS (48) |
||
2381 | ebx - SSF_SET_FONT_SMOOTH (10) |
||
5848 | pathoswith | 2382 | ====================================================================== |
5867 | pathoswith | 2383 | ============ Function 48, subfunction 11 - get font size. ============ |
2384 | ====================================================================== |
||
2385 | Parameters: |
||
2386 | * eax = 48 - function number |
||
2387 | * ebx = 9 - subfunction number |
||
2388 | Returned value: |
||
2389 | * eax = current font height in pixels |
||
2390 | |||
6057 | IgorA | 2391 | ---------------------- Constants for registers: ---------------------- |
2392 | eax - SF_STYLE_SETTINGS (48) |
||
2393 | ebx - SSF_GET_FONT_SIZE (11) |
||
5867 | pathoswith | 2394 | ====================================================================== |
2395 | ============ Function 48, subfunction 12 - set font size. ============ |
||
2396 | ====================================================================== |
||
2397 | Parameters: |
||
2398 | * eax = 48 - function number |
||
2399 | * ebx = 10 - subfunction number |
||
2400 | * cl = new font height in pixels |
||
2401 | |||
6057 | IgorA | 2402 | ---------------------- Constants for registers: ---------------------- |
2403 | eax - SF_STYLE_SETTINGS (48) |
||
2404 | ebx - SSF_SET_FONT_SIZE (12) |
||
5867 | pathoswith | 2405 | ====================================================================== |
118 | diamond | 2406 | =========== Function 49 - Advanced Power Management (APM). =========== |
114 | mikedld | 2407 | ====================================================================== |
2408 | Parameters: |
||
118 | diamond | 2409 | * eax = 49 - function number |
2410 | * dx = number of the APM function |
||
2411 | (analogue of ax in APM specification) |
||
2412 | * bx, cx = parameters of the APM function |
||
114 | mikedld | 2413 | Returned value: |
118 | diamond | 2414 | * 16-bit registers ax, bx, cx, dx, si, di and carry flag CF |
2415 | are set according to the APM specification |
||
2416 | * high halves of 32-bit registers eax, ebx, ecx, |
||
2417 | edx, esi, edi are destroyed |
||
114 | mikedld | 2418 | Remarks: |
118 | diamond | 2419 | * APM 1.2 specification is described in the document |
2420 | "Advanced Power Management (APM) BIOS Specification" |
||
2421 | (Revision 1.2), available at |
||
114 | mikedld | 2422 | http://www.microsoft.com/whdc/archive/amp_12.mspx; |
118 | diamond | 2423 | besides it is included in famous Interrupt List by Ralf Brown |
114 | mikedld | 2424 | (http://www.pobox.com/~ralf/files.html, |
2425 | ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/). |
||
2426 | |||
6057 | IgorA | 2427 | ---------------------- Constants for registers: ---------------------- |
2428 | eax - SF_APM (49) |
||
114 | mikedld | 2429 | ====================================================================== |
118 | diamond | 2430 | =================== Function 50 - set window shape. ================== |
114 | mikedld | 2431 | ====================================================================== |
118 | diamond | 2432 | Normal windows have rectangular shape. This function can give to |
2433 | a window any shape. The shape is given by a set of points inside |
||
2434 | the base rectangle belonging to a window. Position and coordinates |
||
2435 | of the base rectangle are set by function 0 |
||
2436 | and changed by function 67. |
||
114 | mikedld | 2437 | |
118 | diamond | 2438 | --------------------------- Set shape data --------------------------- |
114 | mikedld | 2439 | Parameters: |
118 | diamond | 2440 | * eax = 50 - function number |
2441 | * ebx = 0 - subfunction number |
||
2442 | * ecx = pointer to shape data (array of bytes 0/1) |
||
114 | mikedld | 2443 | Returned value: |
2444 | * function does not return value |
||
2445 | |||
118 | diamond | 2446 | -------------------------- Set shape scale --------------------------- |
114 | mikedld | 2447 | Parameters: |
118 | diamond | 2448 | * eax = 50 - function number |
2449 | * ebx = 1 - subfunction number |
||
2450 | * ecx sets a scale: each byte of data defines |
||
2451 | (2^scale)*(2^scale) pixels |
||
114 | mikedld | 2452 | Returned value: |
2453 | * function does not return value |
||
2454 | Remarks: |
||
118 | diamond | 2455 | * Default scale is 0 (scale factor is 1). If in the shape data |
2456 | one byte corresponds to one pixel, there is no necessity |
||
2457 | to set scale. |
||
2458 | * Let's designate xsize = window width (in pixels), ysize = height; |
||
2459 | pay attention, that they are one pixel more than defined by |
||
114 | mikedld | 2460 | functions 0, 67. |
118 | diamond | 2461 | * On definition of scale xsize and ysize must be divisible |
2462 | on 2^scale. |
||
2463 | * Byte of data on offset 'a' must be 0/1 and defines belonging |
||
2464 | to a window of square with the side 2^scale (if scale=0, |
||
2465 | this is one pixel) and coordinates of the left upper corner |
||
114 | mikedld | 2466 | (a mod (xsize shr scale), a div (xsize shr scale)) |
118 | diamond | 2467 | * Data size: (xsize shr scale)*(ysize shr scale). |
2468 | * Data must be presented in the memory and not change |
||
2469 | after set of shape. |
||
2470 | * The system views the shape data at every window redraw by |
||
2471 | function 0. |
||
2472 | * The call of subfunction 0 with NULL pointer results in return |
||
2473 | to the rectangular shape. |
||
114 | mikedld | 2474 | |
6057 | IgorA | 2475 | ---------------------- Constants for registers: ---------------------- |
2476 | eax - SF_SET_WINDOW_SHAPE (50) |
||
114 | mikedld | 2477 | ====================================================================== |
2478 | ==================== Function 51 - create thread. ==================== |
||
2479 | ====================================================================== |
||
2480 | Parameters: |
||
118 | diamond | 2481 | * eax = 51 - function number |
2482 | * ebx = 1 - unique subfunction |
||
2483 | * ecx = address of thread entry point (starting eip) |
||
2484 | * edx = pointer to thread stack (starting esp) |
||
114 | mikedld | 2485 | Returned value: |
118 | diamond | 2486 | * eax = -1 - error (there is too many threads) |
2487 | * otherwise eax = TID - thread identifier |
||
114 | mikedld | 2488 | |
6057 | IgorA | 2489 | ---------------------- Constants for registers: ---------------------- |
2490 | eax - SF_CREATE_THREAD (51) |
||
114 | mikedld | 2491 | ====================================================================== |
4199 | mario79 | 2492 | ==================== Function 54, subfunction 0 ====================== |
2493 | ============== Get the number of slots in the clipboard. ============= |
||
2494 | ====================================================================== |
||
2495 | Parameters: |
||
2496 | * eax = 54 - function number |
||
2497 | * ebx = 0 - subfunction number |
||
2498 | Returned value: |
||
2499 | * eax = slots in the clipboard |
||
2500 | * eax = -1 - main list area not found |
||
2501 | |||
6057 | IgorA | 2502 | ---------------------- Constants for registers: ---------------------- |
2503 | eax - SF_CLIPBOARD (54) |
||
2504 | ebx - SSF_GET_SLOT_COUNT (0) |
||
4199 | mario79 | 2505 | ====================================================================== |
2506 | ==================== Function 54, subfunction 1 ====================== |
||
2507 | ================= Read the data from the clipboard. ================== |
||
2508 | ====================================================================== |
||
2509 | Parameters: |
||
2510 | * eax = 54 - function number |
||
2511 | * ebx = 1 - subfunction number |
||
2512 | * eсx = slot number |
||
2513 | Returned value: |
||
2514 | * eax = if successful - pointer to a memory with data |
||
2515 | * eax = 1 - error |
||
2516 | * eax = -1 - main list area not found |
||
6079 | serge | 2517 | |
6057 | IgorA | 2518 | ---------------------- Constants for registers: ---------------------- |
2519 | eax - SF_CLIPBOARD (54) |
||
2520 | ebx - SSF_READ_CB (1) |
||
4199 | mario79 | 2521 | ====================================================================== |
2522 | ==================== Function 54, subfunction 2 ====================== |
||
2523 | ================= Write the data to the clipboard. =================== |
||
2524 | ====================================================================== |
||
2525 | Parameters: |
||
2526 | * eax = 54 - function number |
||
2527 | * ebx = 2 - subfunction number |
||
2528 | * eсx = the number of bytes to be copied |
||
2529 | * edx = a pointer to a buffer for data to be copied |
||
2530 | Returned value: |
||
2531 | * eax = 0 - success |
||
2532 | * eax = 1 - error |
||
2533 | * eax = -1 - main list area not found |
||
6057 | IgorA | 2534 | |
2535 | ---------------------- Constants for registers: ---------------------- |
||
2536 | eax - SF_CLIPBOARD (54) |
||
2537 | ebx - SSF_WRITE_CB (2) |
||
4199 | mario79 | 2538 | ====================================================================== |
2539 | ===================== Function 54, subfunction 3 ===================== |
||
2540 | ================ Delete the last slot in the clipboard =============== |
||
2541 | ====================================================================== |
||
2542 | Parameters: |
||
2543 | * eax = 54 - function number |
||
2544 | * ebx = 3 - subfunction number |
||
2545 | Returned value: |
||
2546 | * eax = 0 - success |
||
2547 | * eax = 1 - error |
||
2548 | * eax = -1 - main list area not found |
||
6057 | IgorA | 2549 | |
2550 | ---------------------- Constants for registers: ---------------------- |
||
2551 | eax - SF_CLIPBOARD (54) |
||
2552 | ebx - SSF_DEL_SLOT (3) |
||
4199 | mario79 | 2553 | ====================================================================== |
2554 | ===================== Function 54, subfunction 4 ===================== |
||
2555 | ===================== Alarm reset the lock buffer ==================== |
||
2556 | ====================================================================== |
||
2557 | Parameters: |
||
2558 | * eax = 54 - function number |
||
2559 | * ebx = 4 - subfunction number |
||
2560 | Returned value: |
||
2561 | * eax = 0 - success |
||
2562 | * eax = -1 - main list area not found or no blocking |
||
2563 | Remarks: |
||
2564 | * Used in exceptional cases, where no responsible or killed |
||
2565 | application blocked the clipboard operations. |
||
2566 | |||
6057 | IgorA | 2567 | ---------------------- Constants for registers: ---------------------- |
2568 | eax - SF_CLIPBOARD (54) |
||
2569 | ebx - SSF_UNLOCK_BUFFER (4) |
||
4199 | mario79 | 2570 | ====================================================================== |
2409 | Serge | 2571 | Function 55, subfunction 55 - begin to play data on built-in speaker. |
114 | mikedld | 2572 | ====================================================================== |
2573 | Parameters: |
||
118 | diamond | 2574 | * eax = 55 - function number |
2575 | * ebx = 55 - subfunction number |
||
2576 | * esi = pointer to data |
||
114 | mikedld | 2577 | Returned value: |
118 | diamond | 2578 | * eax = 0 - success |
2579 | * eax = 55 - error (speaker is off or busy) |
||
2580 | Data is an array of items with variable length. |
||
2581 | Format of each item is defined by first byte: |
||
114 | mikedld | 2582 | * 0 = end of data |
118 | diamond | 2583 | * 1..0x80 = sets sound duration on 1/100 of second; sound note |
2584 | is defined by immediate value of frequency |
||
2585 | * following word (2 bytes) contains frequency divider; |
||
2586 | frequency is defined as 1193180/divider |
||
114 | mikedld | 2587 | * 0x81 = invalid |
118 | diamond | 2588 | * 0x82..0xFF = note is defined by octave and number: |
2589 | * duration in 1/100 of second = (first byte)-0x81 |
||
114 | mikedld | 2590 | * there is one more byte; |
118 | diamond | 2591 | * (second byte)=0xFF - delay |
2592 | * otherwise it looks like a*0x10+b, where b=number of the note in |
||
2593 | an octave from 1 to 12, a=number of octave (beginning from 0) |
||
114 | mikedld | 2594 | Remarks: |
118 | diamond | 2595 | * Speaker play can be disabled/enabled by |
2596 | subfunction 8 of function 18. |
||
2597 | * Function returns control, having informed the system |
||
2598 | an information on request. Play itself goes independently from |
||
2599 | the program. |
||
2600 | * The data must be kept in the memory at least up to the end |
||
2601 | of play. |
||
114 | mikedld | 2602 | |
6057 | IgorA | 2603 | ---------------------- Constants for registers: ---------------------- |
2604 | eax - SF_SPEAKER_PLAY (55) |
||
114 | mikedld | 2605 | ====================================================================== |
641 | diamond | 2606 | ======================= Function 57 - PCI BIOS. ====================== |
2607 | ====================================================================== |
||
2608 | Parameters: |
||
2609 | * eax = 57 - function number |
||
2610 | * ebp corresponds to al in PCI BIOS specification |
||
2611 | * other registers are set according to PCI BIOS specification |
||
2612 | Returned value: |
||
2613 | * CF is undefined |
||
2614 | * other registers are set according to PCI BIOS specification |
||
2615 | Remarks: |
||
2616 | * Many effects of this function can be also achieved with |
||
2617 | corresponding subfunctions of function 62. |
||
2618 | * The function calls PCI32 BIOS extension, documented e.g. in |
||
2619 | http://alpha1.dyns.net/files/PCI/bios21.pdf. |
||
2620 | * If BIOS does not support this extension, its behavior is emulated |
||
2621 | (through kernel-mode analogues of subfunctions of function 62). |
||
2622 | |||
6057 | IgorA | 2623 | ---------------------- Constants for registers: ---------------------- |
2624 | eax - SF_PCI_BIOS (57) |
||
641 | diamond | 2625 | ====================================================================== |
118 | diamond | 2626 | ========== Function 60 - Inter Process Communication (IPC). ========== |
114 | mikedld | 2627 | ====================================================================== |
118 | diamond | 2628 | IPC is used for message dispatching from one process/thread to |
2629 | another. Previously it is necessary to agree how to interpret |
||
114 | mikedld | 2630 | the concrete message. |
2631 | |||
118 | diamond | 2632 | ----------- Subfunction 1 - set the area for IPC receiving ----------- |
2633 | Is called by process-receiver. |
||
114 | mikedld | 2634 | Parameters: |
118 | diamond | 2635 | * eax = 60 - function number |
2636 | * ebx = 1 - subfunction number |
||
2637 | * ecx = pointer to the buffer |
||
2638 | * edx = size of the buffer |
||
114 | mikedld | 2639 | Returned value: |
118 | diamond | 2640 | * eax = 0 - always success |
2641 | Format of IPC-buffer: |
||
2642 | * +0: dword: if nonzero, buffer is considered locked; |
||
2643 | lock/unlock the buffer, when you work with it and need that |
||
2644 | buffer data are not changed from outside (no new messages) |
||
114 | mikedld | 2645 | * +4: dword: occupied place in the buffer (in bytes) |
2646 | * +8: first message |
||
2647 | * +8+n: second message |
||
2648 | * ... |
||
118 | diamond | 2649 | Format of a message: |
2650 | * +0: dword: PID of sender |
||
2651 | * +4: dword: message length (not including this header) |
||
2652 | * +8: n*byte: message data |
||
114 | mikedld | 2653 | |
118 | diamond | 2654 | ------------------ Subfunction 2 - send IPC message ------------------ |
2655 | Is called by process-sender. |
||
114 | mikedld | 2656 | Parameters: |
118 | diamond | 2657 | * eax = 60 - function number |
2658 | * ebx = 2 - subfunction number |
||
114 | mikedld | 2659 | * ecx = PID of receiver |
118 | diamond | 2660 | * edx = pointer to the message data |
2661 | * esi = message length (in bytes) |
||
114 | mikedld | 2662 | Returned value: |
118 | diamond | 2663 | * eax = 0 - success |
2664 | * eax = 1 - the receiver has not defined buffer for IPC messages |
||
2665 | (can be, still have no time, |
||
2666 | and can be, this is not right process) |
||
2667 | * eax = 2 - the receiver has blocked IPC-buffer; try to wait a bit |
||
2668 | * eax = 3 - overflow of IPC-buffer of the receiver |
||
114 | mikedld | 2669 | * eax = 4 - process/thread with such PID does not exist |
2670 | Remarks: |
||
118 | diamond | 2671 | * Immediately after writing of IPC-message to the buffer the system |
2672 | sends to the receiver the event with code 7 (see event codes). |
||
114 | mikedld | 2673 | |
6057 | IgorA | 2674 | ---------------------- Constants for registers: ---------------------- |
2675 | eax - SF_IPC (60) |
||
2676 | ebx - SSF_SET_AREA (1), SSF_SEND_MESSAGE (2) |
||
114 | mikedld | 2677 | ====================================================================== |
118 | diamond | 2678 | ==== Function 61 - get parameters for the direct graphics access. ==== |
114 | mikedld | 2679 | ====================================================================== |
118 | diamond | 2680 | The data of the graphics screen (the memory area which displays |
2681 | screen contents) are accessible to a program directly, without |
||
2682 | any system calls, through the selector gs: |
||
5871 | hidnplayr | 2683 | mov eax, [gs:0] |
118 | diamond | 2684 | places in eax the first dword of the buffer, which contains |
2685 | information on color of the left upper point (and, possibly, colors |
||
2686 | of several following). |
||
5871 | hidnplayr | 2687 | mov [gs:0], eax |
118 | diamond | 2688 | by work in VESA modes with LFB sets color of the left upper point |
2689 | (and, possibly, colors of several following). |
||
2690 | To interpret the data of graphics screen program needs to know |
||
2691 | some parameters, returning by this function. |
||
114 | mikedld | 2692 | Remarks: |
118 | diamond | 2693 | * Graphics parameters changes very seldom at work, |
2694 | namely, only in cases, when user works with the application VRR. |
||
2695 | * At videomode change the system redraws all windows (event |
||
2696 | with code 1) and redraws the background (event 5). |
||
2697 | Same events occur in other cases too, which meet much more often, |
||
2698 | than videomode change. |
||
2699 | * By operation in videomodes with LFB the selector gs points to |
||
2700 | LFB itself, so reading/writing on gs result directly in |
||
2701 | change of screen contents. By operation in videomodes without |
||
2702 | LFB gs points to some data area in the kernel, and all functions |
||
2703 | of screen output fulfil honesty double operation on writing |
||
2704 | directly to the screen and writing to this buffer. In result |
||
2705 | at reading contents of this buffer the results correspond to |
||
2706 | screen contents (with, generally speaking, large color |
||
2707 | resolution), and writing is ignored. |
||
2708 | One exception is the mode 320*200, for which main loop of the |
||
2709 | system thread updates the screen according to mouse movements. |
||
114 | mikedld | 2710 | |
2711 | ------------------------- Screen resolution -------------------------- |
||
2712 | Parameters: |
||
118 | diamond | 2713 | * eax = 61 - function number |
2714 | * ebx = 1 - subfunction number |
||
114 | mikedld | 2715 | Returned value: |
118 | diamond | 2716 | * eax = [resolution on x axis]*65536 + [resolution on y axis] |
114 | mikedld | 2717 | Remarks: |
118 | diamond | 2718 | * One can use function 14 paying attention that |
2719 | it returns sizes on 1 pixel less. It is fully equivalent way. |
||
114 | mikedld | 2720 | |
118 | diamond | 2721 | ---------------------- Number of bits per pixel ---------------------- |
114 | mikedld | 2722 | Parameters: |
118 | diamond | 2723 | * eax = 61 - function number |
2724 | * ebx = 2 - subfunction number |
||
114 | mikedld | 2725 | Returned value: |
118 | diamond | 2726 | * eax = number of bits per pixel (24 or 32) |
114 | mikedld | 2727 | |
118 | diamond | 2728 | -------------------- Number of bytes per scanline -------------------- |
114 | mikedld | 2729 | Parameters: |
118 | diamond | 2730 | * eax = 61 - function number |
2731 | * ebx = 3 - subfunction number |
||
114 | mikedld | 2732 | Returned value: |
118 | diamond | 2733 | * eax = number of bytes occupied by one scanline |
114 | mikedld | 2734 | (horizontal line on the screen) |
2735 | |||
6057 | IgorA | 2736 | ---------------------- Constants for registers: ---------------------- |
2737 | eax - SF_GET_GRAPHICAL_PARAMS (61) |
||
2738 | ebx - SSF_SCREEN_SIZE (1), SSF_BITS_PER_PIXEL (2), |
||
2739 | SSF_BYTES_PER_LINE (3) |
||
114 | mikedld | 2740 | ====================================================================== |
118 | diamond | 2741 | ===== Function 62, subfunction 0 - get version of PCI-interface. ===== |
114 | mikedld | 2742 | ====================================================================== |
2743 | Parameters: |
||
118 | diamond | 2744 | * eax = 62 - function number |
2745 | * bl = 0 - subfunction number |
||
114 | mikedld | 2746 | Returned value: |
118 | diamond | 2747 | * eax = -1 - PCI access is disabled; otherwise |
2748 | * ah.al = version of PCI-interface (ah=version, al=subversion) |
||
2749 | * high word of eax is zeroed |
||
114 | mikedld | 2750 | Remarks: |
118 | diamond | 2751 | * Previously low-level access to PCI for applications must be |
2752 | enabled by subfunction 12 of function 21. |
||
2753 | * If PCI BIOS is not supported, the value of ax is undefined. |
||
114 | mikedld | 2754 | |
6057 | IgorA | 2755 | ---------------------- Constants for registers: ---------------------- |
2756 | eax - SF_PCI (62) |
||
2757 | ebx - SSF_GET_VERSION (0) |
||
114 | mikedld | 2758 | ====================================================================== |
118 | diamond | 2759 | ==== Function 62, subfunction 1 - get number of the last PCI-bus. ==== |
114 | mikedld | 2760 | ====================================================================== |
2761 | Parameters: |
||
118 | diamond | 2762 | * eax = 62 - function number |
2763 | * bl = 1 - subfunction number |
||
114 | mikedld | 2764 | Returned value: |
118 | diamond | 2765 | * eax = -1 - access to PCI is disabled; otherwise |
2766 | * al = number of the last PCI-bus; other bytes of eax are destroyed |
||
114 | mikedld | 2767 | Remarks: |
118 | diamond | 2768 | * Previously low-level access to PCI for applications must be |
2769 | enabled by subfunction 12 of function 21. |
||
2770 | * If PCI BIOS is not supported, the value of ax is undefined. |
||
114 | mikedld | 2771 | |
6057 | IgorA | 2772 | ---------------------- Constants for registers: ---------------------- |
2773 | eax - SF_PCI (62) |
||
2774 | ebx - SSF_GET_LAST_BUS (1) |
||
114 | mikedld | 2775 | ====================================================================== |
118 | diamond | 2776 | ===================== Function 62, subfunction 2 ===================== |
2777 | ===== Get mechanism of addressing to the PCI configuration space. ==== |
||
114 | mikedld | 2778 | ====================================================================== |
2779 | Parameters: |
||
118 | diamond | 2780 | * eax = 62 - function number |
2781 | * bl = 2 - subfunction number |
||
114 | mikedld | 2782 | Returned value: |
118 | diamond | 2783 | * eax = -1 - access to PCI is disabled; otherwise |
2784 | * al = mechanism (1 or 2); other bytes of eax are destroyed |
||
114 | mikedld | 2785 | Remarks: |
118 | diamond | 2786 | * Previously low-level access to PCI for applications must be |
2787 | enabled by subfunction 12 of function 21. |
||
2788 | * Addressing mechanism is selected depending on |
||
2789 | equipment characteristics. |
||
2790 | * Subfunctions of read and write work automatically |
||
2791 | with the selected mechanism. |
||
114 | mikedld | 2792 | |
6057 | IgorA | 2793 | ---------------------- Constants for registers: ---------------------- |
2794 | eax - SF_PCI (62) |
||
2795 | ebx - SSF_GET_ADRR_MODE (2) |
||
114 | mikedld | 2796 | ====================================================================== |
118 | diamond | 2797 | ======== Function 62, subfunctions 4,5,6 - read PCI-register. ======== |
114 | mikedld | 2798 | ====================================================================== |
2799 | Parameters: |
||
118 | diamond | 2800 | * eax = 62 - function number |
2801 | * bl = 4 - read byte |
||
2802 | * bl = 5 - read word |
||
2803 | * bl = 6 - read dword |
||
114 | mikedld | 2804 | * bh = number of PCI-bus |
118 | diamond | 2805 | * ch = dddddfff, where ddddd = number of the device on the bus, |
2806 | fff = function number of device |
||
2807 | * cl = number of register (must be even for bl=5, |
||
2808 | divisible by 4 for bl=6) |
||
114 | mikedld | 2809 | Returned value: |
118 | diamond | 2810 | * eax = -1 - error (access to PCI is disabled or parameters |
2811 | are not supported); otherwise |
||
2812 | * al/ax/eax (depending on requested size) contains the data; |
||
2813 | the other part of register eax is destroyed |
||
114 | mikedld | 2814 | Remarks: |
118 | diamond | 2815 | * Previously low-level access to PCI for applications must be |
2816 | enabled by subfunction 12 of function 21. |
||
2817 | * Access mechanism 2 supports only 16 devices on a bus and ignores |
||
2818 | function number. To get access mechanism use subfunction 2. |
||
2819 | * Some registers are standard and exist for all devices, some are |
||
2820 | defined by the concrete device. The list of registers of the |
||
2821 | first type can be found e.g. in famous |
||
114 | mikedld | 2822 | Interrupt List by Ralf Brown |
2823 | (http://www.pobox.com/~ralf/files.html, |
||
2824 | ftp://ftp.cs.cmu.edu/afs/cs/user/ralf/pub/); |
||
118 | diamond | 2825 | registers of the second type must be listed |
2826 | in the device documentation. |
||
114 | mikedld | 2827 | |
6057 | IgorA | 2828 | ---------------------- Constants for registers: ---------------------- |
2829 | eax - SF_PCI (62) |
||
2830 | ebx - SSF_READ_BYTE (4), SSF_READ_WORD (5), SSF_READ_DWORD (6) |
||
114 | mikedld | 2831 | ====================================================================== |
118 | diamond | 2832 | ====== Function 62, subfunctions 8,9,10 - write to PCI-register. ===== |
114 | mikedld | 2833 | ====================================================================== |
2834 | Parameters: |
||
118 | diamond | 2835 | * eax = 62 - function number |
2836 | * bl = 8 - write byte |
||
2837 | * bl = 9 - write word |
||
2838 | * bl = 10 - write dword |
||
114 | mikedld | 2839 | * bh = number of PCI-bus |
118 | diamond | 2840 | * ch = dddddfff, where ddddd = number of the device on the bus, |
2841 | fff = function number of device |
||
2842 | * cl = number of register (must be even for bl=9, |
||
2843 | divisible by 4 for bl=10) |
||
2844 | * dl/dx/edx (depending on requested size) contatins |
||
2845 | the data to write |
||
114 | mikedld | 2846 | Returned value: |
118 | diamond | 2847 | * eax = -1 - error (access to PCI is disabled or parameters |
2848 | are not supported) |
||
2849 | * eax = 0 - success |
||
114 | mikedld | 2850 | Remarks: |
118 | diamond | 2851 | * Previously low-level access to PCI for applications must be |
2852 | enabled by subfunction 12 of function 21. |
||
2853 | * Access mechanism 2 supports only 16 devices on a bus and ignores |
||
2854 | function number. To get access mechanism use subfunction 2. |
||
2855 | * Some registers are standard and exist for all devices, some are |
||
2856 | defined by the concrete device. The list of registers of the |
||
2857 | first type can be found e.g. in famous Interrupt List by |
||
2858 | Ralf Brown; registers of the second type must be listed |
||
2859 | in the device documentation. |
||
114 | mikedld | 2860 | |
6057 | IgorA | 2861 | ---------------------- Constants for registers: ---------------------- |
2862 | eax - SF_PCI (62) |
||
2863 | ebx - SSF_WRITE_BYTE (8), SSF_WRITE_WORD (9), SSF_WRITE_DWORD (10) |
||
114 | mikedld | 2864 | ====================================================================== |
118 | diamond | 2865 | ============== Function 63 - work with the debug board. ============== |
114 | mikedld | 2866 | ====================================================================== |
118 | diamond | 2867 | The debug board is the global system buffer (with the size |
499 | diamond | 2868 | 1024 bytes), to which any program can write (generally speaking, |
118 | diamond | 2869 | arbitrary) data and from which other program can read these data. |
2870 | By the agreement written data are text strings interpreted as |
||
2871 | debug messages on a course of program execution. The kernel in |
||
2872 | some situations also writes to the debug board information on |
||
2873 | execution of some functions; by the agreement kernel messages |
||
2874 | begins from the prefix "K : ". |
||
2875 | For view of the debug board the application 'board' was created, |
||
2876 | which reads data from the buffer and displays them in its window. |
||
2877 | 'board' interpretes the sequence of codes 13,10 as newline. |
||
2878 | A character with null code in an end of line is not necessary, |
||
114 | mikedld | 2879 | but also does not prevent. |
118 | diamond | 2880 | Because debugger has been written, the value of the debug board |
2881 | has decreased, as debugger allows to inspect completely a course of |
||
2882 | program execution without any efforts from the direction of program |
||
2883 | itself. Nevertheless in some cases the debug board is still useful. |
||
114 | mikedld | 2884 | |
118 | diamond | 2885 | ----------------------------- Write byte ----------------------------- |
114 | mikedld | 2886 | Parameters: |
118 | diamond | 2887 | * eax = 63 - function number |
2888 | * ebx = 1 - subfunction number |
||
2889 | * cl = data byte |
||
114 | mikedld | 2890 | Returned value: |
2891 | * function does not return value |
||
2892 | Remarks: |
||
118 | diamond | 2893 | * Byte is written to the buffer. Buffer size is 512 bytes. |
2894 | At buffer overflow all obtained data are lost. |
||
2895 | * For output to the debug board of more complicated objects |
||
2896 | (strings, numbers) it is enough to call this function in cycle. |
||
2897 | It is possible not to write the appropriate code manually and use |
||
2898 | file 'debug.inc', which is included into the distributive. |
||
114 | mikedld | 2899 | |
118 | diamond | 2900 | ----------------------------- Read byte ------------------------------ |
2901 | Takes away byte from the buffer. |
||
114 | mikedld | 2902 | Parameters: |
118 | diamond | 2903 | * eax = 63 - function number |
2904 | * ebx = 2 - subfunction number |
||
114 | mikedld | 2905 | Returned value: |
118 | diamond | 2906 | * eax = ebx = 0 - the buffer is empty |
2907 | * eax = byte, ebx = 1 - byte was successfully read |
||
114 | mikedld | 2908 | |
6057 | IgorA | 2909 | ---------------------- Constants for registers: ---------------------- |
2910 | eax - SF_BOARD (63) |
||
2911 | ebx - SSF_DEBUG_WRITE (1), SSF_DEBUG_READ (2) |
||
114 | mikedld | 2912 | ====================================================================== |
118 | diamond | 2913 | ============== Function 64 - resize application memory. ============== |
114 | mikedld | 2914 | ====================================================================== |
2915 | Parameters: |
||
118 | diamond | 2916 | * eax = 64 - function number |
2917 | * ebx = 1 - unique subfunction |
||
2918 | * ecx = new memory size |
||
114 | mikedld | 2919 | Returned value: |
118 | diamond | 2920 | * eax = 0 - success |
2921 | * eax = 1 - not enough memory |
||
114 | mikedld | 2922 | Remarks: |
193 | diamond | 2923 | * There is another way to dynamically allocate/free memory - |
2924 | subfunctions 11, 12, 13 of function 68. |
||
2925 | * The function cannot be used together with 68.11, 68.12, 68.13. |
||
2926 | The function call will be ignored after creation of process heap |
||
2927 | with function 68.11. |
||
114 | mikedld | 2928 | |
6057 | IgorA | 2929 | ---------------------- Constants for registers: ---------------------- |
2930 | eax - SF_MEMORY_RESIZE (64) |
||
114 | mikedld | 2931 | ====================================================================== |
283 | diamond | 2932 | ======== Function 65 - draw image with palette in the window. ======== |
2933 | ====================================================================== |
||
2934 | Parameters: |
||
2935 | * eax = 65 - function number |
||
2936 | * ebx = pointer to the image |
||
2937 | * ecx = [size on axis x]*65536 + [size on axis y] |
||
2938 | * edx = [coordinate on axis x]*65536 + [coordinate on axis y] |
||
2730 | dunkaist | 2939 | * esi = number of bits per pixel, must be 1,2,4,8,9,15,16,24 or 32; |
1018 | diamond | 2940 | * edi = pointer to palette (2 to the power esi colors 0x00RRGGBB); |
2941 | ignored when esi > 8 |
||
314 | diamond | 2942 | * ebp = offset of next row data relative to previous row data |
283 | diamond | 2943 | Returned value: |
2944 | * function does not return value |
||
2945 | Remarks: |
||
2946 | * Coordinates of the image are coordinates of the upper left corner |
||
2947 | of the image relative to the window. |
||
1018 | diamond | 2948 | * Format of image with 1 bit per pixel: each byte of image |
2949 | (possibly excluding last bytes in rows), contains information on |
||
2950 | the color of 8 pixels, MSB corresponds to first pixel. |
||
2951 | * Format of image with 2 bits per pixel: each byte of image |
||
2952 | (possibly excluding last bytes in rows), contains information on |
||
2953 | the color of 4 pixels, two MSBs correspond to first pixel. |
||
2954 | * Format of image with 4 bits per pixel: each byte of image |
||
2955 | excluding last bytes in rows (if width is odd) contains |
||
2956 | information on the color of 2 pixels, high-order tetrad |
||
2957 | corresponds to first pixel. |
||
2958 | * Format of image with 8 bits per pixel: each byte of image is |
||
2959 | index in the palette. |
||
2730 | dunkaist | 2960 | * Format of image with 9 bits per pixel: array of one byte values; |
2961 | each byte (8 bit) represents the intensity of gray for one pixel; |
||
2962 | this format is equal to 8bpp without palette. |
||
1018 | diamond | 2963 | * Format of image with 15 bits per pixel: the color of each pixel |
2964 | is coded as (bit representation) 0RRRRRGGGGGBBBBB - 5 bits per |
||
2965 | each color. |
||
2966 | * Format of image with 16 bits per pixel: the color of each pixel |
||
2967 | is coded as RRRRRGGGGGGBBBBB (5+6+5). |
||
2968 | * Format of image with 24 bits per pixel: the color of each pixel |
||
2969 | is coded as 3 bytes - sequentially blue, green, red components. |
||
2970 | * Format of image with 32 bits per pixel: similar to 24, but |
||
6402 | ashmew2 | 2971 | one additional ignored byte is present. It's format is BGRX, |
2972 | where X is the ignored byte. |
||
314 | diamond | 2973 | * The call to function 7 is equivalent to call to this function |
2974 | with esi=24, ebp=0. |
||
283 | diamond | 2975 | |
6057 | IgorA | 2976 | ---------------------- Constants for registers: ---------------------- |
2977 | eax - SF_PUT_IMAGE_EXT (65) |
||
283 | diamond | 2978 | ====================================================================== |
118 | diamond | 2979 | ================== Function 66 - work with keyboard. ================= |
114 | mikedld | 2980 | ====================================================================== |
118 | diamond | 2981 | The input mode influences results of reading keys by function 2. |
2982 | When a program loads, ASCII input mode is set for it. |
||
114 | mikedld | 2983 | |
118 | diamond | 2984 | -------------- Subfunction 1 - set keyboard input mode. -------------- |
114 | mikedld | 2985 | Parameters: |
118 | diamond | 2986 | * eax = 66 - function number |
2987 | * ebx = 1 - subfunction number |
||
114 | mikedld | 2988 | * ecx = mode: |
2989 | * 0 = normal (ASCII-characters) |
||
2990 | * 1 = scancodes |
||
2991 | Returned value: |
||
2992 | * function does not return value |
||
2993 | |||
118 | diamond | 2994 | -------------- Subfunction 2 - get keyboard input mode. -------------- |
114 | mikedld | 2995 | Parameters: |
118 | diamond | 2996 | * eax = 66 - function number |
2997 | * ebx = 2 - subfunction number |
||
114 | mikedld | 2998 | Returned value: |
2999 | * eax = current mode |
||
3000 | |||
118 | diamond | 3001 | ------------ Subfunction 3 - get status of control keys. ------------- |
114 | mikedld | 3002 | Parameters: |
118 | diamond | 3003 | * eax = 66 - function number |
3004 | * ebx = 3 - subfunction number |
||
114 | mikedld | 3005 | Returned value: |
3006 | * eax = bit mask: |
||
3355 | mario79 | 3007 | * bit 0 (mask 1): left Shift is pressed |
3008 | * bit 1 (mask 2): right Shift is pressed |
||
3009 | * bit 2 (mask 4): left Ctrl is pressed |
||
3010 | * bit 3 (mask 8): right Ctrl is pressed |
||
3011 | * bit 4 (mask 0x10): left Alt is pressed |
||
3012 | * bit 5 (mask 0x20): right Alt is pressed |
||
3013 | * bit 6 (mask 0x40): CapsLock is on |
||
3014 | * bit 7 (mask 0x80): NumLock is on |
||
3015 | * bit 8 (mask 0x100): ScrollLock is on |
||
3016 | * bit 9 (mask 0x200): left Win is pressed |
||
3017 | * bit 10 (mask 0x400): right Win is pressed |
||
118 | diamond | 3018 | * other bits are cleared |
114 | mikedld | 3019 | |
118 | diamond | 3020 | -------------- Subfunction 4 - set system-wide hotkey. --------------- |
3021 | When hotkey is pressed, the system notifies only those applications, |
||
3022 | which have installed it; the active application (which receives |
||
3023 | all normal input) does not receive such keys. |
||
3024 | The notification consists in sending event with the code 2. |
||
3025 | Reading hotkey is the same as reading normal key - by function 2. |
||
114 | mikedld | 3026 | Parameters: |
118 | diamond | 3027 | * eax = 66 - function number |
3028 | * ebx = 4 - subfunction number |
||
3029 | * cl determines key scancode; |
||
3030 | use cl=0 to give combinations such as Ctrl+Shift |
||
3031 | * edx = 0xXYZ determines possible states of control keys: |
||
3032 | * Z (low 4 bits) determines state of LShift and RShift: |
||
3033 | * 0 = no key must be pressed; |
||
3034 | * 1 = exactly one key must be pressed; |
||
3035 | * 2 = both keys must be pressed; |
||
3036 | * 3 = must be pressed LShift, but not RShift; |
||
3037 | * 4 = must be pressed RShift, but not LShift |
||
3038 | * Y - similar for LCtrl and RCtrl; |
||
3039 | * X - similar for LAlt and RAlt |
||
114 | mikedld | 3040 | Returned value: |
118 | diamond | 3041 | * eax=0 - success |
3042 | * eax=1 - too mant hotkeys (maximum 256 are allowed) |
||
114 | mikedld | 3043 | Remarks: |
118 | diamond | 3044 | * Hotkey can work either at pressing or at release. Release |
3045 | scancode of a key is more on 128 than pressing scancode |
||
3046 | (i.e. high bit is set). |
||
3047 | * Several applications can set the same combination; |
||
3048 | all such applications will be informed on pressing |
||
3049 | such combination. |
||
114 | mikedld | 3050 | |
118 | diamond | 3051 | -------------- Subfunction 5 - delete installed hotkey. -------------- |
114 | mikedld | 3052 | Parameters: |
118 | diamond | 3053 | * eax = 66 - function number |
3054 | * ebx = 5 - subfunction number |
||
3055 | * cl = scancode of key and edx = 0xXYZ the same as in subfunction 4 |
||
114 | mikedld | 3056 | Returned value: |
118 | diamond | 3057 | * eax = 0 - success |
114 | mikedld | 3058 | * eax = 1 - there is no such hotkey |
3059 | Remarks: |
||
118 | diamond | 3060 | * When a process/thread terminates, all hotkey installed by it are |
3061 | deleted. |
||
3062 | * The call to this subfunction does not affect other applications. |
||
3063 | If other application has defined the same combination, it will |
||
3064 | still receive notices. |
||
114 | mikedld | 3065 | |
2709 | mario79 | 3066 | --------------- Subfunction 6 - block the normal input. -------------- |
3067 | Parameters: |
||
3068 | * eax = 66 - function number |
||
3069 | * ebx = 6 - subfunction number |
||
3070 | Returned value: |
||
3071 | * function does not return value |
||
3072 | Remarks: |
||
3073 | * Blocking the normal keyboard input for installed hotkeys |
||
3074 | * To emulate a mouse via the keyboard, the application MOUSEMUL |
||
3075 | |||
3076 | ------------ Subfunction 7 - unlock the normal input. ---------------- |
||
3077 | Parameters: |
||
3078 | * eax = 66 - function number |
||
3079 | * ebx = 7 - subfunction number |
||
3080 | Returned value: |
||
3081 | * function does not return value |
||
3082 | Remarks: |
||
3083 | * Unlocking the results of the f. 66.6 |
||
3084 | * To emulate a mouse via the keyboard, the application MOUSEMUL |
||
3085 | |||
6057 | IgorA | 3086 | ---------------------- Constants for registers: ---------------------- |
3087 | eax - SF_KEYBOARD (66) |
||
3088 | ebx - SSF_SET_INPUT_MODE (1), SSF_GET_INPUT_MODE (2), |
||
3089 | SSF_GET_CONTROL_KEYS (3), SSF_SET_SYS_HOTKEY (4), |
||
3090 | SSF_DEL_SYS_HOTKEY (5), SSF_LOCK_INPUT (6), SSF_UNLOCK_INPUT (7) |
||
114 | mikedld | 3091 | ====================================================================== |
118 | diamond | 3092 | ========= Function 67 - change position/sizes of the window. ========= |
114 | mikedld | 3093 | ====================================================================== |
3094 | Parameters: |
||
118 | diamond | 3095 | * eax = 67 - function number |
114 | mikedld | 3096 | * ebx = new x-coordinate of the window |
3097 | * ecx = new y-coordinate of the window |
||
3098 | * edx = new x-size of the window |
||
3099 | * esi = new y-size of the window |
||
3100 | Returned value: |
||
3101 | * function does not return value |
||
3102 | Remarks: |
||
118 | diamond | 3103 | * The value -1 for a parameter means "do not change"; e.g. to move |
3104 | the window without resizing it is possible to specify edx=esi=-1. |
||
3105 | * Previously the window must be defined by function 0. |
||
114 | mikedld | 3106 | It sets initial coordinates and sizes of the window. |
118 | diamond | 3107 | * Sizes of the window are understood in sense of function 0, |
3108 | that is one pixel less than real sizes. |
||
3109 | * The function call for maximized windows is simply ignored. |
||
3110 | * For windows of appropriate styles position and/or sizes can be |
||
3111 | changed by user; current position and sizes can be obtained by |
||
3112 | call to function 9. |
||
3113 | * The function sends to the window redraw event (with the code 1). |
||
114 | mikedld | 3114 | |
6057 | IgorA | 3115 | ---------------------- Constants for registers: ---------------------- |
3116 | eax - SF_CHANGE_WINDOW (67) |
||
114 | mikedld | 3117 | ====================================================================== |
118 | diamond | 3118 | ====== Function 68, subfunction 0 - get the task switch counter. ===== |
114 | mikedld | 3119 | ====================================================================== |
3120 | Parameters: |
||
118 | diamond | 3121 | * eax = 68 - function number |
3122 | * ebx = 0 - subfunction number |
||
114 | mikedld | 3123 | Returned value: |
118 | diamond | 3124 | * eax = number of task switches from the system booting |
3125 | (modulo 2^32) |
||
114 | mikedld | 3126 | |
6057 | IgorA | 3127 | ---------------------- Constants for registers: ---------------------- |
3128 | eax - SF_SYS_MISC (68) |
||
3129 | ebx - SSF_GET_TASK_SWITCH_COUNT (0) |
||
114 | mikedld | 3130 | ====================================================================== |
118 | diamond | 3131 | ======= Function 68, subfunction 1 - switch to the next thread. ====== |
114 | mikedld | 3132 | ====================================================================== |
118 | diamond | 3133 | The function completes the current time slice allocated to the |
3134 | thread and switches to the next. (Which thread in which process |
||
3135 | will be next, is unpredictable). Later, when execution queue |
||
3136 | will reach the current thread, execution will be continued. |
||
114 | mikedld | 3137 | Parameters: |
118 | diamond | 3138 | * eax = 68 - function number |
3139 | * ebx = 1 - subfunction number |
||
114 | mikedld | 3140 | Returned value: |
3141 | * function does not return value |
||
3142 | |||
6057 | IgorA | 3143 | ---------------------- Constants for registers: ---------------------- |
3144 | eax - SF_SYS_MISC (68) |
||
3145 | ebx - SSF_SWITCH_TASK (1) |
||
114 | mikedld | 3146 | ====================================================================== |
118 | diamond | 3147 | ============= Function 68, subfunction 2 - cache + rdpmc. ============ |
114 | mikedld | 3148 | ====================================================================== |
3149 | Parameters: |
||
118 | diamond | 3150 | * eax = 68 - function number |
3151 | * ebx = 2 - subfunction number |
||
3152 | * ecx = required action: |
||
3153 | * ecx = 0 - enable instruction 'rdpmc' |
||
3154 | (ReaD Performance-Monitoring Counters) for applications |
||
3155 | * ecx = 1 - find out whether cache is disabled/enabled |
||
3156 | * ecx = 2 - enable cache |
||
3157 | * ecx = 3 - disable cache |
||
114 | mikedld | 3158 | Returned value: |
3159 | * for ecx=0: |
||
118 | diamond | 3160 | * eax = the value of cr4 |
114 | mikedld | 3161 | * for ecx=1: |
3162 | * eax = (cr0 and 0x60000000): |
||
118 | diamond | 3163 | * eax = 0 - cache is on |
3164 | * eax <> 0 - cache is off |
||
114 | mikedld | 3165 | * for ecx=2 and ecx=3: |
3166 | * function does not return value |
||
3167 | |||
6057 | IgorA | 3168 | ---------------------- Constants for registers: ---------------------- |
3169 | eax - SF_SYS_MISC (68) |
||
3170 | ebx - SSF_PERFORMANCE (2) |
||
3171 | ecx - SSSF_ALLOW_RDPMC (0), SSSF_CACHE_STATUS (1), |
||
3172 | SSSF_CACHE_ON (2), SSSF_CACHE_OFF (3) |
||
114 | mikedld | 3173 | ====================================================================== |
3174 | =========== Function 68, subfunction 3 - read MSR-register. ========== |
||
3175 | ====================================================================== |
||
118 | diamond | 3176 | MSR = Model Specific Register; the complete list of MSR-registers |
3177 | of a processor is included to the documentation on it (for example, |
||
3178 | IA-32 Intel Architecture Software Developer's Manual, |
||
3179 | Volume 3, Appendix B); each processor family has its own subset |
||
3180 | of the MSR-registers. |
||
114 | mikedld | 3181 | Parameters: |
118 | diamond | 3182 | * eax = 68 - function number |
3183 | * ebx = 3 - subfunction number |
||
3184 | * ecx is ignored |
||
3185 | * edx = MSR address |
||
114 | mikedld | 3186 | Returned value: |
118 | diamond | 3187 | * ebx:eax = high:low dword of the result |
114 | mikedld | 3188 | Remarks: |
118 | diamond | 3189 | * If ecx contains nonexistent or not implemented for this processor |
3190 | MSR, processor will generate an exception in the kernel, which |
||
3191 | will kill the thread. |
||
3192 | * Previously it is necessary to check, whether MSRs are supported |
||
3193 | as a whole, with the instruction 'cpuid'. Otherwise processor |
||
3194 | will generate other exception in the kernel, which will anyway |
||
3195 | kill the thread. |
||
114 | mikedld | 3196 | |
6057 | IgorA | 3197 | ---------------------- Constants for registers: ---------------------- |
3198 | eax - SF_SYS_MISC (68) |
||
3199 | ebx - SSF_READ_MSR (3) |
||
114 | mikedld | 3200 | ====================================================================== |
118 | diamond | 3201 | ========= Function 68, subfunction 4 - write to MSR-register. ======== |
114 | mikedld | 3202 | ====================================================================== |
118 | diamond | 3203 | MSR = Model Specific Register; the complete list of MSR-registers |
3204 | of a processor is included to the documentation on it (for example, |
||
3205 | IA-32 Intel Architecture Software Developer's Manual, |
||
3206 | Volume 3, Appendix B); each processor family has its own subset |
||
3207 | of the MSR-registers. |
||
114 | mikedld | 3208 | Parameters: |
118 | diamond | 3209 | * eax = 68 - function number |
3210 | * ebx = 4 - subfunction number |
||
3211 | * ecx is ignored |
||
3212 | * edx = MSR address |
||
3213 | * esi:edi = high:low dword |
||
114 | mikedld | 3214 | Returned value: |
499 | diamond | 3215 | * function does not return value |
3216 | Remarks: |
||
118 | diamond | 3217 | * If ecx contains nonexistent or not implemented for this processor |
3218 | MSR, processor will generate an exception in the kernel, which |
||
3219 | will kill the thread. |
||
3220 | * Previously it is necessary to check, whether MSRs are supported |
||
3221 | as a whole, with the instruction 'cpuid'. Otherwise processor |
||
3222 | will generate other exception in the kernel, which will anyway |
||
3223 | kill the thread. |
||
114 | mikedld | 3224 | |
6057 | IgorA | 3225 | ---------------------- Constants for registers: ---------------------- |
3226 | eax - SF_SYS_MISC (68) |
||
3227 | ebx - SSF_WRITE_MSR (4) |
||
114 | mikedld | 3228 | ====================================================================== |
193 | diamond | 3229 | ======= Function 68, subfunction 11 - initialize process heap. ======= |
114 | mikedld | 3230 | ====================================================================== |
3231 | Parameters: |
||
118 | diamond | 3232 | * eax = 68 - function number |
193 | diamond | 3233 | * ebx = 11 - subfunction number |
114 | mikedld | 3234 | Returned value: |
193 | diamond | 3235 | * eax = 0 - failed |
3236 | * otherwise size of created heap |
||
114 | mikedld | 3237 | Remarks: |
193 | diamond | 3238 | * The function call initializes heap, from which one can in future |
3239 | allocate and free memory blocks with subfunctions 12 and 13. |
||
3240 | Heap size is equal to total amount of free application memory. |
||
3241 | * The second function call from the same process results in |
||
3242 | returning the size of the existing heap. |
||
3243 | * After creation of the heap calls to function 64 will be ignored. |
||
114 | mikedld | 3244 | |
6057 | IgorA | 3245 | ---------------------- Constants for registers: ---------------------- |
3246 | eax - SF_SYS_MISC (68) |
||
3247 | ebx - SSF_HEAP_INIT (11) |
||
114 | mikedld | 3248 | ====================================================================== |
193 | diamond | 3249 | ======== Function 68, subfunction 12 - allocate memory block. ======== |
114 | mikedld | 3250 | ====================================================================== |
3251 | Parameters: |
||
118 | diamond | 3252 | * eax = 68 - function number |
193 | diamond | 3253 | * ebx = 12 - subfunction number |
3254 | * ecx = required size in bytes |
||
114 | mikedld | 3255 | Returned value: |
193 | diamond | 3256 | * eax = pointer to the allocated block |
114 | mikedld | 3257 | Remarks: |
193 | diamond | 3258 | * Before this call one must initialize process heap by call to |
3259 | subfunction 11. |
||
3260 | * The function allocates an integer number of pages (4 Kb) in such |
||
3261 | way that the real size of allocated block is more than or equal to |
||
3262 | requested size. |
||
114 | mikedld | 3263 | |
6057 | IgorA | 3264 | ---------------------- Constants for registers: ---------------------- |
3265 | eax - SF_SYS_MISC (68) |
||
3266 | ebx - SSF_MEM_ALLOC (12) |
||
114 | mikedld | 3267 | ====================================================================== |
193 | diamond | 3268 | ========== Function 68, subfunction 13 - free memory block. ========== |
114 | mikedld | 3269 | ====================================================================== |
3270 | Parameters: |
||
118 | diamond | 3271 | * eax = 68 - function number |
193 | diamond | 3272 | * ebx = 13 - subfunction number |
3273 | * ecx = pointer to the memory block |
||
114 | mikedld | 3274 | Returned value: |
193 | diamond | 3275 | * eax = 1 - success |
3276 | * eax = 0 - failed |
||
114 | mikedld | 3277 | Remarks: |
448 | diamond | 3278 | * The memory block must have been allocated by subfunction 12 |
3279 | or subfunction 20. |
||
114 | mikedld | 3280 | |
6057 | IgorA | 3281 | ---------------------- Constants for registers: ---------------------- |
3282 | eax - SF_SYS_MISC (68) |
||
3283 | ebx - SSF_MEM_FREE (13) |
||
114 | mikedld | 3284 | ====================================================================== |
1074 | Galkov | 3285 | ===================== Function 68, subfunction 14 ==================== |
1662 | Nasarus | 3286 | ============ Wait for signal from another program/driver. ============ |
114 | mikedld | 3287 | ====================================================================== |
3288 | Parameters: |
||
118 | diamond | 3289 | * eax = 68 - function number |
193 | diamond | 3290 | * ebx = 14 - subfunction number |
1074 | Galkov | 3291 | * ecx = pointer to the buffer for information (24 bytes) |
114 | mikedld | 3292 | Returned value: |
193 | diamond | 3293 | * buffer pointed to by ecx contains the following information: |
1662 | Nasarus | 3294 | * +0: dword: identifier for following data of signal |
3295 | * +4: dword: data of signal (20 bytes), format of which is defined |
||
3296 | by the first dword |
||
114 | mikedld | 3297 | |
6057 | IgorA | 3298 | ---------------------- Constants for registers: ---------------------- |
3299 | eax - SF_SYS_MISC (68) |
||
3300 | ebx - SSF_WAIT_SIGNAL (14) |
||
114 | mikedld | 3301 | ====================================================================== |
193 | diamond | 3302 | ============= Function 68, subfunction 16 - load driver. ============= |
3303 | ====================================================================== |
||
3304 | Parameters: |
||
3305 | * eax = 68 - function number |
||
3306 | * ebx = 16 - subfunction number |
||
3307 | * ecx = pointer to ASCIIZ-string with driver name |
||
3308 | Returned value: |
||
3309 | * eax = 0 - failed |
||
3310 | * otherwise eax = driver handle |
||
3311 | Remarks: |
||
3312 | * If the driver was not loaded yet, it is loaded; |
||
3313 | if the driver was loaded yet, nothing happens. |
||
3314 | * Driver name is case-sensitive. |
||
3315 | Maximum length of the name is 16 characters, including |
||
3316 | terminating null character, the rest is ignored. |
||
346 | diamond | 3317 | * Driver ABC is loaded from file /rd/1/drivers/ABC.obj. |
193 | diamond | 3318 | |
6057 | IgorA | 3319 | ---------------------- Constants for registers: ---------------------- |
3320 | eax - SF_SYS_MISC (68) |
||
3321 | ebx - SSF_LOAD_DRIVER (16) |
||
193 | diamond | 3322 | ====================================================================== |
3323 | ============ Function 68, subfunction 17 - driver control. =========== |
||
3324 | ====================================================================== |
||
3325 | Parameters: |
||
3326 | * eax = 68 - function number |
||
3327 | * ebx = 17 - subfunction number |
||
3328 | * ecx = pointer to the control structure: |
||
3329 | * +0: dword: handle of driver |
||
3330 | * +4: dword: code of driver function |
||
3331 | * +8: dword: pointer to input data |
||
3332 | * +12 = +0xC: dword: size of input data |
||
3333 | * +16 = +0x10: dword: pointer to output data |
||
3334 | * +20 = +0x14: dword: size of output data |
||
3335 | Returned value: |
||
1662 | Nasarus | 3336 | * eax = determined by driver |
193 | diamond | 3337 | Remarks: |
3338 | * Function codes and the structure of input/output data |
||
3339 | are defined by driver. |
||
3340 | * Previously one must obtain driver handle by subfunction 16. |
||
3341 | |||
6057 | IgorA | 3342 | ---------------------- Constants for registers: ---------------------- |
3343 | eax - SF_SYS_MISC (68) |
||
3344 | ebx - SSF_CONTROL_DRIVER (17) |
||
193 | diamond | 3345 | ====================================================================== |
277 | diamond | 3346 | =============== Function 68, subfunction 19 - load DLL. ============== |
3347 | ====================================================================== |
||
3348 | Parameters: |
||
3349 | * eax = 68 - function number |
||
3350 | * ebx = 19 - subfunction number |
||
6502 | pathoswith | 3351 | * ecx = pointer to the string with path to DLL, |
3352 | rules of path forming can be found in function 70 description. |
||
277 | diamond | 3353 | Returned value: |
3354 | * eax = 0 - failed |
||
3355 | * otherwise eax = pointer to DLL export table |
||
3356 | Remarks: |
||
3357 | * Export table is an array of structures of 2 dword's, terminated |
||
3358 | by zero. The first dword in structure points to function name, |
||
3359 | the second dword contains address of function. |
||
3360 | |||
6057 | IgorA | 3361 | ---------------------- Constants for registers: ---------------------- |
3362 | eax - SF_SYS_MISC (68) |
||
3363 | ebx - SSF_LOAD_DLL (19) |
||
277 | diamond | 3364 | ====================================================================== |
448 | diamond | 3365 | ======= Function 68, subfunction 20 - reallocate memory block. ======= |
3366 | ====================================================================== |
||
3367 | Parameters: |
||
3368 | * eax = 68 - function number |
||
3369 | * ebx = 20 - subfunction number |
||
3370 | * ecx = new size in bytes |
||
3371 | * edx = pointer to already allocated block |
||
3372 | Returned value: |
||
3373 | * eax = pointer to the reallocated block, 0 = error |
||
3374 | Remarks: |
||
3375 | * Before this call one must initialize process heap by call to |
||
3376 | subfunction 11. |
||
3377 | * The function allocates an integer number of pages (4 Kb) in such |
||
3378 | way that the real size of allocated block is more than or equal to |
||
3379 | requested size. |
||
3380 | * If edx=0, the function call is equivalent to memory allocation |
||
3381 | with subfunction 12. Otherwise the block at edx |
||
3382 | must be allocated earlier with subfunction 12 or this subfunction. |
||
3383 | * If ecx=0, the function frees memory block at edx and returns 0. |
||
3384 | * The contents of the block are unchanged up to the shorter of |
||
3385 | the new and old sizes. |
||
3386 | |||
6057 | IgorA | 3387 | ---------------------- Constants for registers: ---------------------- |
3388 | eax - SF_SYS_MISC (68) |
||
3389 | ebx - SSF_MEM_REALLOC (20) |
||
448 | diamond | 3390 | ====================================================================== |
2646 | mario79 | 3391 | =========== Function 68, subfunction 21 - load driver PE. ============ |
3392 | ====================================================================== |
||
3393 | Parameters: |
||
3394 | * eax = 68 - function number |
||
3395 | * ebx = 21 - subfunction number |
||
3396 | * ecx = pointer to ASCIIZ-string with driver name |
||
2647 | mario79 | 3397 | * edx = pointer to command line |
2646 | mario79 | 3398 | Returned value: |
3399 | * eax = 0 - failed |
||
3400 | * otherwise eax = driver handle |
||
3401 | Remarks: |
||
3402 | * If the driver was not loaded yet, it is loaded; |
||
3403 | if the driver was loaded yet, nothing happens. |
||
3404 | |||
6057 | IgorA | 3405 | ---------------------- Constants for registers: ---------------------- |
3406 | eax - SF_SYS_MISC (68) |
||
3407 | ebx - SSF_LOAD_DRIVER_PE (21) |
||
2646 | mario79 | 3408 | ====================================================================== |
1662 | Nasarus | 3409 | ======== Function 68, subfunction 22 - open named memory area. ======= |
1077 | Galkov | 3410 | ====================================================================== |
3411 | Parameters: |
||
3412 | * eax = 68 - function number |
||
1662 | Nasarus | 3413 | * ebx = 22 - subfunction number |
3414 | * ecx = area name. Maximum of 31 characters with terminating zero |
||
3415 | * edx = area size in bytes for SHM_CREATE and SHM_OPEN_ALWAYS |
||
3416 | * esi = flags for open and access: |
||
3417 | * SHM_OPEN = 0x00 - open existing memory area. If an area |
||
3418 | with such name does not exist, the function |
||
3419 | will return error code 5. |
||
3420 | * SHM_OPEN_ALWAYS = 0x04 - open existing or create new |
||
3421 | memory area. |
||
3422 | * SHM_CREATE = 0x08 - create new memory area. If an area |
||
3423 | with such name already exists, the function |
||
3424 | will return error code 10. |
||
3425 | * SHM_READ = 0x00 - only read access |
||
3426 | * SHM_WRITE = 0x01 - read and write access |
||
3427 | Returned value: |
||
3428 | * eax = pointer to memory area, 0 if error has occured |
||
3429 | * if new area is created (SHM_CREATE or SHM_OPEN_ALWAYS): |
||
3430 | edx = 0 - success, otherwise - error code |
||
3431 | * if existing area is opened (SHM_OPEN or SHM_OPEN_ALWAYS): |
||
3432 | edx = error code (if eax=0) or area size in bytes |
||
3433 | Error codes: |
||
3434 | * E_NOTFOUND = 5 |
||
3435 | * E_ACCESS = 10 |
||
3436 | * E_NOMEM = 30 |
||
3437 | * E_PARAM = 33 |
||
3438 | Remarks: |
||
3439 | * Before this call one must initialize process heap by call to |
||
3440 | subfunction 11. |
||
3441 | * If a new area is created, access flags set maximal rights |
||
3442 | for other processes. An attempt from other process to open |
||
3443 | with denied rights will fail with error code E_ACCESS. |
||
3444 | * The process which has created an area always has write access. |
||
3445 | |||
6057 | IgorA | 3446 | ---------------------- Constants for registers: ---------------------- |
3447 | eax - SF_SYS_MISC (68) |
||
3448 | ebx - SSF_MEM_OPEN (22) |
||
1662 | Nasarus | 3449 | ====================================================================== |
3450 | ======= Function 68, subfunction 23 - close named memory area. ======= |
||
3451 | ====================================================================== |
||
3452 | Parameters: |
||
3453 | * eax = 68 - function number |
||
3454 | * ebx = 23 - subfunction number |
||
3455 | * ecx = area name. Maximum of 31 characters with terminating zero |
||
3456 | Returned value: |
||
3457 | * eax destroyed |
||
3458 | Remarks: |
||
3459 | * A memory area is physically freed (with deleting all data and |
||
3460 | freeing physical memory), when all threads which have opened |
||
3461 | this area will close it. |
||
3462 | * When thread is terminating, all opened by it areas are closed. |
||
3463 | |||
6057 | IgorA | 3464 | ---------------------- Constants for registers: ---------------------- |
3465 | eax - SF_SYS_MISC (68) |
||
3466 | ebx - SSF_MEM_CLOSE (23) |
||
1662 | Nasarus | 3467 | ====================================================================== |
3468 | ======== Function 68, subfunction 24 - set exception handler. ======== |
||
3469 | ====================================================================== |
||
3470 | Parameters: |
||
3471 | * eax = 68 - function number |
||
1077 | Galkov | 3472 | * ebx = 24 - subfunction number |
3473 | * ecx = address of the new exception handler |
||
1662 | Nasarus | 3474 | * edx = the mask of handled exceptions |
1077 | Galkov | 3475 | Returned value: |
3476 | * eax = address of the old exception handler (0, if it was not set) |
||
1662 | Nasarus | 3477 | * ebx = the old mask of handled exceptions |
1077 | Galkov | 3478 | Remarks: |
1662 | Nasarus | 3479 | * Bit number in mask of exceptions corresponds to exception number |
3480 | in CPU-specification (Intel-PC). For example, FPU exceptions have |
||
3481 | number 16 (#MF), and SSE exceptions - 19 (#XF). |
||
3482 | * The current implementation ignores the inquiry for hook of 7 |
||
3483 | exception - the system handles #NM by its own. |
||
3484 | * The exception handler is called with exception number as first |
||
3485 | (and only) stack parameter. So, correct exit from the handler is |
||
3486 | RET 4. It returns to the instruction, that caused the exception, |
||
3487 | for faults, and to the next instruction for traps (see |
||
3488 | classification of exceptions in CPU specification). |
||
3489 | * When user handler receives control, the corresponding bit in |
||
3490 | the exception mask is cleared. Raising this exception |
||
3491 | in consequence leads to default handling, that is, |
||
3492 | terminating the application in absence of debugger or |
||
3493 | suspend with notification of debugger otherwise. |
||
3494 | * After user handler completes critical operations, it can set |
||
3495 | the corresponding bit in the exception mask with subfunction 25. |
||
3496 | Also user handler is responsible for clearing exceptions flags in |
||
3497 | FPU and/or SSE. |
||
1077 | Galkov | 3498 | |
6057 | IgorA | 3499 | ---------------------- Constants for registers: ---------------------- |
3500 | eax - SF_SYS_MISC (68) |
||
3501 | ebx - SSF_SET_EXCEPTION_HANDLER (24) |
||
1077 | Galkov | 3502 | ====================================================================== |
5983 | pathoswith | 3503 | ======== Function 68, subfunction 25 - set exception activity ======== |
1077 | Galkov | 3504 | ====================================================================== |
3505 | Parameters: |
||
3506 | * eax = 68 - function number |
||
3507 | * ebx = 25 - subfunction number |
||
3508 | * ecx = signal number |
||
3509 | * edx = value of activity (0/1) |
||
3510 | Returned value: |
||
1662 | Nasarus | 3511 | * eax = -1 - invalid signal number |
3512 | * otherwise eax = old value of activity for this signal (0/1) |
||
1077 | Galkov | 3513 | Remarks: |
1662 | Nasarus | 3514 | * In current implementation only mask for user excepton handler, |
3515 | which has been previously set by subfunction 24, |
||
3516 | is changed. Signal number corresponds to exception number. |
||
1077 | Galkov | 3517 | |
6057 | IgorA | 3518 | ---------------------- Constants for registers: ---------------------- |
3519 | eax - SF_SYS_MISC (68) |
||
3520 | ebx - SSF_SET_EXCEPTION_STATE (25) |
||
1077 | Galkov | 3521 | ====================================================================== |
3787 | Serge | 3522 | ====== Function 68, subfunction 26 - release memory pages ============ |
3523 | ====================================================================== |
||
3524 | Parameters: |
||
3525 | * eax = 68 - function number |
||
3526 | * ebx = 26 - subfunction number |
||
3527 | * ecx = pointer to the memory block, allocated by subfunction 12 |
||
3528 | * edx = offset from the block beginnings |
||
3529 | * esi = the size of the region of memory to release, in bytes |
||
3530 | Remarks: |
||
3531 | * function release range of pages from ecx+edx to ecx+edx+esi |
||
3532 | and set virtual memory into reserved state. |
||
3533 | |||
6057 | IgorA | 3534 | ---------------------- Constants for registers: ---------------------- |
3535 | eax - SF_SYS_MISC (68) |
||
3536 | ebx - SSF_MEM_FREE_EXT (26) |
||
3787 | Serge | 3537 | ====================================================================== |
3538 | ========== Function 68, subfunction 27 - load file =================== |
||
3539 | ====================================================================== |
||
3540 | Parameters: |
||
3541 | * eax = 68 - function number |
||
3542 | * ebx = 27 - subfunction number |
||
6511 | pathoswith | 3543 | * ecx = pointer to the string with path to file, |
3544 | rules of path forming can be found in function 70 description. |
||
3787 | Serge | 3545 | Returned value: |
3546 | * eax = pointer to the loaded file, or zero |
||
3547 | * edx = size of the loaded file, or zero |
||
3548 | Remarks: |
||
3549 | * function loads file and unpacks, if necessary |
||
3550 | |||
6057 | IgorA | 3551 | ---------------------- Constants for registers: ---------------------- |
3552 | eax - SF_SYS_MISC (68) |
||
3553 | ebx - SSF_LOAD_FILE (27) |
||
3787 | Serge | 3554 | ====================================================================== |
1662 | Nasarus | 3555 | ====================== Function 69 - debugging. ====================== |
114 | mikedld | 3556 | ====================================================================== |
118 | diamond | 3557 | A process can load other process as debugged by set of corresponding |
193 | diamond | 3558 | bit by call to subfunction 7 of function 70. |
118 | diamond | 3559 | A process can have only one debugger; one process can debug some |
3560 | others. The system notifies debugger on events occuring with |
||
3561 | debugged process. Messages are written to the buffer defined by |
||
114 | mikedld | 3562 | subfunction 0. |
118 | diamond | 3563 | Format of a message: |
3564 | * +0: dword: message code |
||
3565 | * +4: dword: PID of debugged process |
||
3566 | * +8: there can be additional data depending on message code |
||
3567 | Message codes: |
||
114 | mikedld | 3568 | * 1 = exception |
118 | diamond | 3569 | * in addition dword-number of the exception is given |
3570 | * process is suspended |
||
3571 | * 2 = process has terminated |
||
3572 | * comes at any termination: both through the system function -1, |
||
3573 | and at "murder" by any other process (including debugger itself) |
||
114 | mikedld | 3574 | * 3 = debug exception int 1 = #DB |
118 | diamond | 3575 | * in addition dword-image of the register DR6 is given: |
3576 | * bits 0-3: condition of the corresponding breakpoint (set by |
||
3577 | subfunction 9) is satisfied |
||
3539 | clevermous | 3578 | * bit 14: exception has occured because of the trace mode |
118 | diamond | 3579 | (flag TF is set TF) |
3580 | * process is suspended |
||
3581 | When debugger terminates, all debugged processes are killed. |
||
3582 | If debugger does not want this, it must previously detach by |
||
114 | mikedld | 3583 | subfunction 3. |
3584 | |||
1018 | diamond | 3585 | All subfunctions are applicable only to processes/threads started |
3586 | from the current by function 70 with set debugging flag. |
||
118 | diamond | 3587 | Debugging of multithreaded programs is not supported yet. |
3588 | The full list of subfunctions: |
||
3589 | * subfunction 0 - define data area for debug messages |
||
3590 | * subfunction 1 - get contents of registers of debugged thread |
||
3591 | * subfunction 2 - set contents of registers of debugged thread |
||
3592 | * subfunction 3 - detach from debugged process |
||
3593 | * subfunction 4 - suspend debugged thread |
||
3594 | * subfunction 5 - resume debugged thread |
||
3595 | * subfunction 6 - read from the memory of debugged process |
||
3596 | * subfunction 7 - write to the memory of debugged process |
||
3597 | * subfunction 8 - terminate debugged thread |
||
3598 | * subfunction 9 - set/clear hardware breakpoint |
||
114 | mikedld | 3599 | |
6057 | IgorA | 3600 | ---------------------- Constants for registers: ---------------------- |
3601 | eax - SF_DEBUG (69) |
||
3602 | ebx - SSF_SET_MESSAGE_AREA (0), SSF_GET_REGISTERS (1), |
||
3603 | SSF_SET_REGISTERS (2), SSF_DETACH (3), SSF_SUSPEND (4), |
||
3604 | SSF_RESUME (5), SSF_READ_MEMORY (6), SSF_WRITE_MEMORY (7), |
||
3605 | SSF_TERMINATE (8), SSF_DEFINE_BREAKPOINT (9) |
||
114 | mikedld | 3606 | ====================================================================== |
118 | diamond | 3607 | = Function 69, subfunction 0 - define data area fror debug messages. = |
114 | mikedld | 3608 | ====================================================================== |
3609 | Parameters: |
||
118 | diamond | 3610 | * eax = 69 - function number |
3611 | * ebx = 0 - subfunction number |
||
114 | mikedld | 3612 | * ecx = pointer |
3613 | Format of data area: |
||
118 | diamond | 3614 | * +0: dword: N = buffer size (not including this header) |
3615 | * +4: dword: occupied place |
||
114 | mikedld | 3616 | * +8: N*byte: buffer |
3617 | Returned value: |
||
3618 | * function does not return value |
||
3619 | Remarks: |
||
118 | diamond | 3620 | * If the size field is negative, the buffer is considered locked |
3621 | and at arrival of new message the system will wait. |
||
3622 | For synchronization frame all work with the buffer by operations |
||
3623 | lock/unlock |
||
5871 | hidnplayr | 3624 | neg [bufsize] |
118 | diamond | 3625 | * Data in the buffer are considered as array of items with variable |
3626 | length - messages. Format of a message is explained in |
||
3627 | general description. |
||
114 | mikedld | 3628 | |
6057 | IgorA | 3629 | ---------------------- Constants for registers: ---------------------- |
3630 | eax - SF_DEBUG (69) |
||
3631 | ebx - SSF_SET_MESSAGE_AREA (0) |
||
114 | mikedld | 3632 | ====================================================================== |
118 | diamond | 3633 | ===================== Function 69, subfunction 1 ===================== |
3634 | ============ Get contents of registers of debugged thread. =========== |
||
114 | mikedld | 3635 | ====================================================================== |
3636 | Parameters: |
||
118 | diamond | 3637 | * eax = 69 - function number |
3638 | * ebx = 1 - subfunction number |
||
114 | mikedld | 3639 | * ecx = thread identifier |
118 | diamond | 3640 | * edx = size of context structure, must be 0x28=40 bytes |
3641 | * esi = pointer to context structure |
||
114 | mikedld | 3642 | Returned value: |
3643 | * function does not return value |
||
118 | diamond | 3644 | Format of context structure: (FPU is not supported yet) |
114 | mikedld | 3645 | * +0: dword: eip |
3646 | * +4: dword: eflags |
||
3647 | * +8: dword: eax |
||
3648 | * +12 = +0xC: dword: ecx |
||
3649 | * +16 = +0x10: dword: edx |
||
3650 | * +20 = +0x14: dword: ebx |
||
3651 | * +24 = +0x18: dword: esp |
||
3652 | * +28 = +0x1C: dword: ebp |
||
3653 | * +32 = +0x20: dword: esi |
||
3654 | * +36 = +0x24: dword: edi |
||
3655 | Remarks: |
||
118 | diamond | 3656 | * If the thread executes code of ring-0, the function returns |
3657 | contents of registers of ring-3. |
||
3658 | * Process must be loaded for debugging (as is shown in |
||
3659 | general description). |
||
114 | mikedld | 3660 | |
6057 | IgorA | 3661 | ---------------------- Constants for registers: ---------------------- |
3662 | eax - SF_DEBUG (69) |
||
3663 | ebx - SSF_GET_REGISTERS (1) |
||
114 | mikedld | 3664 | ====================================================================== |
118 | diamond | 3665 | ===================== Function 69, subfunction 2 ===================== |
3666 | ============ Set contents of registers of debugged thread. =========== |
||
114 | mikedld | 3667 | ====================================================================== |
3668 | Parameters: |
||
118 | diamond | 3669 | * eax = 69 - function number |
3670 | * ebx = 2 - subfunction number |
||
114 | mikedld | 3671 | * ecx = thread identifier |
118 | diamond | 3672 | * edx = size of context structure, must be 0x28=40 bytes |
6758 | pathoswith | 3673 | * esi -> context structure |
114 | mikedld | 3674 | Returned value: |
3675 | * function does not return value |
||
118 | diamond | 3676 | Format of context structure is shown in the description of |
3677 | subfunction 1. |
||
114 | mikedld | 3678 | Remarks: |
118 | diamond | 3679 | * If the thread executes code of ring-0, the function returns |
3680 | contents of registers of ring-3. |
||
3681 | * Process must be loaded for debugging (as is shown in |
||
3682 | general description). |
||
114 | mikedld | 3683 | |
6057 | IgorA | 3684 | ---------------------- Constants for registers: ---------------------- |
3685 | eax - SF_DEBUG (69) |
||
3686 | ebx - SSF_SET_REGISTERS (2) |
||
114 | mikedld | 3687 | ====================================================================== |
118 | diamond | 3688 | ===== Function 69, subfunction 3 - detach from debugged process. ===== |
114 | mikedld | 3689 | ====================================================================== |
3690 | Parameters: |
||
118 | diamond | 3691 | * eax = 69 - function number |
3692 | * ebx = 3 - subfunction number |
||
114 | mikedld | 3693 | * ecx = identifier |
3694 | Returned value: |
||
3695 | * function does not return value |
||
3696 | Remarks: |
||
118 | diamond | 3697 | * If the process was suspended, it resumes execution. |
114 | mikedld | 3698 | |
6057 | IgorA | 3699 | ---------------------- Constants for registers: ---------------------- |
3700 | eax - SF_DEBUG (69) |
||
3701 | ebx - SSF_DETACH (3) |
||
114 | mikedld | 3702 | ====================================================================== |
1018 | diamond | 3703 | ======== Function 69, subfunction 4 - suspend debugged thread. ======= |
114 | mikedld | 3704 | ====================================================================== |
3705 | Parameters: |
||
118 | diamond | 3706 | * eax = 69 - function number |
3707 | * ebx = 4 - subfunction number |
||
3708 | * ecx = thread identifier |
||
114 | mikedld | 3709 | Returned value: |
3710 | * function does not return value |
||
1018 | diamond | 3711 | Remarks: |
3712 | * Process must be loaded for debugging (as is shown in |
||
3713 | general description). |
||
114 | mikedld | 3714 | |
6057 | IgorA | 3715 | ---------------------- Constants for registers: ---------------------- |
3716 | eax - SF_DEBUG (69) |
||
3717 | ebx - SSF_SUSPEND (4) |
||
114 | mikedld | 3718 | ====================================================================== |
1018 | diamond | 3719 | ======== Function 69, subfunction 5 - resume debugged thread. ======== |
114 | mikedld | 3720 | ====================================================================== |
3721 | Parameters: |
||
118 | diamond | 3722 | * eax = 69 - function number |
3723 | * ebx = 5 - subfunction number |
||
3724 | * ecx = thread identifier |
||
114 | mikedld | 3725 | Returned value: |
3726 | * function does not return value |
||
1018 | diamond | 3727 | Remarks: |
3728 | * Process must be loaded for debugging (as is shown in |
||
3729 | general description). |
||
114 | mikedld | 3730 | |
6057 | IgorA | 3731 | ---------------------- Constants for registers: ---------------------- |
3732 | eax - SF_DEBUG (69) |
||
3733 | ebx - SSF_RESUME (5) |
||
114 | mikedld | 3734 | ====================================================================== |
118 | diamond | 3735 | = Fucntion 69, subfunction 6 - read from memory of debugged process. = |
114 | mikedld | 3736 | ====================================================================== |
3737 | Parameters: |
||
118 | diamond | 3738 | * eax = 69 - function number |
3739 | * ebx = 6 - subfunction number |
||
114 | mikedld | 3740 | * ecx = identifier |
118 | diamond | 3741 | * edx = number of bytes to read |
3742 | * esi = address in the memory of debugged process |
||
3743 | * edi = pointer to buffer for data |
||
114 | mikedld | 3744 | Returned value: |
118 | diamond | 3745 | * eax = -1 at an error (invalid PID or buffer) |
3746 | * otherwise eax = number of read bytes (possibly, 0, |
||
3747 | if esi is too large) |
||
114 | mikedld | 3748 | Remarks: |
118 | diamond | 3749 | * Process must be loaded for debugging (as is shown in |
3750 | general description). |
||
114 | mikedld | 3751 | |
6057 | IgorA | 3752 | ---------------------- Constants for registers: ---------------------- |
3753 | eax - SF_DEBUG (69) |
||
3754 | ebx - SSF_READ_MEMORY (6) |
||
114 | mikedld | 3755 | ====================================================================== |
118 | diamond | 3756 | == Function 69, subfunction 7 - write to memory of debugged process. = |
114 | mikedld | 3757 | ====================================================================== |
3758 | Parameters: |
||
118 | diamond | 3759 | * eax = 69 - function number |
3760 | * ebx = 7 - subfunction number |
||
114 | mikedld | 3761 | * ecx = identifier |
118 | diamond | 3762 | * edx = number of bytes to write |
3763 | * esi = address of memory in debugged process |
||
3764 | * edi = pointer to data |
||
114 | mikedld | 3765 | Returned value: |
118 | diamond | 3766 | * eax = -1 at an error (invalid PID or buffer) |
3767 | * otherwise eax = number of written bytes (possibly, 0, |
||
3768 | if esi is too large) |
||
114 | mikedld | 3769 | Remarks: |
118 | diamond | 3770 | * Process must be loaded for debugging (as is shown in |
3771 | general description). |
||
114 | mikedld | 3772 | |
6057 | IgorA | 3773 | ---------------------- Constants for registers: ---------------------- |
3774 | eax - SF_DEBUG (69) |
||
3775 | ebx - SSF_WRITE_MEMORY (7) |
||
114 | mikedld | 3776 | ====================================================================== |
118 | diamond | 3777 | ======= Function 69, subfunction 8 - terminate debugged thread. ====== |
114 | mikedld | 3778 | ====================================================================== |
3779 | Parameters: |
||
118 | diamond | 3780 | * eax = 69 - function number |
3781 | * ebx = 8 - subfunction number |
||
114 | mikedld | 3782 | * ecx = identifier |
3783 | Returned value: |
||
3784 | * function does not return value |
||
3785 | Remarks: |
||
118 | diamond | 3786 | * Process must be loaded for debugging (as is shown in |
3787 | general description). |
||
3788 | * The function is similar to subfunction 2 of function 18 |
||
3789 | with two differences: it requires first remark and |
||
3790 | accepts PID rather than slot number. |
||
114 | mikedld | 3791 | |
6057 | IgorA | 3792 | ---------------------- Constants for registers: ---------------------- |
3793 | eax - SF_DEBUG (69) |
||
3794 | ebx - SSF_TERMINATE (8) |
||
114 | mikedld | 3795 | ====================================================================== |
118 | diamond | 3796 | ===== Function 69, subfunction 9 - set/clear hardware breakpoint. ==== |
114 | mikedld | 3797 | ====================================================================== |
3798 | Parameters: |
||
118 | diamond | 3799 | * eax = 69 - function number |
3800 | * ebx = 9 - subfunction number |
||
114 | mikedld | 3801 | * ecx = thread identifier |
118 | diamond | 3802 | * dl = index of breakpoint, from 0 to 3 inclusively |
114 | mikedld | 3803 | * dh = flags: |
118 | diamond | 3804 | * if high bit is cleared - set breakpoint: |
114 | mikedld | 3805 | * bits 0-1 - condition: |
3806 | * 00 = breakpoint on execution |
||
118 | diamond | 3807 | * 01 = breakpoint on read |
3808 | * 11 = breakpoint on read/write |
||
3809 | * bits 2-3 - length; for breakpoints on exception it must be |
||
3810 | 00, otherwise one of |
||
3811 | * 00 = byte |
||
114 | mikedld | 3812 | * 01 = word |
118 | diamond | 3813 | * 11 = dword |
3814 | * esi = breakpoint address; must be aligned according to |
||
3815 | the length (i.e. must be even for word breakpoints, |
||
3816 | divisible by 4 for dword) |
||
3817 | * if high bit is set - clear breakpoint |
||
114 | mikedld | 3818 | Returned value: |
118 | diamond | 3819 | * eax = 0 - success |
114 | mikedld | 3820 | * eax = 1 - error in the input data |
118 | diamond | 3821 | * eax = 2 - (reserved, is never returned in the current |
3822 | implementation) a global breakpoint with that index is already set |
||
114 | mikedld | 3823 | Remarks: |
118 | diamond | 3824 | * Process must be loaded for debugging (as is shown in |
3825 | general description). |
||
3826 | * Hardware breakpoints are implemented through DRx-registers of |
||
3827 | the processor, all limitations results from this. |
||
3828 | * The function can reinstall the breakpoint, previously set |
||
3829 | by it (and it does not inform on this). |
||
3830 | Carry on the list of set breakpoints in the debugger. |
||
3831 | * Breakpoints generate debug exception #DB, on which the system |
||
3832 | notifies debugger. |
||
3833 | * Breakpoints on write and read/write act after |
||
3834 | execution of the caused it instruction. |
||
114 | mikedld | 3835 | |
6057 | IgorA | 3836 | ---------------------- Constants for registers: ---------------------- |
3837 | eax - SF_DEBUG (69) |
||
3838 | ebx - SSF_DEFINE_BREAKPOINT (9) |
||
114 | mikedld | 3839 | ====================================================================== |
118 | diamond | 3840 | ==== Function 70 - work with file system with long names support. ==== |
114 | mikedld | 3841 | ====================================================================== |
3842 | Parameters: |
||
3843 | * eax = 70 |
||
118 | diamond | 3844 | * ebx = pointer to the information structure |
114 | mikedld | 3845 | Returned value: |
118 | diamond | 3846 | * eax = 0 - success; otherwise file system error code |
3847 | * some subfunctions return value in other registers too |
||
3848 | General format of the information structure: |
||
3849 | * +0: dword: subfunction number |
||
3850 | * +4: dword: file offset |
||
3851 | * +8: dword: high dword of offset (must be 0) or flags field |
||
114 | mikedld | 3852 | * +12 = +0xC: dword: size |
118 | diamond | 3853 | * +16 = +0x10: dword: pointer to data |
6473 | pathoswith | 3854 | * +20 = +0x14: ?: path - zero terminated string |
6502 | pathoswith | 3855 | or |
6473 | pathoswith | 3856 | * +20 = +0x14: byte: 0 |
3857 | * +21 = +0x15: dword: pointer to string |
||
6502 | pathoswith | 3858 | Case sensitivity depends on filesystem. |
6758 | pathoswith | 3859 | If a path not begins with '/', it is considered a relative. |
3860 | To get or set the current folder, use the function 30. |
||
3861 | '../' in the beginning means a lift by one folder relatively current folder. |
||
6502 | pathoswith | 3862 | To set the encoding, put at the start of the string a byte with next values: |
3863 | * 1 = cp866 |
||
3864 | * 2 = UTF-16LE |
||
3865 | * 3 = UTF-8 |
||
6758 | pathoswith | 3866 | otherwise will be used cp866. In an absolute path |
3867 | you may put this byte after the '/' or put an additional '/' before it. |
||
3868 | Format of an absolute path: |
||
6473 | pathoswith | 3869 | /base/number/dir1/dir2/.../dirn/file, |
3870 | where base/number identifies device, on which file is located: |
||
3871 | * RD/1 = ramdisk |
||
3872 | * FD/1 = first floppy drive, |
||
3873 | FD/2 = second floppy drive |
||
3874 | * HD0/x, HD1/x, HD2/x, HD3/x = hard drives accordingly on |
||
118 | diamond | 3875 | IDE0 (Primary Master), IDE1 (Primary Slave), |
114 | mikedld | 3876 | IDE2 (Secondary Master), IDE3 (Secondary Slave); |
6473 | pathoswith | 3877 | x - partition number on the selected hard drive, starts from 1 |
3878 | * CD0/1, CD1/1, CD2/1, CD3/1 = same for cd |
||
3879 | * SYS = system folder (encoding inaffected key), |
||
3880 | second key may be set by sysfunction 30.3. |
||
114 | mikedld | 3881 | Examples: |
6473 | pathoswith | 3882 | * '/sys/example.asm',0 |
3883 | * '/rd/1/example.asm',0 |
||
3884 | * '/HD0/1/folder/file.txt',0 |
||
3885 | * '/hd2/2/pics/tanzania.bmp',0 |
||
3886 | * 2,'/',0,'sys','/',0,'F',0,'I',0,'L',0,'E',0,0,0 |
||
1662 | Nasarus | 3887 | |
118 | diamond | 3888 | Available subfunctions: |
114 | mikedld | 3889 | * subfunction 0 - read file |
3890 | * subfunction 1 - read folder |
||
3891 | * subfunction 2 - create/rewrite file |
||
131 | diamond | 3892 | * subfunction 3 - write to existing file |
133 | diamond | 3893 | * subfunction 4 - set file size |
118 | diamond | 3894 | * subfunction 5 - get attributes of file/folder |
3895 | * subfunction 6 - set attributes of file/folder |
||
114 | mikedld | 3896 | * subfunction 7 - start application |
193 | diamond | 3897 | * subfunction 8 - delete file/folder |
321 | diamond | 3898 | * subfunction 9 - create folder |
118 | diamond | 3899 | For CD-drives due to hardware limitations only subfunctions |
3900 | 0,1,5 and 7 are available, other subfunctions return error |
||
3901 | with code 2. |
||
641 | diamond | 3902 | At the first call of subfunctions 0,1,5,7 to ATAPI devices |
3903 | (CD and DVD) the manual control of tray is locked due to caching |
||
3904 | drive data. Unlocking is made when subfunction 4 of function 24 |
||
3905 | is called for corresponding device. |
||
114 | mikedld | 3906 | |
6057 | IgorA | 3907 | ---------------------- Constants for registers: ---------------------- |
3908 | eax - SF_FILE (70) |
||
3909 | [ebx] - SSF_READ_FILE (0), SSF_READ_FOLDER (1), SSF_CREATE_FILE (2), |
||
3910 | SSF_WRITE_FILE (3), SSF_SET_END (4), SSF_GET_INFO (5), |
||
3911 | SSF_SET_INFO (6), SSF_START_APP (7), SSF_DELETE (8), |
||
3912 | SSF_CREATE_FOLDER (9) |
||
114 | mikedld | 3913 | ====================================================================== |
118 | diamond | 3914 | === Function 70, subfunction 0 - read file with long names support. == |
114 | mikedld | 3915 | ====================================================================== |
3916 | Parameters: |
||
118 | diamond | 3917 | * eax = 70 - function number |
3918 | * ebx = pointer to the information structure |
||
3919 | Format of the information structure: |
||
3920 | * +0: dword: 0 = subfunction number |
||
3921 | * +4: dword: file offset (in bytes) |
||
3922 | * +8: dword: 0 (reserved for high dword of offset) |
||
3923 | * +12 = +0xC: dword: number of bytes to read |
||
3924 | * +16 = +0x10: dword: pointer to buffer for data |
||
6473 | pathoswith | 3925 | * +20 = +0x14: path, general rules of names forming |
114 | mikedld | 3926 | Returned value: |
118 | diamond | 3927 | * eax = 0 - success, otherwise file system error code |
3928 | * ebx = number of read bytes or -1=0xffffffff if file was not found |
||
114 | mikedld | 3929 | Remarks: |
118 | diamond | 3930 | * If file was ended before last requested block was read, |
3931 | the function will read as many as it can, and after that return |
||
3932 | eax=6 (EOF). |
||
3933 | * The function does not allow to read folder (returns eax=10, |
||
3934 | access denied). |
||
114 | mikedld | 3935 | |
6057 | IgorA | 3936 | ---------------------- Constants for registers: ---------------------- |
3937 | eax - SF_FILE (70) |
||
3938 | [ebx] - SSF_READ_FILE (0) |
||
118 | diamond | 3939 | ====================================================================== |
3940 | == Function 70, subfunction 1 - read folder with long names support. = |
||
3941 | ====================================================================== |
||
114 | mikedld | 3942 | Parameters: |
118 | diamond | 3943 | * eax = 70 - function number |
3944 | * ebx = pointer to the information structure |
||
3945 | Format of the information structure: |
||
3946 | * +0: dword: 1 = subfunction number |
||
3947 | * +4: dword: index of starting block (beginning from 0) |
||
6473 | pathoswith | 3948 | * +8: dword: encoding: |
3949 | * 0 = cp866 -> byte per char |
||
3950 | * 1 = UTF-16LE -> word per char |
||
118 | diamond | 3951 | * +12 = +0xC: dword: number of blocks to read |
3952 | * +16 = +0x10: dword: pointer to buffer for data, buffer size |
||
6473 | pathoswith | 3953 | must be not less than 32+n(40+256*enc+8) bytes |
3954 | * +20 = +0x14: path, general rules of names forming |
||
114 | mikedld | 3955 | Returned value: |
118 | diamond | 3956 | * eax = 0 - success, otherwise file system error code |
3957 | * ebx = number of files, information on which was written to |
||
3958 | the buffer, or -1=0xffffffff, if folder was not found |
||
114 | mikedld | 3959 | Structure of the buffer: |
6473 | pathoswith | 3960 | * header (32 bytes) |
3961 | * block with information on file 1 |
||
3962 | * block with information on file 2 |
||
114 | mikedld | 3963 | * ... |
3964 | Structure of header: |
||
118 | diamond | 3965 | * +0: dword: version of structure (current is 1) |
3966 | * +4: dword: number of placed blocks; is not greater than requested |
||
3967 | in the field +12 of information structure; can be less, if |
||
3968 | there are no more files in folder (the same as in ebx) |
||
3969 | * +8: dword: total number of files in folder |
||
3970 | * +12 = +0xC: 20*byte: reserved (zeroed) |
||
3971 | Structure of block of data for folder entry (BDFE): |
||
3972 | * +0: dword: attributes of file: |
||
3973 | * bit 0 (mask 1): file is read-only |
||
3974 | * bit 1 (mask 2): file is hidden |
||
3975 | * bit 2 (mask 4): file is system |
||
3976 | * bit 3 (mask 8): this is not a file but volume label |
||
3977 | (for one partition meets no more than once and |
||
3978 | only in root folder) |
||
3979 | * bit 4 (mask 0x10): this is a folder |
||
3980 | * bit 5 (mask 0x20): file was not archived - many archivation |
||
3981 | programs have an option to archive only files with this bit set, |
||
3982 | and after archiving this bit is cleared - it can be useful |
||
3983 | for automatically creating of backup-archives as at writing |
||
3984 | this bit is usually set |
||
6473 | pathoswith | 3985 | * +4: dword: encoding: |
3986 | * 0 = cp866 -> byte per char |
||
3987 | * 1 = UTF-16LE -> word per char |
||
118 | diamond | 3988 | * +8: 4*byte: time of file creation |
3989 | * +12 = +0xC: 4*byte: date of file creation |
||
3990 | * +16 = +0x10: 4*byte: time of last access (read or write) |
||
114 | mikedld | 3991 | * +20 = +0x14: 4*byte: date of last access |
118 | diamond | 3992 | * +24 = +0x18: 4*byte: time of last modification |
3993 | * +28 = +0x1C: 4*byte: date of last modification |
||
3994 | * +32 = +0x20: qword: file size in bytes (up to 16777216 Tb) |
||
6473 | pathoswith | 3995 | * +40 = +0x28: (256*enc+8)*byte: name |
118 | diamond | 3996 | Time format: |
114 | mikedld | 3997 | * +0: byte: seconds |
3998 | * +1: byte: minutes |
||
3999 | * +2: byte: hours |
||
4000 | * +3: byte: reserved (0) |
||
118 | diamond | 4001 | * for example, 23.59.59 is written as (in hex) 3B 3B 17 00 |
4002 | Date format: |
||
4003 | * +0: byte: day |
||
4004 | * +1: byte: month |
||
4005 | * +2: word: year |
||
4006 | * for example, 25.11.1979 is written as (in hex) 19 0B BB 07 |
||
114 | mikedld | 4007 | Remarks: |
6473 | pathoswith | 4008 | * If BDFE contains cp866 name, the length of BDFE is 304 bytes, |
4009 | if UTF-16LE name - 560 bytes. Value of length is aligned |
||
4010 | on 16-byte bound to accelerate processing in CPU cache. |
||
4011 | * Name string is zero terminated, further data contain garbage. |
||
118 | diamond | 4012 | * If files in folder were ended before requested number was read, |
4013 | the function will read as many as it can, and after that return |
||
4014 | eax=6 (EOF). |
||
114 | mikedld | 4015 | * Any folder on the disk, except for root, contains two special |
118 | diamond | 4016 | entries "." and "..", identifying accordingly the folder itself |
4017 | and the parent folder. |
||
4018 | * The function allows also to read virtual folders "/", "/rd", |
||
4019 | "/fd", "/hd[n]", thus attributes of subfolders are set to 0x10, |
||
4020 | and times and dates are zeroed. An alternative way to get the |
||
4021 | equipment information - subfunction 11 of function 18. |
||
114 | mikedld | 4022 | |
6057 | IgorA | 4023 | ---------------------- Constants for registers: ---------------------- |
4024 | eax - SF_FILE (70) |
||
4025 | [ebx] - SSF_READ_FOLDER (1) |
||
114 | mikedld | 4026 | ====================================================================== |
118 | diamond | 4027 | ===================== Function 70, subfunction 2 ===================== |
4028 | ============ Create/rewrite file with long names support. ============ |
||
114 | mikedld | 4029 | ====================================================================== |
4030 | Parameters: |
||
118 | diamond | 4031 | * eax = 70 - function number |
4032 | * ebx = pointer to the information structure |
||
4033 | Format of the information structure: |
||
4034 | * +0: dword: 2 = subfunction number |
||
114 | mikedld | 4035 | * +4: dword: 0 (reserved) |
4036 | * +8: dword: 0 (reserved) |
||
4066 | shikhin | 4037 | * +12 = +0xC: dword: number of bytes to write |
118 | diamond | 4038 | * +16 = +0x10: dword: pointer to data |
6473 | pathoswith | 4039 | * +20 = +0x14: path, general rules of names forming |
114 | mikedld | 4040 | Returned value: |
118 | diamond | 4041 | * eax = 0 - success, otherwise file system error code |
4042 | * ebx = number of written bytes (possibly 0) |
||
114 | mikedld | 4043 | Remarks: |
118 | diamond | 4044 | * If a file with given name did not exist, it is created; |
4045 | if it existed, it is rewritten. |
||
4046 | * If there is not enough free space on disk, the function will |
||
4047 | write as many as can and then return error code 8. |
||
4048 | * The function is not supported for CD (returns error code 2). |
||
114 | mikedld | 4049 | |
6057 | IgorA | 4050 | ---------------------- Constants for registers: ---------------------- |
4051 | eax - SF_FILE (70) |
||
4052 | [ebx] - SSF_CREATE_FILE (2) |
||
114 | mikedld | 4053 | ====================================================================== |
131 | diamond | 4054 | ===================== Function 70, subfunction 3 ===================== |
4055 | =========== Write to existing file with long names support. ========== |
||
4056 | ====================================================================== |
||
4057 | Parameters: |
||
4058 | * eax = 70 - function number |
||
4059 | * ebx = pointer to the information structure |
||
4060 | Format of the information structure: |
||
4061 | * +0: dword: 3 = subfunction number |
||
4062 | * +4: dword: file offset (in bytes) |
||
4063 | * +8: dword: high dword of offset (must be 0 for FAT) |
||
4064 | * +12 = +0xC: dword: number of bytes to write |
||
4065 | * +16 = +0x10: dword: pointer to data |
||
6473 | pathoswith | 4066 | * +20 = +0x14: path, general rules of names forming |
131 | diamond | 4067 | Returned value: |
4068 | * eax = 0 - success, otherwise file system error code |
||
4069 | * ebx = number of written bytes (possibly 0) |
||
4070 | Remarks: |
||
4071 | * The file must already exist, otherwise function returns eax=5. |
||
4072 | * The only result of write 0 bytes is update in the file attributes |
||
4073 | date/time of modification and access to the current date/time. |
||
4074 | * If beginning and/or ending position is greater than file size |
||
4075 | (except for the previous case), the file is expanded to needed |
||
4076 | size with zero characters. |
||
133 | diamond | 4077 | * The function is not supported for CD (returns error code 2). |
131 | diamond | 4078 | |
6057 | IgorA | 4079 | ---------------------- Constants for registers: ---------------------- |
4080 | eax - SF_FILE (70) |
||
4081 | [ebx] - SSF_WRITE_FILE (3) |
||
131 | diamond | 4082 | ====================================================================== |
133 | diamond | 4083 | ============ Function 70, subfunction 4 - set end of file. =========== |
4084 | ====================================================================== |
||
4085 | Parameters: |
||
4086 | * eax = 70 - function number |
||
4087 | * ebx = pointer to the information structure |
||
4088 | Format of the information structure: |
||
4089 | * +0: dword: 4 = subfunction number |
||
4090 | * +4: dword: low dword of new file size |
||
4091 | * +8: dword: high dword of new file size (must be 0 for FAT) |
||
4092 | * +12 = +0xC: dword: 0 (reserved) |
||
4093 | * +16 = +0x10: dword: 0 (reserved) |
||
6473 | pathoswith | 4094 | * +20 = +0x14: path, general rules of names forming |
133 | diamond | 4095 | Returned value: |
4096 | * eax = 0 - success, otherwise file system error code |
||
4097 | * ebx destroyed |
||
4098 | Remarks: |
||
6758 | pathoswith | 4099 | * If new file size is less than old one, file will be truncated. |
4100 | If new size is greater than old one, file will be expanded, and if |
||
4101 | size difference is up to 16 MB, new space will be cleared with 0. |
||
133 | diamond | 4102 | * If there is not enough free space on disk for expansion, the |
4103 | function will expand to maximum possible size and then return |
||
4104 | error code 8. |
||
4105 | * The function is not supported for CD (returns error code 2). |
||
4106 | |||
6057 | IgorA | 4107 | ---------------------- Constants for registers: ---------------------- |
4108 | eax - SF_FILE (70) |
||
4109 | [ebx] - SSF_SET_END (4) |
||
133 | diamond | 4110 | ====================================================================== |
118 | diamond | 4111 | ==== Function 70, subfunction 5 - get information on file/folder. ==== |
114 | mikedld | 4112 | ====================================================================== |
4113 | Parameters: |
||
118 | diamond | 4114 | * eax = 70 - function number |
4115 | * ebx = pointer to the information structure |
||
4116 | Format of the information structure: |
||
4117 | * +0: dword: 5 = subfunction number |
||
114 | mikedld | 4118 | * +4: dword: 0 (reserved) |
6427 | pathoswith | 4119 | * +8: dword: 0 or flags (for the root folder) |
114 | mikedld | 4120 | * +12 = +0xC: dword: 0 (reserved) |
118 | diamond | 4121 | * +16 = +0x10: dword: pointer to buffer for data (40 bytes) |
6473 | pathoswith | 4122 | * +20 = +0x14: path, general rules of names forming |
114 | mikedld | 4123 | Returned value: |
118 | diamond | 4124 | * eax = 0 - success, otherwise file system error code |
4125 | * ebx destroyed |
||
4126 | Information on file is returned in the BDFE format (block of data |
||
6427 | pathoswith | 4127 | for folder entry), explained in the description of subfunction 1, |
4128 | but without filename, except the root folder. |
||
114 | mikedld | 4129 | Remarks: |
6427 | pathoswith | 4130 | * For the root folder returns size and name of partition. |
4131 | * The function does not support virtual folders such as / and /rd. |
||
114 | mikedld | 4132 | |
6057 | IgorA | 4133 | ---------------------- Constants for registers: ---------------------- |
4134 | eax - SF_FILE (70) |
||
4135 | [ebx] - SSF_GET_INFO (5) |
||
114 | mikedld | 4136 | ====================================================================== |
118 | diamond | 4137 | ===== Function 70, subfunction 6 - set attributes of file/folder. ==== |
114 | mikedld | 4138 | ====================================================================== |
4139 | Parameters: |
||
118 | diamond | 4140 | * eax = 70 - function number |
4141 | * ebx = pointer to the information structure |
||
4142 | Format of the information structure: |
||
4143 | * +0: dword: 6 = subfunction number |
||
114 | mikedld | 4144 | * +4: dword: 0 (reserved) |
4145 | * +8: dword: 0 (reserved) |
||
4146 | * +12 = +0xC: dword: 0 (reserved) |
||
118 | diamond | 4147 | * +16 = +0x10: dword: pointer to buffer with attributes (32 bytes) |
6473 | pathoswith | 4148 | * +20 = +0x14: path, general rules of names forming |
114 | mikedld | 4149 | Returned value: |
118 | diamond | 4150 | * eax = 0 - success, otherwise file system error code |
4151 | * ebx destroyed |
||
4152 | File attributes are first 32 bytes in BDFE (block of data |
||
4153 | for folder entry), explained in the description of subfunction 1 |
||
4154 | (that is, without name and size of file). Attribute |
||
4155 | file/folder/volume label (bits 3,4 in dword +0) is not changed. |
||
4156 | Byte +4 (name format) is ignored. |
||
114 | mikedld | 4157 | Remarks: |
118 | diamond | 4158 | * The function does not support virtual folders such as /, /rd and |
4159 | root folders like /rd/1. |
||
4160 | * The function is not supported for CD (returns error code 2). |
||
114 | mikedld | 4161 | |
6057 | IgorA | 4162 | ---------------------- Constants for registers: ---------------------- |
4163 | eax - SF_FILE (70) |
||
4164 | [ebx] - SSF_SET_INFO (6) |
||
114 | mikedld | 4165 | ====================================================================== |
118 | diamond | 4166 | =========== Function 70, subfunction 7 - start application. ========== |
114 | mikedld | 4167 | ====================================================================== |
4168 | Parameters: |
||
118 | diamond | 4169 | * eax = 70 - function number |
4170 | * ebx = pointer to the information structure |
||
4171 | Format of the information structure: |
||
4172 | * +0: dword: 7 = subfunction number |
||
4173 | * +4: dword: flags field: |
||
3539 | clevermous | 4174 | * bit 0: start process as debugged |
118 | diamond | 4175 | * other bits are reserved and must be set to 0 |
4176 | * +8: dword: 0 or pointer to ASCIIZ-string with parameters |
||
114 | mikedld | 4177 | * +12 = +0xC: dword: 0 (reserved) |
4178 | * +16 = +0x10: dword: 0 (reserved) |
||
6473 | pathoswith | 4179 | * +20 = +0x14: path, general rules of names forming |
114 | mikedld | 4180 | Returned value: |
4181 | * eax > 0 - program is loaded, eax contains PID |
||
118 | diamond | 4182 | * eax < 0 - an error has occured, -eax contains |
4183 | file system error code |
||
4184 | * ebx destroyed |
||
114 | mikedld | 4185 | Remarks: |
118 | diamond | 4186 | * Command line must be terminated by the character with the code 0 |
4187 | (ASCIIZ-string); function takes into account either all characters |
||
4188 | up to terminating zero inclusively or first 256 character |
||
4189 | regarding what is less. |
||
4190 | * If the process is started as debugged, it is created in |
||
4191 | the suspended state; to run use subfunction 5 of function 69. |
||
114 | mikedld | 4192 | |
6057 | IgorA | 4193 | ---------------------- Constants for registers: ---------------------- |
4194 | eax - SF_FILE (70) |
||
4195 | [ebx] - SSF_START_APP (7) |
||
114 | mikedld | 4196 | ====================================================================== |
193 | diamond | 4197 | ========== Function 70, subfunction 8 - delete file/folder. ========== |
4198 | ====================================================================== |
||
4199 | Parameters: |
||
4200 | * eax = 70 - function number |
||
4201 | * ebx = pointer to the information structure |
||
4202 | Format of the information structure: |
||
4203 | * +0: dword: 8 = subfunction number |
||
4204 | * +4: dword: 0 (reserved) |
||
4205 | * +8: dword: 0 (reserved) |
||
4206 | * +12 = +0xC: dword: 0 (reserved) |
||
4207 | * +16 = +0x10: dword: 0 (reserved) |
||
6473 | pathoswith | 4208 | * +20 = +0x14: path, general rules of names forming |
193 | diamond | 4209 | Returned value: |
4210 | * eax = 0 - success, otherwise file system error code |
||
4211 | * ebx destroyed |
||
4212 | Remarks: |
||
4213 | * The function is not supported for CD (returns error code 2). |
||
4214 | * The function can delete only empty folders (attempt to delete |
||
4215 | nonempty folder results in error with code 10, "access denied"). |
||
4216 | |||
6057 | IgorA | 4217 | ---------------------- Constants for registers: ---------------------- |
4218 | eax - SF_FILE (70) |
||
4219 | [ebx] - SSF_DELETE (8) |
||
193 | diamond | 4220 | ====================================================================== |
321 | diamond | 4221 | ============= Function 70, subfunction 9 - create folder. ============ |
4222 | ====================================================================== |
||
4223 | Parameters: |
||
4224 | * eax = 70 - function number |
||
4225 | * ebx = pointer to the information structure |
||
4226 | Format of the information structure: |
||
4227 | * +0: dword: 9 = subfunction number |
||
4228 | * +4: dword: 0 (reserved) |
||
4229 | * +8: dword: 0 (reserved) |
||
4230 | * +12 = +0xC: dword: 0 (reserved) |
||
4231 | * +16 = +0x10: dword: 0 (reserved) |
||
6473 | pathoswith | 4232 | * +20 = +0x14: path, general rules of names forming |
321 | diamond | 4233 | Returned value: |
4234 | * eax = 0 - success, otherwise file system error code |
||
4235 | * ebx destroyed |
||
4236 | Remarks: |
||
4237 | * The function is not supported for CD (returns error code 2). |
||
4238 | * The parent folder must already exist. |
||
4239 | * If target folder already exists, function returns success (eax=0). |
||
4240 | |||
6057 | IgorA | 4241 | ---------------------- Constants for registers: ---------------------- |
4242 | eax - SF_FILE (70) |
||
4243 | [ebx] - SSF_CREATE_FOLDER (9) |
||
321 | diamond | 4244 | ====================================================================== |
118 | diamond | 4245 | ========== Function 71, subfunction 1 - set window caption. ========== |
114 | mikedld | 4246 | ====================================================================== |
4247 | Parameters: |
||
4248 | * eax = 71 - function number |
||
4249 | * ebx = 1 - subfunction number |
||
5926 | pathoswith | 4250 | * ecx = pointer to zero terminated string |
114 | mikedld | 4251 | Returned value: |
118 | diamond | 4252 | * function does not return value |
114 | mikedld | 4253 | Remarks: |
5926 | pathoswith | 4254 | * You may set the caption string encoding by putting |
4255 | at the start of the string a byte with next values: |
||
4256 | 1 = cp866 |
||
4257 | 2 = UTF-16LE |
||
4258 | 3 = UTF-8 |
||
4259 | otherwise will be used cp866. |
||
118 | diamond | 4260 | * Pass NULL in ecx to remove caption. |
114 | mikedld | 4261 | |
6057 | IgorA | 4262 | ---------------------- Constants for registers: ---------------------- |
4263 | eax - SF_SET_CAPTION (71) |
||
114 | mikedld | 4264 | ====================================================================== |
665 | diamond | 4265 | =============== Function 72 - send message to a window. ============== |
4266 | ====================================================================== |
||
4267 | |||
4268 | - Subfunction 1 - send message with parameter to the active window. -- |
||
4269 | Parameters: |
||
4270 | * eax = 72 - function number |
||
4271 | * ebx = 1 - subfunction number |
||
4272 | * ecx = event code: 2 or 3 |
||
4273 | * edx = parameter: key code for ecx=2, button identifier for ecx=3 |
||
4274 | Returned value: |
||
4275 | * eax = 0 - success |
||
4276 | * eax = 1 - buffer is full |
||
4277 | |||
6057 | IgorA | 4278 | ---------------------- Constants for registers: ---------------------- |
4279 | eax - SF_SEND_MESSAGE (72) |
||
665 | diamond | 4280 | ====================================================================== |
3315 | mario79 | 4281 | ===================== Function 73 - blit bitmap ===================== |
4282 | ====================================================================== |
||
4283 | |||
4284 | Parameters: |
||
4285 | * eax = 73 - function number |
||
4286 | |||
4287 | * ebx = ROP and optional flags |
||
4288 | 31 6 5 4 3 0 |
||
4289 | [ reserved ][T][B][ROP] |
||
4290 | ROP - raster operation code |
||
4291 | 0: Copy |
||
4292 | 1-15: reserved |
||
4293 | B - blit into the background surface |
||
4294 | T - transparent blit |
||
4295 | |||
4296 | * ecx = pointer to the function parameters |
||
4297 | destination offset and clipping |
||
4298 | +0 signed dword: destination rectangle X offset from the window |
||
4299 | top-left corner |
||
4300 | +4 signed dword: destination rectangle Y offset from the window |
||
4301 | top-left corner |
||
4302 | +8 dword: destination rectangle width |
||
4303 | +12 dword: destination rectangle height |
||
4304 | |||
4305 | source offset and clipping |
||
4306 | +16 signed dword: source rectangle X offset from the bitmap |
||
4307 | top-left corner |
||
4308 | +20 signed dword: source rectangle Y offset from the bitmap |
||
4309 | top-left corner |
||
4310 | +24 dword: source rectangle width |
||
4311 | +28 dword: source rectangle height |
||
4312 | |||
3338 | mario79 | 4313 | +32: dword: bitmap data - must be 32bpp |
4314 | +36: dword: size of the bitmap row in bytes |
||
3315 | mario79 | 4315 | |
4316 | Returned value: |
||
4317 | * function does not return value |
||
4318 | |||
6057 | IgorA | 4319 | ---------------------- Constants for registers: ---------------------- |
4320 | eax - SF_BLITTER (73) |
||
3315 | mario79 | 4321 | ====================================================================== |
5871 | hidnplayr | 4322 | = Function 74, Subfunction 255, Get number of active network devices. = |
3571 | hidnplayr | 4323 | ====================================================================== |
4324 | Parameters: |
||
4325 | * eax = 74 - function number |
||
5871 | hidnplayr | 4326 | * bl = 255 - subfunction number |
3571 | hidnplayr | 4327 | Returned value: |
4328 | * eax = number of active network devices |
||
4329 | |||
6057 | IgorA | 4330 | ---------------------- Constants for registers: ---------------------- |
4331 | eax - SF_NETWORK_GET (74) |
||
4332 | bl - SSF_DEVICE_COUNT (255) |
||
3571 | hidnplayr | 4333 | ====================================================================== |
4334 | ======== Function 74, Subfunction 0, Get network device type. ======== |
||
4335 | ====================================================================== |
||
4336 | Parameters: |
||
4337 | * eax = 74 - function number |
||
4338 | * bl = 0 - subfunction number |
||
4339 | * bh = device number |
||
4340 | Returned value: |
||
5871 | hidnplayr | 4341 | * eax = device type number |
3571 | hidnplayr | 4342 | |
6057 | IgorA | 4343 | ---------------------- Constants for registers: ---------------------- |
4344 | eax - SF_NETWORK_GET (74) |
||
4345 | bl - SSF_DEVICE_TYPE (0) |
||
3571 | hidnplayr | 4346 | ====================================================================== |
4347 | ======== Function 74, Subfunction 1, Get network device name. ======== |
||
4348 | ====================================================================== |
||
4349 | Parameters: |
||
4350 | * eax = 74 - function number |
||
4351 | * bl = 1 - subfunction number |
||
4352 | * bh = device number |
||
4353 | * ecx = pointer to 64 byte buffer |
||
4354 | Returned value: |
||
4355 | * eax = -1 on error |
||
4356 | * The network device name is written into the buffer, on success |
||
4357 | |||
6057 | IgorA | 4358 | ---------------------- Constants for registers: ---------------------- |
4359 | eax - SF_NETWORK_GET (74) |
||
4360 | bl - SSF_DEVICE_NAME (1) |
||
3571 | hidnplayr | 4361 | ====================================================================== |
4362 | ========= Function 74, Subfunction 2, Reset network device. ========== |
||
4363 | ====================================================================== |
||
4364 | Parameters: |
||
4365 | * eax = 74 - function number |
||
4366 | * bl = 2 - subfunction number |
||
4367 | * bh = device number |
||
4368 | Returned value: |
||
4369 | * eax = -1 on error |
||
4370 | |||
6057 | IgorA | 4371 | ---------------------- Constants for registers: ---------------------- |
4372 | eax - SF_NETWORK_GET (74) |
||
4373 | bl - SSF_RESET_DEVICE (2) |
||
3571 | hidnplayr | 4374 | ====================================================================== |
4375 | ========== Function 74, Subfunction 3, Stop network device. ========== |
||
4376 | ====================================================================== |
||
4377 | Parameters: |
||
4378 | * eax = 74 - function number |
||
4379 | * bl = 3 - subfunction number |
||
4380 | * bh = device number |
||
4381 | Returned value: |
||
4382 | * eax = -1 on error |
||
5983 | pathoswith | 4383 | |
6057 | IgorA | 4384 | ---------------------- Constants for registers: ---------------------- |
4385 | eax - SF_NETWORK_GET (74) |
||
4386 | bl - SSF_STOP_DEVICE (3) |
||
5871 | hidnplayr | 4387 | ====================================================================== |
4388 | =========== Function 74, Subfunction 4, Get device pointer. ========== |
||
4389 | ====================================================================== |
||
4390 | Parameters: |
||
4391 | * eax = 74 - function number |
||
4392 | * bl = 4 - subfunction number |
||
4393 | * bh = device number |
||
4394 | Returned value: |
||
5983 | pathoswith | 4395 | * eax = device pointer, -1 on error |
4396 | |||
6057 | IgorA | 4397 | ---------------------- Constants for registers: ---------------------- |
4398 | eax - SF_NETWORK_GET (74) |
||
4399 | bl - SSF_DEVICE_POINER (4) |
||
5871 | hidnplayr | 4400 | ====================================================================== |
4401 | ========= Function 74, Subfunction 6, Get packet TX counter. ========= |
||
4402 | ====================================================================== |
||
4403 | Parameters: |
||
4404 | * eax = 74 - function number |
||
4405 | * bl = 6 - subfunction number |
||
4406 | * bh = device number |
||
4407 | Returned value: |
||
4408 | * eax = Number of packets sent since device start, -1 on error |
||
5983 | pathoswith | 4409 | |
6057 | IgorA | 4410 | ---------------------- Constants for registers: ---------------------- |
4411 | eax - SF_NETWORK_GET (74) |
||
4412 | bl - SSF_TX_PACKET_COUNT (6) |
||
5871 | hidnplayr | 4413 | ====================================================================== |
4414 | ========= Function 74, Subfunction 7, Get packet RX counter. ========= |
||
4415 | ====================================================================== |
||
4416 | Parameters: |
||
4417 | * eax = 74 - function number |
||
4418 | * bl = 7 - subfunction number |
||
4419 | * bh = device number |
||
4420 | Returned value: |
||
4421 | * eax = Number of packets received since device start, -1 on error |
||
5983 | pathoswith | 4422 | |
6057 | IgorA | 4423 | ---------------------- Constants for registers: ---------------------- |
4424 | eax - SF_NETWORK_GET (74) |
||
4425 | bl - SSF_RX_PACKET_COUNT (7) |
||
5871 | hidnplayr | 4426 | ====================================================================== |
4427 | ========== Function 74, Subfunction 8, Get TX byte counter. ========== |
||
4428 | ====================================================================== |
||
4429 | Parameters: |
||
4430 | * eax = 74 - function number |
||
4431 | * bl = 8 - subfunction number |
||
4432 | * bh = device number |
||
4433 | Returned value: |
||
4434 | * eax = Number of bytes sent since device start (lower dword) |
||
4435 | -1 on error |
||
4436 | * ebx = Number of bytes sent since device start (higher dword) |
||
3571 | hidnplayr | 4437 | |
6057 | IgorA | 4438 | ---------------------- Constants for registers: ---------------------- |
4439 | eax - SF_NETWORK_GET (74) |
||
4440 | bl - SSF_TX_BYTE_COUNT (8) |
||
3571 | hidnplayr | 4441 | ====================================================================== |
5871 | hidnplayr | 4442 | ========== Function 74, Subfunction 9, Get RX byte counter. ========== |
4443 | ====================================================================== |
||
4444 | Parameters: |
||
4445 | * eax = 74 - function number |
||
4446 | * bl = 9 - subfunction number |
||
4447 | * bh = device number |
||
4448 | Returned value: |
||
4449 | * eax = Number of bytes received since device start (lower dword) |
||
4450 | -1 on error |
||
4451 | * ebx = Number of bytes received since device start (higher dword) |
||
5983 | pathoswith | 4452 | |
6057 | IgorA | 4453 | ---------------------- Constants for registers: ---------------------- |
4454 | eax - SF_NETWORK_GET (74) |
||
4455 | bl - SSF_RX_BYTE_COUNT (9) |
||
5871 | hidnplayr | 4456 | ====================================================================== |
4457 | ========== Function 74, Subfunction 10, Get link status. ============= |
||
4458 | ====================================================================== |
||
4459 | Parameters: |
||
4460 | * eax = 74 - function number |
||
4461 | * bl = 10 - subfunction number |
||
4462 | * bh = device number |
||
4463 | Returned value: |
||
4464 | * eax = link status, -1 on error |
||
5983 | pathoswith | 4465 | |
5871 | hidnplayr | 4466 | Link status: |
4467 | ETH_LINK_DOWN = 0b ; Link is down |
||
4468 | ETH_LINK_UNKNOWN= 1b ; There could be an active link |
||
4469 | ETH_LINK_FD = 10b ; full duplex flag |
||
4470 | ETH_LINK_10M = 100b ; 10 mbit |
||
4471 | ETH_LINK_100M = 1000b ; 100 mbit |
||
5983 | pathoswith | 4472 | ETH_LINK_1G = 1100b ; gigabit |
4473 | |||
6057 | IgorA | 4474 | ---------------------- Constants for registers: ---------------------- |
4475 | eax - SF_NETWORK_GET (74) |
||
4476 | bl - SSF_LINK_STATUS (10) |
||
5871 | hidnplayr | 4477 | ====================================================================== |
3571 | hidnplayr | 4478 | ============== Function 75, Subfunction 0, Open socket. ============== |
4479 | ====================================================================== |
||
4480 | Parameters: |
||
4481 | * eax = 75 - function number |
||
4482 | * bl = 0 - subfunction number |
||
4483 | * ecx = domain |
||
4484 | * edx = type |
||
4485 | * esi = protocol |
||
4486 | Returned value: |
||
4487 | * eax = socket number, -1 on error |
||
3867 | hidnplayr | 4488 | * ebx = errorcode |
3571 | hidnplayr | 4489 | |
6057 | IgorA | 4490 | ---------------------- Constants for registers: ---------------------- |
4491 | eax - SF_NETWORK_SOCKET (75) |
||
4492 | bl - SSF_OPEN (0) |
||
3571 | hidnplayr | 4493 | ====================================================================== |
4494 | ============= Function 75, Subfunction 1, Close socket. ============== |
||
4495 | ====================================================================== |
||
4496 | Parameters: |
||
4497 | * eax = 75 - function number |
||
4498 | * bl = 1 - subfunction number |
||
4499 | * ecx = socket number |
||
4500 | Returned value: |
||
4501 | * eax = -1 on error |
||
3867 | hidnplayr | 4502 | * ebx = errorcode |
3571 | hidnplayr | 4503 | |
6057 | IgorA | 4504 | ---------------------- Constants for registers: ---------------------- |
4505 | eax - SF_NETWORK_SOCKET (75) |
||
4506 | bl - SSF_CLOSE (1) |
||
3571 | hidnplayr | 4507 | ====================================================================== |
4508 | ================== Function 75, Subfunction 2, Bind. ================= |
||
4509 | ====================================================================== |
||
4510 | Parameters: |
||
4511 | * eax = 75 - function number |
||
4512 | * bl = 2 - subfunction number |
||
4513 | * ecx = socket number |
||
4514 | * edx = pointer to sockaddr structure |
||
4515 | * esi = length of sockaddr structure |
||
6712 | 0CodErr | 4516 | Format of SockAddr structure: |
4517 | * +0: Word: Family |
||
4518 | * +2: 14*Byte: Data |
||
3571 | hidnplayr | 4519 | Returned value: |
4520 | * eax = -1 on error |
||
3867 | hidnplayr | 4521 | * ebx = errorcode |
3571 | hidnplayr | 4522 | |
6057 | IgorA | 4523 | ---------------------- Constants for registers: ---------------------- |
4524 | eax - SF_NETWORK_SOCKET (75) |
||
4525 | bl - SSF_BIND (2) |
||
3571 | hidnplayr | 4526 | ====================================================================== |
4527 | ================= Function 75, Subfunction 3, Listen. ================ |
||
4528 | ====================================================================== |
||
4529 | Parameters: |
||
4530 | * eax = 75 - function number |
||
4531 | * bl = 3 - subfunction number |
||
4532 | * ecx = socket number |
||
4533 | * edx = backlog |
||
4534 | Returned value: |
||
4535 | * eax = -1 on error |
||
3867 | hidnplayr | 4536 | * ebx = errorcode |
3571 | hidnplayr | 4537 | |
6057 | IgorA | 4538 | ---------------------- Constants for registers: ---------------------- |
4539 | eax - SF_NETWORK_SOCKET (75) |
||
4540 | bl - SSF_LISTEN (3) |
||
3571 | hidnplayr | 4541 | ====================================================================== |
4542 | ================ Function 75, Subfunction 4, Connect. ================ |
||
4543 | ====================================================================== |
||
4544 | Parameters: |
||
4545 | * eax = 75 - function number |
||
4546 | * bl = 4 - subfunction number |
||
4547 | * ecx = socket number |
||
4548 | * edx = pointer to sockaddr structure |
||
4549 | * esi = length of sockaddr structure |
||
6712 | 0CodErr | 4550 | Format of SockAddr structure: |
4551 | * +0: Word: Family |
||
6758 | pathoswith | 4552 | * +2: 14*Byte: Data |
3571 | hidnplayr | 4553 | Returned value: |
4554 | * eax = -1 on error |
||
3867 | hidnplayr | 4555 | * ebx = errorcode |
3571 | hidnplayr | 4556 | |
6057 | IgorA | 4557 | ---------------------- Constants for registers: ---------------------- |
4558 | eax - SF_NETWORK_SOCKET (75) |
||
4559 | bl - SSF_CONNECT (4) |
||
3571 | hidnplayr | 4560 | ====================================================================== |
4561 | ================= Function 75, Subfunction 5, Accept. ================ |
||
4562 | ====================================================================== |
||
4563 | Parameters: |
||
4564 | * eax = 75 - function number |
||
4565 | * bl = 5 - subfunction number |
||
4566 | * ecx = socket number |
||
4567 | * edx = pointer to sockaddr structure |
||
4568 | * esi = length of sockaddr structure |
||
6712 | 0CodErr | 4569 | Format of SockAddr structure: |
4570 | * +0: Word: Family |
||
6758 | pathoswith | 4571 | * +2: 14*Byte: Data |
3571 | hidnplayr | 4572 | Returned value: |
3867 | hidnplayr | 4573 | * eax = socket number of accepted socket, -1 on error |
4574 | * ebx = errorcode |
||
3571 | hidnplayr | 4575 | |
6057 | IgorA | 4576 | ---------------------- Constants for registers: ---------------------- |
4577 | eax - SF_NETWORK_SOCKET (75) |
||
4578 | bl - SSF_ACCEPT (5) |
||
3571 | hidnplayr | 4579 | ====================================================================== |
4580 | ================== Function 75, Subfunction 6, Send. ================= |
||
4581 | ====================================================================== |
||
4582 | Parameters: |
||
4583 | * eax = 75 - function number |
||
4584 | * bl = 6 - subfunction number |
||
4585 | * ecx = socket number |
||
4586 | * edx = pointer to buffer |
||
4587 | * esi = length of buffer |
||
3867 | hidnplayr | 4588 | * edi = flags |
3571 | hidnplayr | 4589 | Returned value: |
4590 | * eax = number of bytes copied, -1 on error |
||
3867 | hidnplayr | 4591 | * ebx = errorcode |
3571 | hidnplayr | 4592 | |
6057 | IgorA | 4593 | ---------------------- Constants for registers: ---------------------- |
4594 | eax - SF_NETWORK_SOCKET (75) |
||
4595 | bl - SSF_SEND (6) |
||
3571 | hidnplayr | 4596 | ====================================================================== |
4597 | ================ Function 75, Subfunction 7, Receive. ================ |
||
4598 | ====================================================================== |
||
4599 | Parameters: |
||
4600 | * eax = 75 - function number |
||
4601 | * bl = 7 - subfunction number |
||
4602 | * ecx = socket number |
||
4603 | * edx = pointer to buffer |
||
4604 | * esi = length of buffer |
||
4605 | * edi = flags |
||
4606 | Returned value: |
||
4607 | * eax = number of bytes copied, -1 on error |
||
3867 | hidnplayr | 4608 | * ebx = errorcode |
3571 | hidnplayr | 4609 | |
6057 | IgorA | 4610 | ---------------------- Constants for registers: ---------------------- |
4611 | eax - SF_NETWORK_SOCKET (75) |
||
4612 | bl - SSF_RECEIVE (7) |
||
3571 | hidnplayr | 4613 | ====================================================================== |
4614 | =========== Function 75, Subfunction 8, Set socket options. ========== |
||
4615 | ====================================================================== |
||
4616 | Parameters: |
||
4617 | * eax = 75 - function number |
||
4618 | * bl = 8 - subfunction number |
||
4619 | * ecx = socket number |
||
4620 | * edx = pointer to optstruct |
||
4621 | Returned value: |
||
4622 | * eax = -1 on error |
||
3867 | hidnplayr | 4623 | * ebx = errorcode |
3571 | hidnplayr | 4624 | Remarks: |
4625 | |||
6079 | serge | 4626 | Optstruct: |
5871 | hidnplayr | 4627 | dd level |
4628 | dd optionname |
||
4629 | dd optlength |
||
4630 | db options... |
||
3571 | hidnplayr | 4631 | |
6057 | IgorA | 4632 | ---------------------- Constants for registers: ---------------------- |
4633 | eax - SF_NETWORK_SOCKET (75) |
||
4634 | bl - SSF_SET_OPTIONS (8) |
||
3571 | hidnplayr | 4635 | ====================================================================== |
4636 | =========== Function 75, Subfunction 9, Get socket options. ========== |
||
4637 | ====================================================================== |
||
4638 | Parameters: |
||
4639 | * eax = 75 - function number |
||
4640 | * bl = 9 - subfunction number |
||
4641 | * ecx = socket number |
||
4642 | * edx = pointer to optstruct |
||
4643 | Returned value: |
||
4644 | * eax = -1 on error |
||
3867 | hidnplayr | 4645 | * ebx = errorcode |
3571 | hidnplayr | 4646 | Remarks: |
4647 | |||
6079 | serge | 4648 | Optstruct: |
5871 | hidnplayr | 4649 | dd level |
4650 | dd optionname |
||
4651 | dd optlength |
||
4652 | db options... |
||
3571 | hidnplayr | 4653 | |
6057 | IgorA | 4654 | ---------------------- Constants for registers: ---------------------- |
4655 | eax - SF_NETWORK_SOCKET (75) |
||
4656 | bl - SSF_GET_OPTIONS (9) |
||
3571 | hidnplayr | 4657 | ====================================================================== |
6235 | pathoswith | 4658 | ============ Function 75, Subfunction 10, Get socketpair. ============ |
3571 | hidnplayr | 4659 | ====================================================================== |
4660 | Parameters: |
||
4661 | * eax = 75 - function number |
||
4662 | * bl = 10 - subfunction number |
||
4663 | Returned value: |
||
4664 | * eax = socketnum1, -1 on error |
||
3867 | hidnplayr | 4665 | * ebx = socketnum2, errorcode on error |
6057 | IgorA | 4666 | |
4667 | ---------------------- Constants for registers: ---------------------- |
||
4668 | eax - SF_NETWORK_SOCKET (75) |
||
4669 | bl - SSF_GET_PAIR (10) |
||
5871 | hidnplayr | 4670 | ====================================================================== |
4671 | ============ Function 76, Network options and statistics. ============ |
||
4672 | ====================================================================== |
||
4673 | Parameters: |
||
4674 | * eax = 76 - function number |
||
4675 | * high half of ebx = protocol number |
||
4676 | * bh = device number |
||
4677 | * bl = subfunction number |
||
3571 | hidnplayr | 4678 | |
6634 | hidnplayr | 4679 | ====================================================================== |
4680 | ==== Function 76, Protocol 0 - Ethernet, Subfunction 0, Read MAC. ==== |
||
4681 | ====================================================================== |
||
4682 | Parameters: |
||
4683 | * eax = 76 - function number |
||
4684 | * high half of ebx = 0 (Ethernet) |
||
4685 | * bh = device number |
||
4686 | * bl = 0 (Read MAC) |
||
4687 | Returned value: |
||
4688 | * eax = -1 on error, otherwise lower bits of MAC |
||
4689 | * bx = upper bits of MAC |
||
6758 | pathoswith | 4690 | |
6634 | hidnplayr | 4691 | ====================================================================== |
4692 | = Function 76, Protocol 1 - IPv4, Subfunction 0, Read # Packets sent = |
||
4693 | ====================================================================== |
||
4694 | Parameters: |
||
4695 | * eax = 76 - function number |
||
4696 | * high half of ebx = 1 (IPv4) |
||
4697 | * bh = device number |
||
4698 | * bl = 0 (Read # packets sent) |
||
4699 | Returned value: |
||
4700 | * eax = number of packets sent (-1 on error) |
||
6758 | pathoswith | 4701 | |
6634 | hidnplayr | 4702 | ====================================================================== |
4703 | = Function 76, Protocol 1 - IPv4, Subfunction 1, Read # Packets rcvd = |
||
4704 | ====================================================================== |
||
4705 | Parameters: |
||
4706 | * eax = 76 - function number |
||
4707 | * high half of ebx = 1 (IPv4) |
||
4708 | * bh = device number |
||
4709 | * bl = 1 (Read # packets received) |
||
4710 | Returned value: |
||
4711 | * eax = number of packets received (-1 on error) |
||
6758 | pathoswith | 4712 | |
6634 | hidnplayr | 4713 | ====================================================================== |
4714 | === Function 76, Protocol 1 - IPv4, Subfunction 2, Read IP address === |
||
4715 | ====================================================================== |
||
4716 | Parameters: |
||
4717 | * eax = 76 - function number |
||
4718 | * high half of ebx = 1 (IPv4) |
||
4719 | * bh = device number |
||
4720 | * bl = 2 (Read IP address) |
||
4721 | Returned value: |
||
4722 | * eax = IP address (-1 on error) |
||
6758 | pathoswith | 4723 | |
6634 | hidnplayr | 4724 | ====================================================================== |
4725 | === Function 76, Protocol 1 - IPv4, Subfunction 3, Set IP address ==== |
||
4726 | ====================================================================== |
||
4727 | Parameters: |
||
4728 | * eax = 76 - function number |
||
4729 | * high half of ebx = 1 (IPv4) |
||
4730 | * bh = device number |
||
4731 | * bl = 3 (Set IP address) |
||
4732 | * ecx = IP address |
||
4733 | Returned value: |
||
4734 | * eax = -1 on error |
||
6235 | pathoswith | 4735 | |
6634 | hidnplayr | 4736 | ====================================================================== |
4737 | == Function 76, Protocol 1 - IPv4, Subfunction 4, Read DNS address === |
||
4738 | ====================================================================== |
||
4739 | Parameters: |
||
4740 | * eax = 76 - function number |
||
4741 | * high half of ebx = 1 (IPv4) |
||
4742 | * bh = device number |
||
4743 | * bl = 4 (Read DNS server IP address) |
||
4744 | Returned value: |
||
4745 | * eax = DNS server IP address (-1 on error) |
||
6758 | pathoswith | 4746 | |
6634 | hidnplayr | 4747 | ====================================================================== |
4748 | === Function 76, Protocol 1 - IPv4, Subfunction 5, Set DNS address === |
||
4749 | ====================================================================== |
||
4750 | Parameters: |
||
4751 | * eax = 76 - function number |
||
4752 | * high half of ebx = 1 (IPv4) |
||
4753 | * bh = device number |
||
4754 | * bl = 5 (Set DNS address) |
||
4755 | * ecx = DNS server IP address |
||
4756 | Returned value: |
||
4757 | * eax = -1 on error |
||
6079 | serge | 4758 | |
6634 | hidnplayr | 4759 | ====================================================================== |
4760 | == Function 76, Protocol 1 - IPv4, Subfunction 6, Read subnet mask === |
||
4761 | ====================================================================== |
||
4762 | Parameters: |
||
4763 | * eax = 76 - function number |
||
4764 | * high half of ebx = 1 (IPv4) |
||
4765 | * bh = device number |
||
4766 | * bl = 6 (Read subnet mask) |
||
4767 | Returned value: |
||
4768 | * eax = subnet mask (-1 on error) |
||
6758 | pathoswith | 4769 | |
6634 | hidnplayr | 4770 | ====================================================================== |
4771 | === Function 76, Protocol 1 - IPv4, Subfunction 7, Set subnet mask === |
||
4772 | ====================================================================== |
||
4773 | Parameters: |
||
4774 | * eax = 76 - function number |
||
4775 | * high half of ebx = 1 (IPv4) |
||
4776 | * bh = device number |
||
4777 | * bl = 7 (Set DNS address) |
||
4778 | * ecx = subnet mask |
||
4779 | Returned value: |
||
4780 | * eax = -1 on error |
||
6758 | pathoswith | 4781 | |
6634 | hidnplayr | 4782 | ====================================================================== |
4783 | ===== Function 76, Protocol 1 - IPv4, Subfunction 8, Read gateway ==== |
||
4784 | ====================================================================== |
||
4785 | Parameters: |
||
4786 | * eax = 76 - function number |
||
4787 | * high half of ebx = 1 (IPv4) |
||
4788 | * bh = device number |
||
4789 | * bl = 8 (Read gateway IP address) |
||
4790 | Returned value: |
||
4791 | * eax = gateway IP address (-1 on error) |
||
6758 | pathoswith | 4792 | |
6634 | hidnplayr | 4793 | ====================================================================== |
4794 | ===== Function 76, Protocol 1 - IPv4, Subfunction 9, Set gateway ===== |
||
4795 | ====================================================================== |
||
4796 | Parameters: |
||
4797 | * eax = 76 - function number |
||
4798 | * high half of ebx = 1 (IPv4) |
||
4799 | * bh = device number |
||
4800 | * bl = 9 (Set getway address) |
||
4801 | * ecx = gateway IP address |
||
4802 | Returned value: |
||
4803 | * eax = -1 on error |
||
6758 | pathoswith | 4804 | |
6634 | hidnplayr | 4805 | ====================================================================== |
4806 | = Function 76, Protocol 2 - ICMP, Subfunction 0, Read # Packets sent = |
||
4807 | ====================================================================== |
||
4808 | Parameters: |
||
4809 | * eax = 76 - function number |
||
4810 | * high half of ebx = 2 (ICMP) |
||
4811 | * bh = device number |
||
4812 | * bl = 0 (Read # packets sent) |
||
4813 | Returned value: |
||
4814 | * eax = number of packets sent (-1 on error) |
||
6758 | pathoswith | 4815 | |
6634 | hidnplayr | 4816 | ====================================================================== |
4817 | = Function 76, Protocol 2 - ICMP, Subfunction 1, Read # Packets rcvd = |
||
4818 | ====================================================================== |
||
4819 | Parameters: |
||
4820 | * eax = 76 - function number |
||
4821 | * high half of ebx = 2 (ICMP) |
||
4822 | * bh = device number |
||
4823 | * bl = 1 (Read # packets received) |
||
4824 | Returned value: |
||
4825 | * eax = number of packets received (-1 on error) |
||
6758 | pathoswith | 4826 | |
6634 | hidnplayr | 4827 | ====================================================================== |
4828 | = Function 76, Protocol 3 - UDP, Subfunction 0, Read # Packets sent == |
||
4829 | ====================================================================== |
||
4830 | Parameters: |
||
4831 | * eax = 76 - function number |
||
4832 | * high half of ebx = 3 (UDP) |
||
4833 | * bh = device number |
||
4834 | * bl = 0 (Read # packets sent) |
||
4835 | Returned value: |
||
4836 | * eax = number of packets sent (-1 on error) |
||
6758 | pathoswith | 4837 | |
6634 | hidnplayr | 4838 | ====================================================================== |
4839 | = Function 76, Protocol 3 - UDP, Subfunction 1, Read # Packets rcvd == |
||
4840 | ====================================================================== |
||
4841 | Parameters: |
||
4842 | * eax = 76 - function number |
||
4843 | * high half of ebx = 3 (UDP) |
||
4844 | * bh = device number |
||
4845 | * bl = 1 (Read # packets received) |
||
4846 | Returned value: |
||
4847 | * eax = number of packets received (-1 on error) |
||
6758 | pathoswith | 4848 | |
6634 | hidnplayr | 4849 | ====================================================================== |
4850 | = Function 76, Protocol 4 - TCP, Subfunction 0, Read # Packets sent == |
||
4851 | ====================================================================== |
||
4852 | Parameters: |
||
4853 | * eax = 76 - function number |
||
4854 | * high half of ebx = 4 (TCP) |
||
4855 | * bh = device number |
||
4856 | * bl = 0 (Read # packets sent) |
||
4857 | Returned value: |
||
4858 | * eax = number of packets sent (-1 on error) |
||
6758 | pathoswith | 4859 | |
6634 | hidnplayr | 4860 | ====================================================================== |
4861 | = Function 76, Protocol 4 - TCP, Subfunction 1, Read # Packets rcvd == |
||
4862 | ====================================================================== |
||
4863 | Parameters: |
||
4864 | * eax = 76 - function number |
||
4865 | * high half of ebx = 4 (TCP) |
||
4866 | * bh = device number |
||
4867 | * bl = 1 (Read # packets received) |
||
4868 | Returned value: |
||
4869 | * eax = number of packets received (-1 on error) |
||
6758 | pathoswith | 4870 | |
6634 | hidnplayr | 4871 | ====================================================================== |
4872 | = Function 76, Protocol 5 - ARP, Subfunction 0, Read # Packets sent == |
||
4873 | ====================================================================== |
||
4874 | Parameters: |
||
4875 | * eax = 76 - function number |
||
4876 | * high half of ebx = 5 (ARP) |
||
4877 | * bh = device number |
||
4878 | * bl = 0 (Read # packets sent) |
||
4879 | Returned value: |
||
4880 | * eax = number of packets sent (-1 on error) |
||
6758 | pathoswith | 4881 | |
6634 | hidnplayr | 4882 | ====================================================================== |
4883 | = Function 76, Protocol 5 - ARP, Subfunction 1, Read # Packets rcvd == |
||
4884 | ====================================================================== |
||
4885 | Parameters: |
||
4886 | * eax = 76 - function number |
||
4887 | * high half of ebx = 5 (ARP) |
||
4888 | * bh = device number |
||
4889 | * bl = 1 (Read # packets received) |
||
4890 | Returned value: |
||
4891 | * eax = number of packets received (-1 on error) |
||
6758 | pathoswith | 4892 | |
6634 | hidnplayr | 4893 | ====================================================================== |
4894 | == Function 76, Protocol 5 - ARP, Subfunction 2, Read # ARP entries == |
||
4895 | ====================================================================== |
||
4896 | Parameters: |
||
4897 | * eax = 76 - function number |
||
4898 | * high half of ebx = 5 (ARP) |
||
4899 | * bh = device number |
||
4900 | * bl = 2 (Read # current entries in the ARP table) |
||
4901 | Returned value: |
||
4902 | * eax = number of entries (-1 on error) |
||
6079 | serge | 4903 | |
6634 | hidnplayr | 4904 | ====================================================================== |
4905 | ==== Function 76, Protocol 5 - ARP, Subfunction 3, Read ARP entry ==== |
||
4906 | ====================================================================== |
||
4907 | Parameters: |
||
4908 | * eax = 76 - function number |
||
4909 | * high half of ebx = 5 (ARP) |
||
4910 | * bh = device number |
||
4911 | * bl = 3 (Read ARP entry) |
||
4912 | * ecx = ARP entry number (0 based) |
||
4913 | * edi = ptr to buffer where ARP entry will be written |
||
4914 | Returned value: |
||
4915 | * eax = -1 on error |
||
6758 | pathoswith | 4916 | Remarks: |
6634 | hidnplayr | 4917 | ARP_entry struct is defined in ARP.inc in kernel and currently looks like this: |
4918 | struct ARP_entry |
||
4919 | IP dd ? |
||
4920 | MAC dp ? |
||
4921 | Status dw ? |
||
4922 | TTL dw ? |
||
6758 | pathoswith | 4923 | ends |
5871 | hidnplayr | 4924 | |
6634 | hidnplayr | 4925 | ====================================================================== |
4926 | ==== Function 76, Protocol 5 - ARP, Subfunction 4, Add ARP entry ==== |
||
4927 | ====================================================================== |
||
4928 | Parameters: |
||
4929 | * eax = 76 - function number |
||
4930 | * high half of ebx = 5 (ARP) |
||
4931 | * bh = device number |
||
4932 | * bl = 4 (Add ARP entry) |
||
4933 | * esi = ptr to buffer holding ARP entry |
||
4934 | Returned value: |
||
4935 | * eax = -1 on error |
||
6758 | pathoswith | 4936 | Remarks: |
6634 | hidnplayr | 4937 | See previous function for details on ARP entry. |
6758 | pathoswith | 4938 | |
6634 | hidnplayr | 4939 | ====================================================================== |
4940 | === Function 76, Protocol 5 - ARP, Subfunction 5, Remove ARP entry ==== |
||
4941 | ====================================================================== |
||
4942 | Parameters: |
||
4943 | * eax = 76 - function number |
||
4944 | * high half of ebx = 5 (ARP) |
||
4945 | * bh = device number |
||
4946 | * bl = 3 (Read ARP entry) |
||
4947 | * ecx = ARP entry number (0 based), use -1 to clear whole ARP table. |
||
4948 | Returned value: |
||
4949 | * eax = -1 on error |
||
4950 | |||
4951 | ====================================================================== |
||
4952 | === Function 76, Protocol 5 - ARP, Subfunction 6, Send ARP announce == |
||
4953 | ====================================================================== |
||
4954 | Parameters: |
||
4955 | * eax = 76 - function number |
||
4956 | * high half of ebx = 5 (ARP) |
||
4957 | * bh = device number |
||
4958 | * bl = 6 (Send ARP announce) |
||
4959 | Returned value: |
||
4960 | * eax = -1 on error |
||
6758 | pathoswith | 4961 | |
6634 | hidnplayr | 4962 | ====================================================================== |
4963 | === Function 76, Protocol 5 - ARP, Subfunction 7, Read # conflicts === |
||
4964 | ====================================================================== |
||
4965 | Parameters: |
||
4966 | * eax = 76 - function number |
||
4967 | * high half of ebx = 5 (ARP) |
||
4968 | * bh = device number |
||
4969 | * bl = 7 (Read # IP address conflicts that have occured) |
||
4970 | Returned value: |
||
4971 | * eax = # IP address conflicts (-1 on error) |
||
5871 | hidnplayr | 4972 | |
6057 | IgorA | 4973 | ---------------------- Constants for registers: ---------------------- |
4974 | eax - SF_NETWORK_PROTOCOL (76) |
||
3571 | hidnplayr | 4975 | ====================================================================== |
6079 | serge | 4976 | ========== Function 77, Subfunction 0, Create futex object =========== |
4977 | ====================================================================== |
||
4978 | Parameters: |
||
4979 | * eax = 77 - function number |
||
4980 | * ebx = 0 - subfunction number |
||
4981 | * ecx = pointer to futex dword |
||
4982 | Returned value: |
||
4983 | * eax = futex handle, 0 on error |
||
4984 | Remarks: |
||
4985 | * Use subfunction 1 to destroy the futex. |
||
4986 | The kernel destroys the futexes automatically when the process |
||
4987 | terminates. |
||
6235 | pathoswith | 4988 | |
4989 | ---------------------- Constants for registers: ---------------------- |
||
4990 | eax - SF_FUTEX (77) |
||
4991 | ebx - SSF_CREATE (0) |
||
6079 | serge | 4992 | ====================================================================== |
4993 | ========= Function 77, Subfunction 1, Destroy futex object =========== |
||
4994 | ====================================================================== |
||
4995 | Parameters: |
||
4996 | * eax = 77 - function number |
||
4997 | * ebx = 1 - subfunction number |
||
4998 | * ecx = futex handle |
||
4999 | Returned value: |
||
5000 | * eax = 0 - successfull, -1 on error |
||
5001 | Remarks: |
||
5002 | * The futex handle must have been created by subfunction 0 |
||
5003 | |||
6235 | pathoswith | 5004 | ---------------------- Constants for registers: ---------------------- |
5005 | eax - SF_FUTEX (77) |
||
5006 | ebx - SSF_DESTROY (1) |
||
6079 | serge | 5007 | ====================================================================== |
5008 | =============== Function 77, Subfunction 2, Futex wait =============== |
||
5009 | ====================================================================== |
||
5010 | Parameters: |
||
5011 | * eax = 77 - function number |
||
5012 | * ebx = 2 - subfunction number |
||
5013 | * ecx = futex handle |
||
5014 | * edx = control value |
||
5015 | * esi = timeout in system ticks or 0 for infinity |
||
5016 | Returned value: |
||
6089 | serge | 5017 | * eax = 0 - successfull |
5018 | -1 - timeout |
||
5019 | -2 - futex dword does not have the same value as edx |
||
6079 | serge | 5020 | Remarks: |
5021 | * This functionn tests that the value at the futex dword still |
||
5022 | contains the expected control value, and if so, then sleeps |
||
5023 | waiting for a wake operation on the futex. |
||
5024 | * The futex handle must have been created by subfunction 0 |
||
5025 | |||
6235 | pathoswith | 5026 | ---------------------- Constants for registers: ---------------------- |
5027 | eax - SF_FUTEX (77) |
||
5028 | ebx - SSF_WAIT (2) |
||
6079 | serge | 5029 | ====================================================================== |
5030 | =============== Function 77, Subfunction 3, Futex wake =============== |
||
5031 | ====================================================================== |
||
5032 | Parameters: |
||
5033 | * eax = 77 - function number |
||
5034 | * ebx = 3 - subfunction number |
||
5035 | * ecx = futex handle |
||
5036 | * edx = number of waiters to wake |
||
5037 | Returned value: |
||
5038 | * eax = number of waiters that were woken up |
||
5039 | |||
5040 | Remarks: |
||
5041 | * This function wakes at most edx of the waiters that are |
||
5042 | waiting (e.g., inside futex wait) on the futex dword |
||
5043 | * The futex handle must have been created by subfunction 0 |
||
5044 | |||
6235 | pathoswith | 5045 | ---------------------- Constants for registers: ---------------------- |
5046 | eax - SF_FUTEX (77) |
||
5047 | ebx - SSF_WAKE (3) |
||
6079 | serge | 5048 | ====================================================================== |
118 | diamond | 5049 | =============== Function -1 - terminate thread/process =============== |
114 | mikedld | 5050 | ====================================================================== |
5051 | Parameters: |
||
118 | diamond | 5052 | * eax = -1 - function number |
114 | mikedld | 5053 | Returned value: |
118 | diamond | 5054 | * function does not return neither value nor control |
114 | mikedld | 5055 | Remarks: |
118 | diamond | 5056 | * If the process did not create threads obviously, it has only |
5057 | one thread, which termination results in process termination. |
||
5058 | * If the current thread is last in the process, its termination |
||
5059 | also results in process terminates. |
||
5060 | * This function terminates the current thread. Other thread can be |
||
5061 | killed by call to subfunction 2 of function 18. |
||
114 | mikedld | 5062 | |
6235 | pathoswith | 5063 | ---------------------- Constants for registers: ---------------------- |
5064 | eax - SF_TERMINATE_PROCESS (-1) |
||
114 | mikedld | 5065 | ====================================================================== |
5066 | =========================== List of events =========================== |
||
5067 | ====================================================================== |
||
118 | diamond | 5068 | Next event can be retrieved by the call of one from functions 10 |
5069 | (to wait for event), 11 (to check without waiting), 23 |
||
5070 | (to wait during the given time). |
||
5071 | These functions return only those events, which enter into a mask set |
||
5072 | by function 40. By default it is first three, |
||
5073 | there is enough for most applications. |
||
114 | mikedld | 5074 | Codes of events: |
118 | diamond | 5075 | * 1 = redraw event (is reset by call to function 0) |
5076 | * 2 = key on keyboard is pressed (acts, only when the window is |
||
5077 | active) or hotkey is pressed; is reset, when all keys from |
||
5078 | the buffer are read out by function 2 |
||
5079 | * 3 = button is pressed, defined earlier by function 8 |
||
5080 | (or close button, created implicitly by function 0; |
||
5081 | minimize button is handled by the system and sends no message; |
||
5082 | acts, only when the window is active; |
||
5083 | is reset when all buttons from the buffer |
||
5084 | are read out by function 17) |
||
5085 | * 4 = reserved (in current implementation never comes even after |
||
5086 | unmasking by function 40) |
||
2513 | mario79 | 5087 | * 5 = kernel finished redrawing of the desktop background |
118 | diamond | 5088 | * 6 = mouse event (something happened - button pressing or moving; |
5089 | is reset at reading) |
||
5090 | * 7 = IPC event (see function 60 - |
||
5091 | Inter Process Communication; is reset at reading) |
||
5092 | * 8 = network event (is reset at reading) |
||
5093 | * 9 = debug event (is reset at reading; see |
||
5094 | debug subsystem) |
||
5095 | * 16..31 = event with appropriate IRQ |
||
5096 | (16=IRQ0, 31=IRQ15) (is reset after reading all IRQ data) |
||
114 | mikedld | 5097 | |
5098 | ====================================================================== |
||
118 | diamond | 5099 | =================== Error codes of the file system =================== |
114 | mikedld | 5100 | ====================================================================== |
118 | diamond | 5101 | * 0 = success |
5102 | * 2 = function is not supported for the given file system |
||
5103 | * 3 = unknown file system |
||
5104 | * 5 = file not found |
||
5105 | * 6 = end of file, EOF |
||
5106 | * 7 = pointer lies outside of application memory |
||
5107 | * 8 = disk is full |
||
6235 | pathoswith | 5108 | * 9 = file system error |
114 | mikedld | 5109 | * 10 = access denied |
118 | diamond | 5110 | * 11 = device error |
6235 | pathoswith | 5111 | * 12 = file system requires more memory |
5112 | |||
118 | diamond | 5113 | Application start functions can return also following errors: |
5114 | * 30 = 0x1E = not enough memory |
||
5115 | * 31 = 0x1F = file is not executable |
||
5116 | * 32 = 0x20 = too many processes>>0,>=>=>=0xFFFF. |