MdePkg/Include/IndustryStandard/ElTorito.h

   1 /** @file
   2   ElTorito Partitions Format Definition.
   3   This file includes some defintions from
   4   1. "El Torito" Bootable CD-ROM Format Specification, Version 1.0.
   5   2. Volume and File Structure of CDROM for Information Interchange,
   6      Standard ECMA-119. (IS0 9660)
   7
   8 Copyright (c) 2006 - 2008, Intel Corporation
   9 All rights reserved. This program and the accompanying materials
  10 are licensed and made available under the terms and conditions of the BSD License
  11 which accompanies this distribution.  The full text of the license may be found at
  12 http://opensource.org/licenses/bsd-license.php
  13
  14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  16
  17 **/
  18
  19 #ifndef _ELTORITO_H_
  20 #define _ELTORITO_H_
  21
  22 //
  23 // CDROM_VOLUME_DESCRIPTOR.Types, defined in ISO 9660
  24 //
  25 #define CDVOL_TYPE_STANDARD 0x0
  26 #define CDVOL_TYPE_CODED    0x1
  27 #define CDVOL_TYPE_END      0xFF
  28
  29 ///
  30 /// CDROM_VOLUME_DESCRIPTOR.Id
  31 ///
  32 #define CDVOL_ID  "CD001"
  33
  34 ///
  35 /// CDROM_VOLUME_DESCRIPTOR.SystemId
  36 ///
  37 #define CDVOL_ELTORITO_ID "EL TORITO SPECIFICATION"
  38
  39 //
  40 // Indicator types
  41 //
  42 #define ELTORITO_ID_CATALOG               0x01
  43 #define ELTORITO_ID_SECTION_BOOTABLE      0x88
  44 #define ELTORITO_ID_SECTION_NOT_BOOTABLE  0x00
  45 #define ELTORITO_ID_SECTION_HEADER        0x90
  46 #define ELTORITO_ID_SECTION_HEADER_FINAL  0x91
  47
  48 //
  49 // ELTORITO_CATALOG.Boot.MediaTypes
  50 //
  51 #define ELTORITO_NO_EMULATION 0x00
  52 #define ELTORITO_12_DISKETTE  0x01
  53 #define ELTORITO_14_DISKETTE  0x02
  54 #define ELTORITO_28_DISKETTE  0x03
  55 #define ELTORITO_HARD_DISK    0x04
  56
  57
  58 #pragma pack(1)
  59
  60 ///
  61 /// CD-ROM Volume Descriptor
  62 ///
  63 typedef union {
  64   struct {
  65     UINT8   Type;
  66     CHAR8   Id[5];           ///< "CD001"
  67     CHAR8   Reserved[82];
  68   } Unknown;
  69
  70   struct {
  71     UINT8   Type;            ///< Must be 0
  72     CHAR8   Id[5];           ///< "CD001"
  73     UINT8   Version;         ///< Must be 1
  74     CHAR8   SystemId[32];    ///< "EL TORITO SPECIFICATION"
  75     CHAR8   Unused[32];      ///< Must be 0
  76     UINT8   EltCatalog[4];   ///< Absolute pointer to first sector of Boot Catalog
  77     CHAR8   Unused2[13];     ///< Must be 0
  78   } BootRecordVolume;
  79
  80   struct {
  81     UINT8   Type;
  82     CHAR8   Id[5];           ///< "CD001"
  83     UINT8   Version;
  84     UINT8   Unused;          ///< Must be 0
  85     CHAR8   SystemId[32];
  86     CHAR8   VolumeId[32];
  87     UINT8   Unused2[8];      ///< Must be 0
  88     UINT32  VolSpaceSize[2]; ///< the number of Logical Blocks
  89   } PrimaryVolume;
  90
  91 } CDROM_VOLUME_DESCRIPTOR;
  92
  93 ///
  94 /// Catalog Entry
  95 ///
  96 typedef union {
  97   struct {
  98     CHAR8       Reserved[0x20];
  99   } Unknown;
 100
 101   ///
 102   /// Catalog validation entry (Catalog header)
 103   ///
 104   struct {
 105     UINT8   Indicator;
 106     UINT8   PlatformId;
 107     UINT16  Reserved;
 108     CHAR8   ManufacId[24];
 109     UINT16  Checksum;
 110     UINT16  Id55AA;
 111   } Catalog;
 112
 113   ///
 114   /// Initial/Default Entry or Section Entry
 115   ///
 116   struct {
 117     UINT8   Indicator;
 118     UINT8   MediaType : 4;
 119     UINT8   Reserved1 : 4;
 120     UINT16  LoadSegment;
 121     UINT8   SystemType;
 122     UINT8   Reserved2;
 123     UINT16  SectorCount;
 124     UINT32  Lba;
 125   } Boot;
 126
 127   ///
 128   /// Section Header Entry
 129   ///
 130   struct {
 131     UINT8   Indicator;
 132     UINT8   PlatformId;
 133     UINT16  SectionEntries;
 134     CHAR8   Id[28];
 135   } Section;
 136
 137 } ELTORITO_CATALOG;
 138
 139 #pragma pack()
 140
 141 #endif