MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h

   1 /** @file
   2   The definition for iSCSI Boot Firmware Table, it's defined in Microsoft's
   3   iSCSI Boot Firmware Table(iBFT) as Defined in ACPI 3.0b Specification.
   4
   5   Copyright (c) 2006 - 2008, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _ISCSI_BOOT_FIRMWARE_TABLE_H_
  17 #define _ISCSI_BOOT_FIRMWARE_TABLE_H_
  18
  19 #include "Acpi30.h"
  20
  21 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_REVISION            0x01
  22 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_STRUCTURE_ALIGNMENT 8
  23
  24 ///
  25 /// Structure Type/ID
  26 ///
  27 typedef enum {
  28   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_RESERVED_STRUCTURE_ID = 0,
  29   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE_ID,
  30   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_ID,
  31   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_ID,
  32   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_ID,
  33   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_EXTERNSIONS_STRUCTURE_ID
  34 } EFI_ACPI_ISCSI_ID_DEFINITIONS;
  35
  36 ///
  37 /// from the definition of IP_PREFIX_ORIGIN Enumeration in MSDN,
  38 /// not defined in Microsoft iBFT document.
  39 ///
  40 typedef enum {
  41   IpPrefixOriginOther = 0,
  42   IpPrefixOriginManual,
  43   IpPrefixOriginWellKnown,
  44   IpPrefixOriginDhcp,
  45   IpPrefixOriginRouterAdvertisement,
  46   IpPrefixOriginUnchanged = 16
  47 } IP_PREFIX_VALUE;
  48
  49 ///
  50 /// iBF Table Header
  51 ///
  52 typedef struct {
  53   UINT32  Signature;
  54   UINT32  Length;
  55   UINT8   Revision;
  56   UINT8   Checksum;
  57   UINT8   OemId[6];
  58   UINT64  OemTableId;
  59   UINT8   Reserved[24];
  60 } EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_HEADER;
  61
  62 ///
  63 /// Common Header of Boot Firmware Table Structure
  64 ///
  65 typedef struct {
  66   UINT8   StructureId;
  67   UINT8   Version;
  68   UINT16  Length;
  69   UINT8   Index;
  70   UINT8   Flags;
  71 } EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_STRUCTURE_HEADER;
  72
  73 ///
  74 /// Control Structure
  75 ///
  76 typedef struct {
  77   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_STRUCTURE_HEADER  Header;
  78   UINT16                                               Extensions;
  79   UINT16                                               InitiatorOffset;
  80   UINT16                                               NIC0Offset;
  81   UINT16                                               Target0Offset;
  82   UINT16                                               NIC1Offset;
  83   UINT16                                               Target1Offset;
  84 } EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE;
  85
  86 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE_VERSION              0x1
  87
  88 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_CONTROL_STRUCTURE_FLAG_BOOT_FAILOVER   BIT0
  89
  90 ///
  91 /// Initiator Structure
  92 ///
  93 typedef struct {
  94   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_STRUCTURE_HEADER  Header;
  95   EFI_IPv6_ADDRESS                                     ISnsServer;
  96   EFI_IPv6_ADDRESS                                     SlpServer;
  97   EFI_IPv6_ADDRESS                                     PrimaryRadiusServer;
  98   EFI_IPv6_ADDRESS                                     SecondaryRadiusServer;
  99   UINT16                                               IScsiNameLength;
 100   UINT16                                               IScsiNameOffset;
 101 } EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE;
 102
 103 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_VERSION             0x1
 104
 105 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_FLAG_BLOCK_VALID    BIT0
 106 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_INITIATOR_STRUCTURE_FLAG_BOOT_SELECTED  BIT1
 107
 108 ///
 109 /// NIC Structure
 110 ///
 111 typedef struct {
 112   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_STRUCTURE_HEADER  Header;
 113   EFI_IPv6_ADDRESS                                     Ip;
 114   UINT8                                                SubnetMaskPrefixLength;
 115   UINT8                                                Origin;
 116   EFI_IPv6_ADDRESS                                     Gateway;
 117   EFI_IPv6_ADDRESS                                     PrimaryDns;
 118   EFI_IPv6_ADDRESS                                     SecondaryDns;
 119   EFI_IPv6_ADDRESS                                     DhcpServer;
 120   UINT16                                               VLanTag;
 121   UINT8                                                Mac[6];
 122   UINT16                                               PciLocation;
 123   UINT16                                               HostNameLength;
 124   UINT16                                               HostNameOffset;
 125 } EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE;
 126
 127 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_VERSION                 0x1
 128
 129 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_FLAG_BLOCK_VALID        BIT0
 130 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_FLAG_BOOT_SELECTED      BIT1
 131 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_NIC_STRUCTURE_FLAG_GLOBAL             BIT2
 132
 133 ///
 134 /// Target Structure
 135 ///
 136 typedef struct {
 137   EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_STRUCTURE_HEADER  Header;
 138   EFI_IPv6_ADDRESS                                     Ip;
 139   UINT16                                               Port;
 140   UINT8                                                BootLun[8];
 141   UINT8                                                CHAPType;
 142   UINT8                                                NicIndex;
 143   UINT16                                               IScsiNameLength;
 144   UINT16                                               IScsiNameOffset;
 145   UINT16                                               CHAPNameLength;
 146   UINT16                                               CHAPNameOffset;
 147   UINT16                                               CHAPSecretLength;
 148   UINT16                                               CHAPSecretOffset;
 149   UINT16                                               ReverseCHAPNameLength;
 150   UINT16                                               ReverseCHAPNameOffset;
 151   UINT16                                               ReverseCHAPSecretLength;
 152   UINT16                                               ReverseCHAPSecretOffset;
 153 } EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE;
 154
 155 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_VERSION               0x1
 156
 157 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_FLAG_BLOCK_VALID      BIT0
 158 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_FLAG_BOOT_SELECTED    BIT1
 159 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_FLAG_RADIUS_CHAP      BIT2
 160 #define EFI_ACPI_ISCSI_BOOT_FIRMWARE_TABLE_TARGET_STRUCTURE_FLAG_RADIUS_RCHAP     BIT3
 161
 162 #endif
 163