Subversion Repositories Kolibri OS

SYSTEM FUNCTIONS of OS Kolibri 0.5.8.1

Number of the function is located in the register eax.

The call of the system function is carried out by the command "int 0x40".

All registers, except for obviously indicated in returned value,

including the register of flags eflags, are saved.

======================================================================

============== Function 0 - define and draw the window. ==============

======================================================================

Defines an application window. Draws a frame of the window, header and

working area. For windows with ñêèíîì defines standard buttons of closing

and minimization.

Parameters:

  * eax = 0 - number of the function

  * ebx = [coordinate on axis x]*65536 + [size on axis x]

  * ecx = [coordinate on axis y]*65536 + [size on axis y]

  * edx = 0xXYRRGGBB, where:

    * Y = style of the window:

      * Y=0 - type I - window of the fixed sizes

      * Y=1 - only to define window area, nothing to draw

      * Y=2 - type II - window with changed sizes

      * Y=3 - window with skinned

      * other possible values (from 4 up to 15) reserved,

        function call with such Y is ignored

    * RR, GG, BB = accordingly red, green, blue

      colours of a working area of the window

      (is ignored for style Y=2)

    * X = DCBA (bits)

      * A = 1 - window has caption; if Y=3, caption string address could be passed in edi,

                otherwise use function 71 subfunction 1

      * B = 1 - draw all graphics primitives relative to window client area

      * C - reserved

      * D = 8 - fill client area with gradient

      other values are reserved

    The following parameters are intended for windows of a type I and II,

    and ignored for styles Y=1,3:

  * esi = 0xXYRRGGBB - colour of header

    * RR, GG, BB define colour

    * Y=0 - usual window, Y=1 - unmovable window

    * X defines a gradient of header: X=0 - no gradient,

      X=8 - usual gradient,

      for windows of a type II X=4 - negative gradient

    * other values X and Y reserved

  * edi = 0x00RRGGBB - colour of a frame

Returned value:

  * function does not return value

Remarks:

  * Location and the sizes of the window are installed by the first call of

    this function and are ignored at subsequent; for change of location

    and/or of sizes already of created window use function 67.

  * If to use windows of appropriate styles, location and - or the sizes of

    the window can vary by the user.

    Current location and the sizes can be obtained by function 9.

  * The window should be located on the screen. If the transferred coordinates

    nd the sizes do not satisfy to this condition, appropriate coordinate

    (or, probably, is considered both) as zero, and if also it does not help,

    the appropriate size (or, probably, both) is installed in a size of the

    screen.

    Further we shall designate xpos, ypos, xsize, ysize - values transmitted

    in ebx, ecx. The coordinates are resulted concerning the left upper corner

    of the window, which, thus, is set as (0,0), coordinate of the right lower

    corner essence (xsize, ysize).

  * The sizes of the window are understood in sense of coordinates of the

    right lower corner. This concerns and to all other functions. It means,

    that the real sizes on 1 pixel are more.

  * Look of the window of a type I:

    * draw external frame of colour indicated in edi,

      in width 1 pixel

    * draw header - rectangle with the left upper corner (1,1) and right lower

      (xsize-1, min (25, ysize)) colour indicated in esi

      (in view of a gradient)

    * If ysize > =26, the working area of the window - rectangle with the left

      upper corner (1,21) and right lower

      (xsize-1, ysize-1) (sizes (xsize-1) * (ysize-21)) - colour

       indicated in edx (in view of a gradient) is painted over

  * Look of the window of a type Y=1:

    * completely defined by the application

  * Look of the window of a type II:

    * draw external frame of width 1 pixel of the "shaded" colour

      edi (all making colours decrease twice)

    * drawn intermediate frame of width 3 pixels of colour edi

    * draw internal frame of width 1 pixel

      "shaded" colour edi

    * draw header - rectangle with the left upper corner (4,4)

      and right lower (xsize-4,min(20,ysize)) colour, indicated â esi

      (in view of a gradient)

    * If ysize > =26, the working area of the window is painted over -

      rectangle with the left upper corner (5,20) and right lower

      (xsize-5,ysize-5) - colour indicated in edx (in view of a gradient)

  * Look of the window with skinned:

    * draw external frame of width 1 pixel

      colour 'outer' from skin

    * draw intermediate framework of width 3 pixels

      colour 'frame' from skin

    * draw internal framework of width 1 pixel

      colour 'inner' from skin

    * draw header (on pictures from skin) in a rectangle

      (0,0) - (xsize,_skinh-1)

    * If ysize > =26, the working area of the window is painted over -

      rectangle with the left upper corner (5, _skinh) and right lower

      (xsize-5,ysize-5) - colour indicated in edx (in view of a gradient)

    * two standard buttons are defined: closings and minimizations

      (see function 8)

    * value _skinh is accessible as result of call

      subfunction 4 functions 48

======================================================================

================= Function 1 - put a point in the window. ============

======================================================================

Parameters:

  * eax = 1 - number of the function

  * ebx = x-coordinate (concerning the window)

  * ecx = y-coordinate (concerning the window)

  * edx = 0x00RRGGBB - colour of a point

    edx = 0x01xxxxxx - to invert colour of a point

          (low 24 bits ignored)

Returned value:

  * function does not return value

======================================================================

======== Function 2 - receive the code of the pressed key. ===========

======================================================================

Takes away the code of the pressed key from the buffer.

Parameters:

  * eax = 2 - number of the function

Returned value:

  * if the buffer is empty, comes back eax=1

  * If the buffer is nonblank, that comes back al=0, ah=code of the pressed key,

    high word of the register eax is set zero

  * If there is "hotkey", comes back

    al=2, ah=scancode of the pressed key (0 for direction keys),

    high word of the register eax contains a status of direction keys

    at the moment of pressing a hotkey

Remarks:

  * There is a common system buffer of the pressed keys by a size of 120 bytes,

    organized as queue.

  * There is one more common system buffer on 120 "hotkey".

  * By call of this function the application with the inactive window

    considers, that the buffer of the pressed keys is empty.

  * By default this function returns ASCII-codes; to switch to the mode

    scancode (and back) it is possible with usage of the function 66.

    However, the hotkey always come back as scancodes.

  * Ffind out, what keys correspond to what codes, is possible, having started

    the applications keyascii and scancode.

  * Scancodes come back directly by keyboard and are fixed; ASCII-codes turn

    out with usage of the conversion tables, which can be installed

    subfunction 2 functions 21 and to read subfunction 2 functions 26.

  * As a consequence, ASCII-codes take into account current keyboard layout

    (rus/en) as against scancodes.

  * The information only about those hotkeys acts which were defined by this

    stream subfunction 4 functions 66.

======================================================================

================ Function 3 - get system time. =======================

======================================================================

Parameters:

  * eax = 3 - number of the function

Returned value:

  * eax = 0x00SSMMHH, where HH:MM:SS = Hours:Minutes:Seconds

  * each unit comes back as BCD-number, for example,

    for time 23:59:59 result will be 0x00595923

Remarks:

  * Look also subfunction 9 functions 26 - obtaining of time from the moment

    of start of the system; it in many cases is more convenient, as returns

    simply DWORD-value of the counter of time.

  * System time can be installed by the function 22.

======================================================================

================ Function 4 - draw text in the window. ===============

======================================================================

Can output both strings with given length and NULL-terminated strings

(0x0) - ASCIIZ(string  db  'text',0). To draw ASCIIZ string, pass -1

in esi (mov esi,-1).

Parameters:

  * eax = 4 - number of the function

  * ebx = [coordinate on axis x]*65536 + [coordinate on axis y]

  * ecx = 0xX0RRGGBB, where

    * RR, GG, BB set colour of the text

    * X sets the used font: 0=system monowide,

      1=system font of variable width

  * edx = pointer by the beginning of string

  * esi = length of string, should be no more 255

Returned value:

  * function does not return value

Remarks:

  * The first system font is read out at loading from the file char.mt,

    second system font - from char2.mt.

  * Both fonts have height 9 pixels, width of the monowide font

    is equal 6 pixels.

======================================================================

========================= Function 5 - pause. =========================

======================================================================

Delays execution of the program on the given time.

Parameters:

  * eax = 5 - number of the function

  * ebx = time in the 1/100 of second

Returned value:

  * function does not return value

Remarks:

  * The transmission ebx=0 does not transfer handle the following process

    and at all does not make any operations. If really it is required to

    transfer handle to the following process (to complete a current time

    slice), use subfunction of 1 function 68.

  * At current realization there will be an immediate return from the function,

    if the addition ebx with current value of the counter of time will call

    32-bit overflow.

======================================================================

============== Function 6 - read the file with ramdisk. ==============

======================================================================

Parameters:

  * eax = 6 - number of the function

  * ebx = pointer on a filename

  * ecx = number of the start block, beginning from 1;

    ecx=0 - read from a beginning of the file (same, as ecx=1);

  * edx = number of blocks for reading;

    edx=0 - read one block (same, as edx=1)

  * esi = pointer on area of memory, where the data will be written

Returned value:

  * eax = file size in bytes, if the file is successfully read

  * eax = -1, if the file is not retrieved

Remarks:

  * The given function is out-of-date; the function 70 allows to fulfil

    the same operations with the extended possibilities.

  * Block = 512 bytes.

  * For reading all file it is possible to 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 "will not be placed" in

    memory of the program.

  * The filename should be or in the format 8+3 characters (first 8 characters

    - purely name, last 3 - extension, the short names and extensions are

    supplemented by blanks), or in the format 8.3 characters

    "FILE.EXT" / "FILE.EX " (name no more than 8 characters, point,

    extension 3 characters supplemented if necessary by blanks).

    The filename should be written by capital letters. The completing

    character with the code 0 is not necessary (ASCIIZ-string).

  * Current implementation ramdisk does not support the directory.

======================================================================

=============== Function 7 - draw image in the window. ===============

======================================================================

Parameters:

  * eax = 7 - number of the function

  * ebx = pointer on the image in the format BBGGRRBBGGRR...

  * ecx = [size on axis x]*65536 + [size on axis y]

  * edx = [coordinate on axis x]*65536 + [coordinate on axis y]

Returned value:

  * function does not return value

Remarks:

  * Coordinates of the image are coordinates of the upper left corner of the

    image concerning the window.

  * Size of the image in bytes is 3*xsize*ysize.

======================================================================

=============== Function 8 - define/delete the button. ===============

======================================================================

Parameters for îïðåäåëåíèÿ êíîïêè:

  * eax = 8 - number of the function

  * ebx = [coordinate on axis x]*65536 + [size on axis x]

  * ecx = [coordinate on axis y]*65536 + [size on axis y]

  * edx = 0xXYnnnnnn, where:

    * nnnnnn = identifier of the button

    * high (31-st) bit edx is reset

    * if 30-th bit edx is installed - to not draw the button

    * If 29-th bit edx is installed - to not draw a frame

      at pressing the button

  * esi = 0x00RRGGBB - colour of the button

Parameters for deleting the button:

  * eax = 8 - number of the function

  * edx = 0x80nnnnnn, where nnnnnn - identifier of the button

Returned value:

  * function does not return value

Remarks:

  * Sizes of the button should be more than 0 and less than 0x8000.

  * For windows with skin at definition of the window (call of 0-th function)

    there are two standard buttons - closing of the window with the

    identifier 1 and minimization of the window with the identifier 0xffff.

  * The creation of two buttons with identical identifiers is admitted.

  * The button with the identifier 0xffff at pressing is interpreted by the

     system as the button of minimization, the system handles such pressing

     independently, not accessing to the application. In rest it is

     the usual button.

  * Total of buttons for all applications is limited to number 4095.

======================================================================

========== Function 9 - information on thread of execution. ==========

======================================================================

Parameters:

  * eax = 9 - number of the function

  * ebx = pointer on the buffer of a size 1 Kb

  * ecx = number of the slot of thread

    ecx = -1 - get information on current thread

Returned value:

  * eax = maximum number of the slot of thread

  * buffer, which specifies ebx, contains the following information:

    * +0: dword: usage of the processor (how many clock ticks per one second

      leaves on fulfilment of this thread)

    * +4: word: position of the window of thread in the window stack

    * +6: word: (there is no ratio to the requested thread)

      number of the slot thread, which window is in the window stack

      in a position ecx

    * +8: word: reserved

    * +10 = +0xA: 11 bytes: name of the process

      (name of an appropriate executable file in the format 8+3)

    * +21 = +0x15: byte: alignment, this byte does not vary

    * +22 = +0x16: dword: address of the process in memory

    * +26 = +0x1A: dword: size of used memory - 1

    * +30 = +0x1E: dword: identifier (PID/TID)

    * +34 = +0x22: dword: coordinate of the window thread on axis x

    * +38 = +0x26: dword: coordinate of the window thread on axis y

    * +42 = +0x2A: dword: size of the window thread on axis x

    * +46 = +0x2E: dword: size of the window thread on axis y

    * +50 = +0x32: word: status of the slot thread:

      * 0 = thread worked

      * 1 = thread paused

      * 2 = thread paused at the moment of waiting event

      * 3 = thread completed as a result of function call -1 or

        under duress as a consequence of call subfunction 2 functions 18

        or termination of the system

      * 4 = thread is completed as a result of exception

      * 5 = thread wait event

      * 9 = requested slot is free,

        all other information on the slot is not meaningful

Remarks:

  * Slots are numbered with 1.

  * Returned value not is a total number of streams, as there are free slots.

  * Ïðè ñîçäàíèè ïðîöåññà àâòîìàòè÷åñêè ñîçäàåòñÿ thread âûïîëíåíèÿ.

  * Function produces the information on thread. Each process has even one

    thread. One process can create some thread, in this case everyone thread

    receives the slot, and the fields +10, +22, +26 in these slots coincide.

    For the applications there is no common way to define, whether two thread

    belong to one process.

  * Active window - window which is taking place on top of the window stack,

    it receives the messages on a keyboard input. For it the position in the

    window stack coincides with returned value.

  * Slot 1 corresponds to special thread of an operating system, for which:

    * window is in the bottom of the window stack, the fields +4 and +6

      contain value 1

    * Nname of the process - "OS/IDLE" (supplemented by blanks)

    * address of the process is equal memory 0, size of used memory

      16 Mb (0x1000000)

    * PID=1

    * coordinates and sizes of the window conditionally rely equal 0

    * status of the slot - always 0 (worked)

    * The execution time adds of time leaving on purely operation, and down

      time in waiting interruption (which can be received by call

      subfunction 4 functions 18).

  * Since the slot 2, the usual applications are placed.

  * Usual applications are placed in memory to the address 0x10000000

    (constant of a kernel std_application_base_address).

    Intersection does not occur, as for each process the own page table.

  * At creation thread to it are assigned the slot in the system table and

    identifier (Process/Thread IDentifier = PID/TID), which for given thread

    do not vary in the subsequent time.

    After completion thread its slot can be anew used for another thread.

    The identifier thread can not be assigned to other stream even after

    completion first.

    Identifiers, assigned to new thread, monotonously grow.

  * If thread yet has not defined the window by function call 0,

    a location and the sizes of this window rely in zero.

  * In the given moment the part of the buffer by a size 52 = 0x34 of byte

    is used only. Nevertheless it is recommended to use the buffer

    by a size 1 KB for the future compatibility, in the future some fields

    can be added.

======================================================================

====================== Function 10 - wait event. =====================

======================================================================

If the message queue is empty, waits for appearance of the message in queue.

In such status thread does not receive CPU time.

Then reads out the message from queue.

Parameters:

  * eax = 10 - number of the function

Returned value:

  * eax = event (look the list of events)

Remarks:

  * Those events are taken into account only which enter into a mask installed

    by the function 40. By default it is events redraw, pressing keys

    and buttons.

  * For check, whether there is a message in queue, use the function 11.

    To wait for the no more defined time, use the function 23.

=======================================================================

= Function 11 - check up, whether there is an event, without waiting. =

=======================================================================

If in a message queue there is any event, reads out and returns it.

If queue is empty, returns zero.

Parameters:

  * eax = 11 - number of the function

Returned value:

  * eax = 0 - message queue is empty

  * èíà÷å eax = event (look the list of events)

Remarks:

  * Those events are taken into account only which enter into a mask installed

    by the function 40. By default it is events redraw, pressing keys

    and buttons.

  * For waiting appearance of event in queue, use the function 10.

    To wait for the no more defined time, use the function 23.

======================================================================

========= Function 12 - begin/complete redraw of the window. =========

======================================================================

---------- Subfunction 1 - begin redraw of the window. ---------------

Parameters:

  * eax = 12 - number of the function

  * ebx = 1 - number subfunction

Returned value:

  * function does not return value

--------- Subfunction 2 - complete redraw of the window. -------------

Parameters:

  * eax = 12 - number of the function

  * ebx = 2 - number subfunction

Returned value:

  * function does not return value

Remarks:

  * Function of a beginning redraw all deletes defined by the

    function 8 buttons, they should be defined again.

======================================================================

============ Function 13 - draw a rectangle in the window. ===========

======================================================================

Parameters:

  * eax = 13 - number of the function

  * ebx = [coordinate on axis x]*65536 + [size on axis x]

  * ecx = [coordinate on axis y]*65536 + [size on axis y]

  * edx = colour 0xRRGGBB èëè 0x80RRGGBB for a gradient of filling

Returned value:

  * function does not return value

Remarks:

  * Coordinates are understood as coordinates of the left upper corner

    of a rectangle concerning the window.

======================================================================

================ Function 14 - get sizes of the screen. ==============

======================================================================

Parameters:

  * eax = 14 - number of the function

Returned value:

  * eax = [xsize]*65536 + [ysize], where

  * xsize = x-coordinate of the right lower corner of the screen =

            size on a horizontal - 1

  * ysize = y-coordinate of the right lower corner of the screen =

            size on a vertical - 1

Remarks:

  * Look also subfunction 5 functions 48 - to receive sizes of

    a working area of the screen.

========================================================================

= Function 15, subfunction 1 - install a size of the background image. =

========================================================================

Parameters:

  * eax = 15 - number of the function

  * ebx = 1 - number subfunction

  * ecx = width of the image

  * edx = height of the image

Returned value:

  * function does not return value

Remarks:

  * Checks on a correctness is not done. The installation of the too large

    values will result that the background will be entered with the data abroad

    of buffer of the background map. The size of the buffer = 0x160000-0x10,

    that corresponds to maximum sizes 800*600. (800*600*3=0x15F900)

  * For upgrade of the screen (after completion of a series of commands

    working with a background) call subfunction 3 redraw of a background.

  * There is a pair function of get of sizes of the background image -

    subfunction 1 function 39.

======================================================================

= Function 15, subfunction 2 - put a point on the background image. ==

======================================================================

Parameters:

  * eax = 15 - number of the function

  * ebx = 2 - number subfunction

  * ecx = offset

  * edx = colour of a point 0xRRGGBB

Returned value:

  * function does not return value

Remarks:

  * Offset for a point with coordinates (x, y) is calculated as

    (x+y*xsize)*3.

  * If the indicated offset exceeds 0x160000-16 =

    1.375 Mb - 16 bytes, call is ignored.

  * For upgrade of the screen (after completion of a series of commands

    working with a background) call subfunction 3 redraw of a background.

  * There is a pair function of obtaining of a point from the background

    image - subfunction 2 functions 39.

======================================================================

=========== Function 15, subfunction 3 - redraw background. ==========

======================================================================

Parameters:

  * eax = 15 - number of the function

  * ebx = 3 - number subfunction

Returned value:

  * function does not return value

=========================================================================

= Function 15, subfunction 4 - set the mode of drawing of a background. =

=========================================================================

Parameters:

  * eax = 15 - number of the function

  * ebx = 4 - number subfunction

  * ecx = mode of drawing:

    * 1 = tile

    * 2 = stretch

Returned value:

  * function does not return value

Remarks:

  * For upgrade of the screen (after completion of a series of commands

    working with a background) call subfunction 3 redraw of a background.

  * There is a pair command of obtaining of the mode redraw of a background

    - subfunction 4 functions 39.

===========================================================================

= Function 15, subfunction 5 - place the block of pixels on a background. =

===========================================================================

Parameters:

  * eax = 15 - number of the function

  * ebx = 5 - number subfunction

  * ecx = pointer on the data in the format BBGGRRBBGGRR...

  * edx = offset in data of the background image

  * esi = size given in bytes = 3 * number of pixels

Returned value:

  * function does not return value

Remarks:

  * If the block gets out abroad 0x160000-16 = 1.375 Mb - 16 bytes,

    the call is ignored.

  * Colour of each pixel is stored as 3 bytes the value BBGGRR.

  * Pixels of the background image are written sequentially from left to right,

    from above downwards.

  * Offset of a pixel with coordinates (x,y) it (x+y*xsize)*3.

  * For upgrade of the screen (after completion of a series of commands

    working with a background) call subfunction 3 redraw of a background.

======================================================================

============= Function 16 - save ramdisk on a diskette. ==============

======================================================================

Parameters:

  * eax = 16 - number of the function

  * ebx = 1 èëè ebx = 2 - on what floppy to save

Returned value:

  * eax = 0 - successfully

  * eax = 1 - error

======================================================================

============== Function 17 - get code of pressed button. =============

======================================================================

Takes away the code of the pressed button from the buffer.

Parameters:

  * eax = 17 - number of the function

Returned value:

  * If the buffer is empty, comes back eax=1

  * If the buffer is nonblank, comes back al=0, the high 24 bits eax contain

    the identifier of the button (in particular, in ah there is a low byte of

    the identifier; if all buttons have the identifier, smaller 256, for

    distinguishing there is enough ah)

Remarks:

  * "Buffer" keeps only one button, at pressing the new button the information

    about old is lost.

  * By call of this function by the application with the inactive window the

    answer " the buffer comes back is empty ".

======================================================================

============ Function 18, subfunction 1 - shutdown system. ===========

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 1 - number subfunction

Returned value:

  * Always comes back eax = 0 as tag of success

Remarks:

  * On last step there is a menu of quit waiting responses of the user.

  * Look also subfunction 9, termination of the system with the parameter

    to speed up choice in the menu of an exit.

======================================================================

= Function 18, subfunction 2 - complete process/thread on the slot. ==

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 2 - number subfunction

  * ecx = number of the slot of process/thread

Returned value:

  * function does not return value

Remarks:

  * It is impossible to complete thread of an operating system OS/IDLE

    (number of the slot 1), it is possible to complete

    any usual thread/process.

  * See also subfunction 18 - completion of process/thread

    with the given identifier.

=========================================================================

= Function 18, subfunction 3 - do to the active window selected thread. =

=========================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 3 - number subfunction

  * ecx = number of the slot thread

Returned value:

  * function does not return value

Remarks:

  * At the instruction correct, but nonexistent slot any window is made active.

  * Find out, what window is active, is possible by call subfunction 7.

==============================================================================

 Function 18, subfunction 4 - get counter of empty clock ticks per one second.

==============================================================================

Empty clock ticks are understood as time, in which the processor stands idle

in waiting interruption (in the instruction hlt).

Parameters:

  * eax = 18 - number of the function

  * ebx = 4 - number subfunction

Returned value:

  * eax = value of the counter of empty clock ticks per one second

======================================================================

=========== Function 18, subfunction 5 - get cpu frequency. ==========

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 5 - number subfunction

Returned value:

  * eax = cpu frequency (modulo 2^32 clock ticks = 4GHz)

=====================================================================

== Function 18, subfunction 6 - save ramdisk in file on hard disk. ==

=====================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 6 - number subfunction

  * ecx defines path to the file:

    * 1 = in the directory "/KOLIBRI"

    * 2 = in the root

    * 3 = edx specifies path (names of folders in the format 8+3, divided '/')

Returned value:

  * eax = 0 - successfully

  * differently eax = an error code of a file system

Remarks:

  * Filename is fixed, "menuet.img" (global variable of

    a kernel image_save from preboot.inc)

  * On what partition what disk the file will be saved, is defined

    subfunction 7 and subfunction 8 functions 21.

  * All directories in the indicated path should exist, differently will

    return value 5, " the file is not retrieved ".

======================================================================

====== Function 18, subfunction 7 - get number of active window. =====

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 7 - number subfunction

Returned value:

  * eax = number of active window (number of the slot thread, which window

    is active)

Remarks:

  * Active window is at the top of the window stack and receives the messages

    on all keyboard input.

  * Make the window active it is possible by call subfunction 3.

=======================================================================

==== Function 18, subfunction 8 - disable/enable a speaker sound . ====

=======================================================================

At the disconnected sound the calls subfunction 55 functions 55 are ignored.

At included - are routed on built - in speaker.

--------------- Subsubfunction 1 - get a status. ----------------

Parameters:

  * eax = 18 - number of the function

  * ebx = 8 - number subfunction

  * ecx = 1 - number subsubfunction

Returned value:

  * eax = 0 - sound speaker is enabled; 1 - is disabled

-------------- Subsubfunction 2 - switch a status. --------------

Switches statuses of disable/enable.

Parameters:

  * eax = 18 - number of the function

  * ebx = 8 - number subfunction

  * ecx = 2 - number subsubfunction

Returned value:

  * function does not return value

===========================================================================

= Function 18, subfunction 9 - shutdown of the system with the parameter. =

===========================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 9 - number subfunction

  * ecx = parameter:

    * 1 = On last step of shutdown to save ramdisk on a diskette then to

      output the menu of an exit and to request of the user further operations

    * 2 = switch off the computer

    * 3 = reboot the computer

    * 4 = restart a kernel from the file kernel.mnt on ramdisk

Returned value:

  * At incorrect ecx the registers do not vary (i.e. eax=18)

  * By correct call tag of success eax=0 always comes back

Remarks:

  * It is not necessary to rely on returned value by incorrect call,

    it can vary in the subsequent versions of a kernel.

  * It is possible to use subfunction 1, that on last step of termination

    the user himself has selected, that it is necessary.

  * It is not recommended to use value ecx=1 (to not irritate the user with

    excessive questions); to save ramdisk on a diskette it is possible by the

    function 16 (which admits specification, on which diskette to write), and

    to complete operation from the menu of an output(exit) it is possible

    already mentioned subfunction 1.

=======================================================================

====== Function 18, subfunction 10 - minimize application window. =====

=======================================================================

Turns off the own window.

Parameters:

  * eax = 18 - number of the function

  * ebx = 10 - number subfunction

Returned value:

  * function does not return value

Remarks:

  * The minimized window from the point of view of the function 9 saves

    a location and sizes.

  * Restoring of an application window occurs at activation subfunction 3.

  * Usually there is no necessity obviously to turn off/restore the window:

    turn off of the window is carried out by the system at pressing the button

    of minimization (which for windows with SKIN is defined automatically by

    function 0, for windows without SKIN it is possible to define by the

    function 8), restoring - application @panel.

======================================================================

==================== Function 18, subfunction 11 =====================

================ Get information on a disk subsystem. ================

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 11 - number subfunction

  * ecx = type of the table:

    * 1 = short version, 10 bytes

    * 2 = full version, 65536 bytes

  * edx = pointer on the buffer (in the application) for table

Returned value:

  * function does not return value

Format of the table: the short version:

  * +0: byte: information about FDD's (drives for diskettes), AAAABBBB,

    where AAAA sets type of the first drive, BBBB - second disk agrees

    to the following list:

    * 0 = there is no drive

    * 1 = 360Kb, 5.25''

    * 2 = 1.2Mb, 5.25''

    * 3 = 720Kb, 3.5''

    * 4 = 1.44Mb, 3.5''

    * 5 = 2.88Mb, 3.5'' (such diskettes already are not used)

    For example, for the standard configuration from one 1.44-drive here will

    be 40h, and for a case 1.2Mb on A: and 1.44Mb on B: the value appears 24h.

  * +1: byte: information about hard disks and CD - drives, AABBCCDD,

    where AA corresponds to the controller IDE0, ..., DD - IDE3:

    * 0 = device is absent

    * 1 = hard disk

    * 2 = CD - drive

    For example, in a case HD on IDE0 and CD on IDE2 here will be 48h.

  * +2: 4 db: Number of the retrieved sections on hard disks with

    accordingly IDE0..., IDE3.

    At absence of the hard disk on IDEx appropriate byte zero, at presence

    shows number of the recognized partitions, which can and to not be (if the

    drive is not formatted or if the file system is not supported). In the

    current version of a kernel for hard disks are supported only FAT16

    and FAT32.

  * +6: 4 db: reserved

Format of the table: the complete version:

  * +0: 10 db: same, as well as in the short version

  * +10: 100 db: data for the first partition

  * +110: 100 db: data for the second partition

  * ...

  * +10+100*(n-1): 100 db: data for the last partition

The sections are located in the following order: at first sequentially all

recognized partitions on HD on IDE0 (if are), then on HD on IDE1 (if is)

etc. up to IDE3.

Format of the information about partition (while is supported only FAT):

  * +0: dword: first physical sector of the partition

  * +4: dword: last physical sector of the partition

    (belongs to partition)

  * +8: dword: sectors in one copy FAT

  * +12 = +0xC: dword: number of copies FAT

  * +16 = +0x10: dword: number of sectors in a cluster

  * +20 = +0x14: dword: byte in sector; the current implementation expects,

    that here 0x200 = 512

  * +24 = +0x18: dword: first cluster of the root in FAT32, 0 for FAT16

  * +28 = +0x1C: dword: first physical sector FAT

  * +32 = +0x20: dword: first physical sector of the root for FAT16,

    is ignored for FAT32

  * +36 = +0x24: dword: number of sectors in the root for FAT16, 0 for FAT32

  * +40 = +0x28: dword: physical sector of a beginning of area of the data

  * +44 = +0x2C: dword: maximum number of a cluster

  * +48 = +0x30: dword: physical sector of the information about a file system

    for FAT32, is ignored for FAT16

  * +52 = +0x34: dword: value used as boundary of special values in FAT

  * +56 = +0x38: dword: value used for bad clusters in FAT

  * +60 = +0x3C: dword: Value used as the end mark at recording of a chain

    in FAT

  * +64 = +0x40: dword: mask superimposed on a unit FAT

  * +68 = +0x44: byte: type of a file system: 16 or 32

  * +69 = +0x45: 31 db: reserved

Remarks:

  * Short table can be used for obtaining the information about available

    devices.

  * First two information fields about partition in the complete version of

    the table inform parameters of the unit which has stayed - parameters of

    a file system FAT. For other file systems (when they will be supported)

    information, specific to a file system, naturally, there will be another,

    but first two fields will be saved constant.

======================================================================

======== Function 18, subfunction 13 - get version of a kernel. ======

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 13 - number subfunction

  * ecx = pointer on the buffer (not less than 16 bytes), where the

    information will be placed

Returned value:

  * function does not return value

Structure of the buffer:

db a,b,c,d for version a.b.c.d

db UID_xxx: one of UID_NONE=0, UID_MENUET=1, UID_KOLIBRI=2

db 'name',0 - ASCIIZ-string with a name

For kernel Kolibri 0.5.8.1:

db 0,5,8,1

db 2

db 'Kolibri',0

=========================================================================

====================== Function 18, subfunction 14 ======================

= Expect a beginning of retrace of a ray of scanning of screen monitor. =

=========================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 14 - number subfunction

Returned value:

  * eax = 0 as tag of success

Remarks:

  * Function is intended only for the active high-efficiency graphics

    applications; is used for smooth output of a graphics.

============================================================================

= Function 18, subfunction 15 - place a mouse pointer in centre of screen. =

============================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 15 - number subfunction

Returned value:

  * eax = 0 as tag of success

======================================================================

====================== Function 18, subfunction 16 ===================

====================== Get a size of the free RAM. ===================

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 16 - number subfunction

Returned value:

  * eax = size of free memory in kilobytes

======================================================================

====================== Function 18, subfunction 17 ===================

====================== Get a size of the amount RAM. =================

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 17 - number subfunction

Returned value:

  * eax = common size of amount memory in kilobytes

======================================================================

====================== Function 18, subfunction 18 ===================

============= complete process/thread on the identifier. =============

======================================================================

Parameters:

  * eax = 18 - number of the function

  * ebx = 18 - number subfunction

  * ecx = identifier of process/thread (PID/TID)

Returned value:

  * eax = 0 - successfully

  * eax = -1 - error (the process is not retrieved or is system)

Remarks:

  * It is impossible to complete thread of an operating system OS/IDLE

   (number of the slot 1), it is possible to complete any usual thread/process.

  * See also subfunction 2 - completion of process / thread on the given slot.

======================================================================

============ Function 19 - start application with ramdisk. ===========

======================================================================

Parameters:

  * eax = 19 - number of the function

  * ebx = pointer on an application name in format similar to function 6

  * ecx = 0 or ecx = the pointer on parameters of the command line

Returned value:

  * If eax > 0, eax contains PID of the created process

  * If eax < 0, -eax - error code of a file system

Remarks:

  * This function is obsolete; use subfunction 7 functions 70.

  * Command line should be ended by the character with the code 0

    (ASCIIZ-strings); it are taken into account or all characters up to

    completing zero inclusively, or the first 256 characters, that are less.

======================================================================

==================== Function 20 - interface MIDI. ===================

======================================================================

------------------------ Subfunction 1 - reset ------------------------

Parameters:

  * eax = 20 - number of the function

  * ebx = 1 - number subfunction

-------------------- Subfunction 2 - output byte ---------------------

Parameters:

  * eax = 20 - number of the function

  * ebx = 2 - number subfunction

  * cl = byte for output

Returned value (is identical to both subfunctions):

  * eax = 0 - successfully

  * eax = 1 - base port is not defined

Remarks:

  * Base port previously should be defined by call

    subfunction of 1 function 21.

======================================================================

==== Function 21, subfunction 1 - install a base port MPU MIDI. ======

======================================================================

Parameters:

  * eax = 21 - number of the function

  * ebx = 1 - number subfunction

  * ecx = number of a base port

Returned value:

  * eax = 0 - successfully

  * eax = -1 - erratic number of a port

Remarks:

  * Number of a port should satisfy to conditions 0x100<=ecx<=0xFFFF.

  * Installation of base is necessary for operation of the function 20.

  * Get installed base port it is possible by call

    subfunction of 1 function 26.

======================================================================

======== Function 21, subfunction 2 - install keyboard layout. =======

======================================================================

Keyboard layout is used for conversion scancodes, acting from the keyboard,

in ASCII-codes which were read - out by the function 2.

Parameters:

  * eax = 21 - number of the function

  * ebx = 2 - number subfunction

  * ecx = what layout to install:

    * 1 = normal layout

    * 2 = layout at pressed Shift

    * 3 = layout at pressed Alt

  * edx = pointer on layout - table of length 128 bytes

Or:

  * ecx = 9

  * dx = identifier of the country (1=eng, 2=fi, 3=ger, 4=rus)

Returned value:

  * eax = 0 - successfully

  * eax = 1 - parameter is given incorrectly

Remarks:

  * If is pressed Alt, the layout with Alt is used; if not is pressed Alt,

    but is pressed Shift, the layout with Shift is used; if not are

    pressed Alt and Shift, but is pressed Ctrl, the normal layout is used,

    then from the code is subtracted 0x60; if not any of direction keys

    is pressed, the normal layout is used.

  * get layouts and identifier of the country it is possible with the help

    subfunction 2 functions 26.

  * The identifier of the country - global environment variable, which by

    kernel is not used; however application @panel displays an icon,

    appropriate to the current country.

  * Application @panel switches layouts on search of the user.

======================================================================

=========== Function 21, subfunction 3 - install base CD. ============

======================================================================

Parameters:

  * eax = 21 - number of the function

  * ebx = 3 - number subfunction

  * ecx = base CD: 1=IDE0, 2=IDE1, 3=IDE2, 4=IDE3

Returned value:

  * eax = 0

Remarks:

  * Base CD is used by the function 24.

  * Receive the installed base CD it is possible by call

    subfunction 3 functions 26.

======================================================================

=== Function 21, subfunction 4 - install base port Sound Blaster. ====

======================================================================

Parameters:

  * eax = 21 - number of the function

  * ebx = 4 - number subfunction

  * ecx = number base port

Returned value:

  * eax = 0 - successfully

  * eax = -1 - erratic number of a port

Remarks:

  * Number of a port should satisfy to conditions 0x100<=ecx<=0xFFFF.

  * Installation of base is necessary for operation of functions 25, 28, 55.

  * Get installed base port it is possible by call subfunction 4 functions 26.

======================================================================

==== Function 21, subfunction 5 - install the language of system. ====

======================================================================

Parameters:

  * eax = 21 - number of the function

  * ebx = 5 - number subfunction

  * ecx = language of system (1=eng, 2=fi, 3=ger, 4=rus)

Returned value:

  * eax = 0

Remarks:

  * Language of the system - global environment variable in any way which

    is not used by kernel, however application @panel draws

    an appropriate icon.

  * Checks on a correctness is not done, as the kernel this variable

    does not use.

  * Get language of the system it is possible by call

    subfunction 5 functions 26.

======================================================================

========= Function 21, subfunction 6 - install base port WSS. ========

======================================================================

Parameters:

  * eax = 21 - number of the function

  * ebx = 6 - number subfunction

  * ecx = base port

Returned value:

  * eax = 0 - successfully

  * eax = -1 - erratic number of a port

Remarks:

  * Number of a port should satisfy to conditions 0x100<=ecx.

  * Base WSS is used by the function 27.

  * Get installed base port WSS it is possible by call

    subfunction 6 functions 26.

======================================================================

=========== Function 21, subfunction 7 - install base HD. ============

======================================================================

The base HD is necessary for definition, on what hard disk to write, at usage

of out-of-date functions of operation with a file system and functions

implicitly using the hard disk (such as subfunction of 6 functions 18);

At usage of functions 58 and 70 and modern syntax /HD0, /HD1, /HD2, /HD3

these functions install base.

Parameters:

  * eax = 21 - number of the function

  * ebx = 7 - number subfunction

  * ecx = base HD: 1=IDE0, 2=IDE1, 3=IDE2, 4=IDE3

Returned value:

  * eax = 0

Remarks:

  * Any application at any moment of time can change base.

  * It is not necessary to change base, when any application works

    with the hard disk. If not want errors of the system.

  * Get installed base it is possible by call subfunction 7 functions 26.

  * It is necessary also to define used partition of

    the hard disk subfunction 8.

======================================================================

========= Function 21, subfunction 8 - install partition HD. =========

======================================================================

The section HD is necessary for definition, on what partition of the hard disk

to write, at usage of out-of-date functions of operation with a file system and

functions implicitly using the hard disk (such as subfunction of 6 functions

18); at usage of functions 58 and 70 and modern syntax /HD0, /HD1, /HD2, /HD3

these functions install base and partition.

Parameters:

  * eax = 21 - number of the function

  * ebx = 8 - number subfunction

  * ecx = partition HD (beginning from 1)

Returned value:

  * eax = 0

Remarks:

  * Any application at any moment of time can change partition.

  * It is not necessary to change partition, when any application works

    with the hard disk. If not want errors of the system.

  * Get installed partition it is possible by call subfunction 8 functions 26.

  * Checks on a correctness is not done.

  * Find out number of partitions on the hard disk it is possible by call

    subfunction 11 functions 18.

  * It is necessary also to define used base of the hard disk subfunction 7

======================================================================

=== Function 21, subfunction 10 - install channel DMA for a sound. ===

======================================================================

Parameters:

  * eax = 21 - number of the function

  * ebx = 10 - number subfunction

  * ecx = number of channel (from 0 up to 3 inclusively)

Returned value:

  * eax = 0 - successfully

  * eax = -1 - incorrect number of the channel

Remarks:

  * Number of the channel DMA is used in subfunction of 1 function 55.

  * Get channel DMA for a sound it is possible by call

    subfunction 10 functions 26.

======================================================================

====================== Function 21, subfunction 11 ===================

=============== Permit/prohibit low level access to HD. ==============

======================================================================

Parameters:

  * eax = 21 - number of the function

  * ebx = 11 - number subfunction

  * ecx = 0/1 - prohibit/permit

Returned value:

  * eax = 0

Remarks:

  * Is used at LBA-reading (subfunction 8 functions 58).

  * Current realization uses only low bit ecx.

  * Get a current status it is possible by call subfunction 11 functions 26.

======================================================================

====================== Function 21, subfunction 12 ===================

============= Permit/prohibit low level access to PCI. ===============

======================================================================

Parameters:

  * eax = 21 - number of the function

  * ebx = 12 - number subfunction

  * ecx = 0/1 - prohibit/permit

Returned value:

  * eax = 0

Remarks: