2 Support for PxeBc dhcp functions.
4 Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
5 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
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.
16 #include "PxeBcImpl.h"
19 // This is a map from the interested DHCP4 option tags' index to the tag value.
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
33 This function initialize the DHCP4 message instance.
35 This function will pad each item of dhcp4 message packet.
37 @param Seed Pointer to the message instance of the DHCP4 packet.
38 @param Udp4 Pointer to the EFI_UDP4_PROTOCOL instance.
43 IN EFI_DHCP4_PACKET
*Seed
,
44 IN EFI_UDP4_PROTOCOL
*Udp4
47 EFI_SIMPLE_NETWORK_MODE Mode
;
48 EFI_DHCP4_HEADER
*Header
;
50 Udp4
->GetModeData (Udp4
, NULL
, NULL
, NULL
, &Mode
);
52 Seed
->Size
= sizeof (EFI_DHCP4_PACKET
);
53 Seed
->Length
= sizeof (Seed
->Dhcp4
);
55 Header
= &Seed
->Dhcp4
.Header
;
57 ZeroMem (Header
, sizeof (EFI_DHCP4_HEADER
));
58 Header
->OpCode
= PXEBC_DHCP4_OPCODE_REQUEST
;
59 Header
->HwType
= Mode
.IfType
;
60 Header
->HwAddrLen
= (UINT8
) Mode
.HwAddressSize
;
61 CopyMem (Header
->ClientHwAddr
, &Mode
.CurrentAddress
, Header
->HwAddrLen
);
63 Seed
->Dhcp4
.Magik
= PXEBC_DHCP4_MAGIC
;
64 Seed
->Dhcp4
.Option
[0] = PXEBC_DHCP4_TAG_EOP
;
69 Copy the DCHP4 packet from srouce to destination.
71 @param Dst Pointer to the EFI_DHCP4_PROTOCOL instance.
72 @param Src Pointer to the EFI_DHCP4_PROTOCOL instance.
76 PxeBcCopyEfiDhcp4Packet (
77 IN EFI_DHCP4_PACKET
*Dst
,
78 IN EFI_DHCP4_PACKET
*Src
81 ASSERT (Dst
->Size
>= Src
->Length
);
83 CopyMem (&Dst
->Dhcp4
, &Src
->Dhcp4
, Src
->Length
);
84 Dst
->Length
= Src
->Length
;
89 Copy the dhcp4 packet to the PxeBc private data and parse the dhcp4 packet.
91 @param Private Pointer to PxeBc private data.
92 @param OfferIndex Index of cached packets as complements of pxe mode data,
93 the index is maximum offer number.
98 IN PXEBC_PRIVATE_DATA
*Private
,
102 EFI_PXE_BASE_CODE_MODE
*Mode
;
103 EFI_DHCP4_PACKET
*Offer
;
105 ASSERT (OfferIndex
< Private
->NumOffers
);
106 ASSERT (OfferIndex
< PXEBC_MAX_OFFER_NUM
);
108 Mode
= Private
->PxeBc
.Mode
;
109 Offer
= &Private
->Dhcp4Offers
[OfferIndex
].Packet
.Offer
;
111 PxeBcCopyEfiDhcp4Packet (&Private
->ProxyOffer
.Packet
.Offer
, Offer
);
112 CopyMem (&Mode
->ProxyOffer
, &Offer
->Dhcp4
, Offer
->Length
);
113 Mode
->ProxyOfferReceived
= TRUE
;
115 PxeBcParseCachedDhcpPacket (&Private
->ProxyOffer
);
120 Parse the cached dhcp packet.
122 @param CachedPacket Pointer to cached dhcp packet.
124 @retval TRUE Succeed to parse and validation.
125 @retval FALSE Fail to parse or validation.
129 PxeBcParseCachedDhcpPacket (
130 IN PXEBC_CACHED_DHCP4_PACKET
*CachedPacket
133 EFI_DHCP4_PACKET
*Offer
;
134 EFI_DHCP4_PACKET_OPTION
**Options
;
135 EFI_DHCP4_PACKET_OPTION
*Option
;
140 CachedPacket
->IsPxeOffer
= FALSE
;
141 ZeroMem (CachedPacket
->Dhcp4Option
, sizeof (CachedPacket
->Dhcp4Option
));
142 ZeroMem (&CachedPacket
->PxeVendorOption
, sizeof (CachedPacket
->PxeVendorOption
));
144 Offer
= &CachedPacket
->Packet
.Offer
;
145 Options
= CachedPacket
->Dhcp4Option
;
148 // Parse interested dhcp options and store their pointers in CachedPacket->Dhcp4Option.
150 for (Index
= 0; Index
< PXEBC_DHCP4_TAG_INDEX_MAX
; Index
++) {
151 Options
[Index
] = PxeBcParseExtendOptions (
153 GET_OPTION_BUFFER_LEN (Offer
),
154 mInterestedDhcp4Tags
[Index
]
159 // Check whether is an offer with PXEClient or not.
161 Option
= Options
[PXEBC_DHCP4_TAG_INDEX_CLASS_ID
];
162 if ((Option
!= NULL
) && (Option
->Length
>= 9) &&
163 (CompareMem (Option
->Data
, DEFAULT_CLASS_ID_DATA
, 9) == 0)) {
165 CachedPacket
->IsPxeOffer
= TRUE
;
169 // Parse pxe vendor options and store their content/pointers in CachedPacket->PxeVendorOption.
171 Option
= Options
[PXEBC_DHCP4_TAG_INDEX_VENDOR
];
172 if (CachedPacket
->IsPxeOffer
&& (Option
!= NULL
)) {
174 if (!PxeBcParseVendorOptions (Option
, &CachedPacket
->PxeVendorOption
)) {
180 // Check whether bootfilename/serverhostname overloaded (See details in dhcp spec).
181 // If overloaded, parse this buffer as nested dhcp options, or just parse bootfilename/
182 // serverhostname option.
184 Option
= Options
[PXEBC_DHCP4_TAG_INDEX_OVERLOAD
];
185 if ((Option
!= NULL
) && ((Option
->Data
[0] & PXEBC_DHCP4_OVERLOAD_FILE
) != 0)) {
187 Options
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] = PxeBcParseExtendOptions (
188 (UINT8
*) Offer
->Dhcp4
.Header
.BootFileName
,
189 sizeof (Offer
->Dhcp4
.Header
.BootFileName
),
190 PXEBC_DHCP4_TAG_BOOTFILE
193 // RFC 2132, Section 9.5 does not strictly state Bootfile name (option 67) is null
194 // terminated string. So force to append null terminated character at the end of string.
196 if (Options
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] != NULL
) {
197 Ptr8
= (UINT8
*)&Options
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
]->Data
[0];
198 Ptr8
+= Options
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
]->Length
;
202 } else if ((Options
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] == NULL
) &&
203 (Offer
->Dhcp4
.Header
.BootFileName
[0] != 0)) {
205 // If the bootfile is not present and bootfilename is present in dhcp packet, just parse it.
206 // And do not count dhcp option header, or else will destory the serverhostname.
208 Options
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] = (EFI_DHCP4_PACKET_OPTION
*) (&Offer
->Dhcp4
.Header
.BootFileName
[0] -
209 OFFSET_OF (EFI_DHCP4_PACKET_OPTION
, Data
[0]));
214 // Determine offer type of the dhcp packet.
216 Option
= Options
[PXEBC_DHCP4_TAG_INDEX_MSG_TYPE
];
217 if ((Option
== NULL
) || (Option
->Data
[0] == 0)) {
219 // It's a bootp offer
221 Option
= CachedPacket
->Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
];
222 if (Option
== NULL
) {
224 // bootp offer without bootfilename, discard it.
229 OfferType
= DHCP4_PACKET_TYPE_BOOTP
;
233 if (IS_VALID_DISCOVER_VENDOR_OPTION (CachedPacket
->PxeVendorOption
.BitMap
)) {
235 // It's a pxe10 offer with PXEClient and discover vendor option.
237 OfferType
= DHCP4_PACKET_TYPE_PXE10
;
238 } else if (IS_VALID_MTFTP_VENDOR_OPTION (CachedPacket
->PxeVendorOption
.BitMap
)) {
240 // It's a wfm11a offer with PXEClient and mtftp vendor option, and
241 // return false since mtftp not supported currently.
246 // If the binl offer with only PXEClient.
248 OfferType
= (UINT8
) ((CachedPacket
->IsPxeOffer
) ? DHCP4_PACKET_TYPE_BINL
: DHCP4_PACKET_TYPE_DHCP_ONLY
);
252 CachedPacket
->OfferType
= OfferType
;
259 Offer dhcp service with a BINL dhcp offer.
261 @param Private Pointer to PxeBc private data.
262 @param Index Index of cached packets as complements of pxe mode data,
263 the index is maximum offer number.
265 @retval TRUE Offer the service successfully under priority BINL.
266 @retval FALSE Boot Service failed, parse cached dhcp packet failed or this
267 BINL ack cannot find options set or bootfile name specified.
272 IN PXEBC_PRIVATE_DATA
*Private
,
276 EFI_DHCP4_PACKET
*Offer
;
277 EFI_IP_ADDRESS ServerIp
;
279 PXEBC_CACHED_DHCP4_PACKET
*CachedPacket
;
280 EFI_DHCP4_PACKET
*Reply
;
282 ASSERT (Index
< PXEBC_MAX_OFFER_NUM
);
283 ASSERT (Private
->Dhcp4Offers
[Index
].OfferType
== DHCP4_PACKET_TYPE_BINL
);
285 Offer
= &Private
->Dhcp4Offers
[Index
].Packet
.Offer
;
288 // Use siaddr(next server) in DHCPOFFER packet header, if zero, use option 54(server identifier)
289 // in DHCPOFFER packet.
290 // (It does not comply with PXE Spec, Ver2.1)
292 if (EFI_IP4_EQUAL (&Offer
->Dhcp4
.Header
.ServerAddr
.Addr
, &mZeroIp4Addr
)) {
295 Private
->Dhcp4Offers
[Index
].Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_SERVER_ID
]->Data
,
296 sizeof (EFI_IPv4_ADDRESS
)
301 &Offer
->Dhcp4
.Header
.ServerAddr
,
302 sizeof (EFI_IPv4_ADDRESS
)
305 if (ServerIp
.Addr
[0] == 0) {
309 CachedPacket
= &Private
->ProxyOffer
;
310 Reply
= &CachedPacket
->Packet
.Offer
;
312 Status
= PxeBcDiscvBootService (
323 if (EFI_ERROR (Status
)) {
327 if (!PxeBcParseCachedDhcpPacket (CachedPacket
)) {
331 if ((CachedPacket
->OfferType
!= DHCP4_PACKET_TYPE_PXE10
) &&
332 (CachedPacket
->Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] == NULL
)) {
334 // This BINL ack doesn't have discovery options set or bootfile name
340 Private
->PxeBc
.Mode
->ProxyOfferReceived
= TRUE
;
341 CopyMem (&Private
->PxeBc
.Mode
->ProxyOffer
, &Reply
->Dhcp4
, Reply
->Length
);
348 Offer dhcp service for each proxy with a BINL dhcp offer.
350 @param Private Pointer to PxeBc private data
351 @param OfferIndex Pointer to the index of cached packets as complements of
352 pxe mode data, the index is maximum offer number.
354 @return If there is no service needed offer return FALSE, otherwise TRUE.
359 IN PXEBC_PRIVATE_DATA
*Private
,
360 OUT UINT32
*OfferIndex
365 for (Index
= 0; Index
< Private
->ProxyIndex
[DHCP4_PACKET_TYPE_BINL
]; Index
++) {
367 *OfferIndex
= Private
->BinlIndex
[Index
];
369 // Try this BINL proxy offer
371 if (PxeBcTryBinl (Private
, *OfferIndex
)) {
381 This function is to check the selected proxy offer (include BINL dhcp offer and
382 DHCP_ONLY offer ) and set the flag and copy the DHCP packets to the Pxe base code
385 @param Private Pointer to PxeBc private data.
387 @retval EFI_SUCCESS Operational successful.
388 @retval EFI_NO_RESPONSE Offer dhcp service failed.
392 PxeBcCheckSelectedOffer (
393 IN PXEBC_PRIVATE_DATA
*Private
396 PXEBC_CACHED_DHCP4_PACKET
*SelectedOffer
;
397 EFI_DHCP4_PACKET_OPTION
**Options
;
399 EFI_DHCP4_PACKET
*Offer
;
400 UINT32 ProxyOfferIndex
;
402 EFI_PXE_BASE_CODE_MODE
*Mode
;
403 EFI_DHCP4_PACKET
*Ack
;
405 ASSERT (Private
->SelectedOffer
!= 0);
407 Status
= EFI_SUCCESS
;
408 SelectedOffer
= &Private
->Dhcp4Offers
[Private
->SelectedOffer
- 1];
409 Options
= SelectedOffer
->Dhcp4Option
;
411 if (SelectedOffer
->OfferType
== DHCP4_PACKET_TYPE_BINL
) {
413 // The addresses are acquired from a BINL dhcp offer, try BINL to get
416 if (!PxeBcTryBinl (Private
, Private
->SelectedOffer
- 1)) {
417 Status
= EFI_NO_RESPONSE
;
419 } else if (SelectedOffer
->OfferType
== DHCP4_PACKET_TYPE_DHCP_ONLY
) {
421 // The selected offer to finish the D.O.R.A. is a DHCP only offer, we need
422 // try proxy offers if there are some, othewise the bootfile name must be
423 // set in this DHCP only offer.
425 if (Private
->GotProxyOffer
) {
427 // Get rid of the compiler warning.
430 if (Private
->SortOffers
) {
432 // The offers are sorted before selecting, the proxy offer type must be
433 // already determined.
435 ASSERT (Private
->ProxyIndex
[Private
->ProxyOfferType
] > 0);
437 if (Private
->ProxyOfferType
== DHCP4_PACKET_TYPE_BINL
) {
439 // We buffer all received BINL proxy offers, try them all one by one
441 if (!PxeBcTryBinlProxy (Private
, &ProxyOfferIndex
)) {
442 Status
= EFI_NO_RESPONSE
;
446 // For other types, only one proxy offer is buffered.
448 ProxyOfferIndex
= Private
->ProxyIndex
[Private
->ProxyOfferType
] - 1;
452 // The proxy offer type is not determined, choose proxy offer in the
455 Status
= EFI_NO_RESPONSE
;
457 for (Index
= 0; Index
< Private
->NumOffers
; Index
++) {
459 Offer
= &Private
->Dhcp4Offers
[Index
].Packet
.Offer
;
460 if (!IS_PROXY_DHCP_OFFER (Offer
)) {
462 // Skip non proxy dhcp offers.
467 if (Private
->Dhcp4Offers
[Index
].OfferType
== DHCP4_PACKET_TYPE_BINL
) {
471 if (!PxeBcTryBinl (Private
, Index
)) {
473 // Failed, skip to the next offer
479 Private
->ProxyOfferType
= Private
->Dhcp4Offers
[Index
].OfferType
;
480 ProxyOfferIndex
= Index
;
481 Status
= EFI_SUCCESS
;
486 if (!EFI_ERROR (Status
) && (Private
->ProxyOfferType
!= DHCP4_PACKET_TYPE_BINL
)) {
488 // Copy the proxy offer to Mode and set the flag
490 PxeBcCopyProxyOffer (Private
, ProxyOfferIndex
);
494 // No proxy offer is received, the bootfile name MUST be set.
496 ASSERT (Options
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] != NULL
);
500 if (!EFI_ERROR (Status
)) {
502 // Everything is OK, set the flag and copy the DHCP packets.
504 Mode
= Private
->PxeBc
.Mode
;
505 Offer
= &SelectedOffer
->Packet
.Offer
;
508 // The discover packet is already copied, just set flag here.
510 Mode
->DhcpDiscoverValid
= TRUE
;
512 Ack
= &Private
->Dhcp4Ack
.Packet
.Ack
;
513 if (SelectedOffer
->OfferType
== DHCP4_PACKET_TYPE_BOOTP
) {
515 // Other type of ACK is already cached. Bootp is special that we should
516 // use the bootp reply as the ACK and put it into the DHCP_ONLY buffer.
518 PxeBcCopyEfiDhcp4Packet (&Private
->Dhcp4Ack
.Packet
.Ack
, Offer
);
521 PxeBcParseCachedDhcpPacket (&Private
->Dhcp4Ack
);
523 Mode
->DhcpAckReceived
= TRUE
;
526 // Copy the dhcp ack.
528 CopyMem (&Mode
->DhcpAck
, &Ack
->Dhcp4
, Ack
->Length
);
536 Cache the Dhcp4 packet offer, Parse and validate each option of the packet.
538 @param Private Pointer to PxeBc private data.
539 @param RcvdOffer Pointer to the received Dhcp proxy offer packet.
543 PxeBcCacheDhcpOffer (
544 IN PXEBC_PRIVATE_DATA
*Private
,
545 IN EFI_DHCP4_PACKET
*RcvdOffer
548 PXEBC_CACHED_DHCP4_PACKET
*CachedOffer
;
549 EFI_DHCP4_PACKET
*Offer
;
552 CachedOffer
= &Private
->Dhcp4Offers
[Private
->NumOffers
];
553 Offer
= &CachedOffer
->Packet
.Offer
;
556 // Cache the orignal dhcp packet
558 PxeBcCopyEfiDhcp4Packet (Offer
, RcvdOffer
);
561 // Parse and validate the options (including dhcp option and vendor option)
563 if (!PxeBcParseCachedDhcpPacket (CachedOffer
)) {
567 OfferType
= CachedOffer
->OfferType
;
568 ASSERT (OfferType
< DHCP4_PACKET_TYPE_MAX
);
570 if (OfferType
== DHCP4_PACKET_TYPE_BOOTP
) {
572 if (Private
->BootpIndex
!= 0) {
574 // Only cache the first bootp offer, discard others.
579 // Take as a dhcp only offer, but record index specifically.
581 Private
->BootpIndex
= Private
->NumOffers
+ 1;
585 if (IS_PROXY_DHCP_OFFER (Offer
)) {
587 // It's a proxy dhcp offer with no your address, including pxe10, wfm11a or binl offer.
589 Private
->GotProxyOffer
= TRUE
;
591 if (OfferType
== DHCP4_PACKET_TYPE_BINL
) {
593 // Cache all binl offers.
595 Private
->BinlIndex
[Private
->ProxyIndex
[DHCP4_PACKET_TYPE_BINL
]] = Private
->NumOffers
;
596 Private
->ProxyIndex
[DHCP4_PACKET_TYPE_BINL
]++;
597 } else if (Private
->ProxyIndex
[OfferType
] != 0) {
599 // Only cache the first pxe10/wfm11a offers each, discard the others.
604 // Record index of the proxy dhcp offer with type other than binl.
606 Private
->ProxyIndex
[OfferType
] = Private
->NumOffers
+ 1;
610 // It's a dhcp offer with your address.
612 ASSERT (Private
->ServerCount
[OfferType
] < PXEBC_MAX_OFFER_NUM
);
613 Private
->OfferIndex
[OfferType
][Private
->ServerCount
[OfferType
]] = Private
->NumOffers
;
614 Private
->ServerCount
[OfferType
]++;
619 // Count the accepted offers.
621 Private
->NumOffers
++;
626 Select the specified proxy offer, such as BINL, DHCP_ONLY and so on.
627 If the proxy does not exist, try offers with bootfile.
629 @param Private Pointer to PxeBc private data.
634 IN PXEBC_PRIVATE_DATA
*Private
639 EFI_DHCP4_PACKET
*Offer
;
641 Private
->SelectedOffer
= 0;
643 if (Private
->SortOffers
) {
645 // Select offer according to the priority
647 if (Private
->ServerCount
[DHCP4_PACKET_TYPE_PXE10
] > 0) {
651 Private
->SelectedOffer
= Private
->OfferIndex
[DHCP4_PACKET_TYPE_PXE10
][0] + 1;
653 } else if (Private
->ServerCount
[DHCP4_PACKET_TYPE_WFM11A
] > 0) {
657 Private
->SelectedOffer
= Private
->OfferIndex
[DHCP4_PACKET_TYPE_WFM11A
][0] + 1;
659 } else if ((Private
->ProxyIndex
[DHCP4_PACKET_TYPE_PXE10
] > 0) &&
660 (Private
->ServerCount
[DHCP4_PACKET_TYPE_DHCP_ONLY
] > 0)
663 // DHCP only and proxy DHCP with PXE10
665 Private
->SelectedOffer
= Private
->OfferIndex
[DHCP4_PACKET_TYPE_DHCP_ONLY
][0] + 1;
666 Private
->ProxyOfferType
= DHCP4_PACKET_TYPE_PXE10
;
668 } else if ((Private
->ProxyIndex
[DHCP4_PACKET_TYPE_WFM11A
] > 0) &&
669 (Private
->ServerCount
[DHCP4_PACKET_TYPE_DHCP_ONLY
] > 0)
672 // DHCP only and proxy DHCP with WfM
674 Private
->SelectedOffer
= Private
->OfferIndex
[DHCP4_PACKET_TYPE_DHCP_ONLY
][0] + 1;
675 Private
->ProxyOfferType
= DHCP4_PACKET_TYPE_WFM11A
;
677 } else if (Private
->ServerCount
[DHCP4_PACKET_TYPE_BINL
] > 0) {
681 Private
->SelectedOffer
= Private
->OfferIndex
[DHCP4_PACKET_TYPE_BINL
][0] + 1;
683 } else if ((Private
->ProxyIndex
[DHCP4_PACKET_TYPE_BINL
] > 0) &&
684 (Private
->ServerCount
[DHCP4_PACKET_TYPE_DHCP_ONLY
] > 0)
687 // DHCP only and proxy DHCP with BINL
689 Private
->SelectedOffer
= Private
->OfferIndex
[DHCP4_PACKET_TYPE_DHCP_ONLY
][0] + 1;
690 Private
->ProxyOfferType
= DHCP4_PACKET_TYPE_BINL
;
694 // Try offers with bootfile
696 for (Index
= 0; Index
< Private
->ServerCount
[DHCP4_PACKET_TYPE_DHCP_ONLY
]; Index
++) {
698 // Select the first DHCP only offer with bootfile
700 OfferIndex
= Private
->OfferIndex
[DHCP4_PACKET_TYPE_DHCP_ONLY
][Index
];
701 if (Private
->Dhcp4Offers
[OfferIndex
].Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] != NULL
) {
702 Private
->SelectedOffer
= OfferIndex
+ 1;
707 if (Private
->SelectedOffer
== 0) {
709 // Select the Bootp reply with bootfile if any
711 Private
->SelectedOffer
= Private
->BootpIndex
;
716 // Try the offers in the received order.
718 for (Index
= 0; Index
< Private
->NumOffers
; Index
++) {
720 Offer
= &Private
->Dhcp4Offers
[Index
].Packet
.Offer
;
722 if (IS_PROXY_DHCP_OFFER (Offer
)) {
729 if ((Private
->Dhcp4Offers
[Index
].OfferType
== DHCP4_PACKET_TYPE_DHCP_ONLY
) &&
730 ((!Private
->GotProxyOffer
) && (Private
->Dhcp4Offers
[Index
].Dhcp4Option
[PXEBC_DHCP4_TAG_INDEX_BOOTFILE
] == NULL
))) {
732 // DHCP only offer but no proxy offer received and no bootfile option in this offer
737 Private
->SelectedOffer
= Index
+ 1;
747 EFI_DHCP4_CALLBACK is provided by the consumer of the EFI DHCPv4 Protocol driver
748 to intercept events that occurred in the configuration process. This structure
749 provides advanced control of each state transition of the DHCP process. The
750 returned status code determines the behavior of the EFI DHCPv4 Protocol driver.
751 There are three possible returned values, which are described in the following
754 @param This Pointer to the EFI DHCPv4 Protocol instance that is used to
755 configure this callback function.
756 @param Context Pointer to the context that is initialized by
757 EFI_DHCP4_PROTOCOL.Configure().
758 @param CurrentState The current operational state of the EFI DHCPv4 Protocol
760 @param Dhcp4Event The event that occurs in the current state, which usually means a
762 @param Packet The DHCP packet that is going to be sent or already received.
763 @param NewPacket The packet that is used to replace the above Packet.
765 @retval EFI_SUCCESS Tells the EFI DHCPv4 Protocol driver to continue the DHCP process.
766 @retval EFI_NOT_READY Only used in the Dhcp4Selecting state. The EFI DHCPv4 Protocol
767 driver will continue to wait for more DHCPOFFER packets until the retry
769 @retval EFI_ABORTED Tells the EFI DHCPv4 Protocol driver to abort the current process and
770 return to the Dhcp4Init or Dhcp4InitReboot state.
776 IN EFI_DHCP4_PROTOCOL
* This
,
778 IN EFI_DHCP4_STATE CurrentState
,
779 IN EFI_DHCP4_EVENT Dhcp4Event
,
780 IN EFI_DHCP4_PACKET
* Packet OPTIONAL
,
781 OUT EFI_DHCP4_PACKET
**NewPacket OPTIONAL
784 PXEBC_PRIVATE_DATA
*Private
;
785 EFI_PXE_BASE_CODE_MODE
*Mode
;
786 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL
*Callback
;
787 EFI_DHCP4_PACKET_OPTION
*MaxMsgSize
;
791 EFI_DHCP4_HEADER
*DhcpHeader
;
793 if ((Dhcp4Event
!= Dhcp4RcvdOffer
) &&
794 (Dhcp4Event
!= Dhcp4SelectOffer
) &&
795 (Dhcp4Event
!= Dhcp4SendDiscover
) &&
796 (Dhcp4Event
!= Dhcp4RcvdAck
) &&
797 (Dhcp4Event
!= Dhcp4SendRequest
)) {
801 Private
= (PXEBC_PRIVATE_DATA
*) Context
;
802 Mode
= Private
->PxeBc
.Mode
;
803 Callback
= Private
->PxeBcCallback
;
806 // Override the Maximum DHCP Message Size.
808 MaxMsgSize
= PxeBcParseExtendOptions (
809 Packet
->Dhcp4
.Option
,
810 GET_OPTION_BUFFER_LEN (Packet
),
811 PXEBC_DHCP4_TAG_MAXMSG
813 if (MaxMsgSize
!= NULL
) {
814 Value
= HTONS (PXEBC_DHCP4_MAX_PACKET_SIZE
);
815 CopyMem (MaxMsgSize
->Data
, &Value
, sizeof (Value
));
818 if ((Dhcp4Event
!= Dhcp4SelectOffer
) && (Callback
!= NULL
)) {
819 Received
= (BOOLEAN
) ((Dhcp4Event
== Dhcp4RcvdOffer
) || (Dhcp4Event
== Dhcp4RcvdAck
));
820 Status
= Callback
->Callback (
825 (EFI_PXE_BASE_CODE_PACKET
*) &Packet
->Dhcp4
827 if (Status
!= EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE
) {
832 Status
= EFI_SUCCESS
;
834 switch (Dhcp4Event
) {
836 case Dhcp4SendDiscover
:
837 case Dhcp4SendRequest
:
838 if (Mode
->SendGUID
) {
840 // send the system GUID instead of the MAC address as the hardware address
841 // in the DHCP packet header.
843 DhcpHeader
= &Packet
->Dhcp4
.Header
;
845 if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID
*) DhcpHeader
->ClientHwAddr
))) {
847 // GUID not yet set - send all 0xff's to show programable (via SetVariable)
848 // SetMem(DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid, sizeof(EFI_GUID), 0xff);
849 // GUID not yet set - send all 0's to show not programable
851 ZeroMem (DhcpHeader
->ClientHwAddr
, sizeof (EFI_GUID
));
854 DhcpHeader
->HwAddrLen
= (UINT8
) sizeof (EFI_GUID
);
857 if (Dhcp4Event
== Dhcp4SendDiscover
) {
859 // Cache the dhcp discover packet, of which some information will be used later.
861 CopyMem (Mode
->DhcpDiscover
.Raw
, &Packet
->Dhcp4
, Packet
->Length
);
867 Status
= EFI_NOT_READY
;
868 if (Private
->NumOffers
< PXEBC_MAX_OFFER_NUM
) {
870 // Cache the dhcp offers in Private->Dhcp4Offers[]
872 PxeBcCacheDhcpOffer (Private
, Packet
);
877 case Dhcp4SelectOffer
:
879 // Select an offer, if succeeded, Private->SelectedOffer points to
880 // the index of the selected one.
882 PxeBcSelectOffer (Private
);
884 if (Private
->SelectedOffer
== 0) {
885 Status
= EFI_ABORTED
;
887 *NewPacket
= &Private
->Dhcp4Offers
[Private
->SelectedOffer
- 1].Packet
.Offer
;
896 ASSERT (Private
->SelectedOffer
!= 0);
898 PxeBcCopyEfiDhcp4Packet (&Private
->Dhcp4Ack
.Packet
.Ack
, Packet
);
910 Initialize the DHCP options and build the option list.
912 @param Private Pointer to PxeBc private data.
913 @param OptList Pointer to a DHCP option list.
915 @param IsDhcpDiscover Discover dhcp option or not.
917 @return The index item number of the option list.
921 PxeBcBuildDhcpOptions (
922 IN PXEBC_PRIVATE_DATA
*Private
,
923 IN EFI_DHCP4_PACKET_OPTION
**OptList
,
924 IN BOOLEAN IsDhcpDiscover
928 PXEBC_DHCP4_OPTION_ENTRY OptEnt
;
932 OptList
[0] = (EFI_DHCP4_PACKET_OPTION
*) Private
->OptionBuffer
;
934 if (!IsDhcpDiscover
) {
936 // Append message type.
938 OptList
[Index
]->OpCode
= PXEBC_DHCP4_TAG_MSG_TYPE
;
939 OptList
[Index
]->Length
= 1;
940 OptEnt
.Mesg
= (PXEBC_DHCP4_OPTION_MESG
*) OptList
[Index
]->Data
;
941 OptEnt
.Mesg
->Type
= PXEBC_DHCP4_MSG_TYPE_REQUEST
;
943 OptList
[Index
] = GET_NEXT_DHCP_OPTION (OptList
[Index
- 1]);
946 // Append max message size.
948 OptList
[Index
]->OpCode
= PXEBC_DHCP4_TAG_MAXMSG
;
949 OptList
[Index
]->Length
= (UINT8
) sizeof (PXEBC_DHCP4_OPTION_MAX_MESG_SIZE
);
950 OptEnt
.MaxMesgSize
= (PXEBC_DHCP4_OPTION_MAX_MESG_SIZE
*) OptList
[Index
]->Data
;
951 Value
= NTOHS (PXEBC_DHCP4_MAX_PACKET_SIZE
);
952 CopyMem (&OptEnt
.MaxMesgSize
->Size
, &Value
, sizeof (UINT16
));
954 OptList
[Index
] = GET_NEXT_DHCP_OPTION (OptList
[Index
- 1]);
957 // Parameter request list option.
959 OptList
[Index
]->OpCode
= PXEBC_DHCP4_TAG_PARA_LIST
;
960 OptList
[Index
]->Length
= 35;
961 OptEnt
.Para
= (PXEBC_DHCP4_OPTION_PARA
*) OptList
[Index
]->Data
;
962 OptEnt
.Para
->ParaList
[0] = PXEBC_DHCP4_TAG_NETMASK
;
963 OptEnt
.Para
->ParaList
[1] = PXEBC_DHCP4_TAG_TIME_OFFSET
;
964 OptEnt
.Para
->ParaList
[2] = PXEBC_DHCP4_TAG_ROUTER
;
965 OptEnt
.Para
->ParaList
[3] = PXEBC_DHCP4_TAG_TIME_SERVER
;
966 OptEnt
.Para
->ParaList
[4] = PXEBC_DHCP4_TAG_NAME_SERVER
;
967 OptEnt
.Para
->ParaList
[5] = PXEBC_DHCP4_TAG_DNS_SERVER
;
968 OptEnt
.Para
->ParaList
[6] = PXEBC_DHCP4_TAG_HOSTNAME
;
969 OptEnt
.Para
->ParaList
[7] = PXEBC_DHCP4_TAG_BOOTFILE_LEN
;
970 OptEnt
.Para
->ParaList
[8] = PXEBC_DHCP4_TAG_DOMAINNAME
;
971 OptEnt
.Para
->ParaList
[9] = PXEBC_DHCP4_TAG_ROOTPATH
;
972 OptEnt
.Para
->ParaList
[10] = PXEBC_DHCP4_TAG_EXTEND_PATH
;
973 OptEnt
.Para
->ParaList
[11] = PXEBC_DHCP4_TAG_EMTU
;
974 OptEnt
.Para
->ParaList
[12] = PXEBC_DHCP4_TAG_TTL
;
975 OptEnt
.Para
->ParaList
[13] = PXEBC_DHCP4_TAG_BROADCAST
;
976 OptEnt
.Para
->ParaList
[14] = PXEBC_DHCP4_TAG_NIS_DOMAIN
;
977 OptEnt
.Para
->ParaList
[15] = PXEBC_DHCP4_TAG_NIS_SERVER
;
978 OptEnt
.Para
->ParaList
[16] = PXEBC_DHCP4_TAG_NTP_SERVER
;
979 OptEnt
.Para
->ParaList
[17] = PXEBC_DHCP4_TAG_VENDOR
;
980 OptEnt
.Para
->ParaList
[18] = PXEBC_DHCP4_TAG_REQUEST_IP
;
981 OptEnt
.Para
->ParaList
[19] = PXEBC_DHCP4_TAG_LEASE
;
982 OptEnt
.Para
->ParaList
[20] = PXEBC_DHCP4_TAG_SERVER_ID
;
983 OptEnt
.Para
->ParaList
[21] = PXEBC_DHCP4_TAG_T1
;
984 OptEnt
.Para
->ParaList
[22] = PXEBC_DHCP4_TAG_T2
;
985 OptEnt
.Para
->ParaList
[23] = PXEBC_DHCP4_TAG_CLASS_ID
;
986 OptEnt
.Para
->ParaList
[24] = PXEBC_DHCP4_TAG_TFTP
;
987 OptEnt
.Para
->ParaList
[25] = PXEBC_DHCP4_TAG_BOOTFILE
;
988 OptEnt
.Para
->ParaList
[26] = PXEBC_PXE_DHCP4_TAG_UUID
;
989 OptEnt
.Para
->ParaList
[27] = 0x80;
990 OptEnt
.Para
->ParaList
[28] = 0x81;
991 OptEnt
.Para
->ParaList
[29] = 0x82;
992 OptEnt
.Para
->ParaList
[30] = 0x83;
993 OptEnt
.Para
->ParaList
[31] = 0x84;
994 OptEnt
.Para
->ParaList
[32] = 0x85;
995 OptEnt
.Para
->ParaList
[33] = 0x86;
996 OptEnt
.Para
->ParaList
[34] = 0x87;
998 OptList
[Index
] = GET_NEXT_DHCP_OPTION (OptList
[Index
- 1]);
1001 // Append UUID/Guid-based client identifier option
1003 OptList
[Index
]->OpCode
= PXEBC_PXE_DHCP4_TAG_UUID
;
1004 OptList
[Index
]->Length
= (UINT8
) sizeof (PXEBC_DHCP4_OPTION_UUID
);
1005 OptEnt
.Uuid
= (PXEBC_DHCP4_OPTION_UUID
*) OptList
[Index
]->Data
;
1006 OptEnt
.Uuid
->Type
= 0;
1008 OptList
[Index
] = GET_NEXT_DHCP_OPTION (OptList
[Index
- 1]);
1010 if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID
*) OptEnt
.Uuid
->Guid
))) {
1012 // GUID not yet set - send all 0xff's to show programable (via SetVariable)
1013 // SetMem(DHCPV4_OPTIONS_BUFFER.DhcpPlatformId.Guid, sizeof(EFI_GUID), 0xff);
1014 // GUID not yet set - send all 0's to show not programable
1016 ZeroMem (OptEnt
.Uuid
->Guid
, sizeof (EFI_GUID
));
1020 // Append client network device interface option
1022 OptList
[Index
]->OpCode
= PXEBC_PXE_DHCP4_TAG_UNDI
;
1023 OptList
[Index
]->Length
= (UINT8
) sizeof (PXEBC_DHCP4_OPTION_UNDI
);
1024 OptEnt
.Undi
= (PXEBC_DHCP4_OPTION_UNDI
*) OptList
[Index
]->Data
;
1025 if (Private
->Nii
!= NULL
) {
1026 OptEnt
.Undi
->Type
= Private
->Nii
->Type
;
1027 OptEnt
.Undi
->MajorVer
= Private
->Nii
->MajorVer
;
1028 OptEnt
.Undi
->MinorVer
= Private
->Nii
->MinorVer
;
1030 OptEnt
.Undi
->Type
= DEFAULT_UNDI_TYPE
;
1031 OptEnt
.Undi
->MajorVer
= DEFAULT_UNDI_MAJOR
;
1032 OptEnt
.Undi
->MinorVer
= DEFAULT_UNDI_MINOR
;
1036 OptList
[Index
] = GET_NEXT_DHCP_OPTION (OptList
[Index
- 1]);
1039 // Append client system architecture option
1041 OptList
[Index
]->OpCode
= PXEBC_PXE_DHCP4_TAG_ARCH
;
1042 OptList
[Index
]->Length
= (UINT8
) sizeof (PXEBC_DHCP4_OPTION_ARCH
);
1043 OptEnt
.Arch
= (PXEBC_DHCP4_OPTION_ARCH
*) OptList
[Index
]->Data
;
1044 Value
= HTONS (EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE
);
1045 CopyMem (&OptEnt
.Arch
->Type
, &Value
, sizeof (UINT16
));
1047 OptList
[Index
] = GET_NEXT_DHCP_OPTION (OptList
[Index
- 1]);
1050 // Append client system architecture option
1052 OptList
[Index
]->OpCode
= PXEBC_DHCP4_TAG_CLASS_ID
;
1053 OptList
[Index
]->Length
= (UINT8
) sizeof (PXEBC_DHCP4_OPTION_CLID
);
1054 OptEnt
.Clid
= (PXEBC_DHCP4_OPTION_CLID
*) OptList
[Index
]->Data
;
1055 CopyMem (OptEnt
.Clid
, DEFAULT_CLASS_ID_DATA
, sizeof (PXEBC_DHCP4_OPTION_CLID
));
1056 CvtNum (EFI_PXE_CLIENT_SYSTEM_ARCHITECTURE
, OptEnt
.Clid
->ArchitectureType
, sizeof (OptEnt
.Clid
->ArchitectureType
));
1058 if (Private
->Nii
!= NULL
) {
1060 // If NII protocol exists, update DHCP option data
1062 CopyMem (OptEnt
.Clid
->InterfaceName
, Private
->Nii
->StringId
, sizeof (OptEnt
.Clid
->InterfaceName
));
1063 CvtNum (Private
->Nii
->MajorVer
, OptEnt
.Clid
->UndiMajor
, sizeof (OptEnt
.Clid
->UndiMajor
));
1064 CvtNum (Private
->Nii
->MinorVer
, OptEnt
.Clid
->UndiMinor
, sizeof (OptEnt
.Clid
->UndiMinor
));
1074 Discover the boot of service and initialize the vendor option if exists.
1076 @param Private Pointer to PxeBc private data.
1077 @param Type PxeBc option boot item type
1078 @param Layer PxeBc option boot item layer
1079 @param UseBis Use BIS or not
1080 @param DestIp Ip address for server
1081 @param IpCount The total count of the server ip address
1082 @param SrvList Server list
1083 @param IsDiscv Discover the vendor or not
1084 @param Reply The dhcp4 packet of Pxe reply
1086 @retval EFI_SUCCESS Operation succeeds.
1087 @retval EFI_OUT_OF_RESOURCES Allocate memory pool failed.
1088 @retval EFI_NOT_FOUND There is no vendor option exists.
1089 @retval EFI_TIMEOUT Send Pxe Discover time out.
1093 PxeBcDiscvBootService (
1094 IN PXEBC_PRIVATE_DATA
* Private
,
1098 IN EFI_IP_ADDRESS
* DestIp
,
1100 IN EFI_PXE_BASE_CODE_SRVLIST
* SrvList
,
1102 OUT EFI_DHCP4_PACKET
* Reply OPTIONAL
1105 EFI_PXE_BASE_CODE_UDP_PORT Sport
;
1106 EFI_PXE_BASE_CODE_MODE
*Mode
;
1107 EFI_DHCP4_PROTOCOL
*Dhcp4
;
1108 EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN Token
;
1114 EFI_DHCP4_LISTEN_POINT ListenPoint
;
1115 EFI_DHCP4_PACKET
*Response
;
1116 EFI_DHCP4_PACKET_OPTION
*OptList
[PXEBC_DHCP4_MAX_OPTION_NUM
];
1118 EFI_DHCP4_PACKET_OPTION
*PxeOpt
;
1119 PXEBC_OPTION_BOOT_ITEM
*PxeBootItem
;
1121 EFI_DHCP4_HEADER
*DhcpHeader
;
1124 Mode
= Private
->PxeBc
.Mode
;
1125 Dhcp4
= Private
->Dhcp4
;
1126 Status
= EFI_SUCCESS
;
1128 ZeroMem (&Token
, sizeof (EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN
));
1130 if (DestIp
== NULL
) {
1131 Sport
= PXEBC_DHCP4_S_PORT
;
1134 Sport
= PXEBC_BS_DISCOVER_PORT
;
1138 if (!UseBis
&& Layer
!= NULL
) {
1139 *Layer
&= EFI_PXE_BASE_CODE_BOOT_LAYER_MASK
;
1142 OptCount
= PxeBcBuildDhcpOptions (Private
, OptList
, FALSE
);
1145 ASSERT (Layer
!= NULL
);
1147 // Add vendor option of PXE_BOOT_ITEM
1149 VendorOptLen
= (UINT8
) ((sizeof (EFI_DHCP4_PACKET_OPTION
) - 1) * 2 + sizeof (PXEBC_OPTION_BOOT_ITEM
) + 1);
1150 OptList
[OptCount
] = AllocatePool (VendorOptLen
);
1151 if (OptList
[OptCount
] == NULL
) {
1152 return EFI_OUT_OF_RESOURCES
;
1155 OptList
[OptCount
]->OpCode
= PXEBC_DHCP4_TAG_VENDOR
;
1156 OptList
[OptCount
]->Length
= (UINT8
) (VendorOptLen
- 2);
1157 PxeOpt
= (EFI_DHCP4_PACKET_OPTION
*) OptList
[OptCount
]->Data
;
1158 PxeOpt
->OpCode
= PXEBC_VENDOR_TAG_BOOT_ITEM
;
1159 PxeOpt
->Length
= (UINT8
) sizeof (PXEBC_OPTION_BOOT_ITEM
);
1160 PxeBootItem
= (PXEBC_OPTION_BOOT_ITEM
*) PxeOpt
->Data
;
1161 PxeBootItem
->Type
= HTONS (Type
);
1162 PxeBootItem
->Layer
= HTONS (*Layer
);
1163 PxeOpt
->Data
[PxeOpt
->Length
] = PXEBC_DHCP4_TAG_EOP
;
1168 Status
= Dhcp4
->Build (Dhcp4
, &Private
->SeedPacket
, 0, NULL
, OptCount
, OptList
, &Token
.Packet
);
1171 FreePool (OptList
[OptCount
- 1]);
1174 if (EFI_ERROR (Status
)) {
1178 DhcpHeader
= &Token
.Packet
->Dhcp4
.Header
;
1179 if (Mode
->SendGUID
) {
1180 if (EFI_ERROR (NetLibGetSystemGuid ((EFI_GUID
*) DhcpHeader
->ClientHwAddr
))) {
1182 // GUID not yet set - send all 0's to show not programable
1184 ZeroMem (DhcpHeader
->ClientHwAddr
, sizeof (EFI_GUID
));
1187 DhcpHeader
->HwAddrLen
= (UINT8
) sizeof (EFI_GUID
);
1190 Xid
= NET_RANDOM (NetRandomInitSeed ());
1191 Token
.Packet
->Dhcp4
.Header
.Xid
= HTONL(Xid
);
1192 Token
.Packet
->Dhcp4
.Header
.Reserved
= HTONS((UINT16
) ((IsBCast
) ? 0x8000 : 0));
1193 CopyMem (&Token
.Packet
->Dhcp4
.Header
.ClientAddr
, &Private
->StationIp
, sizeof (EFI_IPv4_ADDRESS
));
1195 Token
.RemotePort
= Sport
;
1198 SetMem (&Token
.RemoteAddress
, sizeof (EFI_IPv4_ADDRESS
), 0xff);
1200 CopyMem (&Token
.RemoteAddress
, DestIp
, sizeof (EFI_IPv4_ADDRESS
));
1203 CopyMem (&Token
.GatewayAddress
, &Private
->GatewayIp
, sizeof (EFI_IPv4_ADDRESS
));
1206 Token
.ListenPointCount
= 1;
1207 Token
.ListenPoints
= &ListenPoint
;
1208 Token
.ListenPoints
[0].ListenPort
= PXEBC_BS_DISCOVER_PORT
;
1209 CopyMem (&Token
.ListenPoints
[0].ListenAddress
, &Private
->StationIp
, sizeof(EFI_IPv4_ADDRESS
));
1210 CopyMem (&Token
.ListenPoints
[0].SubnetMask
, &Private
->SubnetMask
, sizeof(EFI_IPv4_ADDRESS
));
1213 // Send Pxe Discover
1215 for (TryIndex
= 1; TryIndex
<= PXEBC_BOOT_REQUEST_RETRIES
; TryIndex
++) {
1217 Token
.TimeoutValue
= (UINT16
) (PXEBC_BOOT_REQUEST_TIMEOUT
* TryIndex
);
1218 Token
.Packet
->Dhcp4
.Header
.Seconds
= (UINT16
) (PXEBC_BOOT_REQUEST_TIMEOUT
* (TryIndex
- 1));
1220 Status
= Dhcp4
->TransmitReceive (Dhcp4
, &Token
);
1222 if (Token
.Status
!= EFI_TIMEOUT
) {
1227 if (TryIndex
> PXEBC_BOOT_REQUEST_RETRIES
) {
1229 // No server response our PXE request
1231 Status
= EFI_TIMEOUT
;
1234 if (!EFI_ERROR (Status
)) {
1240 Response
= Token
.ResponseList
;
1242 while (RepIndex
< Token
.ResponseCount
) {
1244 while (SrvIndex
< IpCount
) {
1246 if (SrvList
[SrvIndex
].AcceptAnyResponse
) {
1250 if ((SrvList
[SrvIndex
].Type
== Type
) && EFI_IP4_EQUAL (&(Response
->Dhcp4
.Header
.ServerAddr
), &(Private
->ServerIp
))) {
1257 if ((IpCount
!= SrvIndex
) || (IpCount
== 0)) {
1264 Response
= (EFI_DHCP4_PACKET
*) ((UINT8
*) Response
+ Response
->Size
);
1267 if (RepIndex
< Token
.ResponseCount
) {
1269 if (Reply
!= NULL
) {
1270 PxeBcCopyEfiDhcp4Packet (Reply
, Response
);
1274 CopyMem (&(Mode
->PxeDiscover
), &(Token
.Packet
->Dhcp4
), Token
.Packet
->Length
);
1275 Mode
->PxeDiscoverValid
= TRUE
;
1277 CopyMem (Mode
->PxeReply
.Raw
, &Response
->Dhcp4
, Response
->Length
);
1278 Mode
->PxeReplyReceived
= TRUE
;
1281 Status
= EFI_NOT_FOUND
;
1285 // free the responselist
1287 if (Token
.ResponseList
!= NULL
) {
1288 FreePool (Token
.ResponseList
);
1292 // Free the dhcp packet
1294 FreePool (Token
.Packet
);
1301 Parse interested dhcp options.
1303 @param Buffer Pointer to the dhcp options packet.
1304 @param Length The length of the dhcp options.
1305 @param OptTag The option OpCode.
1307 @return NULL if the buffer length is 0 and OpCode is not
1308 PXEBC_DHCP4_TAG_EOP, or the pointer to the buffer.
1311 EFI_DHCP4_PACKET_OPTION
*
1312 PxeBcParseExtendOptions (
1318 EFI_DHCP4_PACKET_OPTION
*Option
;
1321 Option
= (EFI_DHCP4_PACKET_OPTION
*) Buffer
;
1324 while (Offset
< Length
&& Option
->OpCode
!= PXEBC_DHCP4_TAG_EOP
) {
1326 if (Option
->OpCode
== OptTag
) {
1331 if (Option
->OpCode
== PXEBC_DHCP4_TAG_PAD
) {
1334 Offset
+= Option
->Length
+ 2;
1337 Option
= (EFI_DHCP4_PACKET_OPTION
*) (Buffer
+ Offset
);
1345 This function is to parse and check vendor options.
1347 @param Dhcp4Option Pointer to dhcp options
1348 @param VendorOption Pointer to vendor options
1350 @return TRUE if valid for vendor options, or FALSE.
1354 PxeBcParseVendorOptions (
1355 IN EFI_DHCP4_PACKET_OPTION
*Dhcp4Option
,
1356 IN PXEBC_VENDOR_OPTION
*VendorOption
1360 UINT8 VendorOptionLen
;
1361 EFI_DHCP4_PACKET_OPTION
*PxeOption
;
1364 BitMap
= VendorOption
->BitMap
;
1365 VendorOptionLen
= Dhcp4Option
->Length
;
1366 PxeOption
= (EFI_DHCP4_PACKET_OPTION
*) &Dhcp4Option
->Data
[0];
1369 while ((Offset
< VendorOptionLen
) && (PxeOption
->OpCode
!= PXEBC_DHCP4_TAG_EOP
)) {
1371 // Parse every Vendor Option and set its BitMap
1373 switch (PxeOption
->OpCode
) {
1375 case PXEBC_VENDOR_TAG_MTFTP_IP
:
1377 CopyMem (&VendorOption
->MtftpIp
, PxeOption
->Data
, sizeof (EFI_IPv4_ADDRESS
));
1380 case PXEBC_VENDOR_TAG_MTFTP_CPORT
:
1382 CopyMem (&VendorOption
->MtftpCPort
, PxeOption
->Data
, sizeof (VendorOption
->MtftpCPort
));
1385 case PXEBC_VENDOR_TAG_MTFTP_SPORT
:
1387 CopyMem (&VendorOption
->MtftpSPort
, PxeOption
->Data
, sizeof (VendorOption
->MtftpSPort
));
1390 case PXEBC_VENDOR_TAG_MTFTP_TIMEOUT
:
1392 VendorOption
->MtftpTimeout
= *PxeOption
->Data
;
1395 case PXEBC_VENDOR_TAG_MTFTP_DELAY
:
1397 VendorOption
->MtftpDelay
= *PxeOption
->Data
;
1400 case PXEBC_VENDOR_TAG_DISCOVER_CTRL
:
1402 VendorOption
->DiscoverCtrl
= *PxeOption
->Data
;
1405 case PXEBC_VENDOR_TAG_DISCOVER_MCAST
:
1407 CopyMem (&VendorOption
->DiscoverMcastIp
, PxeOption
->Data
, sizeof (EFI_IPv4_ADDRESS
));
1410 case PXEBC_VENDOR_TAG_BOOT_SERVERS
:
1412 VendorOption
->BootSvrLen
= PxeOption
->Length
;
1413 VendorOption
->BootSvr
= (PXEBC_BOOT_SVR_ENTRY
*) PxeOption
->Data
;
1416 case PXEBC_VENDOR_TAG_BOOT_MENU
:
1418 VendorOption
->BootMenuLen
= PxeOption
->Length
;
1419 VendorOption
->BootMenu
= (PXEBC_BOOT_MENU_ENTRY
*) PxeOption
->Data
;
1422 case PXEBC_VENDOR_TAG_MENU_PROMPT
:
1424 VendorOption
->MenuPromptLen
= PxeOption
->Length
;
1425 VendorOption
->MenuPrompt
= (PXEBC_MENU_PROMPT
*) PxeOption
->Data
;
1428 case PXEBC_VENDOR_TAG_MCAST_ALLOC
:
1430 CopyMem (&VendorOption
->McastIpBase
, PxeOption
->Data
, sizeof (EFI_IPv4_ADDRESS
));
1431 CopyMem (&VendorOption
->McastIpBlock
, PxeOption
->Data
+ 4, sizeof (VendorOption
->McastIpBlock
));
1432 CopyMem (&VendorOption
->McastIpRange
, PxeOption
->Data
+ 6, sizeof (VendorOption
->McastIpRange
));
1435 case PXEBC_VENDOR_TAG_CREDENTIAL_TYPES
:
1437 VendorOption
->CredTypeLen
= PxeOption
->Length
;
1438 VendorOption
->CredType
= (UINT32
*) PxeOption
->Data
;
1441 case PXEBC_VENDOR_TAG_BOOT_ITEM
:
1443 CopyMem (&VendorOption
->BootSrvType
, PxeOption
->Data
, sizeof (VendorOption
->BootSrvType
));
1444 CopyMem (&VendorOption
->BootSrvLayer
, PxeOption
->Data
+ 2, sizeof (VendorOption
->BootSrvLayer
));
1448 SET_VENDOR_OPTION_BIT_MAP (BitMap
, PxeOption
->OpCode
);
1450 if (PxeOption
->OpCode
== PXEBC_DHCP4_TAG_PAD
) {
1453 Offset
= (UINT8
) (Offset
+ PxeOption
->Length
+ 2);
1456 PxeOption
= (EFI_DHCP4_PACKET_OPTION
*) (Dhcp4Option
->Data
+ Offset
);
1460 // FixMe, return falas if invalid of any vendor option
1468 This function display boot item detail.
1470 If the length of the boot item string over 70 Char, just display 70 Char.
1472 @param Str Pointer to a string (boot item string).
1473 @param Len The length of string.
1477 PxeBcDisplayBootItem (
1484 Len
= (UINT8
) MIN (70, Len
);
1487 AsciiPrint ("%a \n", Str
);
1493 Choose the boot prompt.
1495 @param Private Pointer to PxeBc private data.
1497 @retval EFI_SUCCESS Select boot prompt done.
1498 @retval EFI_TIMEOUT Select boot prompt time out.
1499 @retval EFI_NOT_FOUND The proxy offer is not Pxe10.
1500 @retval EFI_ABORTED User cancel the operation.
1501 @retval EFI_NOT_READY Read the input key from the keybroad has not finish.
1505 PxeBcSelectBootPrompt (
1506 IN PXEBC_PRIVATE_DATA
*Private
1509 PXEBC_CACHED_DHCP4_PACKET
*Packet
;
1510 PXEBC_VENDOR_OPTION
*VendorOpt
;
1511 EFI_EVENT TimeoutEvent
;
1512 EFI_EVENT DescendEvent
;
1513 EFI_INPUT_KEY InputKey
;
1521 TimeoutEvent
= NULL
;
1522 DescendEvent
= NULL
;
1524 if (Private
->PxeBc
.Mode
->ProxyOfferReceived
) {
1526 Packet
= &Private
->ProxyOffer
;
1529 Packet
= &Private
->Dhcp4Ack
;
1532 if (Packet
->OfferType
!= DHCP4_PACKET_TYPE_PXE10
) {
1533 return EFI_NOT_FOUND
;
1536 VendorOpt
= &Packet
->PxeVendorOption
;
1538 if (!IS_VALID_BOOT_PROMPT (VendorOpt
->BitMap
)) {
1542 Timeout
= VendorOpt
->MenuPrompt
->Timeout
;
1543 Prompt
= VendorOpt
->MenuPrompt
->Prompt
;
1544 PromptLen
= (UINT8
) (VendorOpt
->MenuPromptLen
- 1);
1550 if (Timeout
== 255) {
1554 Status
= gBS
->CreateEvent (
1562 if (EFI_ERROR (Status
)) {
1566 Status
= gBS
->SetTimer (
1569 Timeout
* TICKS_PER_SECOND
1572 if (EFI_ERROR (Status
)) {
1576 Status
= gBS
->CreateEvent (
1584 if (EFI_ERROR (Status
)) {
1588 Status
= gBS
->SetTimer (
1594 if (EFI_ERROR (Status
)) {
1598 SecCol
= gST
->ConOut
->Mode
->CursorColumn
;
1599 SecRow
= gST
->ConOut
->Mode
->CursorRow
;
1601 PxeBcDisplayBootItem (Prompt
, PromptLen
);
1603 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, SecCol
+ PromptLen
, SecRow
);
1604 AsciiPrint ("(%d) ", Timeout
--);
1606 while (EFI_ERROR (gBS
->CheckEvent (TimeoutEvent
))) {
1608 if (!EFI_ERROR (gBS
->CheckEvent (DescendEvent
))) {
1609 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, SecCol
+ PromptLen
, SecRow
);
1610 AsciiPrint ("(%d) ", Timeout
--);
1613 if (gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &InputKey
) == EFI_NOT_READY
) {
1615 gBS
->Stall (10 * TICKS_PER_MS
);
1619 if (InputKey
.ScanCode
== 0) {
1621 switch (InputKey
.UnicodeChar
) {
1623 Status
= EFI_ABORTED
;
1629 Status
= EFI_TIMEOUT
;
1637 switch (InputKey
.ScanCode
) {
1639 Status
= EFI_TIMEOUT
;
1643 Status
= EFI_ABORTED
;
1654 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, 0 , SecRow
+ 1);
1658 if (DescendEvent
!= NULL
) {
1659 gBS
->CloseEvent (DescendEvent
);
1662 if (TimeoutEvent
!= NULL
) {
1663 gBS
->CloseEvent (TimeoutEvent
);
1671 Select the boot menu.
1673 @param Private Pointer to PxeBc private data.
1674 @param Type The type of the menu.
1675 @param UseDefaultItem Use default item or not.
1677 @retval EFI_ABORTED User cancel operation.
1678 @retval EFI_SUCCESS Select the boot menu success.
1679 @retval EFI_NOT_READY Read the input key from the keybroad has not finish.
1683 PxeBcSelectBootMenu (
1684 IN PXEBC_PRIVATE_DATA
*Private
,
1686 IN BOOLEAN UseDefaultItem
1689 PXEBC_CACHED_DHCP4_PACKET
*Packet
;
1690 PXEBC_VENDOR_OPTION
*VendorOpt
;
1691 EFI_INPUT_KEY InputKey
;
1700 PXEBC_BOOT_MENU_ENTRY
*MenuItem
;
1701 PXEBC_BOOT_MENU_ENTRY
*MenuArray
[PXEBC_MAX_MENU_NUM
];
1708 if (Private
->PxeBc
.Mode
->ProxyOfferReceived
) {
1710 Packet
= &Private
->ProxyOffer
;
1713 Packet
= &Private
->Dhcp4Ack
;
1716 ASSERT (Packet
->OfferType
== DHCP4_PACKET_TYPE_PXE10
);
1718 VendorOpt
= &Packet
->PxeVendorOption
;
1720 if (!IS_VALID_BOOT_MENU (VendorOpt
->BitMap
)) {
1724 SetMem (Blank
, sizeof(Blank
), ' ');
1726 MenuSize
= VendorOpt
->BootMenuLen
;
1727 MenuItem
= VendorOpt
->BootMenu
;
1729 if (MenuSize
== 0) {
1730 return EFI_NOT_READY
;
1733 while (MenuSize
> 0) {
1734 MenuArray
[Index
++] = MenuItem
;
1735 MenuSize
= (UINT8
) (MenuSize
- (MenuItem
->DescLen
+ 3));
1736 MenuItem
= (PXEBC_BOOT_MENU_ENTRY
*) ((UINT8
*) MenuItem
+ MenuItem
->DescLen
+ 3);
1737 if (Index
>= PXEBC_MAX_MENU_NUM
) {
1742 if (UseDefaultItem
) {
1743 *Type
= MenuArray
[0]->Type
;
1744 *Type
= NTOHS (*Type
);
1750 for (Index
= 0; Index
< MenuNum
; Index
++) {
1751 PxeBcDisplayBootItem (MenuArray
[Index
]->DescStr
, MenuArray
[Index
]->DescLen
);
1754 TopRow
= gST
->ConOut
->Mode
->CursorRow
- MenuNum
;
1757 ASSERT (Select
< PXEBC_MAX_MENU_NUM
);
1759 // highlight selected row
1761 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_BLACK
, EFI_LIGHTGRAY
));
1762 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, 0, TopRow
+ Select
);
1763 Blank
[MenuArray
[Select
]->DescLen
] = 0;
1764 AsciiPrint ("%a\r", Blank
);
1765 PxeBcDisplayBootItem (MenuArray
[Select
]->DescStr
, MenuArray
[Select
]->DescLen
);
1766 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, 0, TopRow
+ MenuNum
);
1767 LastSelect
= Select
;
1769 while (gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &InputKey
) == EFI_NOT_READY
) {
1770 gBS
->Stall (10 * TICKS_PER_MS
);
1773 if (InputKey
.ScanCode
!= 0) {
1774 switch (InputKey
.UnicodeChar
) {
1776 InputKey
.ScanCode
= SCAN_ESC
;
1779 case CTRL ('j'): /* linefeed */
1780 case CTRL ('m'): /* return */
1784 case CTRL ('i'): /* tab */
1788 InputKey
.ScanCode
= SCAN_DOWN
;
1791 case CTRL ('h'): /* backspace */
1794 InputKey
.ScanCode
= SCAN_UP
;
1798 InputKey
.ScanCode
= 0;
1802 switch (InputKey
.ScanCode
) {
1813 if (++Select
== MenuNum
) {
1824 case SCAN_PAGE_DOWN
:
1826 Select
= (UINT16
) (MenuNum
- 1);
1833 /* unhighlight last selected row */
1834 gST
->ConOut
->SetAttribute (gST
->ConOut
, EFI_TEXT_ATTR (EFI_LIGHTGRAY
, EFI_BLACK
));
1835 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, 0, TopRow
+ LastSelect
);
1836 Blank
[MenuArray
[LastSelect
]->DescLen
] = 0;
1837 AsciiPrint ("%a\r", Blank
);
1838 PxeBcDisplayBootItem (MenuArray
[LastSelect
]->DescStr
, MenuArray
[LastSelect
]->DescLen
);
1839 gST
->ConOut
->SetCursorPosition (gST
->ConOut
, 0, TopRow
+ MenuNum
);
1842 ASSERT (Select
< PXEBC_MAX_MENU_NUM
);
1845 // Swap the byte order
1847 CopyMem (Type
, &MenuArray
[Select
]->Type
, sizeof (UINT16
));
1848 *Type
= NTOHS (*Type
);