2 Functions declaration related with DHCPv6 for UefiPxeBc Driver.
4 Copyright (c) 2009 - 2012, 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 1472
22 #define PXEBC_IP6_POLICY_MAX 0xff
24 #define PXEBC_DHCP6_S_PORT 547
25 #define PXEBC_DHCP6_C_PORT 546
27 #define PXEBC_DHCP6_OPT_CLIENT_ID 1
28 #define PXEBC_DHCP6_OPT_SERVER_ID 2
29 #define PXEBC_DHCP6_OPT_IA_NA 3
30 #define PXEBC_DHCP6_OPT_IA_TA 4
31 #define PXEBC_DHCP6_OPT_IAADDR 5
32 #define PXEBC_DHCP6_OPT_ORO 6
33 #define PXEBC_DHCP6_OPT_PREFERENCE 7
34 #define PXEBC_DHCP6_OPT_ELAPSED_TIME 8
35 #define PXEBC_DHCP6_OPT_REPLAY_MSG 9
36 #define PXEBC_DHCP6_OPT_AUTH 11
37 #define PXEBC_DHCP6_OPT_UNICAST 12
38 #define PXEBC_DHCP6_OPT_STATUS_CODE 13
39 #define PXEBC_DHCP6_OPT_RAPID_COMMIT 14
40 #define PXEBC_DHCP6_OPT_USER_CLASS 15
41 #define PXEBC_DHCP6_OPT_VENDOR_CLASS 16
42 #define PXEBC_DHCP6_OPT_VENDOR_OPTS 17
43 #define PXEBC_DHCP6_OPT_INTERFACE_ID 18
44 #define PXEBC_DHCP6_OPT_RECONFIG_MSG 19
45 #define PXEBC_DHCP6_OPT_RECONFIG_ACCEPT 20
46 #define PXEBC_DHCP6_OPT_BOOT_FILE_URL 59 // Assigned by IANA, RFC 5970
47 #define PXEBC_DHCP6_OPT_BOOT_FILE_PARAM 60 // Assigned by IANA, RFC 5970
48 #define PXEBC_DHCP6_OPT_ARCH 61 // Assigned by IANA, RFC 5970
49 #define PXEBC_DHCP6_OPT_UNDI 62 // Assigned by IANA, RFC 5970
50 #define PXEBC_DHCP6_ENTERPRISE_NUM 343 // TODO: IANA TBD: temporarily using Intel's
51 #define PXEBC_DHCP6_MAX_BOOT_FILE_SIZE 65535 // It's a limitation of bit length, 65535*512 bytes.
54 #define PXEBC_DHCP6_IDX_IA_NA 0
55 #define PXEBC_DHCP6_IDX_BOOT_FILE_URL 1
56 #define PXEBC_DHCP6_IDX_BOOT_FILE_PARAM 2
57 #define PXEBC_DHCP6_IDX_VENDOR_CLASS 3
58 #define PXEBC_DHCP6_IDX_MAX 4
60 #define PXEBC_DHCP6_BOOT_FILE_URL_PREFIX "tftp://"
61 #define PXEBC_TFTP_URL_SEPARATOR '/'
62 #define PXEBC_ADDR_START_DELIMITER '['
63 #define PXEBC_ADDR_END_DELIMITER ']'
65 #define GET_NEXT_DHCP6_OPTION(Opt) \
66 (EFI_DHCP6_PACKET_OPTION *) ((UINT8 *) (Opt) + \
67 sizeof (EFI_DHCP6_PACKET_OPTION) + (NTOHS ((Opt)->OpLen)) - 1)
69 #define GET_DHCP6_OPTION_SIZE(Pkt) \
70 ((Pkt)->Length - sizeof (EFI_DHCP6_HEADER))
72 #define IS_PROXY_OFFER(Type) \
73 ((Type) == PxeOfferTypeProxyBinl || \
74 (Type) == PxeOfferTypeProxyPxe10 || \
75 (Type) == PxeOfferTypeProxyWfm11a)
81 } PXEBC_DHCP6_OPTION_ORO
;
87 } PXEBC_DHCP6_OPTION_UNDI
;
91 } PXEBC_DHCP6_OPTION_ARCH
;
94 UINT8 ClassIdentifier
[10];
95 UINT8 ArchitecturePrefix
[5];
96 UINT8 ArchitectureType
[5];
98 UINT8 InterfaceName
[4];
107 PXEBC_CLASS_ID ClassId
;
108 } PXEBC_DHCP6_OPTION_VENDOR_CLASS
;
113 PXEBC_DHCP6_OPTION_ORO
*Oro
;
114 PXEBC_DHCP6_OPTION_UNDI
*Undi
;
115 PXEBC_DHCP6_OPTION_ARCH
*Arch
;
116 PXEBC_DHCP6_OPTION_VENDOR_CLASS
*VendorClass
;
117 } PXEBC_DHCP6_OPTION_ENTRY
;
121 EFI_DHCP6_PACKET_OPTION
*Option
;
123 } PXEBC_DHCP6_OPTION_NODE
;
126 EFI_DHCP6_PACKET Offer
;
127 EFI_DHCP6_PACKET Ack
;
128 UINT8 Buffer
[PXEBC_DHCP6_PACKET_MAX_SIZE
];
129 } PXEBC_DHCP6_PACKET
;
132 PXEBC_DHCP6_PACKET Packet
;
133 PXEBC_OFFER_TYPE OfferType
;
134 EFI_DHCP6_PACKET_OPTION
*OptList
[PXEBC_DHCP6_IDX_MAX
];
135 } PXEBC_DHCP6_PACKET_CACHE
;
139 Free all the nodes in the boot file list.
141 @param[in] Head The pointer to the head of the list.
145 PxeBcFreeBootFileOption (
151 Parse the Boot File URL option.
153 @param[out] FileName The pointer to the boot file name.
154 @param[in, out] SrvAddr The pointer to the boot server address.
155 @param[in] BootFile The pointer to the boot file URL option data.
156 @param[in] Length Length of the boot file URL option data.
158 @retval EFI_ABORTED User canceled the operation.
159 @retval EFI_SUCCESS Selected the boot menu successfully.
160 @retval EFI_NOT_READY Read the input key from the keybroad has not finish.
164 PxeBcExtractBootFileUrl (
165 OUT UINT8
**FileName
,
166 IN OUT EFI_IPv6_ADDRESS
*SrvAddr
,
173 Parse the Boot File Parameter option.
175 @param[in] BootFilePara The pointer to the boot file parameter option data.
176 @param[out] BootFileSize The pointer to the parsed boot file size.
178 @retval EFI_SUCCESS Successfully obtained the boot file size from parameter option.
179 @retval EFI_NOT_FOUND Failed to extract the boot file size from parameter option.
183 PxeBcExtractBootFileParam (
184 IN CHAR8
*BootFilePara
,
185 OUT UINT16
*BootFileSize
190 Parse the cached DHCPv6 packet, including all the options.
192 @param[in] Cache6 The pointer to a cached DHCPv6 packet.
194 @retval EFI_SUCCESS Parsed the DHCPv6 packet successfully.
195 @retval EFI_DEVICE_ERROR Failed to parse and invalid packet.
199 PxeBcParseDhcp6Packet (
200 IN PXEBC_DHCP6_PACKET_CACHE
*Cache6
205 Register the ready address by Ip6Config protocol.
207 @param[in] Private The pointer to the PxeBc private data.
208 @param[in] Address The pointer to the ready address.
210 @retval EFI_SUCCESS Registered the address succesfully.
211 @retval Others Failed to register the address.
215 PxeBcRegisterIp6Address (
216 IN PXEBC_PRIVATE_DATA
*Private
,
217 IN EFI_IPv6_ADDRESS
*Address
222 Unregister the address by Ip6Config protocol.
224 @param[in] Private The pointer to the PxeBc private data.
228 PxeBcUnregisterIp6Address (
229 IN PXEBC_PRIVATE_DATA
*Private
234 Build and send out the request packet for the bootfile, and parse the reply.
236 @param[in] Private The pointer to the PxeBc private data.
237 @param[in] Type PxeBc option boot item type.
238 @param[in] Layer The pointer to the option boot item layer.
239 @param[in] UseBis Use BIS or not.
240 @param[in] DestIp The pointer to the server address.
242 @retval EFI_SUCCESS Successfully discovered theboot file.
243 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource.
244 @retval EFI_NOT_FOUND Can't get the PXE reply packet.
245 @retval Others Failed to discover boot file.
250 IN PXEBC_PRIVATE_DATA
*Private
,
254 IN EFI_IP_ADDRESS
*DestIp
259 Start the DHCPv6 S.A.R.R. process to acquire the IPv6 address and other PXE boot information.
261 @param[in] Private The pointer to the PxeBc private data.
262 @param[in] Dhcp6 The pointer to EFI_DHCP6_PROTOCOL.
264 @retval EFI_SUCCESS The S.A.R.R. process successfully finished.
265 @retval Others Failed to finish the S.A.R.R. process.
270 IN PXEBC_PRIVATE_DATA
*Private
,
271 IN EFI_DHCP6_PROTOCOL
*Dhcp6