]>
Commit | Line | Data |
---|---|---|
d933e70a JW |
1 | /** @file\r |
2 | Functions declaration related with DHCPv4 for HTTP boot driver.\r | |
3 | \r | |
4 | Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials are licensed and made available under \r | |
6 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
7 | The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php. \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef __EFI_UEFI_HTTP_BOOT_DHCP4_H__\r | |
16 | #define __EFI_UEFI_HTTP_BOOT_DHCP4_H__\r | |
17 | \r | |
18 | #define HTTP_BOOT_DHCP4_OPTION_MAX_NUM 16\r | |
19 | #define HTTP_BOOT_DHCP4_OPTION_MAX_SIZE 312\r | |
20 | #define HTTP_BOOT_DHCP4_PACKET_MAX_SIZE 1472\r | |
21 | \r | |
22 | #define HTTP_BOOT_DHCP4_OPCODE_REQUEST 1\r | |
23 | #define HTTP_BOOT_DHCP4_OPCODE_REPLY 2\r | |
24 | #define HTTP_BOOT_DHCP4_MSG_TYPE_REQUEST 3\r | |
25 | #define HTTP_BOOT_DHCP4_MAGIC 0x63538263 // network byte order\r | |
26 | \r | |
27 | //\r | |
28 | // Dhcp Options\r | |
29 | //\r | |
30 | #define HTTP_BOOT_DHCP4_TAG_PAD 0 // Pad Option\r | |
31 | #define HTTP_BOOT_DHCP4_TAG_EOP 255 // End Option\r | |
32 | #define HTTP_BOOT_DHCP4_TAG_NETMASK 1 // Subnet Mask\r | |
33 | #define HTTP_BOOT_DHCP4_TAG_TIME_OFFSET 2 // Time Offset from UTC\r | |
34 | #define HTTP_BOOT_DHCP4_TAG_ROUTER 3 // Router option,\r | |
35 | #define HTTP_BOOT_DHCP4_TAG_TIME_SERVER 4 // Time Server\r | |
36 | #define HTTP_BOOT_DHCP4_TAG_NAME_SERVER 5 // Name Server\r | |
37 | #define HTTP_BOOT_DHCP4_TAG_DNS_SERVER 6 // Domain Name Server\r | |
38 | #define HTTP_BOOT_DHCP4_TAG_HOSTNAME 12 // Host Name\r | |
39 | #define HTTP_BOOT_DHCP4_TAG_BOOTFILE_LEN 13 // Boot File Size\r | |
40 | #define HTTP_BOOT_DHCP4_TAG_DUMP 14 // Merit Dump File\r | |
41 | #define HTTP_BOOT_DHCP4_TAG_DOMAINNAME 15 // Domain Name\r | |
42 | #define HTTP_BOOT_DHCP4_TAG_ROOTPATH 17 // Root path\r | |
43 | #define HTTP_BOOT_DHCP4_TAG_EXTEND_PATH 18 // Extensions Path\r | |
44 | #define HTTP_BOOT_DHCP4_TAG_EMTU 22 // Maximum Datagram Reassembly Size\r | |
45 | #define HTTP_BOOT_DHCP4_TAG_TTL 23 // Default IP Time-to-live\r | |
46 | #define HTTP_BOOT_DHCP4_TAG_BROADCAST 28 // Broadcast Address\r | |
47 | #define HTTP_BOOT_DHCP4_TAG_NIS_DOMAIN 40 // Network Information Service Domain\r | |
48 | #define HTTP_BOOT_DHCP4_TAG_NIS_SERVER 41 // Network Information Servers\r | |
49 | #define HTTP_BOOT_DHCP4_TAG_NTP_SERVER 42 // Network Time Protocol Servers\r | |
50 | #define HTTP_BOOT_DHCP4_TAG_VENDOR 43 // Vendor Specific Information\r | |
51 | #define HTTP_BOOT_DHCP4_TAG_REQUEST_IP 50 // Requested IP Address\r | |
52 | #define HTTP_BOOT_DHCP4_TAG_LEASE 51 // IP Address Lease Time\r | |
53 | #define HTTP_BOOT_DHCP4_TAG_OVERLOAD 52 // Option Overload\r | |
54 | #define HTTP_BOOT_DHCP4_TAG_MSG_TYPE 53 // DHCP Message Type\r | |
55 | #define HTTP_BOOT_DHCP4_TAG_SERVER_ID 54 // Server Identifier\r | |
56 | #define HTTP_BOOT_DHCP4_TAG_PARA_LIST 55 // Parameter Request List\r | |
57 | #define HTTP_BOOT_DHCP4_TAG_MAXMSG 57 // Maximum DHCP Message Size\r | |
58 | #define HTTP_BOOT_DHCP4_TAG_T1 58 // Renewal (T1) Time Value\r | |
59 | #define HTTP_BOOT_DHCP4_TAG_T2 59 // Rebinding (T2) Time Value\r | |
60 | #define HTTP_BOOT_DHCP4_TAG_CLASS_ID 60 // Vendor class identifier\r | |
61 | #define HTTP_BOOT_DHCP4_TAG_CLIENT_ID 61 // Client-identifier\r | |
62 | #define HTTP_BOOT_DHCP4_TAG_TFTP 66 // TFTP server name\r | |
63 | #define HTTP_BOOT_DHCP4_TAG_BOOTFILE 67 // Bootfile name\r | |
64 | #define HTTP_BOOT_DHCP4_TAG_ARCH 93\r | |
65 | #define HTTP_BOOT_DHCP4_TAG_UNDI 94\r | |
66 | #define HTTP_BOOT_DHCP4_TAG_UUID 97\r | |
67 | \r | |
68 | #define HTTP_BOOT_DHCP4_OVERLOAD_FILE 1\r | |
69 | #define HTTP_BOOT_DHCP4_OVERLOAD_SERVER_NAME 2\r | |
70 | \r | |
71 | ///\r | |
72 | /// HTTP Tag definition that identifies the processor \r | |
73 | /// and programming environment of the client system.\r | |
74 | /// These identifiers are defined by IETF:\r | |
75 | /// http://www.ietf.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml\r | |
76 | ///\r | |
77 | #if defined (MDE_CPU_IA32)\r | |
78 | #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x000F\r | |
79 | #elif defined (MDE_CPU_X64)\r | |
80 | #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x0010\r | |
81 | #elif defined (MDE_CPU_ARM)\r | |
82 | #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x0012\r | |
83 | #elif defined (MDE_CPU_AARCH64)\r | |
84 | #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x0013\r | |
85 | #elif defined (MDE_CPU_EBC)\r | |
86 | #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x0011\r | |
87 | #endif\r | |
88 | \r | |
89 | /// DHCP offer types among HTTP boot.\r | |
90 | /// Dhcp4 and Dhcp6 share this definition, and corresponding\r | |
91 | /// relatioinship is as follows:\r | |
92 | /// Dhcp4Discover <> Dhcp6Solicit\r | |
93 | /// Dhcp4Offer <> Dhcp6Advertise\r | |
94 | /// Dhcp4Request <> Dhcp6Request\r | |
95 | /// Dhcp4Ack <> DHcp6Reply\r | |
96 | ///\r | |
97 | typedef enum {\r | |
98 | //\r | |
99 | // <IP address, IP expressed URI> or\r | |
100 | // <IP address, IP expressed URI, Name-server (will be ignored)>\r | |
101 | //\r | |
102 | HttpOfferTypeDhcpIpUri,\r | |
103 | //\r | |
104 | // <IP address, Domain-name expressed URI, Name-server>\r | |
105 | //\r | |
106 | HttpOfferTypeDhcpNameUriDns,\r | |
107 | //\r | |
108 | // <IP address, Name-server>\r | |
109 | //\r | |
110 | HttpOfferTypeDhcpDns,\r | |
111 | //\r | |
112 | // <IP address>\r | |
113 | //\r | |
114 | HttpOfferTypeDhcpOnly,\r | |
115 | //\r | |
116 | // <Domain-name expressed URI> or\r | |
117 | // <Domain-name expressed URI, Name-server (will be ignored)>\r | |
118 | //\r | |
119 | HttpOfferTypeProxyNameUri,\r | |
120 | //\r | |
121 | // <IP expressed URI> or\r | |
122 | // <IP expressed URI, Name-server (will be ignored)>\r | |
123 | //\r | |
124 | HttpOfferTypeProxyIpUri,\r | |
125 | //\r | |
126 | // <IP address, Domain-name expressed URI>\r | |
127 | //\r | |
128 | HttpOfferTypeDhcpNameUri,\r | |
129 | HttpOfferTypeMax\r | |
130 | } HTTP_BOOT_OFFER_TYPE;\r | |
131 | \r | |
132 | #define HTTP_BOOT_DHCP_RETRIES 4\r | |
133 | #define HTTP_BOOT_OFFER_MAX_NUM 16\r | |
134 | \r | |
135 | // The array index of the DHCP4 option tag interested\r | |
136 | //\r | |
137 | #define HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE_LEN 0\r | |
138 | #define HTTP_BOOT_DHCP4_TAG_INDEX_OVERLOAD 1\r | |
139 | #define HTTP_BOOT_DHCP4_TAG_INDEX_MSG_TYPE 2\r | |
140 | #define HTTP_BOOT_DHCP4_TAG_INDEX_SERVER_ID 3\r | |
141 | #define HTTP_BOOT_DHCP4_TAG_INDEX_CLASS_ID 4\r | |
142 | #define HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE 5\r | |
143 | #define HTTP_BOOT_DHCP4_TAG_INDEX_DNS_SERVER 6\r | |
144 | #define HTTP_BOOT_DHCP4_TAG_INDEX_MAX 7\r | |
145 | \r | |
146 | #pragma pack(1)\r | |
147 | \r | |
148 | typedef struct {\r | |
149 | UINT8 ParaList[135];\r | |
150 | } HTTP_BOOT_DHCP4_OPTION_PARA;\r | |
151 | \r | |
152 | typedef struct {\r | |
153 | UINT16 Size;\r | |
154 | } HTTP_BOOT_DHCP4_OPTION_MAX_MESG_SIZE;\r | |
155 | \r | |
156 | typedef struct {\r | |
157 | UINT8 Type;\r | |
158 | UINT8 MajorVer;\r | |
159 | UINT8 MinorVer;\r | |
160 | } HTTP_BOOT_DHCP4_OPTION_UNDI;\r | |
161 | \r | |
162 | typedef struct {\r | |
163 | UINT8 Type;\r | |
164 | } HTTP_BOOT_DHCP4_OPTION_MESG;\r | |
165 | \r | |
166 | typedef struct {\r | |
167 | UINT16 Type;\r | |
168 | } HTTP_BOOT_DHCP4_OPTION_ARCH;\r | |
169 | \r | |
170 | typedef struct {\r | |
171 | UINT8 ClassIdentifier[11];\r | |
172 | UINT8 ArchitecturePrefix[5];\r | |
173 | UINT8 ArchitectureType[5];\r | |
174 | UINT8 Lit3[1];\r | |
175 | UINT8 InterfaceName[4];\r | |
176 | UINT8 Lit4[1];\r | |
177 | UINT8 UndiMajor[3];\r | |
178 | UINT8 UndiMinor[3];\r | |
179 | } HTTP_BOOT_DHCP4_OPTION_CLID;\r | |
180 | \r | |
181 | typedef struct {\r | |
182 | UINT8 Type;\r | |
183 | UINT8 Guid[16];\r | |
184 | } HTTP_BOOT_DHCP4_OPTION_UUID;\r | |
185 | \r | |
186 | typedef struct {\r | |
187 | UINT16 Type;\r | |
188 | UINT16 Layer;\r | |
189 | } HTTP_BOOT_OPTION_BOOT_ITEM;\r | |
190 | \r | |
191 | #pragma pack()\r | |
192 | \r | |
193 | typedef union {\r | |
194 | HTTP_BOOT_DHCP4_OPTION_PARA *Para;\r | |
195 | HTTP_BOOT_DHCP4_OPTION_UNDI *Undi;\r | |
196 | HTTP_BOOT_DHCP4_OPTION_ARCH *Arch;\r | |
197 | HTTP_BOOT_DHCP4_OPTION_CLID *Clid;\r | |
198 | HTTP_BOOT_DHCP4_OPTION_UUID *Uuid;\r | |
199 | HTTP_BOOT_DHCP4_OPTION_MESG *Mesg;\r | |
200 | HTTP_BOOT_DHCP4_OPTION_MAX_MESG_SIZE *MaxMesgSize;\r | |
201 | } HTTP_BOOT_DHCP4_OPTION_ENTRY;\r | |
202 | \r | |
203 | #define GET_NEXT_DHCP_OPTION(Opt) \\r | |
204 | (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + \\r | |
205 | sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)\r | |
206 | \r | |
207 | #define GET_OPTION_BUFFER_LEN(Pkt) \\r | |
208 | ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)\r | |
209 | \r | |
210 | #define DEFAULT_CLASS_ID_DATA "HTTPClient:Arch:xxxxx:UNDI:003000"\r | |
211 | #define DEFAULT_UNDI_TYPE 1\r | |
212 | #define DEFAULT_UNDI_MAJOR 3\r | |
213 | #define DEFAULT_UNDI_MINOR 0\r | |
214 | \r | |
215 | typedef struct {\r | |
216 | UINT32 Reserved;\r | |
217 | } HTTP_BOOT_VENDOR_OPTION;\r | |
218 | \r | |
219 | typedef union {\r | |
220 | EFI_DHCP4_PACKET Offer;\r | |
221 | EFI_DHCP4_PACKET Ack;\r | |
222 | UINT8 Buffer[HTTP_BOOT_DHCP4_PACKET_MAX_SIZE];\r | |
223 | } HTTP_BOOT_DHCP4_PACKET;\r | |
224 | \r | |
225 | typedef struct {\r | |
226 | //\r | |
227 | // URI component\r | |
228 | //\r | |
229 | CHAR8 *Scheme;\r | |
230 | CHAR8 *Authority;\r | |
231 | CHAR8 *Path;\r | |
232 | CHAR8 *Query;\r | |
233 | CHAR8 *Fragment; /// TODO: may not required in HTTP URL\r | |
234 | \r | |
235 | CHAR8 *RegName; /// Point to somewhere in Authority\r | |
236 | BOOLEAN AddrIsOk;\r | |
237 | EFI_IP_ADDRESS Address;\r | |
238 | UINT16 Port;\r | |
239 | } HTTP_BOOT_URI_CONTENT;\r | |
240 | \r | |
241 | typedef struct {\r | |
242 | HTTP_BOOT_DHCP4_PACKET Packet;\r | |
243 | HTTP_BOOT_OFFER_TYPE OfferType;\r | |
244 | VOID *UriParser;\r | |
245 | EFI_DHCP4_PACKET_OPTION *OptList[HTTP_BOOT_DHCP4_TAG_INDEX_MAX];\r | |
246 | } HTTP_BOOT_DHCP4_PACKET_CACHE;\r | |
247 | \r | |
b659408b ZL |
248 | /**\r |
249 | Select an DHCPv4 or DHCP6 offer, and record SelectIndex and SelectProxyType.\r | |
250 | \r | |
251 | @param[in] Private Pointer to HTTP boot driver private data.\r | |
252 | \r | |
253 | **/\r | |
254 | VOID\r | |
255 | HttpBootSelectDhcpOffer (\r | |
256 | IN HTTP_BOOT_PRIVATE_DATA *Private\r | |
257 | );\r | |
258 | \r | |
d933e70a JW |
259 | /**\r |
260 | Start the D.O.R.A DHCPv4 process to acquire the IPv4 address and other Http boot information.\r | |
261 | \r | |
262 | @param[in] Private Pointer to HTTP_BOOT private data.\r | |
263 | \r | |
264 | @retval EFI_SUCCESS The D.O.R.A process successfully finished.\r | |
265 | @retval Others Failed to finish the D.O.R.A process.\r | |
266 | \r | |
267 | **/\r | |
268 | EFI_STATUS\r | |
269 | HttpBootDhcp4Dora (\r | |
270 | IN HTTP_BOOT_PRIVATE_DATA *Private\r | |
271 | );\r | |
272 | \r | |
273 | /**\r | |
274 | This function will register the default DNS addresses to the network device.\r | |
275 | \r | |
276 | @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.\r | |
277 | @param[in] DataLength Size of the buffer pointed to by DnsServerData in bytes.\r | |
278 | @param[in] DnsServerData Point a list of DNS server address in an array\r | |
279 | of EFI_IPv4_ADDRESS instances.\r | |
280 | \r | |
281 | @retval EFI_SUCCESS The DNS configuration has been configured successfully.\r | |
282 | @retval Others Failed to configure the address.\r | |
283 | \r | |
284 | **/\r | |
285 | EFI_STATUS\r | |
286 | HttpBootRegisterIp4Dns (\r | |
287 | IN HTTP_BOOT_PRIVATE_DATA *Private,\r | |
288 | IN UINTN DataLength,\r | |
289 | IN VOID *DnsServerData\r | |
290 | );\r | |
291 | \r | |
292 | #endif\r |