WebSVN – Kolibri OS – Diff – /kernel/branches/Kolibri-acpi/docs/sysfuncs.txt

     the moment of start of the system; it is more convenient, because
     returns simply DWORD-value of the time counter.
   * System time can be set by function 22.
 ======================================================================
-============ Function 4 - draw text string in the window. ============
+=================== Function 4 - draw text string. ===================
 ======================================================================
 Parameters:
   * eax = 4 - function number
-  * ebx = [coordinate on axis x]*65536 + [coordinate on axis y]
+  * ebx = X*65536+Y, coordinates in the window or buffer
-  * ecx = 0xXYRRGGBB, where
+  * ecx = 0xXXRRGGBB, where
     * RR, GG, BB specify text color
-    * X=ABnn (bits):
+    * XX = ABFFCSSS (bits):
-      * nn specifies the used font: 0=system monospaced,
+      * A=1 - output zero terminated string
-=system font of variable width
+      * B=1 - fill background (color = edi)
-      * A=0 - output esi characters, A=1 - output ASCIIZ-string
+      * FF specifies the font and encoding:
+= 6x9  cp866
+= 8x16 cp866
-      * B=1 - fill background with the color edi
+= 8x16 UTF-16LE
+= 8x16 UTF-8
-    * Y = Cnnn
+      * C=0 - draw to the window,
-      * C=1 redirect the output to the user area, specified in edi
+        C=1 - draw to the user buffer (edi)
-      * nnn - not used in the current, must be 0 (zero)
+      * SSS = (size multiplier)-1, so 0 = x1, 7 = x8
   * edx = pointer to the beginning of the string
-  * esi = for A=0 length of the string, must not exceed 255;
-          for A=1 is ignored
+  * esi = for A=0 length of the string, for A=1 is ignored
-  * edi = color to fill background, if B=1
+  * edi = for B=1 color to fill background,
-  * edi = pointer to user area, for redirect, if C=1
+          for C=1 pointer to user buffer
 Returned value:
   * function does not return value
-Remarks:
-  * First system font is read out at loading from the file char.mt,
+Remarks:
-    second - from char2.mt.
+  * You can not use B=1 and C=1 at the same time, since both use edi.
-  * Both fonts have height 9 pixels, width of the monospaced font
-    is equal to 6 pixels.
+  * When SSS=0, font may be smoothed, depending on system setting.
-  * C=1, pixel depth = 32 bits, user area is as follows:
+  * User buffer structure:
-    dword Xsize
+Xsize       dd
-    dword Ysize
-    rest of the area = Xsize * Y size * 4
-  * You can not use B = 1 and C = 1, at the same time. Since in both
+Ysize       dd
-    cases, the register edi is used for different purposes.
+picture     rb  Xsize*Ysize*4  ; 32 bpp
 ======================================================================
     and does not make any operations at all. If it is really required
     to transfer control to the next process (to complete a current
     time slice), use subfunction 1 of function 68.
-======================================================================
-============== Function 6 - read the file from ramdisk. ==============
-======================================================================
-Parameters:
-  * eax = 6 - function number
-  * ebx = pointer to the filename
-  * ecx = number of start block, beginning from 1;
-    ecx=0 - read from the beginning of the file (same as ecx=1)
-  * edx = number of blocks to read;
-    edx=0 - read one block (same as edx=1)
-  * esi = pointer to memory area for the data
-Returned value:
-  * eax = file size in bytes, if the file was successfully read
-  * eax = -1, if the file was not found
-Remarks:
-  * This function is out-of-date; function 70 allows
-    to fulfil the same operations with the extended possibilities.
-  * Block = 512 bytes.
-  * For reading all file you can specify the certainly large value
-    in edx, for example, edx = -1; but in this case be ready that
-    the program will "fall", if the file will appear too large and can
-    not be placed in the program memory.
-  * The filename must be either in the format 8+3 characters
-    (first 8 characters - name itself, last 3 - extension,
-    the short names and extensions are supplemented with spaces),
-    or in the format 8.3 characters "FILE.EXT"/"FILE.EX "
-    (name no more than 8 characters, dot, extension 3 characters
-    supplemented if necessary by spaces).
-    The filename must be written with capital letters. The terminating
-    character with code 0 is not necessary (not ASCIIZ-string).
-  * This function does not support folders on the ramdisk.
 ======================================================================
 =============== Function 7 - draw image in the window. ===============
 ======================================================================
 Paramters:
   * eax = 7 - function number
   * ecx = 1 - subsubfunction number
   * edx = new value for speed
 Returned value:
   * function does not return value
+Remark: recommended speed = 1, 0 = lock the cursor.
----------------- Subsubfunction 2 - get mouse delay. -----------------
+------------- Subsubfunction 2 - get mouse acceleration. -------------
 Parameters:
   * eax = 18 - function number
   * ebx = 19 - subfunction number
   * ecx = 2 - subsubfunction number
 Returned value:
-  * eax = current mouse delay
+  * eax = 0 - off, 1 - slight, 2 - medium, 3 - intense
----------------- Subsubfunction 3 - set mouse delay. -----------------
+------------- Subsubfunction 3 - set mouse acceleration. -------------
 Parameters:
   * eax = 18 - function number
   * ebx = 19 - subfunction number
   * ecx = 3 - subsubfunction number
-  * edx = new value for mouse delay
+  * edx = 0 - off, 1 - slight, 2 - medium, 3 - intense
 Returned value:
   * function does not return value
     * bit 2 is set = middle button is pressed
     * bit 3 is set = 4th button is pressed
     * bit 4 is set = 5th button is pressed
 Returned value:
   * function does not return value
-Remarks:
-  * It is recommended to set speed of the mouse (in subsubfunction 1)
+-------------- Subsubfunction 6 - get doubleclick delay. -------------
+Parameters:
-    from 1 up to 9. The installed value is not inspected by the kernel
+  * eax = 18 - function number
-    code, so set it carefully, at incorrect value the cursor
+  * ebx = 19 - subfunction number
-    can "freeze". Speed of the mouse can be regulated through the
+  * ecx = 6 - subsubfunction number
-    application SETUP.
+Returned value:
-  * Recommended delay of the mouse (in subsubfunction 3) = 10. Lower
+  * eax = current doubleclick delay (100 = 1 second)
-    value is not handled by COM mice. At the very large values the
+-------------- Subsubfunction 7 - set doubleclick delay. -------------
+Parameters:
-    movement of the mouse on 1 pixel is impossible and the cursor will
+  * eax = 18 - function number
-    jump on the value of installed speed (subsubfunction 1). The
+  * ebx = 19 - subfunction number
-    installed value is not inspected by the kernel code.
+  * ecx = 7 - subsubfunction number
-    Mouse delay can be regulated through the application SETUP.
+  * dl  = new value for doubleclick delay (100 = 1 second)
-  * The subsubfunction 4 does not check the passed value. Before
+Returned value:
-    its call find out current screen resolution (with function 14)
+  * function does not return value
-    and check that the value of position is inside the limits of the
+Remark: mouse settings can be modified in the application mouse_cfg.
-    screen.
 ======================================================================
 ======== Function 18, subfunction 20 - get information on RAM. =======
 ======================================================================
   * The sizes specified in the function should not exceed the sizes
     of the current video mode, otherwise the function will not change
     anything.
+======================================================================
+===================== Function 18, subfunction 25 ====================
+===== Control position of the window relative to other windows. ======
+======================================================================
+------------- Subsubfunction 1 - get position  -----------------------
+Parameters:
+  * eax = 18 - function number
+  * ebx = 25 - subfunction number
+  * ecx = 1 - subsubfunction number
+  * edx = -1(for current window) or PID application
+Returned value:
+  * eax = one of the constants window position
+------------- Subsubfunction 2 - set position  -----------------------
+Parameters:
+  * eax = 18 - function number
+  * ebx = 25 - subfunction number
+  * ecx = 2 - subsubfunction number
+  * edx = -1(for current window) or PID application
+  * esi = new window position (one of the constants below)
+Returned value:
+  * eax = 0 - error
+  * eax = 1 - success
+Constant position of the window relative to other windows:
+ ZPOS_DESKTOP     = -2 - on the background
+ ZPOS_ALWAYS_BACK = -1 - behind all the windows
+ ZPOS_NORMAL      = 0  - normal
+ ZPOS_ALWAYS_TOP  = 1  - on top of all windows
 ======================================================================
 ==================== Function 20 - MIDI interface. ===================
 ======================================================================
   * Counter takes modulo 2^32, that correspond to a little more
     than 497 days.
   * To get system time use function 3.
+======================================================================
+===================== Function 26, subfunction 10 ====================
+========== Get the value of the high precision time counter. =========
+======================================================================
+Parameters:
+  * eax = 26 - function number
+  * ebx = 10 - subfunction number
+Returned value:
+  * eax = number of nanoseconds since system boot time (lower DWORD)
+  * edx = number of nanoseconds since system boot time (high DWORD)
+Remarks:
+  * The counter is based on HPET, if HPET is not available, resolution
+    will be reduced to 10 000 000 nanoseconds.
 ======================================================================
 ===================== Function 26, subfunction 11 ====================
 ========== Find out whether low-level HD access is enabled. ==========
 ======================================================================
 Parameters:
     relative y-coordinate, and the high word - relative x-coordinate
     (with correct sign). Otherwise the low word is negative and still
     contains relative y-coordinate, and to the high word
 should be added.
------------- Subfunction 2 - pressed buttons of the mouse ------------
+------------- Subfunction 2 - states of the mouse buttons ------------
 Parameters:
   * eax = 37 - function number
   * ebx = 2 - subfunction number
+Returned value:
+  * eax = bits 0-4 equal to subfunction 3
+------- Subfunction 3 - states and events of the mouse buttons -------
+Parameters:
+  * eax = 37 - function number
+  * ebx = 3 - subfunction number
 Returned value:
+  * eax contains next information:
-  * eax contains information on the pressed mouse buttons:
+states:
-  * bit 0 is set = left button is pressed
+  * bit 0 is set = left button is held
-  * bit 1 is set = right button is pressed
+  * bit 1 is set = right button is held
+  * bit 2 is set = middle button is held
+  * bit 3 is set = 4th button is held
+  * bit 4 is set = 5th button is held
-  * bit 2 is set = middle button is pressed
+events:
-  * bit 3 is set = 4th button is pressed
+  * bit 8 is set = left button is pressed
+  * bit 9 is set = right button is pressed
+  * bit 10 is set = middle button is pressed
+  * bit 15 is set = vertical scroll is used
-  * bit 4 is set = 5th button is pressed
+  * bit 16 is set = left button is released
+  * bit 17 is set = right button is released
+  * bit 18 is set = middle button is released
+  * bit 23 is set = horisontal scroll is used
-  * other bits are cleared
+  * bit 24 is set = doubleclick by left button
 -------------------- Subfunction 4 - load cursor ---------------------
 Parameters:
     on ramdisk.
   * User can change the skin statically by creating hisself
     'default.skn' or dynamically with the application 'desktop'.
+======================================================================
+====== Function 48, subfunction 9 - get font smoothing setting. ======
+======================================================================
+Parameters:
+  * eax = 48 - function number
+  * ebx = 9 - subfunction number
+Returned value:
+  * eax = 2 - subpixel, 1 - anti-aliasing, 0 - off
+======================================================================
+========== Function 48, subfunction 10 - set font smoothing. =========
+======================================================================
+Parameters:
+  * eax = 48 - function number
+  * ebx = 10 - subfunction number
+  * cl  = 2 - subpixel, 1 - anti-aliasing, 0 - off
+======================================================================
+============ Function 48, subfunction 11 - get font size. ============
+======================================================================
+Parameters:
+  * eax = 48 - function number
+  * ebx = 9 - subfunction number
+Returned value:
+  * eax = current font height in pixels
+======================================================================
+============ Function 48, subfunction 12 - set font size. ============
+======================================================================
+Parameters:
+  * eax = 48 - function number
+  * ebx = 10 - subfunction number
+  * cl  = new font height in pixels
 ======================================================================
 =========== Function 49 - Advanced Power Management (APM). ===========
 ======================================================================
 Parameters:
   * eax = 49 - function number
     the corresponding bit in the exception mask with subfunction 25.
     Also user handler is responsible for clearing exceptions flags in
     FPU and/or SSE.
 ======================================================================
-====== Function 68, subfunction 25 - set FPU exception handler. ======
+======== Function 68, subfunction 25 - set exception activity ========
 ======================================================================
 Parameters:
   * eax = 68 - function number
   * ebx = 25 - subfunction number
 ========== Function 71, subfunction 1 - set window caption. ==========
 ======================================================================
 Parameters:
   * eax = 71 - function number
   * ebx = 1 - subfunction number
-  * ecx = pointer to caption string
+  * ecx = pointer to zero terminated string
 Returned value:
   * function does not return value
 Remarks:
-  * String must be in the ASCIIZ-format. Disregarding real string
+  * You may set the caption string encoding by putting
-    length, no more than 255 characters are drawn.
+    at the start of the string a byte with next values:
+= cp866
+= UTF-16LE
+= UTF-8
+    otherwise will be used cp866.
   * Pass NULL in ecx to remove caption.
 ======================================================================
 =============== Function 72 - send message to a window. ==============
 Returned value:
   * function does not return value
 ======================================================================
-= Function 74, Subfunction -1, Get number of active network devices. =
+= Function 74, Subfunction 255, Get number of active network devices. =
 ======================================================================
 Parameters:
   * eax = 74 - function number
-  * bl = -1 - subfunction number
+  * bl = 255 - subfunction number
 Returned value:
   * eax = number of active network devices
 Parameters:
   * eax = 74 - function number
   * bl = 0 - subfunction number
   * bh = device number
 Returned value:
-  * eax = device type
+  * eax = device type number
 ======================================================================
 ======== Function 74, Subfunction 1, Get network device name. ========
 ======================================================================
   * bh = device number
 Returned value:
   * eax = -1 on error
+======================================================================
+=========== Function 74, Subfunction 4, Get device pointer. ==========
+======================================================================
+Parameters:
+  * eax = 74 - function number
+  * bl = 4 - subfunction number
+  * bh = device number
+Returned value:
+  * eax = device pointer, -1 on error
+======================================================================
+========= Function 74, Subfunction 6, Get packet TX counter. =========
+======================================================================
+Parameters:
+  * eax = 74 - function number
+  * bl = 6 - subfunction number
+  * bh = device number
+Returned value:
+  * eax = Number of packets sent since device start, -1 on error
+======================================================================
+========= Function 74, Subfunction 7, Get packet RX counter. =========
+======================================================================
+Parameters:
+  * eax = 74 - function number
+  * bl = 7 - subfunction number
+  * bh = device number
+Returned value:
+  * eax = Number of packets received since device start, -1 on error
+======================================================================
+========== Function 74, Subfunction 8, Get TX byte counter. ==========
+======================================================================
+Parameters:
+  * eax = 74 - function number
+  * bl = 8 - subfunction number
+  * bh = device number
+Returned value:
+  * eax = Number of bytes sent since device start (lower dword)
+                  -1 on error
+  * ebx = Number of bytes sent since device start (higher dword)
+======================================================================
+========== Function 74, Subfunction 9, Get RX byte counter. ==========
+======================================================================
+Parameters:
+  * eax = 74 - function number
+  * bl = 9 - subfunction number
+  * bh = device number
+Returned value:
+  * eax = Number of bytes received since device start (lower dword)
+                  -1 on error
+  * ebx = Number of bytes received since device start (higher dword)
+======================================================================
+========== Function 74, Subfunction 10, Get link status. =============
+======================================================================
+Parameters:
+  * eax = 74 - function number
+  * bl = 10 - subfunction number
+  * bh = device number
+Returned value:
+  * eax = link status, -1 on error
+  Link status:
+    ETH_LINK_DOWN   =    0b         ; Link is down
+    ETH_LINK_UNKNOWN=    1b         ; There could be an active link
+    ETH_LINK_FD     =   10b         ; full duplex flag
+    ETH_LINK_10M    =  100b         ; 10 mbit
+    ETH_LINK_100M   = 1000b         ; 100 mbit
+    ETH_LINK_1G     = 1100b         ; gigabit
 ======================================================================
 ============== Function 75, Subfunction 0, Open socket. ==============
 ======================================================================
 Parameters:
   * eax = 75 - function number
 Returned value:
   * eax = -1 on error
   * ebx = errorcode
 Remarks:
+  Optstruct:
-  Optstruct: dd level
+    dd level
-             dd optionname
+    dd optionname
-             dd optlength
+    dd optlength
-             db options...
+    db options...
 Returned value:
   * eax = -1 on error
   * ebx = errorcode
 Remarks:
+  Optstruct:
-  Optstruct: dd level
+    dd level
-             dd optionname
+    dd optionname
-             dd optlength
+    dd optlength
-             db options...
+    db options...
 Returned value:
   * eax = socketnum1, -1 on error
   * ebx = socketnum2, errorcode on error
+======================================================================
+============ Function 76, Network options and statistics. ============
+======================================================================
+Parameters:
+  * eax = 76 - function number
+  * high half of ebx = protocol number
+  * bh = device number
+  * bl = subfunction number
+Ethernet (0)
+- Read MAC
+IPv4 (1)
+- Read # IP packets send
+- Read # IP packets received
+- Read IP
+- Write IP
+- Read DNS
+- Write DNS
+- Read subnet
+- Write subnet
+- Read gateway
+- Write gateway
+ICMP (2)
+- Read # ICMP packets send
+- Read # ICMP packets received
+- enable/disable ICMP echo reply
+UDP (3)
+- Read # UDP packets send
+- Read # UDP packets received
+TCP (4)
+- Read # TCP packets send
+- Read # TCP packets received
+ARP (5)
+- Read # ARP packets send
+- Read # ARP packets received
+- Read # ARP entry's
+- Read ARP entry
+- Add static ARP entry
+- Remove ARP entry (-1 = remove all)
+- Send ARP announce on specified interface
+- Read # ARP conflicts (IP address conflicts)
 ======================================================================
 =============== Function -1 - terminate thread/process ===============
 ======================================================================
 Parameters:
   * eax = -1 - function number

Subversion Repositories Kolibri OS

(root)/kernel/branches/Kolibri-acpi/docs/sysfuncs.txt @ 6078 – Rev 5565 → 5984