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