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