aboutsummaryrefslogtreecommitdiffstats
path: root/doc/comboot.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/comboot.txt')
-rw-r--r--doc/comboot.txt68
1 files changed, 34 insertions, 34 deletions
diff --git a/doc/comboot.txt b/doc/comboot.txt
index 8c4a868f..ceee93a5 100644
--- a/doc/comboot.txt
+++ b/doc/comboot.txt
@@ -2,7 +2,7 @@
COMBOOT and COM32 files
-SYSLINUX supports simple standalone programs, using a file format
+Syslinux supports simple standalone programs, using a file format
similar to DOS ".com" files. A 32-bit version, called COM32, is also
provided. A simple API provides access to a limited set of filesystem
and console functions.
@@ -18,7 +18,7 @@ A COMBOOT image can be written to be compatible with MS-DOS. Such a
file will usually have extension ".com". A COMBOOT file which is not
compatible with MS-DOS will usually have extension ".cbt".
-Before running the program, SYSLINUX sets up the following fields in
+Before running the program, Syslinux sets up the following fields in
the Program Segment Prefix (PSP), a structure at offset 0 in the
program segment:
@@ -37,18 +37,18 @@ paragraph value given at offset 2.
On startup, SP is set up to point to the end of the 64K segment, at
0xfffe. Under DOS it is possible for SP to contain a smaller
-value if memory is very tight; this is never the case under SYSLINUX.
+value if memory is very tight; this is never the case under Syslinux.
The program should make no assumptions about what segment address it
will be loaded at; instead it should look at the segment registers on
-program startup. Both DOS and SYSLINUX will guarantee CS == DS == ES
+program startup. Both DOS and Syslinux will guarantee CS == DS == ES
== SS on program start; the program should not assume anything about
the values of FS or GS.
To exit, a program can either execute a near RET (which will jump to
offset 0 which contains an INT 20h instruction, terminating the
program), or execute INT 20h or INT 21h AH=00h or INT 21h AH=4Ch.
-If compatiblity with SYSLINUX 1.xx is desired, use INT 20h.
+If compatiblity with Syslinux 1.xx is desired, use INT 20h.
++++ COM32 file format ++++
@@ -56,7 +56,7 @@ If compatiblity with SYSLINUX 1.xx is desired, use INT 20h.
A COM32 file is a raw binary file containing 32-bit code. It should
be linked to run at address 0x101000, and should not contain any
segment references. It will be run in flat-memory 32-bit protected
-mode. Under SYSLINUX, it will be run in CPL 0, however, since it may
+mode. Under Syslinux, it will be run in CPL 0, however, since it may
be possible to create a COM32 execution engine that would run under
something like Linux DOSEMU, it is recommended that the code does not
assume CPL 0 unless absolutely necessary.
@@ -100,7 +100,7 @@ int _start(unsigned int __nargs,
int (*__cfarcall)(uint32_t, void *, size_t)
);
-The intcall helper function can be used to issue BIOS or SYSLINUX API
+The intcall helper function can be used to issue BIOS or Syslinux API
calls, and takes the interrupt number as first argument. The second
argument is a pointer to the input register definition, an instance of
the following structure (available in <com32.h>):
@@ -133,7 +133,7 @@ The third argument is a pointer to the output register definition, an
instance of the same structure. The third argument can also be zero
(NULL).
-Since BIOS or SYSLINUX API calls can generally only manipulate data
+Since BIOS or Syslinux API calls can generally only manipulate data
below address 0x100000, a "bounce buffer" in low memory, at least 64K
in size, is available, to copy data in and out.
@@ -148,9 +148,9 @@ frame, a size of that stack frame, and returns the return value of EAX
++++ SYSLINUX API CALLS +++
-SYSLINUX provides the following API calls. SYSLINUX 1.xx only
+Syslinux provides the following API calls. Syslinux 1.xx only
supported INT 20h - terminate program. [] indicates the first version
-of SYSLINUX which supported this feature (correctly.)
+of Syslinux which supported this feature (correctly.)
NOTE: Most of the API functionality is still experimental. Expect to
find bugs.
@@ -212,20 +212,20 @@ INT 21h AH=30h [2.00] Check DOS Version
EAX=59530000h EBX=4C530000h ECX=4E490000h EDX=58550000h
This function can thus be used to distinguish running on
- SYSLINUX from running on DOS.
+ Syslinux from running on DOS.
++++ SYSLINUX-SPECIFIC API CALLS ++++
-SYSLINUX-specific API calls are executed using INT 22h, with a
+Syslinux-specific API calls are executed using INT 22h, with a
function number in AX. INT 22h is used by DOS for internal purposes;
do not execute INT 22h under DOS.
DOS-compatible function INT 21h, AH=30h can be used to detect if the
-SYSLINUX API calls are available.
+Syslinux API calls are available.
Any register not specifically listed as modified is preserved;
-however, future versions of SYSLINUX may add additional output
+however, future versions of Syslinux may add additional output
registers to existing calls.
All calls return CF=0 on success, CF=1 on failure. The noted outputs
@@ -238,13 +238,13 @@ AX=0001h [2.00] Get Version
Input: AX 0001h
Output: AX number of INT 22h API functions available
- CH SYSLINUX major version number
- CL SYSLINUX minor version number
- DL SYSLINUX derivative ID (e.g. 32h = PXELINUX)
- ES:SI SYSLINUX version string
- ES:DI SYSLINUX copyright string
+ CH Syslinux major version number
+ CL Syslinux minor version number
+ DL Syslinux derivative ID (e.g. 32h = PXELINUX)
+ ES:SI Syslinux version string
+ ES:DI Syslinux copyright string
- This API call returns the SYSLINUX version and API
+ This API call returns the Syslinux version and API
information.
@@ -264,7 +264,7 @@ AX=0003h [2.01] Run command
Output: Does not return
This API call terminates the program and executes the command
- string as if the user had entered it at the SYSLINUX command
+ string as if the user had entered it at the Syslinux command
line. This API call does not return.
@@ -275,7 +275,7 @@ AX=0004h [2.01] Run default command
This API call terminates the program and executes the default
command string as if the user had pressed Enter alone on the
- SYSLINUX command line. This API call does not return.
+ Syslinux command line. This API call does not return.
AX=0005h [2.00] Force text mode
@@ -297,12 +297,12 @@ AX=0006h [2.08] Open file
CX file block size
Open a file for reading. The exact syntax of the filenames
- allowed depends on the particular SYSLINUX derivative.
+ allowed depends on the particular Syslinux derivative.
- The SYSLINUX file system is block-oriented. The size of a
+ The Syslinux file system is block-oriented. The size of a
block will always be a power of two and no greater than 16K.
- Note: SYSLINUX considers a zero-length file to be nonexistent.
+ Note: Syslinux considers a zero-length file to be nonexistent.
In 3.70 or later, EAX can contain -1 indicating that the file
length is unknown.
@@ -328,7 +328,7 @@ AX=0007h [2.08] Read file
reached.
The address of the buffer (ES:BX) should be at least 512-byte
- aligned. SYSLINUX guarantees at least this alignment for the
+ aligned. Syslinux guarantees at least this alignment for the
COMBOOT load segment or the COM32 bounce buffer.
Keep in mind that a "file" may be a TFTP connection, and that
@@ -454,7 +454,7 @@ AX=000Ah [2.00] Get Derivative-Specific Information
AX=4B01h to obtain the spec packet directly from the
BIOS if necessary.
- This call gives information specific to a particular SYSLINUX
+ This call gives information specific to a particular Syslinux
derivative. The value returned in AL is the same as is
returned in DL by INT 22h AX=0001h.
@@ -502,7 +502,7 @@ AX=000Ch [2.00] Perform final cleanup
EXTLINUX: 0000h Normal cleanup
All other values are undefined, and may have different
- meanings in future versions of SYSLINUX.
+ meanings in future versions of Syslinux.
AX=000Dh [2.08] Cleanup and replace bootstrap code
@@ -644,7 +644,7 @@ AX=0013h [3.08] Idle loop call
Starting with version 3.10, this API call harmlessly returns
failure (CF=1) if invoked on a platform which does not need
idle calls. Additionally, it's safe to call this API call on
- previous SYSLINUX versions (2.00 or later); it will just
+ previous Syslinux versions (2.00 or later); it will just
harmlessly fail. Thus, if this call returns failure (CF=1),
it means that there is no technical reason to call this
function again, although doing so is of course safe.
@@ -667,7 +667,7 @@ AX=0015h [3.10] Get feature flags
Output: ES:BX pointer to flags in memory
CX number of flag bytes
- This function reports whether or not this SYSLINUX version and
+ This function reports whether or not this Syslinux version and
derivative supports specific features. Keep in mind that
future versions might have more bits; remember to treat any
bits beyond the end of the array (as defined by the value in
@@ -735,15 +735,15 @@ AX=0017h [3.30] Report video mode change
Output: None
This function is used to report video mode changes to
- SYSLINUX. It does NOT actually change the video mode, but
- rather, allows SYSLINUX to take appropriate action in response
+ Syslinux. It does NOT actually change the video mode, but
+ rather, allows Syslinux to take appropriate action in response
to a video mode change. Modes that cannot be exited either
with the conventional BIOS mode set command (INT 10h, AH=00h)
or the VESA VBE mode set command (INT 10h, AX=4F02h) should
not be used.
This function returns with a failure if BX contains any bits
- which are undefined in the current version of SYSLINUX.
+ which are undefined in the current version of Syslinux.
The following bits in BX are currently defined:
@@ -767,7 +767,7 @@ AX=0017h [3.30] Report video mode change
This indicates that the BIOS text output functions
(INT 10h, AH=02h, 03h, 06h, 09h, 0Eh, 11h) don't work.
- If this bit is set, SYSLINUX will reset the mode
+ If this bit is set, Syslinux will reset the mode
before printing any characters on the screen.
This is common for VESA modes.