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