Ethersel must use the pci com32 module instead of builtin pci detection code
[syslinux.git] / comboot.doc
blob92852012de380a6e4fe48e39476c8cd69af8f6cc
2                        COMBOOT and COM32 files
5 SYSLINUX supports simple standalone programs, using a file format
6 similar to DOS ".com" files.  A 32-bit version, called COM32, is also
7 provided.  A simple API provides access to a limited set of filesystem
8 and console functions.
11         ++++ COMBOOT file format ++++
13 A COMBOOT file is a raw binary file containing 16-bit code.  It should
14 be linked to run at offset 0x100, and contain no absolute segment
15 references.  It is run in 16-bit real mode.
17 A COMBOOT image can be written to be compatible with MS-DOS.  Such a
18 file will usually have extension ".com".  A COMBOOT file which is not
19 compatible with MS-DOS will usually have extension ".cbt".
21 Before running the program, SYSLINUX sets up the following fields in
22 the Program Segment Prefix (PSP), a structure at offset 0 in the
23 program segment:
25  Offset Size    Meaning
26  0      word    Contains an INT 20h instruction
27  2      word    Contains the paragraph (16-byte "segment" address) at
28                 the end of memory available to the program.
29  128    byte    Length of the command line arguments, including the leading
30                 space but not including the final CR character.
31  129    127b    Command line arguments, starting with a space and ending
32                 with a CR character (ASCII 13).
34 The program is allowed to use memory between the PSP paragraph (which
35 all the CS, DS, ES and SS registers point to at program start) and the
36 paragraph value given at offset 2.
38 On startup, SP is set up to point to the end of the 64K segment, at
39 0xfffe.  Under DOS it is possible for SP to contain a smaller
40 value if memory is very tight; this is never the case under SYSLINUX.
42 The program should make no assumptions about what segment address it
43 will be loaded at; instead it should look at the segment registers on
44 program startup.  Both DOS and SYSLINUX will guarantee CS == DS == ES
45 == SS on program start; the program should not assume anything about
46 the values of FS or GS.
48 To exit, a program can either execute a near RET (which will jump to
49 offset 0 which contains an INT 20h instruction, terminating the
50 program), or execute INT 20h or INT 21h AH=00h or INT 21h AH=4Ch.
51 If compatiblity with SYSLINUX 1.xx is desired, use INT 20h.
54         ++++ COM32 file format ++++
56 A COM32 file is a raw binary file containing 32-bit code.  It should
57 be linked to run at address 0x101000, and should not contain any
58 segment references.  It will be run in flat-memory 32-bit protected
59 mode.  Under SYSLINUX, it will be run in CPL 0, however, since it may
60 be possible to create a COM32 execution engine that would run under
61 something like Linux DOSEMU, it is recommended that the code does not
62 assume CPL 0 unless absolutely necessary.
64 It is highly recommended that every COM32 program begins with the byte
65 sequence B8 FF 4C CD 21 (mov eax,21cd4cffh) as a magic number.
67 A COM32 file should have extension ".c32".
69 On startup, CS will be set up as a flat 32-bit code segment, and DS ==
70 ES == SS will be set up as the equivalent flat 32-bit data segment.
71 FS and GS are reserved for future use and are currently initialized to
72 zero.  A COM32 image should not assume any particular values of
73 segment selectors.
75 ESP is set up at the end of available memory and also serves as
76 notification to the program how much memory is available.
78 The following arguments are passed to the program on the stack:
80  Address  Size  Meaning
81  [ESP]    dword Return (termination) address
82  [ESP+4]  dword Number of additional arguments (currently 5)
83  [ESP+8]  dword Pointer to the command line arguments (null-terminated string)
84  [ESP+12] dword Pointer to INT call helper function
85  [ESP+16] dword Pointer to low memory bounce buffer
86  [ESP+20] dword Size of low memory bounce buffer
87  [ESP+24] dword Pointer to FAR call helper function (new in 2.05)
89 This corresponds to the following C prototype, available in the file
90 com32/include/com32.h:
92 /* The standard prototype for _start() */
93 int _start(unsigned int __nargs,
94            char *__cmdline,
95            void (*__intcall)(uint8_t, com32sys_t *, com32sys_t *),
96            void *__bounce_ptr,
97            unsigned int __bounce_len,
98            void (*__farcall)(uint32_t, uint16_t, com32sys_t *, com32sys_t *));
100 The intcall helper function can be used to issue BIOS or SYSLINUX API
101 calls, and takes the interrupt number as first argument.  The second
102 argument is a pointer to the input register definition, an instance of
103 the following structure (also available in com32.h):
105 typedef union {
106   uint32_t l;
107   uint16_t w[2];
108   uint8_t  b[4];
109 } reg32_t;
111 typedef struct {
112   uint16_t gs;                  /* Offset  0 */
113   uint16_t fs;                  /* Offset  2 */
114   uint16_t es;                  /* Offset  4 */
115   uint16_t ds;                  /* Offset  6 */
117   reg32_t edi;                  /* Offset  8 */
118   reg32_t esi;                  /* Offset 12 */
119   reg32_t ebp;                  /* Offset 16 */
120   reg32_t _unused;              /* Offset 20 */
121   reg32_t ebx;                  /* Offset 24 */
122   reg32_t edx;                  /* Offset 28 */
123   reg32_t ecx;                  /* Offset 32 */
124   reg32_t eax;                  /* Offset 36 */
126   reg32_t eflags;               /* Offset 40 */
127 } com32sys_t;
129 The third argument is a pointer to the output register definition, an
130 instance of the same structure.  The third argument can also be zero
131 (NULL).
133 Since BIOS or SYSLINUX API calls can generally only manipulate data
134 below address 0x100000, a "bounce buffer" in low memory, at least 64K
135 in size, is available, to copy data in and out.
137 The farcall helper function behaves similarly, but takes as its first
138 argument the CS:IP (in the form (CS << 16) + IP) of procedure to be
139 invoked via a FAR CALL.
142         ++++ SYSLINUX API CALLS +++
144 SYSLINUX provides the following API calls.  SYSLINUX 1.xx only
145 supported INT 20h - terminate program. [] indicates the first version
146 of SYSLINUX which supported this feature (correctly.)
148 NOTE: Most of the API functionality is still experimental.  Expect to
149 find bugs.
152         ++++ DOS-COMPATIBLE API CALLS ++++
154 INT 20h         [1.48] Terminate program
155 INT 21h AH=00h  [2.00] Terminate program
156 INT 21h AH=4Ch  [2.00] Terminate program
158         All of these terminate the program.
161 INT 21h AH=01h  [2.01] Get Key with Echo
163         Reads a key from the console input, with echo to the console
164         output.  The read character is returned in AL.  Extended
165         characters received from the keyboard are returned as NUL (00h)
166         + the extended character code.
169 INT 21h AH=02h  [2.01] Write Character
171         Writes a character in DL to the console (video and serial)
172         output.
175 INT 21h AH=04h  [2.01] Write Character to Serial Port
177         Writes a character in DL to the serial console output
178         (if enabled.)  If no serial port is configured, this routine
179         does nothing.
182 INT 21h AH=08h  [2.09] Get Key without Echo
184         Reads a key fron the console input, without echoing it to the
185         console output.  The read character is returned in AL.
188 INT 21h AH=09h  [2.01] Write DOS String to Console
190         Writes a DOS $-terminated string in DS:DX to the console.
193 INT 21h AH=0Bh  [2.00] Check Keyboard
195         Returns AL=FFh if there is a keystroke waiting (which can then
196         be read with INT 21h, AH=01h or AH=08h), otherwise AL=00h.
199 INT 21h AH=30h  [2.00] Check DOS Version
201         This function returns AX=BX=CX=DX=0, corresponding to a
202         hypothetical "DOS 0.0", but the high parts of EAX-EBX-ECX-EDX
203         spell "SYSLINUX":
205         EAX=59530000h EBX=4C530000h ECX=4E490000h EDX=58550000h
207         This function can thus be used to distinguish running on
208         SYSLINUX from running on DOS.
211         ++++ SYSLINUX-SPECIFIC API CALLS ++++
213 SYSLINUX-specific API calls are executed using INT 22h, with a
214 function number in AX.  INT 22h is used by DOS for internal purposes;
215 do not execute INT 22h under DOS.
217 DOS-compatible function INT 21h, AH=30h can be used to detect if the
218 SYSLINUX API calls are available.
220 Any register not specifically listed as modified is preserved;
221 however, future versions of SYSLINUX may add additional output
222 registers to existing calls.
224 All calls return CF=0 on success, CF=1 on failure.  The noted outputs
225 apply if CF=0 only unless otherwise noted.  All calls clobber the
226 arithmetric flags (CF, PF, AF, ZF, SF and OF) but leave all other
227 flags unchanged unless otherwise noted.
230 AX=0001h [2.00] Get Version
232         Input:  AX      0001h
233         Output: AX      number of INT 22h API functions available
234                 CH      SYSLINUX major version number
235                 CL      SYSLINUX minor version number
236                 DL      SYSLINUX derivative ID (e.g. 32h = PXELINUX)
237                 ES:SI   SYSLINUX version string
238                 ES:DI   SYSLINUX copyright string
240         This API call returns the SYSLINUX version and API
241         information.
244 AX=0002h [2.01] Write String
246         Input:  AX      0002h
247                 ES:BX   null-terminated string
248         Output: None
250         Writes a null-terminated string on the console.
253 AX=0003h [2.01] Run command
255         Input:  AX      0003h
256                 ES:BX   null-terminated command string
257         Output: Does not return
259         This API call terminates the program and executes the command
260         string as if the user had entered it at the SYSLINUX command
261         line.  This API call does not return.
264 AX=0004h [2.01] Run default command
266         Input:  AX      0004h
267         Output: Does not return
269         This API call terminates the program and executes the default
270         command string as if the user had pressed Enter alone on the
271         SYSLINUX command line.  This API call does not return.
274 AX=0005h [2.00] Force text mode
276         Input:  AX      0005h
277         Output: None
279         If the screen was in graphics mode (due to displaying a splash
280         screen using the <Ctrl-X> command in a message file, or
281         similar), return to text mode.
284 AX=0006h [2.08] Open file
286         Input:  AX      0006h
287                 ES:SI   null-terminated filename
288         Output: SI      file handle
289                 EAX     length of file in bytes
290                 CX      file block size
292         Open a file for reading.  The exact syntax of the filenames
293         allowed depends on the particular SYSLINUX derivative.
295         The SYSLINUX file system is block-oriented.  The size of a
296         block will always be a power of two and no greater than 16K.
298         Note: SYSLINUX considers a zero-length file to be nonexistent.
301 AX=0007h [2.08] Read file
303         Input:  AX      0007h
304                 SI      file handle
305                 ES:BX   buffer
306                 CX      number of blocks to read
307         Output: SI      file handle, or 0 if EOF was reached
309         Read blocks from a file.  Note that the file handle that is
310         returned in SI may not be the same value that was passed in.
312         If end of file was reached (SI=0), the file was automatically
313         closed.
315         The address of the buffer (ES:BX) should be at least 512-byte
316         aligned.  SYSLINUX guarantees at least this alignment for the
317         COMBOOT load segment or the COM32 bounce buffer.
319         Keep in mind that a "file" may be a TFTP connection, and that
320         leaving a file open for an extended period of time may result
321         in a timeout.
323         WARNING: Calling this function with an invalid file handle
324         will probably crash the system.
327 AX=0008h [2.08] Close file
329         Input:  AX      0008h
330                 SI      file handle
331         Output: None
333         Close a file before reaching the end of file.
335         WARNING: Calling this function with an invalid file handle
336         will probably crash the system.
339 AX=0009h [2.00] Call PXE Stack [PXELINUX ONLY]
341         Input:  AX      0009h
342                 BX      PXE function number
343                 ES:DI   PXE parameter structure buffer
344         Output: AX      PXE return status code
346         Invoke an arbitrary PXE stack function.  On SYSLINUX/ISOLINUX,
347         this function returns with an error (CF=1) and no action is
348         taken.  On PXELINUX, this function always returns with CF=0
349         indicating that the PXE stack was successfully invoked; check
350         the status code in AX and in the first word of the data buffer
351         to determine if the PXE call succeeded or not.
353         The PXE stack will have the UDP stack OPEN; if you change that
354         you cannot call any of the file-related API functions, and
355         must restore UDP OPEN before returning to PXELINUX.
357         PXELINUX reserves UDP port numbers from 49152 to 65535 for its
358         own use; port numbers below that range is available.
361 AX=000Ah [2.00] Get Derivative-Specific Information
363         [SYSLINUX, EXTLINUX]
364         Input:  AX      000Ah
365                 CL      9 (to get a valid return in CL for all versions)
366         Output: AL      31h (SYSLINUX), 34h (EXTLINUX)
367                 DL      drive number
368                 CL      sector size as a power of 2 (9 = 512 bytes) [3.35]
369                 ES:BX   pointer to partition table entry (if DL >= 80h)
371                 Note: This function was broken in EXTLINUX 3.00-3.02.
374         [PXELINUX]
375         Input:  AX      000Ah
376         Output: AL      32h (PXELINUX)
377                 DX      PXE API version detected (DH=major, DL=minor)
378                 ES:BX   pointer to PXENV+ or !PXE structure
379                 FS:SI   pointer to original stack with invocation record
381                 Note: DX notes the API version detected by PXELINUX,
382                 which may be more conservative than the actual version
383                 available.  For exact information examine the API
384                 version entry in the PXENV+ structure, or the API
385                 version entries in the ROMID structures pointed from
386                 the !PXE structure.
388                 PXELINUX will use, and provide, the !PXE structure
389                 over the PXENV+ structure.  Examine the structure
390                 signature to determine which particular structure was
391                 provided.
393                 The FS:SI pointer points to the top of the original stack
394                 provided by the PXE stack, with the following values
395                 pushed at the time PXELINUX is started:
397                 [fs:si+0]       GS              <- top of stack
398                 [fs:si+2]       FS
399                 [fs:si+4]       ES
400                 [fs:si+6]       DS
401                 [fs:si+8]       EDI
402                 [fs:si+12]      ESI
403                 [fs:si+16]      EBP
404                 [fs:si+20]      -
405                 [fs:si+24]      EBX
406                 [fs:si+28]      EDX
407                 [fs:si+32]      ECX
408                 [fs:si+36]      EAX
409                 [fs:si+40]      EFLAGS
410                 [fs:si+44]      PXE return IP   <- t.o.s. when PXELINUX invoked
411                 [fs:si+46]      PXE return CS
414         [ISOLINUX]
415         Input:  AX      000Ah
416         Output: AL      33h (ISOLINUX)
417                 DL      drive number
418                 CL      11 (sector size as a power of 2) [3.35]
419                 ES:BX   pointer to El Torito spec packet
421                 Note: Some very broken El Torito implementations do
422                 not provide the spec packet information.  If so, ES:BX
423                 may point to all zeroes or to garbage.  Call INT 13h,
424                 AX=4B01h to obtain the spec packet directly from the
425                 BIOS if necessary.
427         This call gives information specific to a particular SYSLINUX
428         derivative.  The value returned in AL is the same as is
429         returned in DL by INT 22h AX=0001h.
432 AX=000Bh [2.00] Get Serial Console Configuration
434         Input:  AX      000Bh
435         Output: DX      serial port I/O base (e.g. 3F8h = COM1...)
436                 CX      baud rate divisor (1 = 115200 bps, 2 = 57600 bps...)
437                 BX      flow control configuration bits (see syslinux.doc)
438                         -> bit 15 is set if the video console is disabled
440         If no serial port is configured, DX will be set to 0 and the
441         other registers are undefined.
444 AX=000Ch [2.00] Perform final cleanup
445         Input:  AX      000Ch
446                 DX      derivative-specific flags (0000h = clean up all)
447         Output: Does not return
449         This routine performs any "final cleanup" the boot loader
450         would normally perform before loading a kernel, such as
451         unloading the PXE stack in the case of PXELINUX.  AFTER
452         INVOKING THIS CALL, NO OTHER API CALLS MAY BE INVOKED, NOR MAY
453         THE PROGRAM TERMINATE AND RETURN TO THE BOOT LOADER.  This
454         call basically tells the boot loader "get out of the way, I'll
455         handle it from here."
457         For COM32 images, the boot loader will continue to provide
458         interrupt and BIOS call thunking services as long its memory
459         areas (0x0800-0xffff, 0x100000-0x100fff) are not overwritten.
460         MAKE SURE TO DISABLE INTERRUPTS, AND INSTALL NEW GDT AND IDTS
461         BEFORE OVERWRITING THESE MEMORY AREAS.
463         The permissible values for DX is an OR of these values:
465         SYSLINUX:       0000h   Normal cleanup
467         PXELINUX:       0000h   Normal cleanup
468                         0003h   Keep UNDI and PXE stacks loaded
470         ISOLINUX:       0000h   Normal cleanup
472         EXTLINUX:       0000h   Normal cleanup
474         All other values are undefined, and may have different
475         meanings in future versions of SYSLINUX.
478 AX=000Dh [2.08] Cleanup and replace bootstrap code
479         Input:  AX      000Dh
480                 DX      derivative-specific flags (see previous function)
481                 EDI     bootstrap code (linear address, can be in high memory)
482                 ECX     bootstrap code length in bytes (must fit in low mem)
483                 EBX(!)  initial value of EDX after bootstrap
484                 ESI     initial value of ESI after bootstrap
485                 DS      initial value of DS after bootstrap
486         Output: Does not return
488         This routine performs final cleanup, then takes a piece of
489         code, copies it over the primary bootstrap at address 7C00h,
490         and jumps to it.  This can be used to chainload boot sectors,
491         MBRs, bootstraps, etc.
493         Normal boot sectors expect DL to contain the drive number,
494         and, for hard drives (DL >= 80h) DS:SI to contain a pointer to
495         the 16-byte partition table entry.  The memory between
496         600h-7FFh is available to put the partition table entry in.
498         For PXELINUX, if the PXE stack is not unloaded, all registers
499         (except DS, ESI and EDX) and the stack will be set up as they
500         were set up by the PXE ROM.
503 AX=000Eh [2.11] Get configuration file name
504         Input:  AX      0000Eh
505         Output: ES:BX   null-terminated file name string
507         Returns the name of the configuration file.  Note that it is
508         possible that the configuration file doesn't actually exist.
511 AX=000Fh [3.00] Get IPAPPEND strings [PXELINUX]
512         Input:  AX      000Fh
513         Output: CX      number of strings (currently 2)
514                 ES:BX   pointer to an array of NEAR pointers in
515                         the same segment, one for each of the above
516                         strings
518         Returns the same strings that the "ipappend" option would have
519         added to the command line, one for each bit of the "ipappend"
520         flag value, so entry 0 is the "ip=" string and entry 1 is the
521         "BOOTIF=" string.
524 AX=0010h [3.00] Resolve hostname [PXELINUX]
525         Input:  ES:BX   pointer to null-terminated hostname
526         Output: EAX     IP address of hostname (zero if not found)
528         Queries the DNS server(s) for a specific hostname.  If the
529         hostname does not contain a dot (.), the local domain name
530         is automatically appended.
532         This function only return CF=1 if the function is not
533         supported.  If the function is supported, but the hostname did
534         not resolve, it returns with CF=0, EAX=0.
536         The IP address is returned in network byte order, i.e. if the
537         IP address is 1.2.3.4, EAX will contain 0x04030201.  Note that
538         all uses of IP addresses in PXE are also in network byte order.
541 AX=0011h [3.05] Maximum number of shuffle descriptors
542         Input:  AX      0011h
543         Output: CX      maximum number of descriptors
545         This routine reports the maximum number of shuffle descriptors
546         permitted in a call to function 0012h.
548         Typical values are 682 and 1365.
551 AX=0012h [3.05] Cleanup, shuffle and boot
552         Input:  AX      0012h
553                 DX      derivative-specific flags (see previous function)
554                 ES:DI   shuffle descriptor list (must be in low memory)
555                 CX      number of shuffle descriptors
556                 EBX(!)  initial value of EDX after bootstrap
557                 ESI     initial value of ESI after bootstrap
558                 DS      initial value of DS after bootstrap
559                 EBP     CS:IP of routine to jump to
560         Output: Does not return
561                 (if CX is too large the routine returns with CF=1)
563         This routine performs final cleanup, then performs a sequence
564         of copies, and jumps to a specified real mode entry point.
565         This is a more general version of function 000Dh, which can
566         also be used to load other types of programs.
568         The copies must not touch memory below address 7C00h.
570         ES:DI points to a list of CX descriptors each of the form:
572                 Offset  Size    Meaning
573                  0      dword   destination address
574                  4      dword   source address
575                  8      dword   length in bytes
577         The copies are overlap-safe, like memmove().
579         Normal boot sectors expect DL to contain the drive number,
580         and, for hard drives (DL >= 80h) DS:SI to contain a pointer to
581         the 16-byte partition table entry.  The memory between
582         600h-7FFh is available to put the partition table entry in.
584         For PXELINUX, if the PXE stack is not unloaded, all registers
585         (except DS, ESI and EDX) and the stack will be set up as they
586         were set up by the PXE ROM.
589 AX=0013h [3.08] Idle loop call
590         Input:  AX      0013h
591         Output: None
593         Call this routine while sitting in an idle loop.  It performs
594         any periodic activities required by the filesystem code.  At
595         the moment, this is a no-op on all derivatives except
596         PXELINUX, where it executes PXE calls to answer ARP queries.
598         Starting with version 3.10, this API call harmlessly returns
599         failure (CF=1) if invoked on a platform which does not need
600         idle calls.  Additionally, it's safe to call this API call on
601         previous SYSLINUX versions (2.00 or later); it will just
602         harmlessly fail.  Thus, if this call returns failure (CF=1),
603         it means that there is no technical reason to call this
604         function again, although doing so is of course safe.
607 AX=0014h [3.10] Local boot [PXELINUX, ISOLINUX]
608         Input:  AX      0014h
609                 DX      Local boot parameter
610         Output: Does not return
612         This function invokes the equivalent of the "localboot"
613         configuration file option.  The parameter in DX is the same
614         parameter as would be entered after "localboot" in the
615         configuration file; this parameter is derivative-specific --
616         see syslinux.doc for the definition.
619 AX=0015h [3.10] Get feature flags
620         Input:  AX      0015h
621         Output: ES:BX   pointer to flags in memory
622                 CX      number of flag bytes
624         This function reports whether or not this SYSLINUX version and
625         derivative supports specific features.  Keep in mind that
626         future versions might have more bits; remember to treat any
627         bits beyond the end of the array (as defined by the value in
628         CX) as zero.
630         Currently the following feature flag is defined:
632         Byte    Bit     Definition
633         ----------------------------------------------------
634         0       0       Local boot (AX=0014h) supported
635                 1       Idle loop call (AX=0013h) is a no-op
637         All other flags are reserved.
640 AX=0016h [3.10] Run kernel image
641         Input:  AX      0016h
642                 DS:SI   Filename of kernel image (zero-terminated string)
643                 ES:BX   Command line (zero-terminated string)
644                 ECX     IPAPPEND flags [PXELINUX]
645                 EDX     Type of file (since 3.40)
646         Output: Does not return if successful; returns with CF=1 if
647                 the kernel image is not found.
649         This function is similiar to AX=0003h Run command, except that
650         the filename and command line are treated as if specified in a
651         KERNEL and APPEND statement of a LABEL statement, which means:
653         - The filename has to be exact; no variants are tried;
654         - No global APPEND statement is applied;
655         - ALLOWOPTIONS and IMPLICIT statements in the configuration
656           file do not apply.  It is therefore important that the
657           COMBOOT module doesn't allow the end user to violate the
658           intent of the administrator.
660         Additionally, this function returns with a failure if the file
661         doesn't exist, instead of returning to the command line.  (It
662         may still return to the command line if the image is somehow
663         corrupt, however.)
665         The file types are defined as follows:
667                     Equivalent
668         EDX     Config  Extensions      Type of file    
669         0       KERNEL                  Determined by filename extension
670         1       LINUX   none            Linux kernel image
671         2       BOOT    .bs .bin        Bootstrap program
672         3       BSS     .bss            Boot sector with patch [SYSLINUX]
673         4       PXE     .0              PXE Network Bootstrap Prog [PXELINUX]
674         5       FDIMAGE .img            Floppy disk image [ISOLINUX]
675         6       COMBOOT .com .cbt       16-bit COMBOOT program
676         7       COM32   .c32            COM32 program
677         8       CONFIG                  Configuration file
680 AX=0017h [3.30] Report video mode change
681         Input:  AX      0017h
682                 BX      Video mode flags
683                         Bit 0:  graphics mode
684                         Bit 1:  non-default mode
685                         Bit 2:  VESA mode
686                         Bit 3:  text functions not supported
687                 CX      For graphics modes, pixel columns
688                 DX      For graphics modes, pixel rows
689         Output: None
691         This function is used to report video mode changes to
692         SYSLINUX.  It does NOT actually change the video mode, but
693         rather, allows SYSLINUX to take appropriate action in response
694         to a video mode change.  Modes that cannot be exited either
695         with the conventional BIOS mode set command (INT 10h, AH=00h)
696         or the VESA VBE mode set command (INT 10h, AX=4F02h) should
697         not be used.
699         This function returns with a failure if BX contains any bits
700         which are undefined in the current version of SYSLINUX.
702         The following bits in BX are currently defined:
704         Bit 0: graphics mode
706                 Indicates that the mode is a graphics mode, as opposed
707                 to a text mode.
709         Bit 1: non-standard mode
711                 A non-standard mode is any mode except text mode and
712                 graphics mode 0012h (VGA 640x480, 16 color.)
714         Bit 2: VESA mode
716                 This mode is a VESA mode, and has to be exited with
717                 the VESA VBE API (INT 10h, AX=4F02h) as opposed to the
718                 conventional BIOS API (INT 10h, AH=00h).
720         Bit 3: Text functions not supported
722                 This indicates that the BIOS text output functions
723                 (INT 10h, AH=02h, 03h, 06h, 09h, 0Eh, 11h) don't work.
724                 If this bit is set, SYSLINUX will reset the mode
725                 before printing any characters on the screen.
727                 This is common for VESA modes.
730 AX=0018h [3.30] Query custom font
731         Input:  AX      0018h
732         Output: AL      Height of custom font in scan lines, or zero
733                 ES:BX   Pointer to custom font in memory
735         This call queries if a custom display font has been loaded via
736         the "font" configuration file command.  If no custom font has
737         been loaded, AL contains zero.
740 AX=0019h [3.40] Read disk [SYSLINUX, ISOLINUX, EXTLINUX]
741         Input:  AX      0019h
742                 EDX     Sector number
743                 ESI     Reserved - MUST BE ZERO
744                 EDI     Reserved - MUST BE ZERO
745                 CX      Sector count
746                 ES:BX   Buffer address
747         Output: None
749         Read disk blocks from the active filesystem (partition); for
750         disks, sector number zero is the boot sector.  For ISOLINUX,
751         this call reads the CD-ROM.
753         For compatiblity with all systems, the buffer should
754         *neither* cross 64K boundaries, *nor* wrap around the segment.
756         This routine reports "boot failed" (and does not return) on
757         disk error.