2 Functions declaration related with DHCPv4 for HTTP boot driver.
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __EFI_UEFI_HTTP_BOOT_DHCP4_H__
16 #define __EFI_UEFI_HTTP_BOOT_DHCP4_H__
18 #define HTTP_BOOT_DHCP4_OPTION_MAX_NUM 16
19 #define HTTP_BOOT_DHCP4_OPTION_MAX_SIZE 312
20 #define HTTP_BOOT_DHCP4_PACKET_MAX_SIZE 1472
22 #define HTTP_BOOT_DHCP4_OPCODE_REQUEST 1
23 #define HTTP_BOOT_DHCP4_OPCODE_REPLY 2
24 #define HTTP_BOOT_DHCP4_MSG_TYPE_REQUEST 3
25 #define HTTP_BOOT_DHCP4_MAGIC 0x63538263 // network byte order
30 #define HTTP_BOOT_DHCP4_TAG_PAD 0 // Pad Option
31 #define HTTP_BOOT_DHCP4_TAG_EOP 255 // End Option
32 #define HTTP_BOOT_DHCP4_TAG_NETMASK 1 // Subnet Mask
33 #define HTTP_BOOT_DHCP4_TAG_TIME_OFFSET 2 // Time Offset from UTC
34 #define HTTP_BOOT_DHCP4_TAG_ROUTER 3 // Router option,
35 #define HTTP_BOOT_DHCP4_TAG_TIME_SERVER 4 // Time Server
36 #define HTTP_BOOT_DHCP4_TAG_NAME_SERVER 5 // Name Server
37 #define HTTP_BOOT_DHCP4_TAG_DNS_SERVER 6 // Domain Name Server
38 #define HTTP_BOOT_DHCP4_TAG_HOSTNAME 12 // Host Name
39 #define HTTP_BOOT_DHCP4_TAG_BOOTFILE_LEN 13 // Boot File Size
40 #define HTTP_BOOT_DHCP4_TAG_DUMP 14 // Merit Dump File
41 #define HTTP_BOOT_DHCP4_TAG_DOMAINNAME 15 // Domain Name
42 #define HTTP_BOOT_DHCP4_TAG_ROOTPATH 17 // Root path
43 #define HTTP_BOOT_DHCP4_TAG_EXTEND_PATH 18 // Extensions Path
44 #define HTTP_BOOT_DHCP4_TAG_EMTU 22 // Maximum Datagram Reassembly Size
45 #define HTTP_BOOT_DHCP4_TAG_TTL 23 // Default IP Time-to-live
46 #define HTTP_BOOT_DHCP4_TAG_BROADCAST 28 // Broadcast Address
47 #define HTTP_BOOT_DHCP4_TAG_NIS_DOMAIN 40 // Network Information Service Domain
48 #define HTTP_BOOT_DHCP4_TAG_NIS_SERVER 41 // Network Information Servers
49 #define HTTP_BOOT_DHCP4_TAG_NTP_SERVER 42 // Network Time Protocol Servers
50 #define HTTP_BOOT_DHCP4_TAG_VENDOR 43 // Vendor Specific Information
51 #define HTTP_BOOT_DHCP4_TAG_REQUEST_IP 50 // Requested IP Address
52 #define HTTP_BOOT_DHCP4_TAG_LEASE 51 // IP Address Lease Time
53 #define HTTP_BOOT_DHCP4_TAG_OVERLOAD 52 // Option Overload
54 #define HTTP_BOOT_DHCP4_TAG_MSG_TYPE 53 // DHCP Message Type
55 #define HTTP_BOOT_DHCP4_TAG_SERVER_ID 54 // Server Identifier
56 #define HTTP_BOOT_DHCP4_TAG_PARA_LIST 55 // Parameter Request List
57 #define HTTP_BOOT_DHCP4_TAG_MAXMSG 57 // Maximum DHCP Message Size
58 #define HTTP_BOOT_DHCP4_TAG_T1 58 // Renewal (T1) Time Value
59 #define HTTP_BOOT_DHCP4_TAG_T2 59 // Rebinding (T2) Time Value
60 #define HTTP_BOOT_DHCP4_TAG_CLASS_ID 60 // Vendor class identifier
61 #define HTTP_BOOT_DHCP4_TAG_CLIENT_ID 61 // Client-identifier
62 #define HTTP_BOOT_DHCP4_TAG_TFTP 66 // TFTP server name
63 #define HTTP_BOOT_DHCP4_TAG_BOOTFILE 67 // Bootfile name
64 #define HTTP_BOOT_DHCP4_TAG_ARCH 93
65 #define HTTP_BOOT_DHCP4_TAG_UNDI 94
66 #define HTTP_BOOT_DHCP4_TAG_UUID 97
68 #define HTTP_BOOT_DHCP4_OVERLOAD_FILE 1
69 #define HTTP_BOOT_DHCP4_OVERLOAD_SERVER_NAME 2
72 /// HTTP Tag definition that identifies the processor
73 /// and programming environment of the client system.
74 /// These identifiers are defined by IETF:
75 /// http://www.ietf.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xml
77 #if defined (MDE_CPU_IA32)
78 #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x000F
79 #elif defined (MDE_CPU_X64)
80 #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x0010
81 #elif defined (MDE_CPU_ARM)
82 #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x0012
83 #elif defined (MDE_CPU_AARCH64)
84 #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x0013
85 #elif defined (MDE_CPU_EBC)
86 #define EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE 0x0011
89 /// DHCP offer types among HTTP boot.
90 /// Dhcp4 and Dhcp6 share this definition, and corresponding
91 /// relatioinship is as follows:
92 /// Dhcp4Discover <> Dhcp6Solicit
93 /// Dhcp4Offer <> Dhcp6Advertise
94 /// Dhcp4Request <> Dhcp6Request
95 /// Dhcp4Ack <> DHcp6Reply
99 // <IP address, IP expressed URI>
101 HttpOfferTypeDhcpIpUri
,
103 // <IP address, IP expressed URI, Name-server>
105 HttpOfferTypeDhcpIpUriDns
,
107 // <IP address, Domain-name expressed URI, Name-server>
109 HttpOfferTypeDhcpNameUriDns
,
111 // <IP address, Name-server>
113 HttpOfferTypeDhcpDns
,
117 HttpOfferTypeDhcpOnly
,
119 // <Domain-name expressed URI> or
120 // <Domain-name expressed URI, Name-server (will be ignored)>
122 HttpOfferTypeProxyNameUri
,
124 // <IP expressed URI> or
125 // <IP expressed URI, Name-server (will be ignored)>
127 HttpOfferTypeProxyIpUri
,
129 // <IP address, Domain-name expressed URI>
131 HttpOfferTypeDhcpNameUri
,
133 } HTTP_BOOT_OFFER_TYPE
;
135 #define HTTP_BOOT_DHCP_RETRIES 4
136 #define HTTP_BOOT_OFFER_MAX_NUM 16
138 // The array index of the DHCP4 option tag interested
140 #define HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE_LEN 0
141 #define HTTP_BOOT_DHCP4_TAG_INDEX_OVERLOAD 1
142 #define HTTP_BOOT_DHCP4_TAG_INDEX_MSG_TYPE 2
143 #define HTTP_BOOT_DHCP4_TAG_INDEX_SERVER_ID 3
144 #define HTTP_BOOT_DHCP4_TAG_INDEX_CLASS_ID 4
145 #define HTTP_BOOT_DHCP4_TAG_INDEX_BOOTFILE 5
146 #define HTTP_BOOT_DHCP4_TAG_INDEX_DNS_SERVER 6
147 #define HTTP_BOOT_DHCP4_TAG_INDEX_MAX 7
153 } HTTP_BOOT_DHCP4_OPTION_PARA
;
157 } HTTP_BOOT_DHCP4_OPTION_MAX_MESG_SIZE
;
163 } HTTP_BOOT_DHCP4_OPTION_UNDI
;
167 } HTTP_BOOT_DHCP4_OPTION_MESG
;
171 } HTTP_BOOT_DHCP4_OPTION_ARCH
;
174 UINT8 ClassIdentifier
[11];
175 UINT8 ArchitecturePrefix
[5];
176 UINT8 ArchitectureType
[5];
178 UINT8 InterfaceName
[4];
182 } HTTP_BOOT_DHCP4_OPTION_CLID
;
187 } HTTP_BOOT_DHCP4_OPTION_UUID
;
192 } HTTP_BOOT_OPTION_BOOT_ITEM
;
197 HTTP_BOOT_DHCP4_OPTION_PARA
*Para
;
198 HTTP_BOOT_DHCP4_OPTION_UNDI
*Undi
;
199 HTTP_BOOT_DHCP4_OPTION_ARCH
*Arch
;
200 HTTP_BOOT_DHCP4_OPTION_CLID
*Clid
;
201 HTTP_BOOT_DHCP4_OPTION_UUID
*Uuid
;
202 HTTP_BOOT_DHCP4_OPTION_MESG
*Mesg
;
203 HTTP_BOOT_DHCP4_OPTION_MAX_MESG_SIZE
*MaxMesgSize
;
204 } HTTP_BOOT_DHCP4_OPTION_ENTRY
;
206 #define GET_NEXT_DHCP_OPTION(Opt) \
207 (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + \
208 sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)
210 #define GET_OPTION_BUFFER_LEN(Pkt) \
211 ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)
213 #define DEFAULT_CLASS_ID_DATA "HTTPClient:Arch:xxxxx:UNDI:003000"
214 #define DEFAULT_UNDI_TYPE 1
215 #define DEFAULT_UNDI_MAJOR 3
216 #define DEFAULT_UNDI_MINOR 0
220 } HTTP_BOOT_VENDOR_OPTION
;
223 EFI_DHCP4_PACKET Offer
;
224 EFI_DHCP4_PACKET Ack
;
225 UINT8 Buffer
[HTTP_BOOT_DHCP4_PACKET_MAX_SIZE
];
226 } HTTP_BOOT_DHCP4_PACKET
;
236 CHAR8
*Fragment
; /// TODO: may not required in HTTP URL
238 CHAR8
*RegName
; /// Point to somewhere in Authority
240 EFI_IP_ADDRESS Address
;
242 } HTTP_BOOT_URI_CONTENT
;
245 HTTP_BOOT_DHCP4_PACKET Packet
;
246 HTTP_BOOT_OFFER_TYPE OfferType
;
248 EFI_DHCP4_PACKET_OPTION
*OptList
[HTTP_BOOT_DHCP4_TAG_INDEX_MAX
];
249 } HTTP_BOOT_DHCP4_PACKET_CACHE
;
252 Select an DHCPv4 or DHCP6 offer, and record SelectIndex and SelectProxyType.
254 @param[in] Private Pointer to HTTP boot driver private data.
258 HttpBootSelectDhcpOffer (
259 IN HTTP_BOOT_PRIVATE_DATA
*Private
263 Start the D.O.R.A DHCPv4 process to acquire the IPv4 address and other Http boot information.
265 @param[in] Private Pointer to HTTP_BOOT private data.
267 @retval EFI_SUCCESS The D.O.R.A process successfully finished.
268 @retval Others Failed to finish the D.O.R.A process.
273 IN HTTP_BOOT_PRIVATE_DATA
*Private
277 This function will register the default DNS addresses to the network device.
279 @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
280 @param[in] DataLength Size of the buffer pointed to by DnsServerData in bytes.
281 @param[in] DnsServerData Point a list of DNS server address in an array
282 of EFI_IPv4_ADDRESS instances.
284 @retval EFI_SUCCESS The DNS configuration has been configured successfully.
285 @retval Others Failed to configure the address.
289 HttpBootRegisterIp4Dns (
290 IN HTTP_BOOT_PRIVATE_DATA
*Private
,
292 IN VOID
*DnsServerData