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