iPXE
Data Structures | Macros | Enumerations | Functions | Variables
eltorito.h File Reference

El Torito bootable CD-ROM specification. More...

#include <stdint.h>
#include <ipxe/iso9660.h>

Go to the source code of this file.

Data Structures

struct  eltorito_descriptor_fixed
 An El Torito Boot Record Volume Descriptor (fixed portion) More...
 
struct  eltorito_descriptor
 An El Torito Boot Record Volume Descriptor. More...
 
struct  eltorito_validation_entry
 An El Torito Boot Catalog Validation Entry. More...
 
struct  eltorito_boot_entry
 A bootable entry in the El Torito Boot Catalog. More...
 

Macros

#define ELTORITO_LBA   17
 El Torito Boot Record Volume Descriptor block address. More...
 
#define ELTORITO_BOOTABLE   0x88
 Boot indicator for a bootable ISO image. More...
 

Enumerations

enum  eltorito_platform_id { ELTORITO_PLATFORM_X86 = 0x00, ELTORITO_PLATFORM_POWERPC = 0x01, ELTORITO_PLATFORM_MAC = 0x02 }
 El Torito platform IDs. More...
 
enum  eltorito_media_type { ELTORITO_NO_EMULATION = 0 }
 El Torito media types. More...
 

Functions

 FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
 
struct eltorito_descriptor_fixed __attribute__ ((packed))
 

Variables

uint8_t type
 Descriptor type. More...
 
uint8_t id [5]
 Identifier ("CD001") More...
 
uint8_t version
 Version, must be 1. More...
 
uint8_t system_id [32]
 Boot system indicator; must be "EL TORITO SPECIFICATION". More...
 
struct eltorito_descriptor_fixed fixed
 Fixed portion. More...
 
uint8_t unused [32]
 Unused. More...
 
uint32_t sector
 Boot catalog sector. More...
 
uint8_t header_id
 Header ID; must be 1. More...
 
uint8_t platform_id
 Platform ID. More...
 
uint16_t reserved
 Reserved. More...
 
uint8_t id_string [24]
 ID string. More...
 
uint16_t checksum
 Checksum word. More...
 
uint16_t signature
 Signature; must be 0xaa55. More...
 
enum eltorito_platform_id __attribute__
 
uint8_t indicator
 Boot indicator. More...
 
uint8_t media_type
 Media type. More...
 
uint16_t load_segment
 Load segment. More...
 
uint8_t filesystem
 System type. More...
 
uint8_t reserved_a
 Unused. More...
 
uint16_t length
 Sector count. More...
 
uint32_t start
 Starting sector. More...
 
uint8_t reserved_b [20]
 Unused. More...
 

Detailed Description

El Torito bootable CD-ROM specification.

Definition in file eltorito.h.

Macro Definition Documentation

◆ ELTORITO_LBA

#define ELTORITO_LBA   17

El Torito Boot Record Volume Descriptor block address.

Definition at line 39 of file eltorito.h.

◆ ELTORITO_BOOTABLE

#define ELTORITO_BOOTABLE   0x88

Boot indicator for a bootable ISO image.

Definition at line 95 of file eltorito.h.

Enumeration Type Documentation

◆ eltorito_platform_id

El Torito platform IDs.

Enumerator
ELTORITO_PLATFORM_X86 
ELTORITO_PLATFORM_POWERPC 
ELTORITO_PLATFORM_MAC 

Definition at line 63 of file eltorito.h.

◆ eltorito_media_type

El Torito media types.

Enumerator
ELTORITO_NO_EMULATION 

No emulation.

Definition at line 98 of file eltorito.h.

98  {
99  /** No emulation */
101 };
No emulation.
Definition: eltorito.h:100

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL  )

◆ __attribute__()

Variable Documentation

◆ type

uint8_t type

Descriptor type.

Definition at line 13 of file eltorito.h.

◆ id

uint8_t id[5]

Identifier ("CD001")

Definition at line 15 of file eltorito.h.

◆ version

uint8_t version

Version, must be 1.

Definition at line 17 of file eltorito.h.

◆ system_id

uint8_t system_id[32]

Boot system indicator; must be "EL TORITO SPECIFICATION".

Definition at line 19 of file eltorito.h.

◆ fixed

Fixed portion.

Definition at line 13 of file eltorito.h.

Referenced by syslog_fix_name(), tls_new_ciphertext(), and tls_send_plaintext().

◆ unused

uint8_t unused

◆ sector

uint32_t sector

Boot catalog sector.

Definition at line 17 of file eltorito.h.

Referenced by int13_rw_sectors().

◆ header_id

uint8_t header_id

Header ID; must be 1.

Definition at line 13 of file eltorito.h.

◆ platform_id

uint8_t platform_id

Platform ID.

0 = 80x86 1 = PowerPC 2 = Mac

Definition at line 20 of file eltorito.h.

Referenced by ucode_exec().

◆ reserved

uint16_t reserved

Reserved.

Definition at line 22 of file eltorito.h.

◆ id_string

uint8_t id_string[24]

ID string.

Definition at line 24 of file eltorito.h.

Referenced by peerdisc_open().

◆ checksum

uint16_t checksum

Checksum word.

Definition at line 26 of file eltorito.h.

◆ signature

uint16_t signature

Signature; must be 0xaa55.

Definition at line 28 of file eltorito.h.

◆ __attribute__

◆ indicator

uint8_t indicator

Boot indicator.

Must be ELTORITO_BOOTABLE for a bootable ISO image

Definition at line 16 of file eltorito.h.

◆ media_type

uint8_t media_type

Media type.

Definition at line 20 of file eltorito.h.

◆ load_segment

uint16_t load_segment

Load segment.

Definition at line 22 of file eltorito.h.

◆ filesystem

uint8_t filesystem

System type.

Definition at line 24 of file eltorito.h.

◆ reserved_a

uint8_t reserved_a

Unused.

Definition at line 26 of file eltorito.h.

◆ length

uint16_t length

Sector count.

Definition at line 28 of file eltorito.h.

◆ start

uint32_t start

Starting sector.

Definition at line 30 of file eltorito.h.

◆ reserved_b

uint8_t reserved_b[20]

Unused.

Definition at line 32 of file eltorito.h.