]>
Commit | Line | Data |
---|---|---|
30368135 | 1 | /** @file\r |
f737cfb9 | 2 | Dhcp and Discover routines for PxeBc.\r |
30368135 | 3 | \r |
e3cf3c20 | 4 | Copyright (c) 2013, Red Hat, Inc.\r |
14e84fd8 | 5 | Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 6 | This program and the accompanying materials\r |
30368135 | 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 | |
30368135 | 14 | **/\r |
15 | \r | |
16 | #ifndef __EFI_PXEBC_DHCP_H__\r | |
17 | #define __EFI_PXEBC_DHCP_H__\r | |
18 | \r | |
f6b7393c | 19 | #define PXEBC_DHCP4_MAX_OPTION_NUM 16\r |
20 | #define PXEBC_DHCP4_MAX_OPTION_SIZE 312\r | |
21 | #define PXEBC_DHCP4_MAX_PACKET_SIZE 1472\r | |
22 | \r | |
23 | #define PXEBC_DHCP4_S_PORT 67\r | |
24 | #define PXEBC_DHCP4_C_PORT 68\r | |
25 | #define PXEBC_BS_DOWNLOAD_PORT 69\r | |
26 | #define PXEBC_BS_DISCOVER_PORT 4011\r | |
27 | \r | |
28 | #define PXEBC_DHCP4_OPCODE_REQUEST 1\r | |
29 | #define PXEBC_DHCP4_OPCODE_REPLY 2\r | |
30 | #define PXEBC_DHCP4_MSG_TYPE_REQUEST 3\r | |
31 | #define PXEBC_DHCP4_MAGIC 0x63538263 // network byte order\r | |
32 | //\r | |
33 | // Dhcp Options\r | |
34 | //\r | |
35 | #define PXEBC_DHCP4_TAG_PAD 0 // Pad Option\r | |
36 | #define PXEBC_DHCP4_TAG_EOP 255 // End Option\r | |
37 | #define PXEBC_DHCP4_TAG_NETMASK 1 // Subnet Mask\r | |
38 | #define PXEBC_DHCP4_TAG_TIME_OFFSET 2 // Time Offset from UTC\r | |
39 | #define PXEBC_DHCP4_TAG_ROUTER 3 // Router option,\r | |
40 | #define PXEBC_DHCP4_TAG_TIME_SERVER 4 // Time Server\r | |
41 | #define PXEBC_DHCP4_TAG_NAME_SERVER 5 // Name Server\r | |
42 | #define PXEBC_DHCP4_TAG_DNS_SERVER 6 // Domain Name Server\r | |
43 | #define PXEBC_DHCP4_TAG_HOSTNAME 12 // Host Name\r | |
44 | #define PXEBC_DHCP4_TAG_BOOTFILE_LEN 13 // Boot File Size\r | |
45 | #define PXEBC_DHCP4_TAG_DUMP 14 // Merit Dump File\r | |
46 | #define PXEBC_DHCP4_TAG_DOMAINNAME 15 // Domain Name\r | |
47 | #define PXEBC_DHCP4_TAG_ROOTPATH 17 // Root path\r | |
48 | #define PXEBC_DHCP4_TAG_EXTEND_PATH 18 // Extensions Path\r | |
49 | #define PXEBC_DHCP4_TAG_EMTU 22 // Maximum Datagram Reassembly Size\r | |
50 | #define PXEBC_DHCP4_TAG_TTL 23 // Default IP Time-to-live\r | |
51 | #define PXEBC_DHCP4_TAG_BROADCAST 28 // Broadcast Address\r | |
52 | #define PXEBC_DHCP4_TAG_NIS_DOMAIN 40 // Network Information Service Domain\r | |
53 | #define PXEBC_DHCP4_TAG_NIS_SERVER 41 // Network Information Servers\r | |
54 | #define PXEBC_DHCP4_TAG_NTP_SERVER 42 // Network Time Protocol Servers\r | |
55 | #define PXEBC_DHCP4_TAG_VENDOR 43 // Vendor Specific Information\r | |
56 | #define PXEBC_DHCP4_TAG_REQUEST_IP 50 // Requested IP Address\r | |
57 | #define PXEBC_DHCP4_TAG_LEASE 51 // IP Address Lease Time\r | |
58 | #define PXEBC_DHCP4_TAG_OVERLOAD 52 // Option Overload\r | |
59 | #define PXEBC_DHCP4_TAG_MSG_TYPE 53 // DHCP Message Type\r | |
60 | #define PXEBC_DHCP4_TAG_SERVER_ID 54 // Server Identifier\r | |
61 | #define PXEBC_DHCP4_TAG_PARA_LIST 55 // Parameter Request List\r | |
62 | #define PXEBC_DHCP4_TAG_MAXMSG 57 // Maximum DHCP Message Size\r | |
63 | #define PXEBC_DHCP4_TAG_T1 58 // Renewal (T1) Time Value\r | |
64 | #define PXEBC_DHCP4_TAG_T2 59 // Rebinding (T2) Time Value\r | |
65 | #define PXEBC_DHCP4_TAG_CLASS_ID 60 // Vendor class identifier\r | |
66 | #define PXEBC_DHCP4_TAG_CLIENT_ID 61 // Client-identifier\r | |
67 | #define PXEBC_DHCP4_TAG_TFTP 66 // TFTP server name\r | |
68 | #define PXEBC_DHCP4_TAG_BOOTFILE 67 // Bootfile name\r | |
69 | #define PXEBC_PXE_DHCP4_TAG_ARCH 93\r | |
70 | #define PXEBC_PXE_DHCP4_TAG_UNDI 94\r | |
71 | #define PXEBC_PXE_DHCP4_TAG_UUID 97\r | |
72 | //\r | |
73 | // Sub-Options in Dhcp Vendor Option\r | |
74 | //\r | |
75 | #define PXEBC_VENDOR_TAG_MTFTP_IP 1\r | |
76 | #define PXEBC_VENDOR_TAG_MTFTP_CPORT 2\r | |
77 | #define PXEBC_VENDOR_TAG_MTFTP_SPORT 3\r | |
78 | #define PXEBC_VENDOR_TAG_MTFTP_TIMEOUT 4\r | |
79 | #define PXEBC_VENDOR_TAG_MTFTP_DELAY 5\r | |
80 | #define PXEBC_VENDOR_TAG_DISCOVER_CTRL 6\r | |
81 | #define PXEBC_VENDOR_TAG_DISCOVER_MCAST 7\r | |
82 | #define PXEBC_VENDOR_TAG_BOOT_SERVERS 8\r | |
83 | #define PXEBC_VENDOR_TAG_BOOT_MENU 9\r | |
84 | #define PXEBC_VENDOR_TAG_MENU_PROMPT 10\r | |
85 | #define PXEBC_VENDOR_TAG_MCAST_ALLOC 11\r | |
86 | #define PXEBC_VENDOR_TAG_CREDENTIAL_TYPES 12\r | |
87 | #define PXEBC_VENDOR_TAG_BOOT_ITEM 71\r | |
88 | \r | |
89 | #define PXEBC_DHCP4_DISCOVER_INIT_TIMEOUT 4\r | |
90 | #define PXEBC_DHCP4_DISCOVER_RETRIES 4\r | |
91 | \r | |
92 | #define PXEBC_MAX_MENU_NUM 24\r | |
93 | #define PXEBC_MAX_OFFER_NUM 16\r | |
94 | \r | |
95 | #define PXEBC_BOOT_REQUEST_TIMEOUT 1\r | |
96 | #define PXEBC_BOOT_REQUEST_RETRIES 4\r | |
97 | \r | |
98 | #define PXEBC_DHCP4_OVERLOAD_FILE 1\r | |
99 | #define PXEBC_DHCP4_OVERLOAD_SERVER_NAME 2\r | |
30368135 | 100 | \r |
101 | //\r | |
102 | // The array index of the DHCP4 option tag interested\r | |
103 | //\r | |
f6b7393c | 104 | #define PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN 0\r |
105 | #define PXEBC_DHCP4_TAG_INDEX_VENDOR 1\r | |
106 | #define PXEBC_DHCP4_TAG_INDEX_OVERLOAD 2\r | |
107 | #define PXEBC_DHCP4_TAG_INDEX_MSG_TYPE 3\r | |
108 | #define PXEBC_DHCP4_TAG_INDEX_SERVER_ID 4\r | |
109 | #define PXEBC_DHCP4_TAG_INDEX_CLASS_ID 5\r | |
110 | #define PXEBC_DHCP4_TAG_INDEX_BOOTFILE 6\r | |
111 | #define PXEBC_DHCP4_TAG_INDEX_MAX 7\r | |
30368135 | 112 | \r |
113 | //\r | |
114 | // The type of DHCP OFFER, arranged by priority, PXE10 has the highest priority.\r | |
115 | //\r | |
f6b7393c | 116 | #define DHCP4_PACKET_TYPE_PXE10 0\r |
117 | #define DHCP4_PACKET_TYPE_WFM11A 1\r | |
118 | #define DHCP4_PACKET_TYPE_BINL 2\r | |
119 | #define DHCP4_PACKET_TYPE_DHCP_ONLY 3\r | |
379db4ac | 120 | #define DHCP4_PACKET_TYPE_BOOTP 4\r |
121 | #define DHCP4_PACKET_TYPE_MAX 5\r | |
30368135 | 122 | \r |
123 | #define BIT(x) (1 << x)\r | |
124 | #define CTRL(x) (0x1F & (x))\r | |
125 | \r | |
126 | //\r | |
127 | // WfM11a options\r | |
128 | //\r | |
129 | #define MTFTP_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_MTFTP_IP) | \\r | |
130 | BIT (PXEBC_VENDOR_TAG_MTFTP_CPORT) | \\r | |
131 | BIT (PXEBC_VENDOR_TAG_MTFTP_SPORT) | \\r | |
132 | BIT (PXEBC_VENDOR_TAG_MTFTP_TIMEOUT) | \\r | |
133 | BIT (PXEBC_VENDOR_TAG_MTFTP_DELAY))\r | |
134 | //\r | |
135 | // Discoverty options\r | |
136 | //\r | |
137 | #define DISCOVER_VENDOR_OPTION_BIT_MAP (BIT (PXEBC_VENDOR_TAG_DISCOVER_CTRL) | \\r | |
138 | BIT (PXEBC_VENDOR_TAG_DISCOVER_MCAST) | \\r | |
139 | BIT (PXEBC_VENDOR_TAG_BOOT_SERVERS) | \\r | |
140 | BIT (PXEBC_VENDOR_TAG_BOOT_MENU) | \\r | |
141 | BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))\r | |
142 | \r | |
143 | #define IS_VALID_BOOT_PROMPT(x) \\r | |
144 | ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_MENU_PROMPT)) == BIT (PXEBC_VENDOR_TAG_MENU_PROMPT))\r | |
145 | \r | |
146 | #define IS_VALID_BOOT_MENU(x) \\r | |
147 | ((((x)[0]) & BIT (PXEBC_VENDOR_TAG_BOOT_MENU)) == BIT (PXEBC_VENDOR_TAG_BOOT_MENU))\r | |
148 | \r | |
149 | #define IS_VALID_MTFTP_VENDOR_OPTION(x) \\r | |
150 | (((UINT32) ((x)[0]) & MTFTP_VENDOR_OPTION_BIT_MAP) == MTFTP_VENDOR_OPTION_BIT_MAP)\r | |
151 | \r | |
152 | #define IS_VALID_DISCOVER_VENDOR_OPTION(x) (((UINT32) ((x)[0]) & DISCOVER_VENDOR_OPTION_BIT_MAP) != 0)\r | |
153 | \r | |
154 | #define IS_VALID_CREDENTIAL_VENDOR_OPTION(x) \\r | |
155 | (((UINT32) ((x)[0]) & BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES)) == BIT (PXEBC_VENDOR_TAG_CREDENTIAL_TYPES))\r | |
156 | \r | |
157 | #define IS_VALID_BOOTITEM_VENDOR_OPTION(x) \\r | |
158 | (((UINT32) ((x)[PXEBC_VENDOR_TAG_BOOT_ITEM / 32]) & BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32)) \\r | |
159 | == BIT (PXEBC_VENDOR_TAG_BOOT_ITEM % 32))\r | |
160 | \r | |
161 | #define IS_DISABLE_BCAST_DISCOVER(x) (((x) & BIT (0)) == BIT (0))\r | |
162 | #define IS_DISABLE_MCAST_DISCOVER(x) (((x) & BIT (1)) == BIT (1))\r | |
163 | #define IS_ENABLE_USE_SERVER_LIST(x) (((x) & BIT (2)) == BIT (2))\r | |
30a95d4d | 164 | #define IS_DISABLE_PROMPT_MENU(x) (((x) & BIT (3)) == BIT (3))\r |
30368135 | 165 | \r |
166 | #define SET_VENDOR_OPTION_BIT_MAP(x, y) (((x)[(y) / 32]) = (UINT32) ((x)[(y) / 32]) | BIT ((y) % 32))\r | |
167 | \r | |
168 | #pragma pack(1)\r | |
169 | typedef struct {\r | |
170 | UINT8 ParaList[135];\r | |
171 | } PXEBC_DHCP4_OPTION_PARA;\r | |
172 | \r | |
173 | typedef struct {\r | |
174 | UINT16 Size;\r | |
175 | } PXEBC_DHCP4_OPTION_MAX_MESG_SIZE;\r | |
176 | \r | |
177 | typedef struct {\r | |
178 | UINT8 Type;\r | |
179 | UINT8 MajorVer;\r | |
180 | UINT8 MinorVer;\r | |
181 | } PXEBC_DHCP4_OPTION_UNDI;\r | |
182 | \r | |
183 | typedef struct {\r | |
184 | UINT8 Type;\r | |
185 | } PXEBC_DHCP4_OPTION_MESG;\r | |
186 | \r | |
187 | typedef struct {\r | |
188 | UINT16 Type;\r | |
189 | } PXEBC_DHCP4_OPTION_ARCH;\r | |
190 | \r | |
169a3461 | 191 | #define DEFAULT_CLASS_ID_DATA "PXEClient:Arch:xxxxx:UNDI:003000"\r |
192 | #define DEFAULT_UNDI_TYPE 1\r | |
193 | #define DEFAULT_UNDI_MAJOR 3\r | |
194 | #define DEFAULT_UNDI_MINOR 0\r | |
30368135 | 195 | \r |
196 | typedef struct {\r | |
197 | UINT8 ClassIdentifier[10];\r | |
198 | UINT8 ArchitecturePrefix[5];\r | |
199 | UINT8 ArchitectureType[5];\r | |
200 | UINT8 Lit3[1];\r | |
201 | UINT8 InterfaceName[4];\r | |
202 | UINT8 Lit4[1];\r | |
203 | UINT8 UndiMajor[3];\r | |
204 | UINT8 UndiMinor[3];\r | |
205 | } PXEBC_DHCP4_OPTION_CLID;\r | |
206 | \r | |
207 | typedef struct {\r | |
208 | UINT8 Type;\r | |
209 | UINT8 Guid[16];\r | |
210 | } PXEBC_DHCP4_OPTION_UUID;\r | |
211 | \r | |
212 | typedef struct {\r | |
213 | UINT16 Type;\r | |
214 | UINT16 Layer;\r | |
215 | } PXEBC_OPTION_BOOT_ITEM;\r | |
216 | \r | |
217 | #pragma pack()\r | |
218 | \r | |
219 | typedef union {\r | |
220 | PXEBC_DHCP4_OPTION_PARA *Para;\r | |
221 | PXEBC_DHCP4_OPTION_UNDI *Undi;\r | |
222 | PXEBC_DHCP4_OPTION_ARCH *Arch;\r | |
223 | PXEBC_DHCP4_OPTION_CLID *Clid;\r | |
224 | PXEBC_DHCP4_OPTION_UUID *Uuid;\r | |
225 | PXEBC_DHCP4_OPTION_MESG *Mesg;\r | |
226 | PXEBC_DHCP4_OPTION_MAX_MESG_SIZE *MaxMesgSize;\r | |
227 | } PXEBC_DHCP4_OPTION_ENTRY;\r | |
228 | \r | |
229 | typedef struct {\r | |
230 | UINT16 Type;\r | |
231 | UINT8 IpCnt;\r | |
232 | EFI_IPv4_ADDRESS IpAddr[1];\r | |
233 | } PXEBC_BOOT_SVR_ENTRY;\r | |
234 | \r | |
235 | typedef struct {\r | |
236 | UINT16 Type;\r | |
237 | UINT8 DescLen;\r | |
238 | UINT8 DescStr[1];\r | |
239 | } PXEBC_BOOT_MENU_ENTRY;\r | |
240 | \r | |
241 | typedef struct {\r | |
242 | UINT8 Timeout;\r | |
243 | UINT8 Prompt[1];\r | |
244 | } PXEBC_MENU_PROMPT;\r | |
245 | \r | |
246 | typedef struct {\r | |
247 | UINT32 BitMap[8];\r | |
248 | EFI_IPv4_ADDRESS MtftpIp;\r | |
249 | UINT16 MtftpCPort;\r | |
250 | UINT16 MtftpSPort;\r | |
251 | UINT8 MtftpTimeout;\r | |
252 | UINT8 MtftpDelay;\r | |
253 | UINT8 DiscoverCtrl;\r | |
254 | EFI_IPv4_ADDRESS DiscoverMcastIp;\r | |
255 | EFI_IPv4_ADDRESS McastIpBase;\r | |
256 | UINT16 McastIpBlock;\r | |
257 | UINT16 McastIpRange;\r | |
258 | UINT16 BootSrvType;\r | |
259 | UINT16 BootSrvLayer;\r | |
260 | PXEBC_BOOT_SVR_ENTRY *BootSvr;\r | |
261 | UINT8 BootSvrLen;\r | |
262 | PXEBC_BOOT_MENU_ENTRY *BootMenu;\r | |
263 | UINT8 BootMenuLen;\r | |
264 | PXEBC_MENU_PROMPT *MenuPrompt;\r | |
265 | UINT8 MenuPromptLen;\r | |
266 | UINT32 *CredType;\r | |
267 | UINT8 CredTypeLen;\r | |
268 | } PXEBC_VENDOR_OPTION;\r | |
269 | \r | |
f3f2e05d | 270 | #define PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE (OFFSET_OF (EFI_DHCP4_PACKET, Dhcp4) + PXEBC_DHCP4_MAX_PACKET_SIZE)\r |
30368135 | 271 | \r |
f6b7393c | 272 | typedef union {\r |
273 | EFI_DHCP4_PACKET Offer;\r | |
274 | EFI_DHCP4_PACKET Ack;\r | |
275 | UINT8 Buffer[PXEBC_CACHED_DHCP4_PACKET_MAX_SIZE];\r | |
276 | } PXEBC_DHCP4_PACKET;\r | |
30368135 | 277 | \r |
f6b7393c | 278 | typedef struct {\r |
279 | PXEBC_DHCP4_PACKET Packet;\r | |
30368135 | 280 | BOOLEAN IsPxeOffer;\r |
281 | UINT8 OfferType;\r | |
282 | EFI_DHCP4_PACKET_OPTION *Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_MAX];\r | |
283 | PXEBC_VENDOR_OPTION PxeVendorOption;\r | |
284 | } PXEBC_CACHED_DHCP4_PACKET;\r | |
285 | \r | |
286 | #define GET_NEXT_DHCP_OPTION(Opt) \\r | |
287 | (EFI_DHCP4_PACKET_OPTION *) ((UINT8 *) (Opt) + sizeof (EFI_DHCP4_PACKET_OPTION) + (Opt)->Length - 1)\r | |
288 | \r | |
289 | #define GET_OPTION_BUFFER_LEN(Pkt) ((Pkt)->Length - sizeof (EFI_DHCP4_HEADER) - 4)\r | |
290 | #define IS_PROXY_DHCP_OFFER(Offer) EFI_IP4_EQUAL (&((Offer)->Dhcp4.Header.YourAddr), &mZeroIp4Addr)\r | |
291 | \r | |
292 | #define GET_NEXT_BOOT_SVR_ENTRY(Ent) \\r | |
293 | (PXEBC_BOOT_SVR_ENTRY *) ((UINT8 *) Ent + sizeof (*(Ent)) + ((Ent)->IpCnt - 1) * sizeof (EFI_IPv4_ADDRESS))\r | |
294 | \r | |
f737cfb9 | 295 | \r |
296 | /**\r | |
297 | This function initialize the DHCP4 message instance.\r | |
298 | \r | |
299 | This function will pad each item of dhcp4 message packet.\r | |
300 | \r | |
301 | @param Seed Pointer to the message instance of the DHCP4 packet.\r | |
302 | @param Udp4 Pointer to the EFI_UDP4_PROTOCOL instance.\r | |
303 | \r | |
f737cfb9 | 304 | **/\r |
30368135 | 305 | VOID\r |
306 | PxeBcInitSeedPacket (\r | |
307 | IN EFI_DHCP4_PACKET *Seed,\r | |
308 | IN EFI_UDP4_PROTOCOL *Udp4\r | |
d59b8b55 | 309 | );\r |
30368135 | 310 | \r |
311 | \r | |
312 | /**\r | |
f737cfb9 | 313 | Parse the cached dhcp packet.\r |
30368135 | 314 | \r |
f737cfb9 | 315 | @param CachedPacket Pointer to cached dhcp packet.\r |
30368135 | 316 | \r |
d59b8b55 | 317 | @retval TRUE Succeed to parse and validation.\r |
f737cfb9 | 318 | @retval FALSE Fail to parse or validation.\r |
30368135 | 319 | \r |
320 | **/\r | |
321 | BOOLEAN\r | |
322 | PxeBcParseCachedDhcpPacket (\r | |
323 | IN PXEBC_CACHED_DHCP4_PACKET *CachedPacket\r | |
d59b8b55 | 324 | );\r |
30368135 | 325 | \r |
30368135 | 326 | /**\r |
d59b8b55 | 327 | This function is to check the selected proxy offer (include BINL dhcp offer and\r |
f737cfb9 | 328 | DHCP_ONLY offer ) and set the flag and copy the DHCP packets to the Pxe base code\r |
329 | mode structure.\r | |
30368135 | 330 | \r |
f737cfb9 | 331 | @param Private Pointer to PxeBc private data.\r |
30368135 | 332 | \r |
f737cfb9 | 333 | @retval EFI_SUCCESS Operational successful.\r |
334 | @retval EFI_NO_RESPONSE Offer dhcp service failed.\r | |
30368135 | 335 | \r |
336 | **/\r | |
337 | EFI_STATUS\r | |
338 | PxeBcCheckSelectedOffer (\r | |
339 | IN PXEBC_PRIVATE_DATA *Private\r | |
d59b8b55 | 340 | );\r |
30368135 | 341 | \r |
342 | \r | |
343 | /**\r | |
f737cfb9 | 344 | Callback routine.\r |
345 | \r | |
346 | EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver\r | |
347 | to intercept events that occurred in the configuration process. This structure\r | |
348 | provides advanced control of each state transition of the DHCP process. The\r | |
349 | returned status code determines the behavior of the EFI DHCPv4 Protocol driver.\r | |
350 | There are three possible returned values, which are described in the following\r | |
351 | table.\r | |
352 | \r | |
353 | @param This Pointer to the EFI DHCPv4 Protocol instance that is used to\r | |
354 | configure this callback function.\r | |
355 | @param Context Pointer to the context that is initialized by\r | |
356 | EFI_DHCP4_PROTOCOL.Configure().\r | |
357 | @param CurrentState The current operational state of the EFI DHCPv4 Protocol\r | |
358 | driver.\r | |
359 | @param Dhcp4Event The event that occurs in the current state, which usually means a\r | |
360 | state transition.\r | |
361 | @param Packet The DHCP packet that is going to be sent or already received.\r | |
362 | @param NewPacket The packet that is used to replace the above Packet.\r | |
363 | \r | |
364 | @retval EFI_SUCCESS Tells the EFI DHCPv4 Protocol driver to continue the DHCP process.\r | |
365 | @retval EFI_NOT_READY Only used in the Dhcp4Selecting state. The EFI DHCPv4 Protocol\r | |
366 | driver will continue to wait for more DHCPOFFER packets until the retry\r | |
367 | timeout expires.\r | |
368 | @retval EFI_ABORTED Tells the EFI DHCPv4 Protocol driver to abort the current process and\r | |
369 | return to the Dhcp4Init or Dhcp4InitReboot state.\r | |
30368135 | 370 | \r |
371 | **/\r | |
372 | EFI_STATUS\r | |
6d3ea23f | 373 | EFIAPI\r |
30368135 | 374 | PxeBcDhcpCallBack (\r |
375 | IN EFI_DHCP4_PROTOCOL * This,\r | |
376 | IN VOID *Context,\r | |
377 | IN EFI_DHCP4_STATE CurrentState,\r | |
378 | IN EFI_DHCP4_EVENT Dhcp4Event,\r | |
379 | IN EFI_DHCP4_PACKET * Packet OPTIONAL,\r | |
380 | OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL\r | |
d59b8b55 | 381 | );\r |
30368135 | 382 | \r |
14e84fd8 ZL |
383 | /**\r |
384 | Switch the Ip4 policy to static.\r | |
385 | \r | |
386 | @param[in] Private The pointer to PXEBC_PRIVATE_DATA.\r | |
387 | \r | |
388 | @retval EFI_SUCCESS The policy is already configured to static.\r | |
389 | @retval Others Other error as indicated..\r | |
390 | \r | |
391 | **/\r | |
392 | EFI_STATUS\r | |
393 | PxeBcSetIp4Policy ( \r | |
394 | IN PXEBC_PRIVATE_DATA *Private\r | |
395 | );\r | |
30368135 | 396 | \r |
397 | /**\r | |
f737cfb9 | 398 | Discover the boot of service and initialize the vendor option if exists.\r |
399 | \r | |
400 | @param Private Pointer to PxeBc private data.\r | |
401 | @param Type PxeBc option boot item type\r | |
402 | @param Layer PxeBc option boot item layer\r | |
d59b8b55 | 403 | @param UseBis Use BIS or not\r |
404 | @param DestIp Ip address for server \r | |
405 | @param IpCount The total count of the server ip address \r | |
406 | @param SrvList Server list\r | |
407 | @param IsDiscv Discover the vendor or not\r | |
408 | @param Reply The dhcp4 packet of Pxe reply\r | |
409 | \r | |
410 | @retval EFI_SUCCESS Operation succeeds.\r | |
f737cfb9 | 411 | @retval EFI_OUT_OF_RESOURCES Allocate memory pool failed.\r |
412 | @retval EFI_NOT_FOUND There is no vendor option exists.\r | |
413 | @retval EFI_TIMEOUT Send Pxe Discover time out. \r | |
414 | \r | |
30368135 | 415 | **/\r |
416 | EFI_STATUS\r | |
417 | PxeBcDiscvBootService (\r | |
418 | IN PXEBC_PRIVATE_DATA * Private,\r | |
419 | IN UINT16 Type,\r | |
420 | IN UINT16 *Layer,\r | |
421 | IN BOOLEAN UseBis,\r | |
422 | IN EFI_IP_ADDRESS * DestIp,\r | |
423 | IN UINT16 IpCount,\r | |
424 | IN EFI_PXE_BASE_CODE_SRVLIST * SrvList,\r | |
425 | IN BOOLEAN IsDiscv,\r | |
426 | OUT EFI_DHCP4_PACKET * Reply OPTIONAL\r | |
d59b8b55 | 427 | );\r |
30368135 | 428 | \r |
429 | \r | |
430 | /**\r | |
f737cfb9 | 431 | Initialize the DHCP options and build the option list.\r |
30368135 | 432 | \r |
f737cfb9 | 433 | @param Private Pointer to PxeBc private data.\r |
434 | @param OptList Pointer to a DHCP option list.\r | |
435 | \r | |
436 | @param IsDhcpDiscover Discover dhcp option or not. \r | |
30368135 | 437 | \r |
f737cfb9 | 438 | @return The index item number of the option list.\r |
30368135 | 439 | \r |
440 | **/\r | |
441 | UINT32\r | |
442 | PxeBcBuildDhcpOptions (\r | |
443 | IN PXEBC_PRIVATE_DATA *Private,\r | |
444 | IN EFI_DHCP4_PACKET_OPTION **OptList,\r | |
445 | IN BOOLEAN IsDhcpDiscover\r | |
d59b8b55 | 446 | );\r |
30368135 | 447 | \r |
448 | \r | |
449 | /**\r | |
f6b7393c | 450 | Create the boot options.\r |
30368135 | 451 | \r |
f737cfb9 | 452 | @param OptList Pointer to the list of the options\r |
453 | @param Type the type of option\r | |
454 | @param Layer the layer of the boot options \r | |
455 | @param OptLen length of opotion\r | |
30368135 | 456 | \r |
30368135 | 457 | **/\r |
458 | VOID\r | |
459 | PxeBcCreateBootOptions (\r | |
460 | IN EFI_DHCP4_PACKET_OPTION *OptList,\r | |
461 | IN UINT16 Type,\r | |
462 | IN UINT16 *Layer,\r | |
463 | OUT UINT32 *OptLen\r | |
d59b8b55 | 464 | );\r |
30368135 | 465 | \r |
466 | \r | |
467 | /**\r | |
f737cfb9 | 468 | Parse interested dhcp options.\r |
30368135 | 469 | \r |
f737cfb9 | 470 | @param Buffer Pointer to the dhcp options packet.\r |
d59b8b55 | 471 | @param Length The length of the dhcp options.\r |
472 | @param OptTag The option OpCode.\r | |
30368135 | 473 | \r |
d59b8b55 | 474 | @return NULL if the buffer length is 0 and OpCode is not \r |
f737cfb9 | 475 | PXEBC_DHCP4_TAG_EOP, or the pointer to the buffer.\r |
30368135 | 476 | \r |
477 | **/\r | |
478 | EFI_DHCP4_PACKET_OPTION *\r | |
479 | PxeBcParseExtendOptions (\r | |
480 | IN UINT8 *Buffer,\r | |
481 | IN UINT32 Length,\r | |
482 | IN UINT8 OptTag\r | |
d59b8b55 | 483 | );\r |
30368135 | 484 | \r |
485 | \r | |
486 | /**\r | |
f737cfb9 | 487 | This function is to parse and check vendor options.\r |
30368135 | 488 | \r |
f737cfb9 | 489 | @param Dhcp4Option Pointer to dhcp options\r |
490 | @param VendorOption Pointer to vendor options\r | |
30368135 | 491 | \r |
d59b8b55 | 492 | @return TRUE if valid for vendor options, or FALSE.\r |
30368135 | 493 | \r |
494 | **/\r | |
495 | BOOLEAN\r | |
496 | PxeBcParseVendorOptions (\r | |
497 | IN EFI_DHCP4_PACKET_OPTION *Dhcp4Option,\r | |
d59b8b55 | 498 | IN PXEBC_VENDOR_OPTION *VendorOption\r |
499 | );\r | |
30368135 | 500 | \r |
501 | \r | |
502 | /**\r | |
f737cfb9 | 503 | Choose the boot prompt.\r |
30368135 | 504 | \r |
f737cfb9 | 505 | @param Private Pointer to PxeBc private data.\r |
30368135 | 506 | \r |
f737cfb9 | 507 | @retval EFI_SUCCESS Select boot prompt done.\r |
508 | @retval EFI_TIMEOUT Select boot prompt time out. \r | |
509 | @retval EFI_NOT_FOUND The proxy offer is not Pxe10.\r | |
510 | @retval EFI_ABORTED User cancel the operation.\r | |
511 | @retval EFI_NOT_READY Read the input key from the keybroad has not finish.\r | |
512 | \r | |
30368135 | 513 | **/\r |
514 | EFI_STATUS\r | |
515 | PxeBcSelectBootPrompt (\r | |
516 | IN PXEBC_PRIVATE_DATA *Private\r | |
d59b8b55 | 517 | );\r |
30368135 | 518 | \r |
519 | \r | |
520 | /**\r | |
f737cfb9 | 521 | Select the boot menu.\r |
522 | \r | |
523 | @param Private Pointer to PxeBc private data.\r | |
524 | @param Type The type of the menu.\r | |
525 | @param UseDefaultItem Use default item or not.\r | |
526 | \r | |
527 | @retval EFI_ABORTED User cancel operation.\r | |
528 | @retval EFI_SUCCESS Select the boot menu success.\r | |
529 | @retval EFI_NOT_READY Read the input key from the keybroad has not finish. \r | |
30368135 | 530 | \r |
531 | **/\r | |
532 | EFI_STATUS\r | |
533 | PxeBcSelectBootMenu (\r | |
534 | IN PXEBC_PRIVATE_DATA *Private,\r | |
535 | OUT UINT16 *Type,\r | |
536 | IN BOOLEAN UseDefaultItem\r | |
d59b8b55 | 537 | );\r |
30368135 | 538 | \r |
539 | #endif\r | |
540 | \r |