]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Network/UefiPxeBcDxe/PxeBcDhcp.c
to fill the gap between PI1.0 and code to fix the bug #202435
[mirror_edk2.git] / MdeModulePkg / Universal / Network / UefiPxeBcDxe / PxeBcDhcp.c
CommitLineData
dc361cc5 1/** @file\r
f737cfb9 2 Support for PxeBc dhcp functions.\r
3 \r
6d3ea23f 4Copyright (c) 2007 - 2009, Intel Corporation.<BR> \r
dc361cc5 5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
dc361cc5 13**/\r
14\r
15\r
16#include "PxeBcImpl.h"\r
17\r
18//\r
19// This is a map from the interested DHCP4 option tags' index to the tag value.\r
20//\r
21UINT8 mInterestedDhcp4Tags[PXEBC_DHCP4_TAG_INDEX_MAX] = {\r
22 PXEBC_DHCP4_TAG_BOOTFILE_LEN,\r
23 PXEBC_DHCP4_TAG_VENDOR,\r
24 PXEBC_DHCP4_TAG_OVERLOAD,\r
25 PXEBC_DHCP4_TAG_MSG_TYPE,\r
26 PXEBC_DHCP4_TAG_SERVER_ID,\r
27 PXEBC_DHCP4_TAG_CLASS_ID,\r
28 PXEBC_DHCP4_TAG_BOOTFILE\r
29};\r
30\r
31\r
32/**\r
f737cfb9 33 This function initialize the DHCP4 message instance.\r
dc361cc5 34\r
f737cfb9 35 This function will pad each item of dhcp4 message packet.\r
36 \r
37 @param Seed Pointer to the message instance of the DHCP4 packet.\r
38 @param Udp4 Pointer to the EFI_UDP4_PROTOCOL instance.\r
dc361cc5 39\r
f737cfb9 40 @return none.\r
dc361cc5 41\r
42**/\r
43VOID\r
44PxeBcInitSeedPacket (\r
45 IN EFI_DHCP4_PACKET *Seed,\r
46 IN EFI_UDP4_PROTOCOL *Udp4\r
47 )\r
48{\r
49 EFI_SIMPLE_NETWORK_MODE Mode;\r
50 EFI_DHCP4_HEADER *Header;\r
51\r
52 Udp4->GetModeData (Udp4, NULL, NULL, NULL, &Mode);\r
53\r
54 Seed->Size = sizeof (EFI_DHCP4_PACKET);\r
55 Seed->Length = sizeof (Seed->Dhcp4);\r
56\r
57 Header = &Seed->Dhcp4.Header;\r
58\r
e48e37fc 59 ZeroMem (Header, sizeof (EFI_DHCP4_HEADER));\r
dc361cc5 60 Header->OpCode = PXEBC_DHCP4_OPCODE_REQUEST;\r
61 Header->HwType = Mode.IfType;\r
62 Header->HwAddrLen = (UINT8) Mode.HwAddressSize;\r
e48e37fc 63 CopyMem (Header->ClientHwAddr, &Mode.CurrentAddress, Header->HwAddrLen);\r
dc361cc5 64\r
65 Seed->Dhcp4.Magik = PXEBC_DHCP4_MAGIC;\r
66 Seed->Dhcp4.Option[0] = PXEBC_DHCP4_TAG_EOP;\r
67}\r
68\r
69\r
70/**\r
f737cfb9 71 Copy the DCHP4 packet from srouce to destination.\r
dc361cc5 72\r
f737cfb9 73 @param Dst Pointer to the EFI_DHCP4_PROTOCOL instance.\r
74 @param Src Pointer to the EFI_DHCP4_PROTOCOL instance.\r
dc361cc5 75\r
f737cfb9 76 @return None.\r
dc361cc5 77\r
78**/\r
79VOID\r
80PxeBcCopyEfiDhcp4Packet (\r
81 IN EFI_DHCP4_PACKET *Dst,\r
82 IN EFI_DHCP4_PACKET *Src\r
83 )\r
84{\r
85 ASSERT (Dst->Size >= Src->Length);\r
86\r
e48e37fc 87 CopyMem (&Dst->Dhcp4, &Src->Dhcp4, Src->Length);\r
dc361cc5 88 Dst->Length = Src->Length;\r
89}\r
90\r
91\r
92/**\r
f737cfb9 93 Copy the dhcp4 packet to the PxeBc private data and parse the dhcp4 packet.\r
dc361cc5 94\r
f737cfb9 95 @param Private Pointer to PxeBc private data.\r
96 @param OfferIndex Index of cached packets as complements of pxe mode data,\r
97 the index is maximum offer number.\r
dc361cc5 98\r
f737cfb9 99 @return None.\r
dc361cc5 100\r
101**/\r
102VOID\r
103PxeBcCopyProxyOffer (\r
104 IN PXEBC_PRIVATE_DATA *Private,\r
105 IN UINT32 OfferIndex\r
106 )\r
107{\r
108 EFI_PXE_BASE_CODE_MODE *Mode;\r
109 EFI_DHCP4_PACKET *Offer;\r
110\r
111 ASSERT (OfferIndex < Private->NumOffers);\r
112\r
113 Mode = Private->PxeBc.Mode;\r
114 Offer = &Private->Dhcp4Offers[OfferIndex].Packet.Offer;\r
115\r
116 PxeBcCopyEfiDhcp4Packet (&Private->ProxyOffer.Packet.Offer, Offer);\r
e48e37fc 117 CopyMem (&Mode->ProxyOffer, &Offer->Dhcp4, Offer->Length);\r
dc361cc5 118 Mode->ProxyOfferReceived = TRUE;\r
119\r
120 PxeBcParseCachedDhcpPacket (&Private->ProxyOffer);\r
121}\r
122\r
123\r
124/**\r
125 Parse the cached dhcp packet.\r
126\r
f737cfb9 127 @param CachedPacket Pointer to cached dhcp packet.\r
dc361cc5 128\r
f737cfb9 129 @retval TRUE Succeed to parse and validation.\r
130 @retval FALSE Fail to parse or validation.\r
dc361cc5 131\r
132**/\r
133BOOLEAN\r
134PxeBcParseCachedDhcpPacket (\r
135 IN PXEBC_CACHED_DHCP4_PACKET *CachedPacket\r
136 )\r
137{\r
138 EFI_DHCP4_PACKET *Offer;\r
139 EFI_DHCP4_PACKET_OPTION **Options;\r
140 EFI_DHCP4_PACKET_OPTION *Option;\r
141 UINT8 OfferType;\r
142 UINTN Index;\r
143\r
144 CachedPacket->IsPxeOffer = FALSE;\r
e48e37fc 145 ZeroMem (CachedPacket->Dhcp4Option, sizeof (CachedPacket->Dhcp4Option));\r
146 ZeroMem (&CachedPacket->PxeVendorOption, sizeof (CachedPacket->PxeVendorOption));\r
dc361cc5 147\r
148 Offer = &CachedPacket->Packet.Offer;\r
149 Options = CachedPacket->Dhcp4Option;\r
150\r
151 //\r
152 // Parse interested dhcp options and store their pointers in CachedPacket->Dhcp4Option.\r
153 //\r
154 for (Index = 0; Index < PXEBC_DHCP4_TAG_INDEX_MAX; Index++) {\r
155 Options[Index] = PxeBcParseExtendOptions (\r
156 Offer->Dhcp4.Option,\r
157 GET_OPTION_BUFFER_LEN (Offer),\r
158 mInterestedDhcp4Tags[Index]\r
159 );\r
160 }\r
161\r
162 //\r
163 // Check whether is an offer with PXEClient or not.\r
164 //\r
165 Option = Options[PXEBC_DHCP4_TAG_INDEX_CLASS_ID];\r
166 if ((Option != NULL) && (Option->Length >= 9) &&\r
e48e37fc 167 (CompareMem (Option->Data, DEFAULT_CLASS_ID_DATA, 9) == 0)) {\r
dc361cc5 168\r
169 CachedPacket->IsPxeOffer = TRUE;\r
170 }\r
171\r
172 //\r
173 // Parse pxe vendor options and store their content/pointers in CachedPacket->PxeVendorOption.\r
174 //\r
175 Option = Options[PXEBC_DHCP4_TAG_INDEX_VENDOR];\r
176 if (CachedPacket->IsPxeOffer && (Option != NULL)) {\r
177\r
178 if (!PxeBcParseVendorOptions (Option, &CachedPacket->PxeVendorOption)) {\r
179 return FALSE;\r
180 }\r
181 }\r
182\r
183 //\r
184 // Check whether bootfilename/serverhostname overloaded (See details in dhcp spec).\r
185 // If overloaded, parse this buffer as nested dhcp options, or just parse bootfilename/\r
186 // serverhostname option.\r
187 //\r
188 Option = Options[PXEBC_DHCP4_TAG_INDEX_OVERLOAD];\r
189 if ((Option != NULL) && (Option->Data[0] & PXEBC_DHCP4_OVERLOAD_FILE)) {\r
190\r
191 Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] = PxeBcParseExtendOptions (\r
192 (UINT8 *) Offer->Dhcp4.Header.BootFileName,\r
193 sizeof (Offer->Dhcp4.Header.BootFileName),\r
194 PXEBC_DHCP4_TAG_BOOTFILE\r
195 );\r
196\r
197 } else if ((Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL) &&\r
198 (Offer->Dhcp4.Header.BootFileName[0] != 0)) {\r
199 //\r
200 // If the bootfile is not present and bootfilename is present in dhcp packet, just parse it.\r
201 // And do not count dhcp option header, or else will destory the serverhostname.\r
202 //\r
203 Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] = (EFI_DHCP4_PACKET_OPTION *) (&Offer->Dhcp4.Header.BootFileName[0] -\r
f3f2e05d 204 OFFSET_OF (EFI_DHCP4_PACKET_OPTION, Data[0]));\r
dc361cc5 205\r
206 }\r
207\r
208 //\r
209 // Determine offer type of the dhcp packet.\r
210 //\r
211 Option = Options[PXEBC_DHCP4_TAG_INDEX_MSG_TYPE];\r
212 if ((Option == NULL) || (Option->Data[0] == 0)) {\r
213 //\r
214 // It's a bootp offer\r
215 //\r
216 Option = CachedPacket->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE];\r
217 if (Option == NULL) {\r
218 //\r
219 // bootp offer without bootfilename, discard it.\r
220 //\r
221 return FALSE;\r
222 }\r
223\r
224 OfferType = DHCP4_PACKET_TYPE_BOOTP;\r
225\r
226 } else {\r
227\r
228 if (IS_VALID_DISCOVER_VENDOR_OPTION (CachedPacket->PxeVendorOption.BitMap)) {\r
229 //\r
230 // It's a pxe10 offer with PXEClient and discover vendor option.\r
231 //\r
232 OfferType = DHCP4_PACKET_TYPE_PXE10;\r
233 } else if (IS_VALID_MTFTP_VENDOR_OPTION (CachedPacket->PxeVendorOption.BitMap)) {\r
234 //\r
235 // It's a wfm11a offer with PXEClient and mtftp vendor option, and\r
236 // return false since mtftp not supported currently.\r
237 //\r
238 return FALSE;\r
dc361cc5 239 } else {\r
240 //\r
241 // If the binl offer with only PXEClient.\r
242 //\r
243 OfferType = (UINT8) ((CachedPacket->IsPxeOffer) ? DHCP4_PACKET_TYPE_BINL : DHCP4_PACKET_TYPE_DHCP_ONLY);\r
244 }\r
245 }\r
246\r
247 CachedPacket->OfferType = OfferType;\r
248\r
249 return TRUE;\r
250}\r
251\r
252\r
253/**\r
f737cfb9 254 Offer dhcp service with a BINL dhcp offer.\r
dc361cc5 255\r
f737cfb9 256 @param Private Pointer to PxeBc private data.\r
257 @param Index Index of cached packets as complements of pxe mode data,\r
258 the index is maximum offer number.\r
dc361cc5 259\r
f737cfb9 260 @retval TRUE Offer the service successfully under priority BINL.\r
261 @retval FALSE Boot Service failed, parse cached dhcp packet failed or this \r
262 BINL ack cannot find options set or bootfile name specified.\r
263 \r
dc361cc5 264**/\r
265BOOLEAN\r
266PxeBcTryBinl (\r
267 IN PXEBC_PRIVATE_DATA *Private,\r
268 IN UINT32 Index\r
269 )\r
270{\r
271 EFI_DHCP4_PACKET *Offer;\r
272 EFI_IP_ADDRESS ServerIp;\r
273 EFI_STATUS Status;\r
274 PXEBC_CACHED_DHCP4_PACKET *CachedPacket;\r
275 EFI_DHCP4_PACKET *Reply;\r
276\r
894d038a 277 ASSERT (Index < PXEBC_MAX_OFFER_NUM);\r
dc361cc5 278 ASSERT (Private->Dhcp4Offers[Index].OfferType == DHCP4_PACKET_TYPE_BINL);\r
279\r
280 Offer = &Private->Dhcp4Offers[Index].Packet.Offer;\r
319075ff 281\r
282 //\r
283 // use option 54, if zero, use siaddr in header\r
284 //\r
285 ZeroMem (&ServerIp, sizeof(EFI_IP_ADDRESS));\r
286 if (Private->Dhcp4Offers[Index].Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_SERVER_ID] != NULL) {\r
e48e37fc 287 CopyMem (\r
dc361cc5 288 &ServerIp.Addr[0],\r
289 Private->Dhcp4Offers[Index].Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_SERVER_ID]->Data,\r
290 sizeof (EFI_IPv4_ADDRESS)\r
291 );\r
292 } else {\r
319075ff 293 CopyMem (\r
294 &ServerIp.Addr[0], \r
295 &Offer->Dhcp4.Header.ServerAddr, \r
296 sizeof (EFI_IPv4_ADDRESS)\r
297 );\r
298 }\r
299 if (ServerIp.Addr[0] == 0) {\r
300 return FALSE;\r
dc361cc5 301 }\r
302\r
303 CachedPacket = &Private->ProxyOffer;\r
304 Reply = &CachedPacket->Packet.Offer;\r
305\r
306 Status = PxeBcDiscvBootService (\r
307 Private,\r
308 0,\r
309 NULL,\r
310 FALSE,\r
311 &ServerIp,\r
312 0,\r
313 NULL,\r
314 FALSE,\r
315 Reply\r
316 );\r
317 if (EFI_ERROR (Status)) {\r
318 return FALSE;\r
319 }\r
320\r
321 if (!PxeBcParseCachedDhcpPacket (CachedPacket)) {\r
322 return FALSE;\r
323 }\r
324\r
325 if ((CachedPacket->OfferType != DHCP4_PACKET_TYPE_PXE10) &&\r
326 (CachedPacket->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL)) {\r
327 //\r
328 // This BINL ack doesn't have discovery options set or bootfile name\r
329 // specified.\r
330 //\r
331 return FALSE;\r
332 }\r
333\r
334 Private->PxeBc.Mode->ProxyOfferReceived = TRUE;\r
e48e37fc 335 CopyMem (&Private->PxeBc.Mode->ProxyOffer, &Reply->Dhcp4, Reply->Length);\r
dc361cc5 336\r
337 return TRUE;\r
338}\r
339\r
340\r
341/**\r
f737cfb9 342 Offer dhcp service for each proxy with a BINL dhcp offer.\r
dc361cc5 343\r
f737cfb9 344 @param Private Pointer to PxeBc private data\r
345 @param OfferIndex Pointer to the index of cached packets as complements of \r
346 pxe mode data, the index is maximum offer number.\r
dc361cc5 347\r
f737cfb9 348 @return If there is no service needed offer return FALSE, otherwise TRUE.\r
dc361cc5 349\r
350**/\r
351BOOLEAN\r
352PxeBcTryBinlProxy (\r
353 IN PXEBC_PRIVATE_DATA *Private,\r
354 OUT UINT32 *OfferIndex\r
355 )\r
356{\r
357 UINT32 Index;\r
358\r
359 for (Index = 0; Index < Private->ProxyIndex[DHCP4_PACKET_TYPE_BINL]; Index++) {\r
360\r
361 *OfferIndex = Private->BinlIndex[Index];\r
362 //\r
363 // Try this BINL proxy offer\r
364 //\r
365 if (PxeBcTryBinl (Private, *OfferIndex)) {\r
366 return TRUE;\r
367 }\r
368 }\r
369\r
370 return FALSE;\r
371}\r
372\r
373\r
374/**\r
f737cfb9 375 This function is to check the selected proxy offer (include BINL dhcp offer and\r
376 DHCP_ONLY offer ) and set the flag and copy the DHCP packets to the Pxe base code\r
377 mode structure.\r
dc361cc5 378\r
f737cfb9 379 @param Private Pointer to PxeBc private data.\r
dc361cc5 380\r
f737cfb9 381 @retval EFI_SUCCESS Operational successful.\r
382 @retval EFI_NO_RESPONSE Offer dhcp service failed.\r
dc361cc5 383\r
384**/\r
385EFI_STATUS\r
386PxeBcCheckSelectedOffer (\r
387 IN PXEBC_PRIVATE_DATA *Private\r
388 )\r
389{\r
390 PXEBC_CACHED_DHCP4_PACKET *SelectedOffer;\r
391 EFI_DHCP4_PACKET_OPTION **Options;\r
392 UINT32 Index;\r
393 EFI_DHCP4_PACKET *Offer;\r
394 UINT32 ProxyOfferIndex;\r
395 EFI_STATUS Status;\r
396 EFI_PXE_BASE_CODE_MODE *Mode;\r
397 EFI_DHCP4_PACKET *Ack;\r
398\r
399 ASSERT (Private->SelectedOffer != 0);\r
400\r
401 Status = EFI_SUCCESS;\r
402 SelectedOffer = &Private->Dhcp4Offers[Private->SelectedOffer - 1];\r
403 Options = SelectedOffer->Dhcp4Option;\r
404\r
405 if (SelectedOffer->OfferType == DHCP4_PACKET_TYPE_BINL) {\r
406 //\r
407 // The addresses are acquired from a BINL dhcp offer, try BINL to get\r
408 // the bootfile name\r
409 //\r
410 if (!PxeBcTryBinl (Private, Private->SelectedOffer - 1)) {\r
411 Status = EFI_NO_RESPONSE;\r
412 }\r
05c0e3cb 413 } else if (SelectedOffer->OfferType == DHCP4_PACKET_TYPE_DHCP_ONLY) {\r
dc361cc5 414 //\r
05c0e3cb 415 // The selected offer to finish the D.O.R.A. is a DHCP only offer, we need \r
416 // try proxy offers if there are some, othewise the bootfile name must be \r
417 // set in this DHCP only offer.\r
dc361cc5 418 //\r
05c0e3cb 419 if (Private->GotProxyOffer) {\r
dc361cc5 420 //\r
05c0e3cb 421 // Get rid of the compiler warning.\r
dc361cc5 422 //\r
05c0e3cb 423 ProxyOfferIndex = 0;\r
424 if (Private->SortOffers) {\r
dc361cc5 425 //\r
05c0e3cb 426 // The offers are sorted before selecting, the proxy offer type must be\r
427 // already determined.\r
dc361cc5 428 //\r
05c0e3cb 429 ASSERT (Private->ProxyIndex[Private->ProxyOfferType] > 0);\r
430\r
431 if (Private->ProxyOfferType == DHCP4_PACKET_TYPE_BINL) {\r
432 //\r
433 // We buffer all received BINL proxy offers, try them all one by one\r
434 //\r
435 if (!PxeBcTryBinlProxy (Private, &ProxyOfferIndex)) {\r
436 Status = EFI_NO_RESPONSE;\r
437 }\r
438 } else {\r
439 //\r
440 // For other types, only one proxy offer is buffered.\r
441 //\r
442 ProxyOfferIndex = Private->ProxyIndex[Private->ProxyOfferType] - 1;\r
dc361cc5 443 }\r
444 } else {\r
445 //\r
05c0e3cb 446 // The proxy offer type is not determined, choose proxy offer in the \r
447 // received order.\r
dc361cc5 448 //\r
05c0e3cb 449 Status = EFI_NO_RESPONSE;\r
dc361cc5 450\r
05c0e3cb 451 for (Index = 0; Index < Private->NumOffers; Index++) {\r
dc361cc5 452\r
05c0e3cb 453 Offer = &Private->Dhcp4Offers[Index].Packet.Offer;\r
454 if (!IS_PROXY_DHCP_OFFER (Offer)) {\r
dc361cc5 455 //\r
05c0e3cb 456 // Skip non proxy dhcp offers.\r
dc361cc5 457 //\r
458 continue;\r
459 }\r
dc361cc5 460\r
05c0e3cb 461 if (Private->Dhcp4Offers[Index].OfferType == DHCP4_PACKET_TYPE_BINL) {\r
462 //\r
463 // Try BINL\r
464 //\r
465 if (!PxeBcTryBinl (Private, Index)) {\r
466 //\r
467 // Failed, skip to the next offer\r
468 //\r
469 continue;\r
470 }\r
471 }\r
472\r
473 Private->ProxyOfferType = Private->Dhcp4Offers[Index].OfferType;\r
474 ProxyOfferIndex = Index;\r
475 Status = EFI_SUCCESS;\r
476 break;\r
477 }\r
dc361cc5 478 }\r
dc361cc5 479\r
05c0e3cb 480 if (!EFI_ERROR (Status) && (Private->ProxyOfferType != DHCP4_PACKET_TYPE_BINL)) {\r
481 //\r
482 // Copy the proxy offer to Mode and set the flag\r
483 //\r
484 PxeBcCopyProxyOffer (Private, ProxyOfferIndex);\r
485 }\r
486 } else {\r
dc361cc5 487 //\r
05c0e3cb 488 // No proxy offer is received, the bootfile name MUST be set.\r
dc361cc5 489 //\r
05c0e3cb 490 ASSERT (Options[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] != NULL);\r
dc361cc5 491 }\r
492 }\r
493\r
494 if (!EFI_ERROR (Status)) {\r
495 //\r
496 // Everything is OK, set the flag and copy the DHCP packets.\r
497 //\r
498 Mode = Private->PxeBc.Mode;\r
499 Offer = &SelectedOffer->Packet.Offer;\r
500\r
501 //\r
502 // The discover packet is already copied, just set flag here.\r
503 //\r
504 Mode->DhcpDiscoverValid = TRUE;\r
505\r
506 Ack = &Private->Dhcp4Ack.Packet.Ack;\r
507 if (SelectedOffer->OfferType == DHCP4_PACKET_TYPE_BOOTP) {\r
508 //\r
509 // Other type of ACK is already cached. Bootp is special that we should\r
510 // use the bootp reply as the ACK and put it into the DHCP_ONLY buffer.\r
511 //\r
512 PxeBcCopyEfiDhcp4Packet (&Private->Dhcp4Ack.Packet.Ack, Offer);\r
513 }\r
514\r
515 PxeBcParseCachedDhcpPacket (&Private->Dhcp4Ack);\r
516\r
517 Mode->DhcpAckReceived = TRUE;\r
518\r
519 //\r
520 // Copy the dhcp ack.\r
521 //\r
e48e37fc 522 CopyMem (&Mode->DhcpAck, &Ack->Dhcp4, Ack->Length);\r
dc361cc5 523 }\r
524\r
525 return Status;\r
526}\r
527\r
528\r
529/**\r
f737cfb9 530 Cache the Dhcp4 packet offer, Parse and validate each option of the packet.\r
dc361cc5 531\r
f737cfb9 532 @param Private Pointer to PxeBc private data.\r
533 @param RcvdOffer Pointer to the received Dhcp proxy offer packet.\r
dc361cc5 534\r
f737cfb9 535 @return None.\r
dc361cc5 536\r
537**/\r
538VOID\r
539PxeBcCacheDhcpOffer (\r
540 IN PXEBC_PRIVATE_DATA *Private,\r
541 IN EFI_DHCP4_PACKET *RcvdOffer\r
542 )\r
543{\r
544 PXEBC_CACHED_DHCP4_PACKET *CachedOffer;\r
545 EFI_DHCP4_PACKET *Offer;\r
546 UINT8 OfferType;\r
547\r
548 CachedOffer = &Private->Dhcp4Offers[Private->NumOffers];\r
549 Offer = &CachedOffer->Packet.Offer;\r
550\r
551 //\r
552 // Cache the orignal dhcp packet\r
553 //\r
554 PxeBcCopyEfiDhcp4Packet (Offer, RcvdOffer);\r
555\r
556 //\r
557 // Parse and validate the options (including dhcp option and vendor option)\r
558 //\r
559 if (!PxeBcParseCachedDhcpPacket (CachedOffer)) {\r
560 return ;\r
561 }\r
562\r
563 OfferType = CachedOffer->OfferType;\r
894d038a 564 ASSERT (OfferType < DHCP4_PACKET_TYPE_MAX);\r
dc361cc5 565\r
566 if (OfferType == DHCP4_PACKET_TYPE_BOOTP) {\r
567\r
568 if (Private->BootpIndex != 0) {\r
569 //\r
570 // Only cache the first bootp offer, discard others.\r
571 //\r
572 return ;\r
573 } else {\r
574 //\r
575 // Take as a dhcp only offer, but record index specifically.\r
576 //\r
577 Private->BootpIndex = Private->NumOffers + 1;\r
578 }\r
579 } else {\r
580\r
581 if (IS_PROXY_DHCP_OFFER (Offer)) {\r
582 //\r
583 // It's a proxy dhcp offer with no your address, including pxe10, wfm11a or binl offer.\r
584 //\r
05c0e3cb 585 Private->GotProxyOffer = TRUE;\r
586\r
dc361cc5 587 if (OfferType == DHCP4_PACKET_TYPE_BINL) {\r
588 //\r
589 // Cache all binl offers.\r
590 //\r
591 Private->BinlIndex[Private->ProxyIndex[DHCP4_PACKET_TYPE_BINL]] = Private->NumOffers;\r
592 Private->ProxyIndex[DHCP4_PACKET_TYPE_BINL]++;\r
593 } else if (Private->ProxyIndex[OfferType] != 0) {\r
594 //\r
595 // Only cache the first pxe10/wfm11a offers each, discard the others.\r
596 //\r
597 return ;\r
598 } else {\r
599 //\r
600 // Record index of the proxy dhcp offer with type other than binl.\r
601 //\r
602 Private->ProxyIndex[OfferType] = Private->NumOffers + 1;\r
603 }\r
604 } else {\r
605 //\r
606 // It's a dhcp offer with your address.\r
607 //\r
894d038a 608 ASSERT (Private->ServerCount[OfferType] < PXEBC_MAX_OFFER_NUM);\r
dc361cc5 609 Private->OfferIndex[OfferType][Private->ServerCount[OfferType]] = Private->NumOffers;\r
610 Private->ServerCount[OfferType]++;\r
611 }\r
612 }\r
613\r
614 //\r
615 // Count the accepted offers.\r
616 //\r
617 Private->NumOffers++;\r
618}\r
619\r
620\r
621/**\r
f737cfb9 622 Select the specified proxy offer, such as BINL, DHCP_ONLY and so on.\r
623 If the proxy does not exist, try offers with bootfile.\r
624 \r
625 @param Private Pointer to PxeBc private data.\r
dc361cc5 626\r
f737cfb9 627 @return None\r
dc361cc5 628\r
629**/\r
630VOID\r
631PxeBcSelectOffer (\r
632 IN PXEBC_PRIVATE_DATA *Private\r
633 )\r
634{\r
635 UINT32 Index;\r
636 UINT32 OfferIndex;\r
637 EFI_DHCP4_PACKET *Offer;\r
dc361cc5 638\r
639 Private->SelectedOffer = 0;\r
640\r
641 if (Private->SortOffers) {\r
642 //\r
643 // Select offer according to the priority\r
644 //\r
645 if (Private->ServerCount[DHCP4_PACKET_TYPE_PXE10] > 0) {\r
646 //\r
647 // DHCP with PXE10\r
648 //\r
649 Private->SelectedOffer = Private->OfferIndex[DHCP4_PACKET_TYPE_PXE10][0] + 1;\r
650\r
651 } else if (Private->ServerCount[DHCP4_PACKET_TYPE_WFM11A] > 0) {\r
652 //\r
653 // DHCP with WfM\r
654 //\r
655 Private->SelectedOffer = Private->OfferIndex[DHCP4_PACKET_TYPE_WFM11A][0] + 1;\r
656\r
657 } else if ((Private->ProxyIndex[DHCP4_PACKET_TYPE_PXE10] > 0) &&\r
658 (Private->ServerCount[DHCP4_PACKET_TYPE_DHCP_ONLY] > 0)\r
659 ) {\r
660 //\r
661 // DHCP only and proxy DHCP with PXE10\r
662 //\r
663 Private->SelectedOffer = Private->OfferIndex[DHCP4_PACKET_TYPE_DHCP_ONLY][0] + 1;\r
664 Private->ProxyOfferType = DHCP4_PACKET_TYPE_PXE10;\r
665\r
666 } else if ((Private->ProxyIndex[DHCP4_PACKET_TYPE_WFM11A] > 0) &&\r
667 (Private->ServerCount[DHCP4_PACKET_TYPE_DHCP_ONLY] > 0)\r
668 ) {\r
669 //\r
670 // DHCP only and proxy DHCP with WfM\r
671 //\r
672 Private->SelectedOffer = Private->OfferIndex[DHCP4_PACKET_TYPE_DHCP_ONLY][0] + 1;\r
673 Private->ProxyOfferType = DHCP4_PACKET_TYPE_WFM11A;\r
674\r
675 } else if (Private->ServerCount[DHCP4_PACKET_TYPE_BINL] > 0) {\r
676 //\r
677 // DHCP with BINL\r
678 //\r
679 Private->SelectedOffer = Private->OfferIndex[DHCP4_PACKET_TYPE_BINL][0] + 1;\r
680\r
681 } else if ((Private->ProxyIndex[DHCP4_PACKET_TYPE_BINL] > 0) &&\r
682 (Private->ServerCount[DHCP4_PACKET_TYPE_DHCP_ONLY] > 0)\r
683 ) {\r
684 //\r
685 // DHCP only and proxy DHCP with BINL\r
686 //\r
687 Private->SelectedOffer = Private->OfferIndex[DHCP4_PACKET_TYPE_DHCP_ONLY][0] + 1;\r
688 Private->ProxyOfferType = DHCP4_PACKET_TYPE_BINL;\r
689\r
690 } else {\r
691 //\r
692 // Try offers with bootfile\r
693 //\r
694 for (Index = 0; Index < Private->ServerCount[DHCP4_PACKET_TYPE_DHCP_ONLY]; Index++) {\r
695 //\r
696 // Select the first DHCP only offer with bootfile\r
697 //\r
698 OfferIndex = Private->OfferIndex[DHCP4_PACKET_TYPE_DHCP_ONLY][Index];\r
699 if (Private->Dhcp4Offers[OfferIndex].Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] != NULL) {\r
700 Private->SelectedOffer = OfferIndex + 1;\r
701 break;\r
702 }\r
703 }\r
704\r
705 if (Private->SelectedOffer == 0) {\r
706 //\r
707 // Select the Bootp reply with bootfile if any\r
708 //\r
709 Private->SelectedOffer = Private->BootpIndex;\r
710 }\r
711 }\r
712 } else {\r
713 //\r
714 // Try the offers in the received order.\r
715 //\r
dc361cc5 716 for (Index = 0; Index < Private->NumOffers; Index++) {\r
717\r
718 Offer = &Private->Dhcp4Offers[Index].Packet.Offer;\r
719\r
720 if (IS_PROXY_DHCP_OFFER (Offer)) {\r
721 //\r
722 // Skip proxy offers\r
723 //\r
724 continue;\r
725 }\r
726\r
727 if ((Private->Dhcp4Offers[Index].OfferType == DHCP4_PACKET_TYPE_DHCP_ONLY) &&\r
05c0e3cb 728 ((!Private->GotProxyOffer) && (Private->Dhcp4Offers[Index].Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] == NULL))) {\r
dc361cc5 729 //\r
730 // DHCP only offer but no proxy offer received and no bootfile option in this offer\r
731 //\r
732 continue;\r
733 }\r
734\r
735 Private->SelectedOffer = Index + 1;\r
736 break;\r
737 }\r
738 }\r
739}\r
740\r
741\r
742/**\r
f737cfb9 743 Callback routine.\r
744 \r
745 EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver\r
746 to intercept events that occurred in the configuration process. This structure\r
747 provides advanced control of each state transition of the DHCP process. The\r
748 returned status code determines the behavior of the EFI DHCPv4 Protocol driver.\r
749 There are three possible returned values, which are described in the following\r
750 table.\r
751\r
752 @param This Pointer to the EFI DHCPv4 Protocol instance that is used to\r
753 configure this callback function.\r
754 @param Context Pointer to the context that is initialized by\r
755 EFI_DHCP4_PROTOCOL.Configure().\r
756 @param CurrentState The current operational state of the EFI DHCPv4 Protocol\r
757 driver.\r
758 @param Dhcp4Event The event that occurs in the current state, which usually means a\r
759 state transition.\r
760 @param Packet The DHCP packet that is going to be sent or already received.\r
761 @param NewPacket The packet that is used to replace the above Packet.\r
762\r
763 @retval EFI_SUCCESS Tells the EFI DHCPv4 Protocol driver to continue the DHCP process.\r
764 @retval EFI_NOT_READY Only used in the Dhcp4Selecting state. The EFI DHCPv4 Protocol\r
765 driver will continue to wait for more DHCPOFFER packets until the retry\r
766 timeout expires.\r
767 @retval EFI_ABORTED Tells the EFI DHCPv4 Protocol driver to abort the current process and\r
768 return to the Dhcp4Init or Dhcp4InitReboot state.\r
dc361cc5 769\r
770**/\r
771EFI_STATUS\r
6d3ea23f 772EFIAPI\r
dc361cc5 773PxeBcDhcpCallBack (\r
774 IN EFI_DHCP4_PROTOCOL * This,\r
775 IN VOID *Context,\r
776 IN EFI_DHCP4_STATE CurrentState,\r
777 IN EFI_DHCP4_EVENT Dhcp4Event,\r
778 IN EFI_DHCP4_PACKET * Packet OPTIONAL,\r
779 OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL\r
780 )\r
781{\r
782 PXEBC_PRIVATE_DATA *Private;\r
783 EFI_PXE_BASE_CODE_MODE *Mode;\r
784 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *Callback;\r
785 EFI_DHCP4_PACKET_OPTION *MaxMsgSize;\r
786 UINT16 Value;\r
787 EFI_STATUS Status;\r
788 BOOLEAN Received;\r
982a9eae 789 CHAR8 *SystemSerialNumber;\r
790 EFI_DHCP4_HEADER *DhcpHeader;\r
dc361cc5 791\r
792 if ((Dhcp4Event != Dhcp4RcvdOffer) &&\r
793 (Dhcp4Event != Dhcp4SelectOffer) &&\r
794 (Dhcp4Event != Dhcp4SendDiscover) &&\r
982a9eae 795 (Dhcp4Event != Dhcp4RcvdAck) &&\r
796 (Dhcp4Event != Dhcp4SendRequest)) {\r
dc361cc5 797 return EFI_SUCCESS;\r
798 }\r
799\r
800 Private = (PXEBC_PRIVATE_DATA *) Context;\r
801 Mode = Private->PxeBc.Mode;\r
802 Callback = Private->PxeBcCallback;\r
803\r
804 //\r
805 // Override the Maximum DHCP Message Size.\r
806 //\r
807 MaxMsgSize = PxeBcParseExtendOptions (\r
808 Packet->Dhcp4.Option,\r
809 GET_OPTION_BUFFER_LEN (Packet),\r
810 PXEBC_DHCP4_TAG_MAXMSG\r
811 );\r
812 if (MaxMsgSize != NULL) {\r
813 Value = HTONS (PXEBC_DHCP4_MAX_PACKET_SIZE);\r
e48e37fc 814 CopyMem (MaxMsgSize->Data, &Value, sizeof (Value));\r
dc361cc5 815 }\r
816\r
817 if ((Dhcp4Event != Dhcp4SelectOffer) && (Callback != NULL)) {\r
818 Received = (BOOLEAN) ((Dhcp4Event == Dhcp4RcvdOffer) || (Dhcp4Event == Dhcp4RcvdAck));\r
819 Status = Callback->Callback (\r
820 Callback,\r
821 Private->Function,\r
822 Received,\r
823 Packet->Length,\r
824 (EFI_PXE_BASE_CODE_PACKET *) &Packet->Dhcp4\r
825 );\r
826 if (Status != EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE) {\r
827 return EFI_ABORTED;\r
828 }\r
829 }\r
830\r
831 Status = EFI_SUCCESS;\r
832\r
833 switch (Dhcp4Event) {\r
834\r
835 case Dhcp4SendDiscover:\r
982a9eae 836 case Dhcp4SendRequest:\r
837 if (Mode->SendGUID) {\r
838 //\r
839 // send the system GUID instead of the MAC address as the hardware address\r
840 // in the DHCP packet header.\r
841 //\r
842 DhcpHeader = &Packet->Dhcp4.Header;\r
843\r
844 if (EFI_ERROR (GetSmbiosSystemGuidAndSerialNumber ((EFI_GUID *) DhcpHeader->ClientHwAddr, &SystemSerialNumber))) {\r
845 //\r
846 // GUID not yet set - send all 0xff's to show programable (via SetVariable)\r
847 // SetMem(DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid, sizeof(EFI_GUID), 0xff);\r
848 // GUID not yet set - send all 0's to show not programable\r
849 //\r
850 ZeroMem (DhcpHeader->ClientHwAddr, sizeof (EFI_GUID));\r
851 }\r
852\r
853 DhcpHeader->HwAddrLen = sizeof (EFI_GUID);\r
854 }\r
855\r
856 if (Dhcp4Event == Dhcp4SendDiscover) {\r
857 //\r
858 // Cache the dhcp discover packet, of which some information will be used later.\r
859 //\r
860 CopyMem (Mode->DhcpDiscover.Raw, &Packet->Dhcp4, Packet->Length);\r
861 }\r
dc361cc5 862\r
863 break;\r
864\r
865 case Dhcp4RcvdOffer:\r
866 Status = EFI_NOT_READY;\r
867 if (Private->NumOffers < PXEBC_MAX_OFFER_NUM) {\r
868 //\r
869 // Cache the dhcp offers in Private->Dhcp4Offers[]\r
870 //\r
871 PxeBcCacheDhcpOffer (Private, Packet);\r
872 }\r
873\r
874 break;\r
875\r
876 case Dhcp4SelectOffer:\r
877 //\r
878 // Select an offer, if succeeded, Private->SelectedOffer points to\r
879 // the index of the selected one.\r
880 //\r
881 PxeBcSelectOffer (Private);\r
882\r
883 if (Private->SelectedOffer == 0) {\r
884 Status = EFI_ABORTED;\r
885 } else {\r
886 *NewPacket = &Private->Dhcp4Offers[Private->SelectedOffer - 1].Packet.Offer;\r
887 }\r
888\r
889 break;\r
890\r
891 case Dhcp4RcvdAck:\r
892 //\r
893 // Cache Ack\r
894 //\r
895 ASSERT (Private->SelectedOffer != 0);\r
896\r
897 PxeBcCopyEfiDhcp4Packet (&Private->Dhcp4Ack.Packet.Ack, Packet);\r
898 break;\r
12f3a142 899\r
900 default:\r
901 break;\r
dc361cc5 902 }\r
903\r
904 return Status;\r
905}\r
906\r
907\r
908/**\r
f737cfb9 909 Initialize the DHCP options and build the option list.\r
dc361cc5 910\r
f737cfb9 911 @param Private Pointer to PxeBc private data.\r
912 @param OptList Pointer to a DHCP option list.\r
913 \r
914 @param IsDhcpDiscover Discover dhcp option or not. \r
dc361cc5 915\r
f737cfb9 916 @return The index item number of the option list.\r
dc361cc5 917\r
918**/\r
919UINT32\r
920PxeBcBuildDhcpOptions (\r
921 IN PXEBC_PRIVATE_DATA *Private,\r
922 IN EFI_DHCP4_PACKET_OPTION **OptList,\r
923 IN BOOLEAN IsDhcpDiscover\r
924 )\r
925{\r
926 UINT32 Index;\r
927 PXEBC_DHCP4_OPTION_ENTRY OptEnt;\r
928 UINT16 Value;\r
929 CHAR8 *SystemSerialNumber;\r
930\r
931 Index = 0;\r
932 OptList[0] = (EFI_DHCP4_PACKET_OPTION *) Private->OptionBuffer;\r
933\r
934 if (!IsDhcpDiscover) {\r
935 //\r
936 // Append message type.\r
937 //\r
938 OptList[Index]->OpCode = PXEBC_DHCP4_TAG_MSG_TYPE;\r
939 OptList[Index]->Length = 1;\r
940 OptEnt.Mesg = (PXEBC_DHCP4_OPTION_MESG *) OptList[Index]->Data;\r
941 OptEnt.Mesg->Type = PXEBC_DHCP4_MSG_TYPE_REQUEST;\r
942 Index++;\r
943 OptList[Index] = GET_NEXT_DHCP_OPTION (OptList[Index - 1]);\r
944\r
945 //\r
946 // Append max message size.\r
947 //\r
948 OptList[Index]->OpCode = PXEBC_DHCP4_TAG_MAXMSG;\r
949 OptList[Index]->Length = sizeof (PXEBC_DHCP4_OPTION_MAX_MESG_SIZE);\r
950 OptEnt.MaxMesgSize = (PXEBC_DHCP4_OPTION_MAX_MESG_SIZE *) OptList[Index]->Data;\r
951 Value = NTOHS (PXEBC_DHCP4_MAX_PACKET_SIZE);\r
e48e37fc 952 CopyMem (&OptEnt.MaxMesgSize->Size, &Value, sizeof (UINT16));\r
dc361cc5 953 Index++;\r
954 OptList[Index] = GET_NEXT_DHCP_OPTION (OptList[Index - 1]);\r
955 }\r
956 //\r
957 // Parameter request list option.\r
958 //\r
959 OptList[Index]->OpCode = PXEBC_DHCP4_TAG_PARA_LIST;\r
960 OptList[Index]->Length = 35;\r
961 OptEnt.Para = (PXEBC_DHCP4_OPTION_PARA *) OptList[Index]->Data;\r
962 OptEnt.Para->ParaList[0] = PXEBC_DHCP4_TAG_NETMASK;\r
963 OptEnt.Para->ParaList[1] = PXEBC_DHCP4_TAG_TIME_OFFSET;\r
964 OptEnt.Para->ParaList[2] = PXEBC_DHCP4_TAG_ROUTER;\r
965 OptEnt.Para->ParaList[3] = PXEBC_DHCP4_TAG_TIME_SERVER;\r
966 OptEnt.Para->ParaList[4] = PXEBC_DHCP4_TAG_NAME_SERVER;\r
967 OptEnt.Para->ParaList[5] = PXEBC_DHCP4_TAG_DNS_SERVER;\r
968 OptEnt.Para->ParaList[6] = PXEBC_DHCP4_TAG_HOSTNAME;\r
969 OptEnt.Para->ParaList[7] = PXEBC_DHCP4_TAG_BOOTFILE_LEN;\r
970 OptEnt.Para->ParaList[8] = PXEBC_DHCP4_TAG_DOMAINNAME;\r
971 OptEnt.Para->ParaList[9] = PXEBC_DHCP4_TAG_ROOTPATH;\r
972 OptEnt.Para->ParaList[10] = PXEBC_DHCP4_TAG_EXTEND_PATH;\r
973 OptEnt.Para->ParaList[11] = PXEBC_DHCP4_TAG_EMTU;\r
974 OptEnt.Para->ParaList[12] = PXEBC_DHCP4_TAG_TTL;\r
975 OptEnt.Para->ParaList[13] = PXEBC_DHCP4_TAG_BROADCAST;\r
976 OptEnt.Para->ParaList[14] = PXEBC_DHCP4_TAG_NIS_DOMAIN;\r
977 OptEnt.Para->ParaList[15] = PXEBC_DHCP4_TAG_NIS_SERVER;\r
978 OptEnt.Para->ParaList[16] = PXEBC_DHCP4_TAG_NTP_SERVER;\r
979 OptEnt.Para->ParaList[17] = PXEBC_DHCP4_TAG_VENDOR;\r
980 OptEnt.Para->ParaList[18] = PXEBC_DHCP4_TAG_REQUEST_IP;\r
981 OptEnt.Para->ParaList[19] = PXEBC_DHCP4_TAG_LEASE;\r
982 OptEnt.Para->ParaList[20] = PXEBC_DHCP4_TAG_SERVER_ID;\r
983 OptEnt.Para->ParaList[21] = PXEBC_DHCP4_TAG_T1;\r
984 OptEnt.Para->ParaList[22] = PXEBC_DHCP4_TAG_T2;\r
985 OptEnt.Para->ParaList[23] = PXEBC_DHCP4_TAG_CLASS_ID;\r
986 OptEnt.Para->ParaList[24] = PXEBC_DHCP4_TAG_TFTP;\r
987 OptEnt.Para->ParaList[25] = PXEBC_DHCP4_TAG_BOOTFILE;\r
988 OptEnt.Para->ParaList[26] = PXEBC_PXE_DHCP4_TAG_UUID;\r
989 OptEnt.Para->ParaList[27] = 0x80;\r
990 OptEnt.Para->ParaList[28] = 0x81;\r
991 OptEnt.Para->ParaList[29] = 0x82;\r
992 OptEnt.Para->ParaList[30] = 0x83;\r
993 OptEnt.Para->ParaList[31] = 0x84;\r
994 OptEnt.Para->ParaList[32] = 0x85;\r
995 OptEnt.Para->ParaList[33] = 0x86;\r
996 OptEnt.Para->ParaList[34] = 0x87;\r
997 Index++;\r
998 OptList[Index] = GET_NEXT_DHCP_OPTION (OptList[Index - 1]);\r
999\r
1000 //\r
1001 // Append UUID/Guid-based client identifier option\r
1002 //\r
1003 OptList[Index]->OpCode = PXEBC_PXE_DHCP4_TAG_UUID;\r
1004 OptList[Index]->Length = sizeof (PXEBC_DHCP4_OPTION_UUID);\r
1005 OptEnt.Uuid = (PXEBC_DHCP4_OPTION_UUID *) OptList[Index]->Data;\r
1006 OptEnt.Uuid->Type = 0;\r
1007 Index++;\r
1008 OptList[Index] = GET_NEXT_DHCP_OPTION (OptList[Index - 1]);\r
1009\r
1010 if (EFI_ERROR (GetSmbiosSystemGuidAndSerialNumber ((EFI_GUID *) OptEnt.Uuid->Guid, &SystemSerialNumber))) {\r
1011 //\r
1012 // GUID not yet set - send all 0xff's to show programable (via SetVariable)\r
1013 // SetMem(DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid, sizeof(EFI_GUID), 0xff);\r
1014 // GUID not yet set - send all 0's to show not programable\r
1015 //\r
1016 ZeroMem (OptEnt.Uuid->Guid, sizeof (EFI_GUID));\r
1017 }\r
1018\r
1019 //\r
1020 // Append client network device interface option\r
1021 //\r
1022 OptList[Index]->OpCode = PXEBC_PXE_DHCP4_TAG_UNDI;\r
1023 OptList[Index]->Length = sizeof (PXEBC_DHCP4_OPTION_UNDI);\r
1024 OptEnt.Undi = (PXEBC_DHCP4_OPTION_UNDI *) OptList[Index]->Data;\r
169a3461 1025 if (Private->Nii != NULL) {\r
1026 OptEnt.Undi->Type = Private->Nii->Type;\r
1027 OptEnt.Undi->MajorVer = Private->Nii->MajorVer;\r
1028 OptEnt.Undi->MinorVer = Private->Nii->MinorVer;\r
1029 } else {\r
1030 OptEnt.Undi->Type = DEFAULT_UNDI_TYPE;\r
1031 OptEnt.Undi->MajorVer = DEFAULT_UNDI_MAJOR;\r
1032 OptEnt.Undi->MinorVer = DEFAULT_UNDI_MINOR;\r
1033 }\r
dc361cc5 1034\r
1035 Index++;\r
1036 OptList[Index] = GET_NEXT_DHCP_OPTION (OptList[Index - 1]);\r
1037\r
1038 //\r
1039 // Append client system architecture option\r
1040 //\r
1041 OptList[Index]->OpCode = PXEBC_PXE_DHCP4_TAG_ARCH;\r
1042 OptList[Index]->Length = sizeof (PXEBC_DHCP4_OPTION_ARCH);\r
1043 OptEnt.Arch = (PXEBC_DHCP4_OPTION_ARCH *) OptList[Index]->Data;\r
1044 Value = HTONS (SYS_ARCH);\r
e48e37fc 1045 CopyMem (&OptEnt.Arch->Type, &Value, sizeof (UINT16));\r
dc361cc5 1046 Index++;\r
1047 OptList[Index] = GET_NEXT_DHCP_OPTION (OptList[Index - 1]);\r
1048\r
1049 //\r
1050 // Append client system architecture option\r
1051 //\r
1052 OptList[Index]->OpCode = PXEBC_DHCP4_TAG_CLASS_ID;\r
1053 OptList[Index]->Length = sizeof (PXEBC_DHCP4_OPTION_CLID);\r
1054 OptEnt.Clid = (PXEBC_DHCP4_OPTION_CLID *) OptList[Index]->Data;\r
e48e37fc 1055 CopyMem (OptEnt.Clid, DEFAULT_CLASS_ID_DATA, sizeof (PXEBC_DHCP4_OPTION_CLID));\r
dc361cc5 1056 CvtNum (SYS_ARCH, OptEnt.Clid->ArchitectureType, sizeof (OptEnt.Clid->ArchitectureType));\r
169a3461 1057\r
1058 if (Private->Nii != NULL) {\r
1059 // \r
1060 // If NII protocol exists, update DHCP option data\r
1061 //\r
1062 CopyMem (OptEnt.Clid->InterfaceName, Private->Nii->StringId, sizeof (OptEnt.Clid->InterfaceName));\r
1063 CvtNum (Private->Nii->MajorVer, OptEnt.Clid->UndiMajor, sizeof (OptEnt.Clid->UndiMajor));\r
1064 CvtNum (Private->Nii->MinorVer, OptEnt.Clid->UndiMinor, sizeof (OptEnt.Clid->UndiMinor));\r
1065 }\r
1066\r
dc361cc5 1067 Index++;\r
1068\r
1069 return Index;\r
1070}\r
1071\r
1072\r
1073/**\r
f737cfb9 1074 Discover the boot of service and initialize the vendor option if exists.\r
1075\r
1076 @param Private Pointer to PxeBc private data.\r
1077 @param Type PxeBc option boot item type\r
1078 @param Layer PxeBc option boot item layer\r
1079 @param UseBis Use BIS or not\r
1080 @param DestIp Ip address for server \r
1081 @param IpCount The total count of the server ip address \r
1082 @param SrvList Server list\r
1083 @param IsDiscv Discover the vendor or not\r
1084 @param Reply The dhcp4 packet of Pxe reply\r
1085\r
1086 @retval EFI_SUCCESS Operation succeeds.\r
1087 @retval EFI_OUT_OF_RESOURCES Allocate memory pool failed.\r
1088 @retval EFI_NOT_FOUND There is no vendor option exists.\r
1089 @retval EFI_TIMEOUT Send Pxe Discover time out. \r
1090 \r
dc361cc5 1091**/\r
1092EFI_STATUS\r
1093PxeBcDiscvBootService (\r
1094 IN PXEBC_PRIVATE_DATA * Private,\r
1095 IN UINT16 Type,\r
1096 IN UINT16 *Layer,\r
1097 IN BOOLEAN UseBis,\r
1098 IN EFI_IP_ADDRESS * DestIp,\r
1099 IN UINT16 IpCount,\r
1100 IN EFI_PXE_BASE_CODE_SRVLIST * SrvList,\r
1101 IN BOOLEAN IsDiscv,\r
1102 OUT EFI_DHCP4_PACKET * Reply OPTIONAL\r
1103 )\r
1104{\r
1105 EFI_PXE_BASE_CODE_UDP_PORT Sport;\r
1106 EFI_PXE_BASE_CODE_MODE *Mode;\r
1107 EFI_DHCP4_PROTOCOL *Dhcp4;\r
1108 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN Token;\r
1109 BOOLEAN IsBCast;\r
1110 EFI_STATUS Status;\r
1111 UINT16 RepIndex;\r
1112 UINT16 SrvIndex;\r
1113 UINT16 TryIndex;\r
1114 EFI_DHCP4_LISTEN_POINT ListenPoint;\r
1115 EFI_DHCP4_PACKET *Response;\r
1116 EFI_DHCP4_PACKET_OPTION *OptList[PXEBC_DHCP4_MAX_OPTION_NUM];\r
1117 UINT32 OptCount;\r
1118 EFI_DHCP4_PACKET_OPTION *PxeOpt;\r
1119 PXEBC_OPTION_BOOT_ITEM *PxeBootItem;\r
1120 UINT8 VendorOptLen;\r
982a9eae 1121 CHAR8 *SystemSerialNumber;\r
1122 EFI_DHCP4_HEADER *DhcpHeader;\r
434ce3fe 1123 UINT32 Xid;\r
982a9eae 1124\r
894d038a 1125 ASSERT (IsDiscv && (Layer != NULL));\r
dc361cc5 1126\r
1127 Mode = Private->PxeBc.Mode;\r
1128 Dhcp4 = Private->Dhcp4;\r
1129 Status = EFI_SUCCESS;\r
1130\r
1131 ZeroMem (&Token, sizeof (EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN));\r
1132\r
1133 if (DestIp == NULL) {\r
1134 Sport = PXEBC_DHCP4_S_PORT;\r
1135 IsBCast = TRUE;\r
1136 } else {\r
1137 Sport = PXEBC_BS_DISCOVER_PORT;\r
1138 IsBCast = FALSE;\r
1139 }\r
1140\r
1141 if (!UseBis && Layer != NULL) {\r
1142 *Layer &= EFI_PXE_BASE_CODE_BOOT_LAYER_MASK;\r
1143 }\r
1144\r
1145 OptCount = PxeBcBuildDhcpOptions (Private, OptList, FALSE);\r
1146\r
1147 if (IsDiscv) {\r
1148 //\r
1149 // Add vendor option of PXE_BOOT_ITEM\r
1150 //\r
1151 VendorOptLen = (sizeof (EFI_DHCP4_PACKET_OPTION) - 1) * 2 + sizeof (PXEBC_OPTION_BOOT_ITEM) + 1;\r
e48e37fc 1152 OptList[OptCount] = AllocatePool (VendorOptLen);\r
dc361cc5 1153 if (OptList[OptCount] == NULL) {\r
1154 return EFI_OUT_OF_RESOURCES;\r
1155 }\r
1156\r
1157 OptList[OptCount]->OpCode = PXEBC_DHCP4_TAG_VENDOR;\r
1158 OptList[OptCount]->Length = (UINT8) (VendorOptLen - 2);\r
1159 PxeOpt = (EFI_DHCP4_PACKET_OPTION *) OptList[OptCount]->Data;\r
1160 PxeOpt->OpCode = PXEBC_VENDOR_TAG_BOOT_ITEM;\r
1161 PxeOpt->Length = sizeof (PXEBC_OPTION_BOOT_ITEM);\r
1162 PxeBootItem = (PXEBC_OPTION_BOOT_ITEM *) PxeOpt->Data;\r
1163 PxeBootItem->Type = HTONS (Type);\r
1164 PxeBootItem->Layer = HTONS (*Layer);\r
1165 PxeOpt->Data[PxeOpt->Length] = PXEBC_DHCP4_TAG_EOP;\r
1166\r
1167 OptCount++;\r
1168 }\r
1169\r
1170 Status = Dhcp4->Build (Dhcp4, &Private->SeedPacket, 0, NULL, OptCount, OptList, &Token.Packet);\r
1171\r
1172 if (IsDiscv) {\r
e48e37fc 1173 gBS->FreePool (OptList[OptCount - 1]);\r
dc361cc5 1174 }\r
1175\r
1176 if (EFI_ERROR (Status)) {\r
1177 return Status;\r
1178 }\r
1179\r
982a9eae 1180 DhcpHeader = &Token.Packet->Dhcp4.Header;\r
1181 if (Mode->SendGUID) {\r
1182 if (EFI_ERROR (GetSmbiosSystemGuidAndSerialNumber ((EFI_GUID *) DhcpHeader->ClientHwAddr, &SystemSerialNumber))) {\r
1183 //\r
1184 // GUID not yet set - send all 0's to show not programable\r
1185 //\r
1186 ZeroMem (DhcpHeader->ClientHwAddr, sizeof (EFI_GUID));\r
1187 }\r
1188\r
1189 DhcpHeader->HwAddrLen = sizeof (EFI_GUID);\r
1190 }\r
434ce3fe 1191 \r
1192 Xid = NET_RANDOM (NetRandomInitSeed ());\r
1193 Token.Packet->Dhcp4.Header.Xid = HTONL(Xid);\r
1194 Token.Packet->Dhcp4.Header.Reserved = HTONS((IsBCast) ? 0x8000 : 0);\r
e48e37fc 1195 CopyMem (&Token.Packet->Dhcp4.Header.ClientAddr, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 1196\r
1197 Token.RemotePort = Sport;\r
1198\r
434ce3fe 1199 if (IsBCast) {\r
e48e37fc 1200 SetMem (&Token.RemoteAddress, sizeof (EFI_IPv4_ADDRESS), 0xff);\r
dc361cc5 1201 } else {\r
e48e37fc 1202 CopyMem (&Token.RemoteAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 1203 }\r
1204\r
e48e37fc 1205 CopyMem (&Token.GatewayAddress, &Private->GatewayIp, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 1206\r
1207 if (!IsBCast) {\r
1208 Token.ListenPointCount = 1;\r
1209 Token.ListenPoints = &ListenPoint;\r
1210 Token.ListenPoints[0].ListenPort = PXEBC_BS_DISCOVER_PORT;\r
e48e37fc 1211 CopyMem (&Token.ListenPoints[0].ListenAddress, &Private->StationIp, sizeof(EFI_IPv4_ADDRESS));\r
1212 CopyMem (&Token.ListenPoints[0].SubnetMask, &Private->SubnetMask, sizeof(EFI_IPv4_ADDRESS));\r
dc361cc5 1213 }\r
1214 //\r
1215 // Send Pxe Discover\r
1216 //\r
1217 for (TryIndex = 1; TryIndex <= PXEBC_BOOT_REQUEST_RETRIES; TryIndex++) {\r
1218\r
434ce3fe 1219 Token.TimeoutValue = (UINT16) (PXEBC_BOOT_REQUEST_TIMEOUT * TryIndex);\r
1220 Token.Packet->Dhcp4.Header.Seconds = (UINT16) (PXEBC_BOOT_REQUEST_TIMEOUT * (TryIndex - 1));\r
dc361cc5 1221\r
1222 Status = Dhcp4->TransmitReceive (Dhcp4, &Token);\r
1223\r
1224 if (Token.Status != EFI_TIMEOUT) {\r
1225 break;\r
1226 }\r
1227 }\r
1228\r
1229 if (!EFI_ERROR (Status)) {\r
1230 //\r
1231 // Find Pxe Reply\r
1232 //\r
1233 RepIndex = 0;\r
1234 SrvIndex = 0;\r
1235 Response = Token.ResponseList;\r
1236\r
1237 while (RepIndex < Token.ResponseCount) {\r
1238\r
1239 while (SrvIndex < IpCount) {\r
1240\r
1241 if (SrvList[SrvIndex].AcceptAnyResponse) {\r
1242 break;\r
1243 }\r
1244\r
1245 if ((SrvList[SrvIndex].Type == Type) && EFI_IP4_EQUAL (&(Response->Dhcp4.Header.ServerAddr), &(Private->ServerIp))) {\r
1246 break;\r
1247 }\r
1248\r
1249 SrvIndex++;\r
1250 }\r
1251\r
1252 if ((IpCount != SrvIndex) || (IpCount == 0)) {\r
1253 break;\r
1254 }\r
1255\r
1256 SrvIndex = 0;\r
1257 RepIndex++;\r
1258\r
1259 Response = (EFI_DHCP4_PACKET *) ((UINT8 *) Response + Response->Size);\r
1260 }\r
1261\r
1262 if (RepIndex < Token.ResponseCount) {\r
1263\r
1264 if (Reply != NULL) {\r
1265 PxeBcCopyEfiDhcp4Packet (Reply, Response);\r
1266 }\r
1267\r
1268 if (IsDiscv) {\r
e48e37fc 1269 CopyMem (&(Mode->PxeDiscover), &(Token.Packet->Dhcp4), Token.Packet->Length);\r
dc361cc5 1270 Mode->PxeDiscoverValid = TRUE;\r
1271\r
e48e37fc 1272 CopyMem (Mode->PxeReply.Raw, &Response->Dhcp4, Response->Length);\r
dc361cc5 1273 Mode->PxeReplyReceived = TRUE;\r
1274 }\r
1275 } else {\r
1276 Status = EFI_NOT_FOUND;\r
1277 }\r
1278\r
1279 //\r
1280 // free the responselist\r
1281 //\r
e48e37fc 1282 gBS->FreePool (Token.ResponseList);\r
dc361cc5 1283 }\r
1284 //\r
1285 // Free the dhcp packet\r
1286 //\r
e48e37fc 1287 gBS->FreePool (Token.Packet);\r
dc361cc5 1288\r
1289 return Status;\r
1290}\r
1291\r
1292\r
1293/**\r
f737cfb9 1294 Parse interested dhcp options.\r
dc361cc5 1295\r
f737cfb9 1296 @param Buffer Pointer to the dhcp options packet.\r
1297 @param Length The length of the dhcp options.\r
1298 @param OptTag The option OpCode.\r
dc361cc5 1299\r
f737cfb9 1300 @return NULL if the buffer length is 0 and OpCode is not \r
1301 PXEBC_DHCP4_TAG_EOP, or the pointer to the buffer.\r
dc361cc5 1302\r
1303**/\r
1304EFI_DHCP4_PACKET_OPTION *\r
1305PxeBcParseExtendOptions (\r
1306 IN UINT8 *Buffer,\r
1307 IN UINT32 Length,\r
1308 IN UINT8 OptTag\r
1309 )\r
1310{\r
1311 EFI_DHCP4_PACKET_OPTION *Option;\r
1312 UINT32 Offset;\r
1313\r
1314 Option = (EFI_DHCP4_PACKET_OPTION *) Buffer;\r
1315 Offset = 0;\r
1316\r
1317 while (Offset < Length && Option->OpCode != PXEBC_DHCP4_TAG_EOP) {\r
1318\r
1319 if (Option->OpCode == OptTag) {\r
1320\r
1321 return Option;\r
1322 }\r
1323\r
1324 if (Option->OpCode == PXEBC_DHCP4_TAG_PAD) {\r
1325 Offset++;\r
1326 } else {\r
1327 Offset += Option->Length + 2;\r
1328 }\r
1329\r
1330 Option = (EFI_DHCP4_PACKET_OPTION *) (Buffer + Offset);\r
1331 }\r
1332\r
1333 return NULL;\r
1334}\r
1335\r
1336\r
1337/**\r
1338 This function is to parse and check vendor options.\r
1339\r
1340 @param Dhcp4Option Pointer to dhcp options\r
1341 @param VendorOption Pointer to vendor options\r
1342\r
f737cfb9 1343 @return TRUE if valid for vendor options, or FALSE.\r
dc361cc5 1344\r
1345**/\r
1346BOOLEAN\r
1347PxeBcParseVendorOptions (\r
1348 IN EFI_DHCP4_PACKET_OPTION *Dhcp4Option,\r
1349 IN PXEBC_VENDOR_OPTION *VendorOption\r
1350 )\r
1351{\r
1352 UINT32 *BitMap;\r
1353 UINT8 VendorOptionLen;\r
1354 EFI_DHCP4_PACKET_OPTION *PxeOption;\r
1355 UINT8 Offset;\r
1356\r
1357 BitMap = VendorOption->BitMap;\r
1358 VendorOptionLen = Dhcp4Option->Length;\r
1359 PxeOption = (EFI_DHCP4_PACKET_OPTION *) &Dhcp4Option->Data[0];\r
1360 Offset = 0;\r
1361\r
1362 while ((Offset < VendorOptionLen) && (PxeOption->OpCode != PXEBC_DHCP4_TAG_EOP)) {\r
1363 //\r
1364 // Parse every Vendor Option and set its BitMap\r
1365 //\r
1366 switch (PxeOption->OpCode) {\r
1367\r
1368 case PXEBC_VENDOR_TAG_MTFTP_IP:\r
1369\r
e48e37fc 1370 CopyMem (&VendorOption->MtftpIp, PxeOption->Data, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 1371 break;\r
1372\r
1373 case PXEBC_VENDOR_TAG_MTFTP_CPORT:\r
1374\r
e48e37fc 1375 CopyMem (&VendorOption->MtftpCPort, PxeOption->Data, sizeof (VendorOption->MtftpCPort));\r
dc361cc5 1376 break;\r
1377\r
1378 case PXEBC_VENDOR_TAG_MTFTP_SPORT:\r
1379\r
e48e37fc 1380 CopyMem (&VendorOption->MtftpSPort, PxeOption->Data, sizeof (VendorOption->MtftpSPort));\r
dc361cc5 1381 break;\r
1382\r
1383 case PXEBC_VENDOR_TAG_MTFTP_TIMEOUT:\r
1384\r
1385 VendorOption->MtftpTimeout = *PxeOption->Data;\r
1386 break;\r
1387\r
1388 case PXEBC_VENDOR_TAG_MTFTP_DELAY:\r
1389\r
1390 VendorOption->MtftpDelay = *PxeOption->Data;\r
1391 break;\r
1392\r
1393 case PXEBC_VENDOR_TAG_DISCOVER_CTRL:\r
1394\r
1395 VendorOption->DiscoverCtrl = *PxeOption->Data;\r
1396 break;\r
1397\r
1398 case PXEBC_VENDOR_TAG_DISCOVER_MCAST:\r
1399\r
e48e37fc 1400 CopyMem (&VendorOption->DiscoverMcastIp, PxeOption->Data, sizeof (EFI_IPv4_ADDRESS));\r
dc361cc5 1401 break;\r
1402\r
1403 case PXEBC_VENDOR_TAG_BOOT_SERVERS:\r
1404\r
1405 VendorOption->BootSvrLen = PxeOption->Length;\r
1406 VendorOption->BootSvr = (PXEBC_BOOT_SVR_ENTRY *) PxeOption->Data;\r
1407 break;\r
1408\r
1409 case PXEBC_VENDOR_TAG_BOOT_MENU:\r
1410\r
1411 VendorOption->BootMenuLen = PxeOption->Length;\r
1412 VendorOption->BootMenu = (PXEBC_BOOT_MENU_ENTRY *) PxeOption->Data;\r
1413 break;\r
1414\r
1415 case PXEBC_VENDOR_TAG_MENU_PROMPT:\r
1416\r
1417 VendorOption->MenuPromptLen = PxeOption->Length;\r
1418 VendorOption->MenuPrompt = (PXEBC_MENU_PROMPT *) PxeOption->Data;\r
1419 break;\r
1420\r
1421 case PXEBC_VENDOR_TAG_MCAST_ALLOC:\r
1422\r
e48e37fc 1423 CopyMem (&VendorOption->McastIpBase, PxeOption->Data, sizeof (EFI_IPv4_ADDRESS));\r
1424 CopyMem (&VendorOption->McastIpBlock, PxeOption->Data + 4, sizeof (VendorOption->McastIpBlock));\r
1425 CopyMem (&VendorOption->McastIpRange, PxeOption->Data + 6, sizeof (VendorOption->McastIpRange));\r
dc361cc5 1426 break;\r
1427\r
1428 case PXEBC_VENDOR_TAG_CREDENTIAL_TYPES:\r
1429\r
1430 VendorOption->CredTypeLen = PxeOption->Length;\r
1431 VendorOption->CredType = (UINT32 *) PxeOption->Data;\r
1432 break;\r
1433\r
1434 case PXEBC_VENDOR_TAG_BOOT_ITEM:\r
1435\r
e48e37fc 1436 CopyMem (&VendorOption->BootSrvType, PxeOption->Data, sizeof (VendorOption->BootSrvType));\r
1437 CopyMem (&VendorOption->BootSrvLayer, PxeOption->Data + 2, sizeof (VendorOption->BootSrvLayer));\r
dc361cc5 1438 break;\r
1439 }\r
1440\r
1441 SET_VENDOR_OPTION_BIT_MAP (BitMap, PxeOption->OpCode);\r
1442\r
1443 if (PxeOption->OpCode == PXEBC_DHCP4_TAG_PAD) {\r
1444 Offset++;\r
1445 } else {\r
1446 Offset = (UINT8) (Offset + PxeOption->Length + 2);\r
1447 }\r
1448\r
1449 PxeOption = (EFI_DHCP4_PACKET_OPTION *) (Dhcp4Option->Data + Offset);\r
1450 }\r
1451\r
1452 //\r
1453 // FixMe, return falas if invalid of any vendor option\r
1454 //\r
1455\r
1456 return TRUE;\r
1457}\r
1458\r
1459\r
1460/**\r
f737cfb9 1461 This function display boot item detail.\r
dc361cc5 1462\r
f737cfb9 1463 If the length of the boot item string over 70 Char, just display 70 Char. \r
1464 \r
1465 @param Str Pointer to a string (boot item string).\r
1466 @param Len The length of string.\r
dc361cc5 1467\r
f737cfb9 1468 @return None.\r
dc361cc5 1469\r
1470**/\r
1471VOID\r
1472PxeBcDisplayBootItem (\r
1473 IN UINT8 *Str,\r
1474 IN UINT8 Len\r
1475 )\r
1476{\r
1477 UINT8 Tmp;\r
1478\r
1479 Len = (UINT8) MIN (70, Len);\r
1480 Tmp = Str[Len];\r
1481 Str[Len] = 0;\r
1482 AsciiPrint ("%a \n", Str);\r
1483 Str[Len] = Tmp;\r
1484}\r
1485\r
1486\r
1487/**\r
f737cfb9 1488 Choose the boot prompt.\r
dc361cc5 1489\r
f737cfb9 1490 @param Private Pointer to PxeBc private data.\r
dc361cc5 1491\r
f737cfb9 1492 @retval EFI_SUCCESS Select boot prompt done.\r
1493 @retval EFI_TIMEOUT Select boot prompt time out. \r
1494 @retval EFI_NOT_FOUND The proxy offer is not Pxe10.\r
1495 @retval EFI_ABORTED User cancel the operation.\r
1496 @retval EFI_NOT_READY Read the input key from the keybroad has not finish.\r
1497 \r
dc361cc5 1498**/\r
1499EFI_STATUS\r
1500PxeBcSelectBootPrompt (\r
1501 IN PXEBC_PRIVATE_DATA *Private\r
1502 )\r
1503{\r
1504 PXEBC_CACHED_DHCP4_PACKET *Packet;\r
1505 PXEBC_VENDOR_OPTION *VendorOpt;\r
1506 EFI_EVENT TimeoutEvent;\r
1507 EFI_EVENT DescendEvent;\r
1508 EFI_INPUT_KEY InputKey;\r
1509 EFI_STATUS Status;\r
1510 UINT8 Timeout;\r
1511 UINT8 *Prompt;\r
1512 UINT8 PromptLen;\r
1513 INT32 SecCol;\r
1514 INT32 SecRow;\r
1515\r
1516 TimeoutEvent = NULL;\r
1517 DescendEvent = NULL;\r
1518\r
1519 if (Private->PxeBc.Mode->ProxyOfferReceived) {\r
1520\r
1521 Packet = &Private->ProxyOffer;\r
1522 } else {\r
1523\r
1524 Packet = &Private->Dhcp4Ack;\r
1525 }\r
1526\r
1527 if (Packet->OfferType != DHCP4_PACKET_TYPE_PXE10) {\r
1528 return EFI_NOT_FOUND;\r
1529 }\r
1530\r
1531 VendorOpt = &Packet->PxeVendorOption;\r
1532\r
1533 if (!IS_VALID_BOOT_PROMPT (VendorOpt->BitMap)) {\r
1534 return EFI_SUCCESS;\r
1535 }\r
1536\r
1537 Timeout = VendorOpt->MenuPrompt->Timeout;\r
1538 Prompt = VendorOpt->MenuPrompt->Prompt;\r
1539 PromptLen = (UINT8) (VendorOpt->MenuPromptLen - 1);\r
1540\r
1541 if (Timeout == 0) {\r
1542 return EFI_SUCCESS;\r
1543 }\r
1544\r
1545 if (Timeout == 255) {\r
1546 return EFI_TIMEOUT;\r
1547 }\r
1548\r
1549 Status = gBS->CreateEvent (\r
1550 EVT_TIMER,\r
1551 TPL_CALLBACK,\r
1552 NULL,\r
1553 NULL,\r
1554 &TimeoutEvent\r
1555 );\r
1556\r
1557 if (EFI_ERROR (Status)) {\r
1558 return Status;\r
1559 }\r
1560\r
1561 Status = gBS->SetTimer (\r
1562 TimeoutEvent,\r
1563 TimerRelative,\r
1564 Timeout * TICKS_PER_SECOND\r
1565 );\r
1566\r
1567 if (EFI_ERROR (Status)) {\r
1568 goto ON_EXIT;\r
1569 }\r
1570\r
1571 Status = gBS->CreateEvent (\r
1572 EVT_TIMER,\r
1573 TPL_CALLBACK,\r
1574 NULL,\r
1575 NULL,\r
1576 &DescendEvent\r
1577 );\r
1578\r
1579 if (EFI_ERROR (Status)) {\r
1580 goto ON_EXIT;\r
1581 }\r
1582\r
1583 Status = gBS->SetTimer (\r
1584 DescendEvent,\r
1585 TimerPeriodic,\r
1586 TICKS_PER_SECOND\r
1587 );\r
1588\r
1589 if (EFI_ERROR (Status)) {\r
1590 goto ON_EXIT;\r
1591 }\r
1592\r
1593 SecCol = gST->ConOut->Mode->CursorColumn;\r
1594 SecRow = gST->ConOut->Mode->CursorRow;\r
1595\r
1596 PxeBcDisplayBootItem (Prompt, PromptLen);\r
1597\r
1598 gST->ConOut->SetCursorPosition (gST->ConOut, SecCol + PromptLen, SecRow);\r
1599 AsciiPrint ("(%d) ", Timeout--);\r
1600\r
1601 while (EFI_ERROR (gBS->CheckEvent (TimeoutEvent))) {\r
1602\r
1603 if (!EFI_ERROR (gBS->CheckEvent (DescendEvent))) {\r
1604 gST->ConOut->SetCursorPosition (gST->ConOut, SecCol + PromptLen, SecRow);\r
1605 AsciiPrint ("(%d) ", Timeout--);\r
1606 }\r
1607\r
1608 if (gST->ConIn->ReadKeyStroke (gST->ConIn, &InputKey) == EFI_NOT_READY) {\r
1609\r
1610 gBS->Stall (10 * TICKS_PER_MS);\r
1611 continue;\r
1612 }\r
1613\r
1614 if (InputKey.ScanCode == 0) {\r
1615\r
1616 switch (InputKey.UnicodeChar) {\r
1617 case CTRL ('c'):\r
1618 Status = EFI_ABORTED;\r
1619 break;\r
1620\r
1621 case CTRL ('m'):\r
1622 case 'm':\r
1623 case 'M':\r
1624 Status = EFI_TIMEOUT;\r
1625 break;\r
1626\r
1627 default:\r
1628 continue;\r
1629 }\r
1630 } else {\r
1631\r
1632 switch (InputKey.ScanCode) {\r
1633 case SCAN_F8:\r
1634 Status = EFI_TIMEOUT;\r
1635 break;\r
1636\r
1637 case SCAN_ESC:\r
1638 Status = EFI_ABORTED;\r
1639 break;\r
1640\r
1641 default:\r
1642 continue;\r
1643 }\r
1644 }\r
1645\r
1646 break;\r
1647 }\r
1648\r
1649 gST->ConOut->SetCursorPosition (gST->ConOut, 0 , SecRow + 1);\r
1650\r
1651ON_EXIT:\r
1652\r
1653 if (DescendEvent != NULL) {\r
1654 gBS->CloseEvent (DescendEvent);\r
1655 }\r
1656\r
1657 if (TimeoutEvent != NULL) {\r
1658 gBS->CloseEvent (TimeoutEvent);\r
1659 }\r
1660\r
1661 return Status;\r
1662}\r
1663\r
1664\r
1665/**\r
f737cfb9 1666 Select the boot menu.\r
dc361cc5 1667\r
f737cfb9 1668 @param Private Pointer to PxeBc private data.\r
1669 @param Type The type of the menu.\r
1670 @param UseDefaultItem Use default item or not.\r
1671 \r
1672 @retval EFI_ABORTED User cancel operation.\r
1673 @retval EFI_SUCCESS Select the boot menu success.\r
1674 @retval EFI_NOT_READY Read the input key from the keybroad has not finish. \r
dc361cc5 1675\r
1676**/\r
1677EFI_STATUS\r
1678PxeBcSelectBootMenu (\r
1679 IN PXEBC_PRIVATE_DATA *Private,\r
1680 OUT UINT16 *Type,\r
1681 IN BOOLEAN UseDefaultItem\r
1682 )\r
1683{\r
1684 PXEBC_CACHED_DHCP4_PACKET *Packet;\r
1685 PXEBC_VENDOR_OPTION *VendorOpt;\r
1686 EFI_INPUT_KEY InputKey;\r
1687 UINT8 MenuSize;\r
1688 UINT8 MenuNum;\r
1689 INT32 TopRow;\r
1690 UINT16 Select;\r
1691 UINT16 LastSelect;\r
1692 UINT8 Index;\r
1693 BOOLEAN Finish;\r
1694 CHAR8 Blank[70];\r
1695 PXEBC_BOOT_MENU_ENTRY *MenuItem;\r
1696 PXEBC_BOOT_MENU_ENTRY *MenuArray[PXEBC_MAX_MENU_NUM];\r
1697\r
1698 Finish = FALSE;\r
1699 Select = 1;\r
1700 Index = 0;\r
1701 *Type = 0;\r
1702\r
1703 if (Private->PxeBc.Mode->ProxyOfferReceived) {\r
1704\r
1705 Packet = &Private->ProxyOffer;\r
1706 } else {\r
1707\r
1708 Packet = &Private->Dhcp4Ack;\r
1709 }\r
1710\r
1711 ASSERT (Packet->OfferType == DHCP4_PACKET_TYPE_PXE10);\r
1712\r
1713 VendorOpt = &Packet->PxeVendorOption;\r
1714\r
1715 if (!IS_VALID_BOOT_MENU (VendorOpt->BitMap)) {\r
1716 return EFI_SUCCESS;\r
1717 }\r
1718\r
1719 SetMem (Blank, sizeof(Blank), ' ');\r
1720\r
1721 MenuSize = VendorOpt->BootMenuLen;\r
1722 MenuItem = VendorOpt->BootMenu;\r
1723\r
894d038a 1724 if (MenuSize == 0) {\r
1725 return EFI_NOT_READY;\r
1726 }\r
1727\r
dc361cc5 1728 while (MenuSize > 0) {\r
1729 MenuArray[Index] = MenuItem;\r
1730 MenuSize = (UINT8) (MenuSize - (MenuItem->DescLen + 3));\r
1731 MenuItem = (PXEBC_BOOT_MENU_ENTRY *) ((UINT8 *) MenuItem + MenuItem->DescLen + 3);\r
894d038a 1732 if (Index++ > (PXEBC_MAX_MENU_NUM - 1)) {\r
1733 break;\r
1734 }\r
dc361cc5 1735 }\r
1736\r
1737 if (UseDefaultItem) {\r
894d038a 1738 *Type = MenuArray[0]->Type;\r
58bba940 1739 *Type = NTOHS (*Type);\r
dc361cc5 1740 return EFI_SUCCESS;\r
1741 }\r
1742\r
1743 MenuNum = Index;\r
1744\r
1745 for (Index = 0; Index < MenuNum; Index++) {\r
1746 PxeBcDisplayBootItem (MenuArray[Index]->DescStr, MenuArray[Index]->DescLen);\r
1747 }\r
1748\r
1749 TopRow = gST->ConOut->Mode->CursorRow - MenuNum;\r
1750\r
1751 do {\r
1752 //\r
1753 // highlight selected row\r
1754 //\r
1755 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_BLACK, EFI_LIGHTGRAY));\r
1756 gST->ConOut->SetCursorPosition (gST->ConOut, 0, TopRow + Select);\r
1757 Blank[MenuArray[Select]->DescLen] = 0;\r
1758 AsciiPrint ("%a\r", Blank);\r
1759 PxeBcDisplayBootItem (MenuArray[Select]->DescStr, MenuArray[Select]->DescLen);\r
1760 gST->ConOut->SetCursorPosition (gST->ConOut, 0, TopRow + MenuNum);\r
1761 LastSelect = Select;\r
1762\r
1763 while (gST->ConIn->ReadKeyStroke (gST->ConIn, &InputKey) == EFI_NOT_READY) {\r
1764 gBS->Stall (10 * TICKS_PER_MS);\r
1765 }\r
1766\r
1767 if (!InputKey.ScanCode) {\r
1768 switch (InputKey.UnicodeChar) {\r
1769 case CTRL ('c'):\r
1770 InputKey.ScanCode = SCAN_ESC;\r
1771 break;\r
1772\r
1773 case CTRL ('j'): /* linefeed */\r
1774 case CTRL ('m'): /* return */\r
1775 Finish = TRUE;\r
1776 break;\r
1777\r
1778 case CTRL ('i'): /* tab */\r
1779 case ' ':\r
1780 case 'd':\r
1781 case 'D':\r
1782 InputKey.ScanCode = SCAN_DOWN;\r
1783 break;\r
1784\r
1785 case CTRL ('h'): /* backspace */\r
1786 case 'u':\r
1787 case 'U':\r
1788 InputKey.ScanCode = SCAN_UP;\r
1789 break;\r
1790\r
1791 default:\r
1792 InputKey.ScanCode = 0;\r
1793 }\r
1794 }\r
1795\r
1796 switch (InputKey.ScanCode) {\r
1797 case SCAN_LEFT:\r
1798 case SCAN_UP:\r
f737cfb9 1799 if (Select > 0) {\r
dc361cc5 1800 --Select;\r
1801 }\r
1802\r
1803 break;\r
1804\r
1805 case SCAN_DOWN:\r
1806 case SCAN_RIGHT:\r
1807 if (++Select == MenuNum) {\r
1808 --Select;\r
1809 }\r
1810\r
1811 break;\r
1812\r
1813 case SCAN_PAGE_UP:\r
1814 case SCAN_HOME:\r
1815 Select = 0;\r
1816 break;\r
1817\r
1818 case SCAN_PAGE_DOWN:\r
1819 case SCAN_END:\r
1820 Select = (UINT16) (MenuNum - 1);\r
1821 break;\r
1822\r
1823 case SCAN_ESC:\r
1824 return EFI_ABORTED;\r
1825 }\r
1826\r
1827 /* unhighlight last selected row */\r
1828 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));\r
1829 gST->ConOut->SetCursorPosition (gST->ConOut, 0, TopRow + LastSelect);\r
1830 Blank[MenuArray[LastSelect]->DescLen] = 0;\r
1831 AsciiPrint ("%a\r", Blank);\r
1832 PxeBcDisplayBootItem (MenuArray[LastSelect]->DescStr, MenuArray[LastSelect]->DescLen);\r
1833 gST->ConOut->SetCursorPosition (gST->ConOut, 0, TopRow + MenuNum);\r
1834 } while (!Finish);\r
1835\r
1836 //\r
1837 // Swap the byte order\r
1838 //\r
58bba940 1839 CopyMem (Type, &MenuArray[Select]->Type, sizeof (UINT16));\r
1840 *Type = NTOHS (*Type);\r
dc361cc5 1841\r
1842 return EFI_SUCCESS;\r
1843}\r
1844\r