2 Functions declaration related with DHCPv6 for UefiPxeBc Driver.
4 Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>
6 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.
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.
16 #ifndef __EFI_PXEBC_DHCP6_H__
17 #define __EFI_PXEBC_DHCP6_H__
19 #define PXEBC_DHCP6_OPTION_MAX_NUM 16
20 #define PXEBC_DHCP6_OPTION_MAX_SIZE 312
21 #define PXEBC_DHCP6_PACKET_MAX_SIZE (sizeof (EFI_PXE_BASE_CODE_PACKET))
22 #define PXEBC_IP6_POLICY_MAX 0xff
23 #define PXEBC_IP6_ROUTE_TABLE_TIMEOUT 10
25 #define PXEBC_DHCP6_S_PORT 547
26 #define PXEBC_DHCP6_C_PORT 546
28 #define PXEBC_DHCP6_ENTERPRISE_NUM 343 // TODO: IANA TBD: temporarily using Intel's
29 #define PXEBC_DHCP6_MAX_BOOT_FILE_SIZE 65535 // It's a limitation of bit length, 65535*512 bytes.
32 #define PXEBC_DHCP6_IDX_IA_NA 0
33 #define PXEBC_DHCP6_IDX_BOOT_FILE_URL 1
34 #define PXEBC_DHCP6_IDX_BOOT_FILE_PARAM 2
35 #define PXEBC_DHCP6_IDX_VENDOR_CLASS 3
36 #define PXEBC_DHCP6_IDX_DNS_SERVER 4
37 #define PXEBC_DHCP6_IDX_MAX 5
39 #define PXEBC_DHCP6_BOOT_FILE_URL_PREFIX "tftp://"
40 #define PXEBC_TFTP_URL_SEPARATOR '/'
41 #define PXEBC_ADDR_START_DELIMITER '['
42 #define PXEBC_ADDR_END_DELIMITER ']'
44 #define GET_NEXT_DHCP6_OPTION(Opt) \
45 (EFI_DHCP6_PACKET_OPTION *) ((UINT8 *) (Opt) + \
46 sizeof (EFI_DHCP6_PACKET_OPTION) + (NTOHS ((Opt)->OpLen)) - 1)
48 #define GET_DHCP6_OPTION_SIZE(Pkt) \
49 ((Pkt)->Length - sizeof (EFI_DHCP6_HEADER))
51 #define IS_PROXY_OFFER(Type) \
52 ((Type) == PxeOfferTypeProxyBinl || \
53 (Type) == PxeOfferTypeProxyPxe10 || \
54 (Type) == PxeOfferTypeProxyWfm11a)
60 } PXEBC_DHCP6_OPTION_ORO
;
66 } PXEBC_DHCP6_OPTION_UNDI
;
70 } PXEBC_DHCP6_OPTION_ARCH
;
73 UINT8 ClassIdentifier
[10];
74 UINT8 ArchitecturePrefix
[5];
75 UINT8 ArchitectureType
[5];
77 UINT8 InterfaceName
[4];
86 PXEBC_CLASS_ID ClassId
;
87 } PXEBC_DHCP6_OPTION_VENDOR_CLASS
;
92 PXEBC_DHCP6_OPTION_ORO
*Oro
;
93 PXEBC_DHCP6_OPTION_UNDI
*Undi
;
94 PXEBC_DHCP6_OPTION_ARCH
*Arch
;
95 PXEBC_DHCP6_OPTION_VENDOR_CLASS
*VendorClass
;
96 } PXEBC_DHCP6_OPTION_ENTRY
;
100 EFI_DHCP6_PACKET_OPTION
*Option
;
102 } PXEBC_DHCP6_OPTION_NODE
;
104 #define PXEBC_CACHED_DHCP6_PACKET_MAX_SIZE (OFFSET_OF (EFI_DHCP6_PACKET, Dhcp6) + PXEBC_DHCP6_PACKET_MAX_SIZE)
107 EFI_DHCP6_PACKET Offer
;
108 EFI_DHCP6_PACKET Ack
;
109 UINT8 Buffer
[PXEBC_CACHED_DHCP6_PACKET_MAX_SIZE
];
110 } PXEBC_DHCP6_PACKET
;
113 PXEBC_DHCP6_PACKET Packet
;
114 PXEBC_OFFER_TYPE OfferType
;
115 EFI_DHCP6_PACKET_OPTION
*OptList
[PXEBC_DHCP6_IDX_MAX
];
116 } PXEBC_DHCP6_PACKET_CACHE
;
120 Free all the nodes in the boot file list.
122 @param[in] Head The pointer to the head of the list.
126 PxeBcFreeBootFileOption (
132 Parse the Boot File URL option.
134 @param[in] Private Pointer to PxeBc private data.
135 @param[out] FileName The pointer to the boot file name.
136 @param[in, out] SrvAddr The pointer to the boot server address.
137 @param[in] BootFile The pointer to the boot file URL option data.
138 @param[in] Length Length of the boot file URL option data.
140 @retval EFI_ABORTED User canceled the operation.
141 @retval EFI_SUCCESS Selected the boot menu successfully.
142 @retval EFI_NOT_READY Read the input key from the keybroad has not finish.
146 PxeBcExtractBootFileUrl (
147 IN PXEBC_PRIVATE_DATA
*Private
,
148 OUT UINT8
**FileName
,
149 IN OUT EFI_IPv6_ADDRESS
*SrvAddr
,
156 Parse the Boot File Parameter option.
158 @param[in] BootFilePara The pointer to the boot file parameter option data.
159 @param[out] BootFileSize The pointer to the parsed boot file size.
161 @retval EFI_SUCCESS Successfully obtained the boot file size from parameter option.
162 @retval EFI_NOT_FOUND Failed to extract the boot file size from parameter option.
166 PxeBcExtractBootFileParam (
167 IN CHAR8
*BootFilePara
,
168 OUT UINT16
*BootFileSize
173 Parse the cached DHCPv6 packet, including all the options.
175 @param[in] Cache6 The pointer to a cached DHCPv6 packet.
177 @retval EFI_SUCCESS Parsed the DHCPv6 packet successfully.
178 @retval EFI_DEVICE_ERROR Failed to parse and invalid packet.
182 PxeBcParseDhcp6Packet (
183 IN PXEBC_DHCP6_PACKET_CACHE
*Cache6
188 Register the ready address by Ip6Config protocol.
190 @param[in] Private The pointer to the PxeBc private data.
191 @param[in] Address The pointer to the ready address.
193 @retval EFI_SUCCESS Registered the address succesfully.
194 @retval Others Failed to register the address.
198 PxeBcRegisterIp6Address (
199 IN PXEBC_PRIVATE_DATA
*Private
,
200 IN EFI_IPv6_ADDRESS
*Address
205 Unregister the address by Ip6Config protocol.
207 @param[in] Private The pointer to the PxeBc private data.
211 PxeBcUnregisterIp6Address (
212 IN PXEBC_PRIVATE_DATA
*Private
217 Build and send out the request packet for the bootfile, and parse the reply.
219 @param[in] Private The pointer to the PxeBc private data.
220 @param[in] Type PxeBc option boot item type.
221 @param[in] Layer The pointer to the option boot item layer.
222 @param[in] UseBis Use BIS or not.
223 @param[in] DestIp The pointer to the server address.
225 @retval EFI_SUCCESS Successfully discovered theboot file.
226 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource.
227 @retval EFI_NOT_FOUND Can't get the PXE reply packet.
228 @retval Others Failed to discover boot file.
233 IN PXEBC_PRIVATE_DATA
*Private
,
237 IN EFI_IP_ADDRESS
*DestIp
241 Set the IP6 policy to Automatic.
243 @param[in] Private The pointer to PXEBC_PRIVATE_DATA.
245 @retval EFI_SUCCESS Switch the IP policy succesfully.
246 @retval Others Unexpect error happened.
251 IN PXEBC_PRIVATE_DATA
*Private
255 This function will register the station IP address and flush IP instance to start using the new IP address.
257 @param[in] Private The pointer to PXEBC_PRIVATE_DATA.
259 @retval EFI_SUCCESS The new IP address has been configured successfully.
260 @retval Others Failed to configure the address.
265 IN PXEBC_PRIVATE_DATA
*Private
269 Start the DHCPv6 S.A.R.R. process to acquire the IPv6 address and other PXE boot information.
271 @param[in] Private The pointer to the PxeBc private data.
272 @param[in] Dhcp6 The pointer to EFI_DHCP6_PROTOCOL.
274 @retval EFI_SUCCESS The S.A.R.R. process successfully finished.
275 @retval Others Failed to finish the S.A.R.R. process.
280 IN PXEBC_PRIVATE_DATA
*Private
,
281 IN EFI_DHCP6_PROTOCOL
*Dhcp6