xref: /freebsd/usr.sbin/makefs/cd9660/cd9660_eltorito.h (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)

/*	$NetBSD: cd9660_eltorito.h,v 1.6 2017/01/24 11:22:43 nonaka Exp $	*/

/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2005 Daniel Watt, Walter Deignan, Ryan Gabrys, Alan
 * Perez-Rathke and Ram Vedam.  All rights reserved.
 *
 * This code was written by Daniel Watt, Walter Deignan, Ryan Gabrys,
 * Alan Perez-Rathke and Ram Vedam.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY DANIEL WATT, WALTER DEIGNAN, RYAN
 * GABRYS, ALAN PEREZ-RATHKE AND RAM VEDAM ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL DANIEL WATT, WALTER DEIGNAN, RYAN
 * GABRYS, ALAN PEREZ-RATHKE AND RAM VEDAM BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 */

#ifndef _CD9660_ELTORITO_H_
#define _CD9660_ELTORITO_H_

/* Boot defines */
#define	ET_ID		"EL TORITO SPECIFICATION"
#define	ET_SYS_X86	0
#define	ET_SYS_PPC	1
#define	ET_SYS_MAC	2
#define	ET_SYS_EFI	0xef	/* Platform ID at section header entry */

#define ET_BOOT_ENTRY_SIZE 0x20

#define	ET_BOOTABLE		0x88
#define	ET_NOT_BOOTABLE	0

#define	ET_MEDIA_NOEM	0
#define	ET_MEDIA_12FDD			1
#define	ET_MEDIA_144FDD			2
#define	ET_MEDIA_288FDD			3
#define	ET_MEDIA_HDD			4

#define ET_INDICATOR_HEADERMORE	0x90
#define ET_INDICATOR_HEADERLAST	0x91
#define ET_INDICATOR_EXTENSION	0x44

/*** Boot Structures ***/

typedef struct _boot_volume_descriptor {
	u_char boot_record_indicator	[ISODCL(0x00,0x00)];
	u_char identifier		[ISODCL(0x01,0x05)];
	u_char version			[ISODCL(0x06,0x06)];
	u_char boot_system_identifier	[ISODCL(0x07,0x26)];
	u_char unused1			[ISODCL(0x27,0x46)];
	u_char boot_catalog_pointer	[ISODCL(0x47,0x4A)];
	u_char unused2			[ISODCL(0x4B,0x7FF)];
} boot_volume_descriptor;

typedef struct _boot_catalog_validation_entry {
	u_char header_id		[ISODCL(0x00,0x00)];
	u_char platform_id		[ISODCL(0x01,0x01)];
	u_char reserved1		[ISODCL(0x02,0x03)];
	u_char manufacturer		[ISODCL(0x04,0x1B)];
	u_char checksum			[ISODCL(0x1C,0x1D)];
	u_char key			[ISODCL(0x1E,0x1F)];
} boot_catalog_validation_entry;

typedef struct _boot_catalog_initial_entry {
	u_char boot_indicator		[ISODCL(0x00,0x00)];
	u_char media_type		[ISODCL(0x01,0x01)];
	u_char load_segment		[ISODCL(0x02,0x03)];
	u_char system_type		[ISODCL(0x04,0x04)];
	u_char unused_1			[ISODCL(0x05,0x05)];
	u_char sector_count		[ISODCL(0x06,0x07)];
	u_char load_rba			[ISODCL(0x08,0x0B)];
	u_char unused_2			[ISODCL(0x0C,0x1F)];
} boot_catalog_initial_entry;

#define ET_SECTION_HEADER_MORE		0x90
#define ET_SECTION_HEADER_LAST		0x91

typedef struct _boot_catalog_section_header {
	u_char header_indicator		[ISODCL(0x00,0x00)];
	u_char platform_id		[ISODCL(0x01,0x01)];
	u_char num_section_entries	[ISODCL(0x02,0x03)];
	u_char id_string		[ISODCL(0x04,0x1F)];
} boot_catalog_section_header;

typedef struct _boot_catalog_section_entry {
	u_char boot_indicator		[ISODCL(0x00,0x00)];
	u_char media_type		[ISODCL(0x01,0x01)];
	u_char load_segment		[ISODCL(0x02,0x03)];
	u_char system_type		[ISODCL(0x04,0x04)];
	u_char unused_1			[ISODCL(0x05,0x05)];
	u_char sector_count		[ISODCL(0x06,0x07)];
	u_char load_rba			[ISODCL(0x08,0x0B)];
	u_char selection_criteria	[ISODCL(0x0C,0x0C)];
	u_char vendor_criteria		[ISODCL(0x0D,0x1F)];
} boot_catalog_section_entry;

typedef struct _boot_catalog_section_entry_extension {
	u_char extension_indicator	[ISODCL(0x00,0x00)];
	u_char flags			[ISODCL(0x01,0x01)];
	u_char vendor_criteria		[ISODCL(0x02,0x1F)];
} boot_catalog_section_entry_extension;

#define ET_ENTRY_VE 1
#define ET_ENTRY_IE 2
#define ET_ENTRY_SH 3
#define ET_ENTRY_SE 4
#define ET_ENTRY_EX 5

struct boot_catalog_entry {
	char entry_type;
	union {
		boot_catalog_validation_entry		VE;
		boot_catalog_initial_entry		IE;
		boot_catalog_section_header		SH;
		boot_catalog_section_entry		SE;
		boot_catalog_section_entry_extension	EX;
	} entry_data;

	LIST_ENTRY(boot_catalog_entry) ll_struct;
};

/* Temporary structure */
struct cd9660_boot_image {
	char *filename;
	int size;
	int sector;			/* copied to LoadRBA */
	int num_sectors;
	unsigned int loadSegment;
	u_char targetMode;
	u_char system;
	u_char bootable;
	u_char platform_id;		/* for section header entry */
	/*
	 * If the boot image exists in the filesystem
	 * already, this is a pointer to that node. For the sake
	 * of simplicity in future versions, this pointer is only
	 * to the node in the primary volume. This SHOULD be done
	 * via a hashtable lookup.
	 */
	struct _cd9660node *boot_image_node;
	TAILQ_ENTRY(cd9660_boot_image) image_list;
	int serialno;
};


#endif /* _CD9660_ELTORITO_H_ */