doc/comboot.txt

   1
   2                        COMBOOT and COM32 files
   3
   4
   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.
   9
  10
  11         ++++ COMBOOT file format ++++
  12
  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.
  16
  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".
  20
  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:
  24
  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).
  33
  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.
  37
  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.
  41
  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.
  47
  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.
  52
  53
  54         ++++ COM32R file format ++++
  55
  56 A COM32R file is a raw binary file containing 32-bit code.  It should
  57 be self-relocating, as it will be loaded by the Syslinux core at any
  58 4K aligned address.  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.
  63
  64 A COM32R program must start with the byte sequence B8 FE 4C CD 21 (mov
  65 eax,21cd4cfeh) as a magic number.
  66
  67 The COM32R format replaces the earlier COM32 format, which was linked
  68 to a fixed address (0x101000).
  69
  70 A COM32R file should have extension ".c32".
  71
  72 On startup, CS will be set up as a flat 32-bit code segment, and DS ==
  73 ES == SS will be set up as the equivalent flat 32-bit data segment.
  74 FS and GS are reserved for future use and are currently initialized to
  75 zero.  A COM32R image should not assume any particular values of
  76 segment selectors.
  77
  78 ESP is set up at the end of available memory and also serves as
  79 notification to the program how much memory is available.
  80
  81 The following arguments are passed to the program on the stack:
  82
  83  Address  Size  Meaning
  84  [ESP]    dword Return (termination) address
  85  [ESP+4]  dword Number of additional arguments (currently 7)
  86  [ESP+8]  dword Pointer to the command line arguments (null-terminated string)
  87  [ESP+12] dword Pointer to INT call helper function
  88  [ESP+16] dword Pointer to low memory bounce buffer
  89  [ESP+20] dword Size of low memory bounce buffer
  90  [ESP+24] dword Pointer to FAR call helper function (new in 2.05)
  91  [ESP+28] dword Pointer to CDECL helper function (new in 3.54)
  92  [ESP+32] dword Amount of memory controlled by the Syslinux core (new in 3.74)
  93
  94 This corresponds to the following C prototype, available in the file
  95 com32/include/com32.h:
  96
  97 /* The standard prototype for _start() */
  98 int _start(unsigned int __nargs,
  99            char *__cmdline,
 100            void (*__intcall)(uint8_t, com32sys_t *, com32sys_t *),
 101            void *__bounce_ptr,
 102            unsigned int __bounce_len,
 103            void (*__farcall)(uint32_t, com32sys_t *, com32sys_t *),
 104            int (*__cfarcall)(uint32_t, void *, size_t)
 105            );
 106
 107 The intcall helper function can be used to issue BIOS or Syslinux API
 108 calls, and takes the interrupt number as first argument.  The second
 109 argument is a pointer to the input register definition, an instance of
 110 the following structure (available in <com32.h>):
 111
 112 typedef union {
 113   uint32_t l;
 114   uint16_t w[2];
 115   uint8_t  b[4];
 116 } reg32_t;
 117
 118 typedef struct {
 119   uint16_t gs;                  /* Offset  0 */
 120   uint16_t fs;                  /* Offset  2 */
 121   uint16_t es;                  /* Offset  4 */
 122   uint16_t ds;                  /* Offset  6 */
 123
 124   reg32_t edi;                  /* Offset  8 */
 125   reg32_t esi;                  /* Offset 12 */
 126   reg32_t ebp;                  /* Offset 16 */
 127   reg32_t _unused_esp;          /* Offset 20 */
 128   reg32_t ebx;                  /* Offset 24 */
 129   reg32_t edx;                  /* Offset 28 */
 130   reg32_t ecx;                  /* Offset 32 */
 131   reg32_t eax;                  /* Offset 36 */
 132
 133   reg32_t eflags;               /* Offset 40 */
 134 } com32sys_t;
 135
 136 The third argument is a pointer to the output register definition, an
 137 instance of the same structure.  The third argument can also be zero
 138 (NULL).
 139
 140 Since BIOS or Syslinux API calls can generally only manipulate data
 141 below address 0x100000, a "bounce buffer" in low memory, at least 64K
 142 in size, is available, to copy data in and out.
 143
 144 The farcall helper function behaves similarly, but takes as its first
 145 argument the CS:IP (in the form (CS << 16) + IP) of procedure to be
 146 invoked via a FAR CALL.
 147
 148 The cfarcall helper function takes (CS << 16)+IP, a pointer to a stack
 149 frame, a size of that stack frame, and returns the return value of EAX
 150 (which may need to be appropriate truncated by the user.)
 151
 152
 153         ++++ SYSLINUX API CALLS +++
 154
 155 Syslinux provides the following API calls.  Syslinux 1.xx only
 156 supported INT 20h - terminate program. [] indicates the first version
 157 of Syslinux which supported this feature (correctly.)
 158
 159 NOTE: Most of the API functionality is still experimental.  Expect to
 160 find bugs.
 161
 162
 163         ++++ DOS-COMPATIBLE API CALLS ++++
 164
 165 INT 20h         [1.48] Terminate program
 166 INT 21h AH=00h  [2.00] Terminate program
 167 INT 21h AH=4Ch  [2.00] Terminate program
 168
 169         All of these terminate the program.
 170
 171
 172 INT 21h AH=01h  [2.01] Get Key with Echo
 173
 174         Reads a key from the console input, with echo to the console
 175         output.  The read character is returned in AL.  Extended
 176         characters received from the keyboard are returned as NUL (00h)
 177         + the extended character code.
 178
 179
 180 INT 21h AH=02h  [2.01] Write Character
 181
 182         Writes a character in DL to the console (video and serial)
 183         output.
 184
 185
 186 INT 21h AH=04h  [2.01] Write Character to Serial Port
 187
 188         Writes a character in DL to the serial console output
 189         (if enabled.)  If no serial port is configured, this routine
 190         does nothing.
 191
 192
 193 INT 21h AH=08h  [2.09] Get Key without Echo
 194
 195         Reads a key fron the console input, without echoing it to the
 196         console output.  The read character is returned in AL.
 197
 198
 199 INT 21h AH=09h  [2.01] Write DOS String to Console
 200
 201         Writes a DOS $-terminated string in DS:DX to the console.
 202
 203
 204 INT 21h AH=0Bh  [2.00] Check Keyboard
 205
 206         Returns AL=FFh if there is a keystroke waiting (which can then
 207         be read with INT 21h, AH=01h or AH=08h), otherwise AL=00h.
 208
 209
 210 INT 21h AH=30h  [2.00] Check DOS Version
 211
 212         This function returns AX=BX=CX=DX=0, corresponding to a
 213         hypothetical "DOS 0.0", but the high parts of EAX-EBX-ECX-EDX
 214         spell "SYSLINUX":
 215
 216         EAX=59530000h EBX=4C530000h ECX=4E490000h EDX=58550000h
 217
 218         This function can thus be used to distinguish running on
 219         Syslinux from running on DOS.
 220
 221
 222         ++++ SYSLINUX-SPECIFIC API CALLS ++++
 223
 224 Syslinux-specific API calls are executed using INT 22h, with a
 225 function number in AX.  INT 22h is used by DOS for internal purposes;
 226 do not execute INT 22h under DOS.
 227
 228 DOS-compatible function INT 21h, AH=30h can be used to detect if the
 229 Syslinux API calls are available.
 230
 231 Any register not specifically listed as modified is preserved;
 232 however, future versions of Syslinux may add additional output
 233 registers to existing calls.
 234
 235 All calls return CF=0 on success, CF=1 on failure.  The noted outputs
 236 apply if CF=0 only unless otherwise noted.  All calls clobber the
 237 arithmetric flags (CF, PF, AF, ZF, SF and OF) but leave all other
 238 flags unchanged unless otherwise noted.
 239
 240
 241 AX=0001h [2.00] Get Version
 242
 243         Input:  AX      0001h
 244         Output: AX      number of INT 22h API functions available
 245                 CH      Syslinux major version number
 246                 CL      Syslinux minor version number
 247                 DL      Syslinux derivative ID (e.g. 32h = PXELINUX)
 248                 ES:SI   Syslinux version string
 249                 ES:DI   Syslinux copyright string
 250
 251         This API call returns the Syslinux version and API
 252         information.
 253
 254
 255 AX=0002h [2.01] Write String
 256
 257         Input:  AX      0002h
 258                 ES:BX   null-terminated string
 259         Output: None
 260
 261         Writes a null-terminated string on the console.
 262
 263
 264 AX=0003h [2.01] Run command
 265
 266         Input:  AX      0003h
 267                 ES:BX   null-terminated command string
 268         Output: Does not return
 269
 270         This API call terminates the program and executes the command
 271         string as if the user had entered it at the Syslinux command
 272         line.  This API call does not return.
 273
 274
 275 AX=0004h [2.01] Run default command
 276
 277         Input:  AX      0004h
 278         Output: Does not return
 279
 280         This API call terminates the program and executes the default
 281         command string as if the user had pressed Enter alone on the
 282         Syslinux command line.  This API call does not return.
 283
 284
 285 AX=0005h [2.00] Force text mode
 286
 287         Input:  AX      0005h
 288         Output: None
 289
 290         If the screen was in graphics mode (due to displaying a splash
 291         screen using the <Ctrl-X> command in a message file, or
 292         similar), return to text mode.
 293
 294
 295 AX=0006h [2.08] Open file
 296
 297         Input:  AX      0006h
 298                 ES:SI   null-terminated filename
 299         Output: SI      file handle
 300                 EAX     length of file in bytes, or -1
 301                 CX      file block size
 302
 303         Open a file for reading.  The exact syntax of the filenames
 304         allowed depends on the particular Syslinux derivative.
 305
 306         The Syslinux file system is block-oriented.  The size of a
 307         block will always be a power of two and no greater than 16K.
 308
 309         Note: Syslinux considers a zero-length file to be nonexistent.
 310
 311         In 3.70 or later, EAX can contain -1 indicating that the file
 312         length is unknown.
 313
 314
 315 AX=0007h [2.08] Read file
 316
 317         Input:  AX      0007h
 318                 SI      file handle
 319                 ES:BX   buffer
 320                 CX      number of blocks to read
 321         Output: SI      file handle, or 0 if EOF was reached
 322                 ECX     number of bytes read [3.70]
 323
 324         Read blocks from a file.  Note that the file handle that is
 325         returned in SI may not be the same value that was passed in.
 326
 327         If end of file was reached (SI=0), the file was automatically
 328         closed.
 329
 330         In 3.70 or later, ECX returns the number of bytes read.  This
 331         will always be a multiple of the block size unless EOF is
 332         reached.
 333
 334         The address of the buffer (ES:BX) should be at least 512-byte
 335         aligned.  Syslinux guarantees at least this alignment for the
 336         COMBOOT load segment or the COM32 bounce buffer.
 337
 338         Keep in mind that a "file" may be a TFTP connection, and that
 339         leaving a file open for an extended period of time may result
 340         in a timeout.
 341
 342         WARNING: Calling this function with an invalid file handle
 343         will probably crash the system.
 344
 345
 346 AX=0008h [2.08] Close file
 347
 348         Input:  AX      0008h
 349                 SI      file handle
 350         Output: None
 351
 352         Close a file before reaching the end of file.
 353
 354         WARNING: Calling this function with an invalid file handle
 355         will probably crash the system.
 356
 357
 358 AX=0009h [2.00] Call PXE Stack [PXELINUX ONLY]
 359
 360         Input:  AX      0009h
 361                 BX      PXE function number
 362                 ES:DI   PXE parameter structure buffer
 363         Output: AX      PXE return status code
 364
 365         Invoke an arbitrary PXE stack function.  On SYSLINUX/ISOLINUX,
 366         this function returns with an error (CF=1) and no action is
 367         taken.  On PXELINUX, this function always returns with CF=0
 368         indicating that the PXE stack was successfully invoked; check
 369         the status code in AX and in the first word of the data buffer
 370         to determine if the PXE call succeeded or not.
 371
 372         The PXE stack will have the UDP stack OPEN; if you change that
 373         you cannot call any of the file-related API functions, and
 374         must restore UDP OPEN before returning to PXELINUX.
 375
 376         PXELINUX reserves UDP port numbers from 49152 to 65535 for its
 377         own use; port numbers below that range is available.
 378
 379
 380 AX=000Ah [2.00] Get Derivative-Specific Information
 381
 382         [SYSLINUX, EXTLINUX]
 383         Input:  AX      000Ah
 384                 CL      9 (to get a valid return in CL for all versions)
 385         Output: AL      31h (SYSLINUX), 34h (EXTLINUX)
 386                 DL      drive number
 387                 CL      sector size as a power of 2 (9 = 512 bytes) [3.35]
 388                 ES:BX   pointer to partition table entry (if DL >= 80h)
 389                 FS:SI   pointer to initial ES:DI value [3.53]
 390
 391                 Note: This function was broken in EXTLINUX 3.00-3.02.
 392
 393                 On boot, ES:DI is supposed to point to the BIOS $PnP
 394                 structure, although in practice most operating systems
 395                 will search for it in memory.  However, preserving
 396                 this while chainloading is probably a good idea.
 397
 398                 Note that FS:SI is a pointer to a memory location
 399                 containing the original ES:DI value, not the value
 400                 itself.
 401
 402
 403         [PXELINUX]
 404         Input:  AX      000Ah
 405         Output: AL      32h (PXELINUX)
 406                 DX      PXE API version detected (DH=major, DL=minor)
 407                 ES:BX   pointer to PXENV+ or !PXE structure
 408                 FS:SI   pointer to original stack with invocation record
 409
 410                 Note: DX notes the API version detected by PXELINUX,
 411                 which may be more conservative than the actual version
 412                 available.  For exact information examine the API
 413                 version entry in the PXENV+ structure, or the API
 414                 version entries in the ROMID structures pointed from
 415                 the !PXE structure.
 416
 417                 PXELINUX will use, and provide, the !PXE structure
 418                 over the PXENV+ structure.  Examine the structure
 419                 signature to determine which particular structure was
 420                 provided.
 421
 422                 The FS:SI pointer points to the top of the original stack
 423                 provided by the PXE stack, with the following values
 424                 pushed at the time PXELINUX is started:
 425
 426                 [fs:si+0]       GS              <- top of stack
 427                 [fs:si+2]       FS
 428                 [fs:si+4]       ES
 429                 [fs:si+6]       DS
 430                 [fs:si+8]       EDI
 431                 [fs:si+12]      ESI
 432                 [fs:si+16]      EBP
 433                 [fs:si+20]      -
 434                 [fs:si+24]      EBX
 435                 [fs:si+28]      EDX
 436                 [fs:si+32]      ECX
 437                 [fs:si+36]      EAX
 438                 [fs:si+40]      EFLAGS
 439                 [fs:si+44]      PXE return IP   <- t.o.s. when PXELINUX invoked
 440                 [fs:si+46]      PXE return CS
 441
 442
 443         [ISOLINUX]
 444         Input:  AX      000Ah
 445         Output: AL      33h (ISOLINUX)
 446                 DL      drive number
 447                 CL      11 (sector size as a power of 2) [3.35]
 448                 CH      mode [3.73]
 449                         0 = El Torito
 450                         1 = Hybrid (hard disk), CBIOS mode
 451                         2 = Hybrid (hard disk), EBIOS mode
 452                 ES:BX   pointer to El Torito spec packet
 453                 FS:SI   pointer to initial ES:DI value [3.53]
 454
 455                 Note: Some very broken El Torito implementations do
 456                 not provide the spec packet information.  If so, ES:BX
 457                 may point to all zeroes or to garbage.  Call INT 13h,
 458                 AX=4B01h to obtain the spec packet directly from the
 459                 BIOS if necessary.
 460
 461         This call gives information specific to a particular Syslinux
 462         derivative.  The value returned in AL is the same as is
 463         returned in DL by INT 22h AX=0001h.
 464
 465
 466 AX=000Bh [2.00] Get Serial Console Configuration
 467
 468         Input:  AX      000Bh
 469         Output: DX      serial port I/O base (e.g. 3F8h = COM1...)
 470                 CX      baud rate divisor (1 = 115200 bps, 2 = 57600 bps...)
 471                 BX      flow control configuration bits (see syslinux.txt)
 472                         -> bit 15 is set if the video console is disabled
 473
 474         If no serial port is configured, DX will be set to 0 and the
 475         other registers are undefined.
 476
 477
 478 AX=000Ch [2.00] Perform final cleanup
 479         Input:  AX      000Ch
 480                 DX      derivative-specific flags (0000h = clean up all)
 481         Output: None
 482
 483         This routine performs any "final cleanup" the boot loader
 484         would normally perform before loading a kernel, such as
 485         unloading the PXE stack in the case of PXELINUX.  AFTER
 486         INVOKING THIS CALL, NO OTHER API CALLS MAY BE INVOKED, NOR MAY
 487         THE PROGRAM TERMINATE AND RETURN TO THE BOOT LOADER.  This
 488         call basically tells the boot loader "get out of the way, I'll
 489         handle it from here."
 490
 491         For COM32 images, the boot loader will continue to provide
 492         interrupt and BIOS call thunking services as long its memory
 493         areas (0x0800-0xffff, 0x100000-0x100fff) are not overwritten.
 494         MAKE SURE TO DISABLE INTERRUPTS, AND INSTALL NEW GDT AND IDTS
 495         BEFORE OVERWRITING THESE MEMORY AREAS.
 496
 497         The permissible values for DX is an OR of these values:
 498
 499         SYSLINUX:       0000h   Normal cleanup
 500
 501         PXELINUX:       0000h   Normal cleanup
 502                         0003h   Keep UNDI and PXE stacks loaded
 503
 504         ISOLINUX:       0000h   Normal cleanup
 505
 506         EXTLINUX:       0000h   Normal cleanup
 507
 508         All other values are undefined, and may have different
 509         meanings in future versions of Syslinux.
 510
 511
 512 AX=000Dh [2.08] Cleanup and replace bootstrap code
 513         Input:  AX      000Dh
 514                 DX      derivative-specific flags (see previous function)
 515                 EDI     bootstrap code (linear address, can be in high memory)
 516                 ECX     bootstrap code length in bytes (must fit in low mem)
 517                 EBX(!)  initial value of EDX after bootstrap
 518                 ESI     initial value of ESI after bootstrap
 519                 DS      initial value of DS after bootstrap
 520         Output: Does not return
 521
 522         This routine performs final cleanup, then takes a piece of
 523         code, copies it over the primary bootstrap at address 7C00h,
 524         and jumps to it.  This can be used to chainload boot sectors,
 525         MBRs, bootstraps, etc.
 526
 527         Normal boot sectors expect DL to contain the drive number,
 528         and, for hard drives (DL >= 80h) DS:SI to contain a pointer to
 529         the 16-byte partition table entry.  The memory between
 530         600h-7FFh is available to put the partition table entry in.
 531
 532         For PXELINUX, if the PXE stack is not unloaded, all registers
 533         (except DS, ESI and EDX) and the stack will be set up as they
 534         were set up by the PXE ROM.
 535
 536
 537 AX=000Eh [2.11] Get configuration file name
 538         Input:  AX      0000Eh
 539         Output: ES:BX   null-terminated file name string
 540
 541         Returns the name of the configuration file.  Note that it is
 542         possible that the configuration file doesn't actually exist.
 543
 544
 545 AX=000Fh [3.00] Get IPAPPEND strings [PXELINUX]
 546         Input:  AX      000Fh
 547         Output: CX      number of strings (currently 2)
 548                 ES:BX   pointer to an array of NEAR pointers in
 549                         the same segment, one for each of the above
 550                         strings
 551
 552         Returns the same strings that the "ipappend" option would have
 553         added to the command line, one for each bit of the "ipappend"
 554         flag value, so entry 0 is the "ip=" string and entry 1 is the
 555         "BOOTIF=" string.
 556
 557
 558 AX=0010h [3.00] Resolve hostname [PXELINUX]
 559         Input:  AX      0010h
 560                 ES:BX   pointer to null-terminated hostname
 561         Output: EAX     IP address of hostname (zero if not found)
 562
 563         Queries the DNS server(s) for a specific hostname.  If the
 564         hostname does not contain a dot (.), the local domain name
 565         is automatically appended.
 566
 567         This function only return CF=1 if the function is not
 568         supported.  If the function is supported, but the hostname did
 569         not resolve, it returns with CF=0, EAX=0.
 570
 571         The IP address is returned in network byte order, i.e. if the
 572         IP address is 1.2.3.4, EAX will contain 0x04030201.  Note that
 573         all uses of IP addresses in PXE are also in network byte order.
 574
 575
 576 AX=0011h [3.05] Obsoleted in 3.80
 577
 578
 579 AX=0012h [3.50] Cleanup, shuffle and boot
 580         Input:  AX      0012h
 581                 DX      derivative-specific flags (see function 000Ch)
 582                 ES:DI   shuffle descriptor list (must be in low memory)
 583                 CX      number of shuffle descriptors
 584                 EBX(!)  initial value of EDX after bootstrap
 585                 ESI     initial value of ESI after bootstrap
 586                 DS      initial value of DS after bootstrap
 587                 EBP     CS:IP of routine to jump to
 588         Output: Does not return
 589                 (if CX is too large the routine returns with CF=1)
 590
 591         This routine performs final cleanup, then performs a sequence
 592         of copies, and jumps to a specified real mode entry point.
 593         This is a more general version of function 000Dh, which can
 594         also be used to load other types of programs.
 595
 596         The copies must not touch memory below address 7C00h.
 597
 598         ES:DI points to a list of CX descriptors each of the form:
 599
 600                 Offset  Size    Meaning
 601                  0      dword   destination address
 602                  4      dword   source address
 603                  8      dword   length in bytes
 604
 605         The copies are overlap-safe, like memmove().
 606
 607         Starting in version 3.50, if the source address is -1
 608         (FFFFFFFFh) then the block specified by the destination
 609         address and the length is set to all zero.
 610
 611         Starting in version 3.50, if the destination address is -1
 612         (FFFFFFFFh) then the data block is loaded as a new set of
 613         descriptors, and processing is continued (and unprocessed
 614         descriptors are lost, this is thus typically only used as the
 615         last descriptor in a block.)  The block must still fit in the
 616         internal descriptor buffer (see function 0011h), but can, of
 617         course, itself chain another block.
 618
 619
 620         Normal boot sectors expect DL to contain the drive number,
 621         and, for hard drives (DL >= 80h) DS:SI to contain a pointer to
 622         the 16-byte partition table entry.  The memory between
 623         600h-7FFh is available to put the partition table entry in.
 624
 625         For PXELINUX, if the PXE stack is not unloaded, all registers
 626         (except DS, ESI and EDX) and the stack will be set up as they
 627         were set up by the PXE ROM.
 628
 629         This interface was probably broken before version 3.50.
 630
 631
 632 AX=0013h [3.08] Idle loop call
 633         Input:  AX      0013h
 634         Output: None
 635
 636         Call this routine while sitting in an idle loop.  It performs
 637         any periodic activities required by the filesystem code.  At
 638         the moment, this is a no-op on all derivatives except
 639         PXELINUX, where it executes PXE calls to answer ARP queries.
 640
 641         Starting with version 3.10, this API call harmlessly returns
 642         failure (CF=1) if invoked on a platform which does not need
 643         idle calls.  Additionally, it's safe to call this API call on
 644         previous Syslinux versions (2.00 or later); it will just
 645         harmlessly fail.  Thus, if this call returns failure (CF=1),
 646         it means that there is no technical reason to call this
 647         function again, although doing so is of course safe.
 648
 649
 650 AX=0014h [3.10] Local boot [PXELINUX, ISOLINUX]
 651         Input:  AX      0014h
 652                 DX      Local boot parameter
 653         Output: Does not return
 654
 655         This function invokes the equivalent of the "localboot"
 656         configuration file option.  The parameter in DX is the same
 657         parameter as would be entered after "localboot" in the
 658         configuration file; this parameter is derivative-specific --
 659         see syslinux.txt for the definition.
 660
 661
 662 AX=0015h [3.10] Get feature flags
 663         Input:  AX      0015h
 664         Output: ES:BX   pointer to flags in memory
 665                 CX      number of flag bytes
 666
 667         This function reports whether or not this Syslinux version and
 668         derivative supports specific features.  Keep in mind that
 669         future versions might have more bits; remember to treat any
 670         bits beyond the end of the array (as defined by the value in
 671         CX) as zero.
 672
 673         Currently the following feature flag is defined:
 674
 675         Byte    Bit     Definition
 676         ----------------------------------------------------
 677         0       0       Local boot (AX=0014h) supported
 678                 1       Idle loop call (AX=0013h) is a no-op
 679
 680         All other flags are reserved.
 681
 682
 683 AX=0016h [3.10] Run kernel image
 684         Input:  AX      0016h
 685                 DS:SI   Filename of kernel image (zero-terminated string)
 686                 ES:BX   Command line (zero-terminated string)
 687                 ECX     IPAPPEND flags [PXELINUX]
 688                 EDX     Type of file (since 3.50)
 689         Output: Does not return if successful; returns with CF=1 if
 690                 the kernel image is not found.
 691
 692         This function is similiar to AX=0003h Run command, except that
 693         the filename and command line are treated as if specified in a
 694         KERNEL and APPEND statement of a LABEL statement, which means:
 695
 696         - The filename has to be exact; no variants are tried;
 697         - No global APPEND statement is applied;
 698         - ALLOWOPTIONS and IMPLICIT statements in the configuration
 699           file do not apply.  It is therefore important that the
 700           COMBOOT module doesn't allow the end user to violate the
 701           intent of the administrator.
 702
 703         Additionally, this function returns with a failure if the file
 704         doesn't exist, instead of returning to the command line.  (It
 705         may still return to the command line if the image is somehow
 706         corrupt, however.)
 707
 708         The file types are defined as follows:
 709
 710                     Equivalent
 711         EDX     Config  Extensions      Type of file
 712         0       KERNEL                  Determined by filename extension
 713         1       LINUX   none            Linux kernel image
 714         2       BOOT    .bs .bin        Bootstrap program
 715         3       BSS     .bss            Boot sector with patch [SYSLINUX]
 716         4       PXE     .0              PXE Network Bootstrap Prog [PXELINUX]
 717         5       FDIMAGE .img            Floppy disk image [ISOLINUX]
 718         6       COMBOOT .com .cbt       16-bit COMBOOT program
 719         7       COM32   .c32            COM32 program
 720         8       CONFIG                  Configuration file
 721
 722
 723 AX=0017h [3.30] Report video mode change
 724         Input:  AX      0017h
 725                 BX      Video mode flags
 726                         Bit 0:  graphics mode
 727                         Bit 1:  non-default mode
 728                         Bit 2:  VESA mode
 729                         Bit 3:  text functions not supported
 730                 CX      For graphics modes, pixel columns
 731                 DX      For graphics modes, pixel rows
 732         Output: None
 733
 734         This function is used to report video mode changes to
 735         Syslinux.  It does NOT actually change the video mode, but
 736         rather, allows Syslinux to take appropriate action in response
 737         to a video mode change.  Modes that cannot be exited either
 738         with the conventional BIOS mode set command (INT 10h, AH=00h)
 739         or the VESA VBE mode set command (INT 10h, AX=4F02h) should
 740         not be used.
 741
 742         This function returns with a failure if BX contains any bits
 743         which are undefined in the current version of Syslinux.
 744
 745         The following bits in BX are currently defined:
 746
 747         Bit 0: graphics mode
 748
 749                 Indicates that the mode is a graphics mode, as opposed
 750                 to a text mode.
 751
 752         Bit 1: non-standard mode
 753
 754                 A non-standard mode is any mode except text mode and
 755                 graphics mode 0012h (VGA 640x480, 16 color.)
 756
 757         Bit 2: VESA mode
 758
 759                 This mode is a VESA mode, and has to be exited with
 760                 the VESA VBE API (INT 10h, AX=4F02h) as opposed to the
 761                 conventional BIOS API (INT 10h, AH=00h).
 762
 763         Bit 3: Text functions not supported
 764
 765                 This indicates that the BIOS text output functions
 766                 (INT 10h, AH=02h, 03h, 06h, 09h, 0Eh, 11h) don't work.
 767                 If this bit is set, Syslinux will reset the mode
 768                 before printing any characters on the screen.
 769
 770                 This is common for VESA modes.
 771
 772
 773 AX=0018h [3.30] Query custom font
 774         Input:  AX      0018h
 775         Output: AL      Height of custom font in scan lines, or zero
 776                 ES:BX   Pointer to custom font in memory
 777
 778         This call queries if a custom display font has been loaded via
 779         the "font" configuration file command.  If no custom font has
 780         been loaded, AL contains zero.
 781
 782
 783 AX=0019h [3.50] Read disk [SYSLINUX, ISOLINUX, EXTLINUX]
 784         Input:  AX      0019h
 785                 EDX     Sector number
 786                 ESI     Reserved - MUST BE ZERO
 787                 EDI     Reserved - MUST BE ZERO
 788                 CX      Sector count
 789                 ES:BX   Buffer address
 790         Output: None
 791
 792         Read disk blocks from the active filesystem (partition); for
 793         disks, sector number zero is the boot sector.  For ISOLINUX,
 794         this call reads the CD-ROM.
 795
 796         For compatiblity with all systems, the buffer should
 797         *neither* cross 64K boundaries, *nor* wrap around the segment.
 798
 799         This routine reports "boot failed" (and does not return) on
 800         disk error.
 801
 802         Note: for ISOLINUX in hybrid mode, this call uses simulated
 803         2048-byte CD-ROM sector numbers.
 804
 805
 806 AX=001Ah [3.50] Obsoleted in 3.80
 807
 808
 809 AX=001Bh [3.50] Obsoleted in 3.80
 810
 811
 812 AX=001Ch [3.60] Get pointer to auxilliary data vector
 813         Input:  AX      001Ch
 814         Output: ES:BX   Auxilliary data vector
 815                 CX      Size of the ADV (currently 500 bytes)
 816
 817         The auxillary data vector is a tagged data structure used
 818         to carry a small amount of information (up to 500 bytes) from
 819         one boot to another.
 820
 821
 822 AX=001Dh [3.60] Write auxilliary data vector
 823         Input:  AX      001Dh
 824         Output: None
 825
 826         Write the auxilliary data vector back to disk.  Returns
 827         failure for non-disk-based derivatives unless the "auxdata"
 828         configuration command is used to specify a disk location
 829         (not yet implemented.)
 830
 831         In a future version, PXELINUX may end up attempting to save
 832         the ADV on the server via TFTP write.
 833
 834
 835 AX=001Eh [3.74] Keyboard remapping table
 836         Input:  AX      001Eh
 837                 DX      0000h - all other values reserved
 838         Output: AX      format version (1)
 839                 CX      length in bytes (256)
 840                 ES:BX   pointer to keyboard table
 841
 842         This call queries the keyboard remapping table.  For the current
 843         version, the format code is always 1 and the length is always
 844         256.  This version can be updated simply by overwriting the version
 845         in memory; this may not be true in the future.
 846
 847
 848 AX=001Fh [3.74] Get current working directory
 849         Input:  AX      0001Fh
 850         Output: ES:BX   null-terminated directory name string
 851
 852         Returns the current working directory.  For SYSLINUX, ISOLINUX,
 853         and PXELINUX, this will be an absolute path.  For EXTLINUX, it
 854         currently returns "./".
 855
 856
 857 AX=0020h [3.74] Open directory
 858         Input:  AX      0020h
 859                 ES:SI   /-null-terminated directory name
 860         Output: SI      directory handle
 861                 EAX     clobbered
 862
 863         Open a directory for reading.  Directory name must have a trailing
 864          "/" before the null (otherwise, you're looking for a file)(This
 865         may change as this is a BETA call).
 866
 867
 868 AX=0021h [3.74] Read directory
 869         Input:  AX      0021h
 870                 SI      directory handle
 871                 ES:DI   buffer for file name
 872         Output: DL      Type of file
 873                 SI      directory handle, or 0 if end of directory was reached
 874                 EAX     Size of file
 875                 EBX     Inode of file
 876
 877         Read one filename from the directory, incrementing the
 878         directory structure at SI as appropriate, storing the filename
 879         into the buffer at ES:DI, and returning the type of the file
 880         in DL, the file length in EAX, the inode/file number in EBX
 881         and the updated directory handle.
 882
 883
 884 AX=0022h [3.74] Close directory
 885         Input:  AX      0022h
 886                 SI      directory handle
 887         Output  SI      0
 888
 889         Closes a directory.
 890
 891
 892 AX=0023h [3.80] Get shuffler parameters
 893         Input:  AX      0023h
 894         Output: CX      size of shuffler "safe area" in bytes
 895                 Other registers reserved for future use
 896
 897         This call gives the size of the required shuffler "safe area",
 898         in bytes; for call 0024h.  In the future, it may provide
 899         additional parameters.
 900
 901
 902 AX=0024h [3.80] Cleanup, shuffle and boot, raw version
 903         Input:  AX      0024h
 904                 DX      derivative-specific flags (see function 000Ch)
 905                 EDI     shuffle descriptor list safe area
 906                 ESI     shuffle descriptor list source
 907                 ECX     byte count of shuffle descriptor list
 908         Output: Does not return
 909
 910         This routine performs final cleanup, then performs a sequence
 911         of copies, and jumps to a specified real mode entry point.
 912         This is a more general version of function 000Dh, which can
 913         also be used to load other types of programs.
 914
 915         Unlike previous obsolete versions of this function, there are
 916         no restrictions that copies must not touch memory below
 917         address 7C00h.  Either the shuffle descriptor list or the safe
 918         area (or both) may be located in high memory.
 919
 920         ESI points to a list of descriptors each of the form:
 921
 922                 Offset  Size    Meaning
 923                  0      dword   destination address
 924                  4      dword   source address (-1 = zero)
 925                  8      dword   length in bytes (0 = end of list)
 926
 927         The copies are overlap-safe, like memmove().
 928
 929         Before actually executing the move list, the list is moved to
 930         the address specified in EDI.  The caller is responsibe to
 931         ensure that the moved descriptor list plus a "safe area"
 932         immediately afterwards (the size of which is specified by
 933         function 0023h) is not disturbed by the copy sequence.  It is,
 934         however, safe to overwrite descriptors already consumed.
 935
 936         If the source address is -1 (FFFFFFFFh) then the block
 937         specified by the destination address and the length is set to
 938         all zero.
 939
 940         The list is terminated by an entry with length 0.  For that
 941         entry, the destination is used as an entry point, and the
 942         source represents the type of entry point:
 943
 944                 0       16-bit protected mode (dst is CS.base)
 945                 1       Flat 32-bit protected mode (dst is EIP)
 946
 947         This routine does not set up any GPR register state
 948         whatsoever, including stack.  It is the responsibility of the
 949         caller to make sure the entry point provided sets up any
 950         registers needed.
 951
 952         For mode 0 (16-bit real mode), EAX will contain CR0 with bit 0
 953         masked out, suitable for loading into CR0 to immediately enter
 954         real mode.  Note: if real-mode entry is planned,
 955         (CS.base & 0xfff0000f) should == 0 for compatibility with KVM,
 956         and possibly other virtualization solutions.
 957
 958         In both mode 0 and mode 1, the data segments will be loaded
 959         with read/write data segments, matching the respective code
 960         segment.  For mode 0, B=0 and the limits will be 64K, for mode
 961         1, B=1 and the limits will be 4 GB.