]> git.proxmox.com Git - mirror_edk2.git/blob - NetworkPkg/UefiPxeBcDxe/PxeBcImpl.c
projects / mirror_edk2.git / blob
? search:


15cda8cf69b67e47b21c82923528b872c6390960
[mirror_edk2.git] / NetworkPkg / UefiPxeBcDxe / PxeBcImpl.c
1 /** @file
2 This implementation of EFI_PXE_BASE_CODE_PROTOCOL and EFI_LOAD_FILE_PROTOCOL.
3
4 Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>
5
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #include "PxeBcImpl.h"
17
18
19 /**
20 Enables the use of the PXE Base Code Protocol functions.
21
22 This function enables the use of the PXE Base Code Protocol functions. If the
23 Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then
24 EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted
25 addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted
26 addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported
27 field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will
28 be returned. If there is not enough memory or other resources to start the PXE
29 Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the
30 PXE Base Code Protocol will be started.
31
32 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
33 @param[in] UseIpv6 Specifies the type of IP addresses that are to be
34 used during the session that is being started.
35 Set to TRUE for IPv6, and FALSE for IPv4.
36
37 @retval EFI_SUCCESS The PXE Base Code Protocol was started.
38 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
39 @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the
40 EFI_PXE_BASE_CODE_MODE structure is FALSE.
41 @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.
42 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
43 EFI_PXE_BASE_CODE_PROTOCOL structure.
44 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the
45 PXE Base Code Protocol.
46
47 **/
48 EFI_STATUS
49 EFIAPI
50 EfiPxeBcStart (
51 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
52 IN BOOLEAN UseIpv6
53 )
54 {
55 PXEBC_PRIVATE_DATA *Private;
56 EFI_PXE_BASE_CODE_MODE *Mode;
57 UINTN Index;
58 EFI_STATUS Status;
59
60 if (This == NULL) {
61 return EFI_INVALID_PARAMETER;
62 }
63
64 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
65 Mode = Private->PxeBc.Mode;
66
67 if (Mode->Started) {
68 return EFI_ALREADY_STARTED;
69 }
70
71 //
72 // Detect whether using IPv6 or not, and set it into mode data.
73 //
74 if (UseIpv6 && Mode->Ipv6Available && Mode->Ipv6Supported && Private->Ip6Nic != NULL) {
75 Mode->UsingIpv6 = TRUE;
76 } else if (!UseIpv6 && Private->Ip4Nic != NULL) {
77 Mode->UsingIpv6 = FALSE;
78 } else {
79 return EFI_UNSUPPORTED;
80 }
81
82 if (Mode->UsingIpv6) {
83 AsciiPrint ("\n>>Start PXE over IPv6");
84 //
85 // Configure udp6 instance to receive data.
86 //
87 Status = Private->Udp6Read->Configure (
88 Private->Udp6Read,
89 &Private->Udp6CfgData
90 );
91 if (EFI_ERROR (Status)) {
92 goto ON_ERROR;
93 }
94
95 //
96 // Configure block size for TFTP as a default value to handle all link layers.
97 //
98 Private->BlockSize = (UINTN) (Private->Ip6MaxPacketSize -
99 PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE);
100
101 //
102 // PXE over IPv6 starts here, initialize the fields and list header.
103 //
104 Private->Ip6Policy = PXEBC_IP6_POLICY_MAX;
105 Private->ProxyOffer.Dhcp6.Packet.Offer.Size = PXEBC_DHCP6_PACKET_MAX_SIZE;
106 Private->DhcpAck.Dhcp6.Packet.Ack.Size = PXEBC_DHCP6_PACKET_MAX_SIZE;
107 Private->PxeReply.Dhcp6.Packet.Ack.Size = PXEBC_DHCP6_PACKET_MAX_SIZE;
108
109 for (Index = 0; Index < PXEBC_OFFER_MAX_NUM; Index++) {
110 Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = PXEBC_DHCP6_PACKET_MAX_SIZE;
111 }
112
113 //
114 // Create event and set status for token to capture ICMP6 error message.
115 //
116 Private->Icmp6Token.Status = EFI_NOT_READY;
117 Status = gBS->CreateEvent (
118 EVT_NOTIFY_SIGNAL,
119 TPL_NOTIFY,
120 PxeBcIcmp6ErrorUpdate,
121 Private,
122 &Private->Icmp6Token.Event
123 );
124 if (EFI_ERROR (Status)) {
125 goto ON_ERROR;
126 }
127 } else {
128 AsciiPrint ("\n>>Start PXE over IPv4");
129 //
130 // Configure udp4 instance to receive data.
131 //
132 Status = Private->Udp4Read->Configure (
133 Private->Udp4Read,
134 &Private->Udp4CfgData
135 );
136 if (EFI_ERROR (Status)) {
137 goto ON_ERROR;
138 }
139
140 //
141 // Configure block size for TFTP as a default value to handle all link layers.
142 //
143 Private->BlockSize = (UINTN) (Private->Ip4MaxPacketSize -
144 PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE);
145
146 //
147 // PXE over IPv4 starts here, initialize the fields.
148 //
149 Private->ProxyOffer.Dhcp4.Packet.Offer.Size = PXEBC_DHCP4_PACKET_MAX_SIZE;
150 Private->DhcpAck.Dhcp4.Packet.Ack.Size = PXEBC_DHCP4_PACKET_MAX_SIZE;
151 Private->PxeReply.Dhcp4.Packet.Ack.Size = PXEBC_DHCP4_PACKET_MAX_SIZE;
152
153 for (Index = 0; Index < PXEBC_OFFER_MAX_NUM; Index++) {
154 Private->OfferBuffer[Index].Dhcp4.Packet.Offer.Size = PXEBC_DHCP4_PACKET_MAX_SIZE;
155 }
156
157 PxeBcSeedDhcp4Packet (&Private->SeedPacket, Private->Udp4Read);
158
159 //
160 // Create the event for Arp cache update.
161 //
162 Status = gBS->CreateEvent (
163 EVT_TIMER | EVT_NOTIFY_SIGNAL,
164 TPL_CALLBACK,
165 PxeBcArpCacheUpdate,
166 Private,
167 &Private->ArpUpdateEvent
168 );
169 if (EFI_ERROR (Status)) {
170 goto ON_ERROR;
171 }
172
173 //
174 // Start a periodic timer by second to update Arp cache.
175 //
176 Status = gBS->SetTimer (
177 Private->ArpUpdateEvent,
178 TimerPeriodic,
179 TICKS_PER_SECOND
180 );
181 if (EFI_ERROR (Status)) {
182 goto ON_ERROR;
183 }
184
185 //
186 // Create event and set status for token to capture ICMP error message.
187 //
188 Private->Icmp6Token.Status = EFI_NOT_READY;
189 Status = gBS->CreateEvent (
190 EVT_NOTIFY_SIGNAL,
191 TPL_NOTIFY,
192 PxeBcIcmpErrorUpdate,
193 Private,
194 &Private->IcmpToken.Event
195 );
196 if (EFI_ERROR (Status)) {
197 goto ON_ERROR;
198 }
199 }
200
201 //
202 // If PcdTftpBlockSize is set to non-zero, override the default value.
203 //
204 if (PcdGet64 (PcdTftpBlockSize) != 0) {
205 Private->BlockSize = (UINTN) PcdGet64 (PcdTftpBlockSize);
206 }
207
208 //
209 // Create event for UdpRead/UdpWrite timeout since they are both blocking API.
210 //
211 Status = gBS->CreateEvent (
212 EVT_TIMER,
213 TPL_CALLBACK,
214 NULL,
215 NULL,
216 &Private->UdpTimeOutEvent
217 );
218 if (EFI_ERROR (Status)) {
219 goto ON_ERROR;
220 }
221
222 Private->IsAddressOk = FALSE;
223 Mode->Started = TRUE;
224
225 return EFI_SUCCESS;
226
227 ON_ERROR:
228 if (Mode->UsingIpv6) {
229 if (Private->Icmp6Token.Event != NULL) {
230 gBS->CloseEvent (Private->Icmp6Token.Event);
231 Private->Icmp6Token.Event = NULL;
232 }
233 Private->Udp6Read->Configure (Private->Udp6Read, NULL);
234 Private->Ip6->Configure (Private->Ip6, NULL);
235 } else {
236 if (Private->ArpUpdateEvent != NULL) {
237 gBS->CloseEvent (Private->ArpUpdateEvent);
238 Private->ArpUpdateEvent = NULL;
239 }
240 if (Private->IcmpToken.Event != NULL) {
241 gBS->CloseEvent (Private->IcmpToken.Event);
242 Private->IcmpToken.Event = NULL;
243 }
244 Private->Udp4Read->Configure (Private->Udp4Read, NULL);
245 Private->Ip4->Configure (Private->Ip4, NULL);
246 }
247 return Status;
248 }
249
250
251 /**
252 Disable the use of the PXE Base Code Protocol functions.
253
254 This function stops all activity on the network device. All the resources allocated
255 in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is
256 set to FALSE, and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE
257 structure is already FALSE, then EFI_NOT_STARTED will be returned.
258
259 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
260
261 @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.
262 @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.
263 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
264 EFI_PXE_BASE_CODE_PROTOCOL structure.
265 @retval Others
266
267 **/
268 EFI_STATUS
269 EFIAPI
270 EfiPxeBcStop (
271 IN EFI_PXE_BASE_CODE_PROTOCOL *This
272 )
273 {
274 PXEBC_PRIVATE_DATA *Private;
275 EFI_PXE_BASE_CODE_MODE *Mode;
276 BOOLEAN Ipv6Supported;
277 BOOLEAN Ipv6Available;
278
279 if (This == NULL) {
280 return EFI_INVALID_PARAMETER;
281 }
282
283 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
284 Mode = Private->PxeBc.Mode;
285 Ipv6Supported = Mode->Ipv6Supported;
286 Ipv6Available = Mode->Ipv6Available;
287
288 if (!Mode->Started) {
289 return EFI_NOT_STARTED;
290 }
291
292 if (Mode->UsingIpv6) {
293 //
294 // Configure all the instances for IPv6 as NULL.
295 //
296 ZeroMem (&Private->Udp6CfgData.StationAddress, sizeof (EFI_IPv6_ADDRESS));
297 ZeroMem (&Private->Ip6CfgData.StationAddress, sizeof (EFI_IPv6_ADDRESS));
298 Private->Dhcp6->Stop (Private->Dhcp6);
299 Private->Dhcp6->Configure (Private->Dhcp6, NULL);
300 Private->Udp6Write->Configure (Private->Udp6Write, NULL);
301 Private->Udp6Read->Groups (Private->Udp6Read, FALSE, NULL);
302 Private->Udp6Read->Configure (Private->Udp6Read, NULL);
303 Private->Ip6->Cancel (Private->Ip6, &Private->Icmp6Token);
304 Private->Ip6->Configure (Private->Ip6, NULL);
305 PxeBcUnregisterIp6Address (Private);
306 if (Private->Icmp6Token.Event != NULL) {
307 gBS->CloseEvent (Private->Icmp6Token.Event);
308 Private->Icmp6Token.Event = NULL;
309 }
310 if (Private->Dhcp6Request != NULL) {
311 FreePool (Private->Dhcp6Request);
312 Private->Dhcp6Request = NULL;
313 }
314 if (Private->BootFileName != NULL) {
315 FreePool (Private->BootFileName);
316 Private->BootFileName = NULL;
317 }
318 } else {
319 //
320 // Configure all the instances for IPv4 as NULL.
321 //
322 ZeroMem (&Private->Udp4CfgData.StationAddress, sizeof (EFI_IPv4_ADDRESS));
323 ZeroMem (&Private->Udp4CfgData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));
324 ZeroMem (&Private->Ip4CfgData.StationAddress, sizeof (EFI_IPv4_ADDRESS));
325 ZeroMem (&Private->Ip4CfgData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));
326 Private->Dhcp4->Stop (Private->Dhcp4);
327 Private->Dhcp4->Configure (Private->Dhcp4, NULL);
328 Private->Udp4Write->Configure (Private->Udp4Write, NULL);
329 Private->Udp4Read->Groups (Private->Udp4Read, FALSE, NULL);
330 Private->Udp4Read->Configure (Private->Udp4Read, NULL);
331 Private->Ip4->Cancel (Private->Ip4, &Private->IcmpToken);
332 Private->Ip4->Configure (Private->Ip4, NULL);
333 if (Private->ArpUpdateEvent != NULL) {
334 gBS->CloseEvent (Private->ArpUpdateEvent);
335 Private->ArpUpdateEvent = NULL;
336 }
337 if (Private->IcmpToken.Event != NULL) {
338 gBS->CloseEvent (Private->IcmpToken.Event);
339 Private->IcmpToken.Event = NULL;
340 }
341 }
342
343 gBS->CloseEvent (Private->UdpTimeOutEvent);
344 Private->CurSrcPort = 0;
345 Private->BootFileSize = 0;
346 Private->SolicitTimes = 0;
347 Private->ElapsedTime = 0;
348
349 //
350 // Reset the mode data.
351 //
352 ZeroMem (Mode, sizeof (EFI_PXE_BASE_CODE_MODE));
353 Mode->Ipv6Available = Ipv6Available;
354 Mode->Ipv6Supported = Ipv6Supported;
355 Mode->AutoArp = TRUE;
356 Mode->TTL = DEFAULT_TTL;
357 Mode->ToS = DEFAULT_ToS;
358
359 return EFI_SUCCESS;
360 }
361
362
363 /**
364 Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6
365 S.A.R.R (solicit / advertise / request / reply) sequence.
366
367 If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before
368 they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will
369 be tried in the order in which they are received. Please see the Preboot Execution
370 Environment (PXE) Specification and Unified Extensible Firmware Interface (UEFI)
371 Specification for additional details on the implementation of DHCP.
372 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
373 then the DHCP sequence will be stopped and EFI_ABORTED will be returned.
374
375 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
376 @param[in] SortOffers TRUE if the offers received should be sorted. Set to FALSE to
377 try the offers in the order that they are received.
378
379 @retval EFI_SUCCESS Valid DHCP has completed.
380 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
381 @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
382 EFI_PXE_BASE_CODE_PROTOCOL structure.
383 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
384 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.
385 @retval EFI_ABORTED The callback function aborted the DHCP Protocol.
386 @retval EFI_TIMEOUT The DHCP Protocol timed out.
387 @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.
388 @retval EFI_NO_RESPONSE Valid PXE offer was not received.
389
390 **/
391 EFI_STATUS
392 EFIAPI
393 EfiPxeBcDhcp (
394 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
395 IN BOOLEAN SortOffers
396 )
397 {
398 PXEBC_PRIVATE_DATA *Private;
399 EFI_PXE_BASE_CODE_MODE *Mode;
400 EFI_STATUS Status;
401 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;
402
403 if (This == NULL) {
404 return EFI_INVALID_PARAMETER;
405 }
406
407 Status = EFI_SUCCESS;
408 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
409 Mode = Private->PxeBc.Mode;
410 Mode->IcmpErrorReceived = FALSE;
411 Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DHCP;
412 Private->IsOfferSorted = SortOffers;
413 Private->SolicitTimes = 0;
414 Private->ElapsedTime = 0;
415
416 if (!Mode->Started) {
417 return EFI_NOT_STARTED;
418 }
419
420 if (Mode->UsingIpv6) {
421
422 //
423 // Stop Udp6Read instance
424 //
425 Private->Udp6Read->Configure (Private->Udp6Read, NULL);
426
427 //
428 // Start S.A.R.R. process to get a IPv6 address and other boot information.
429 //
430 Status = PxeBcDhcp6Sarr (Private, Private->Dhcp6);
431 } else {
432
433 //
434 // Stop Udp4Read instance
435 //
436 Private->Udp4Read->Configure (Private->Udp4Read, NULL);
437
438 //
439 // Start D.O.R.A. process to get a IPv4 address and other boot information.
440 //
441 Status = PxeBcDhcp4Dora (Private, Private->Dhcp4);
442 }
443
444 //
445 // Reconfigure the UDP instance with the default configuration.
446 //
447 if (Mode->UsingIpv6) {
448 Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);
449 } else {
450 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
451 }
452 //
453 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
454 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
455 //
456 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
457 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
458 This->SetIpFilter (This, &IpFilter);
459
460 return Status;
461 }
462
463
464 /**
465 Attempts to complete the PXE Boot Server and/or boot image discovery sequence.
466
467 This function attempts to complete the PXE Boot Server and/or boot image discovery
468 sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the
469 PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the
470 EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the
471 PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure
472 will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.
473 In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],
474 has two uses: It is the Boot Server IP address list used for unicast discovery
475 (if the UseUCast field is TRUE), and it is the list used for Boot Server verification
476 (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure
477 is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot
478 Server reply of that type will be accepted. If the AcceptAnyResponse field is
479 FALSE, only responses from Boot Servers with matching IP addresses will be accepted.
480 This function can take at least 10 seconds to timeout and return control to the
481 caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be
482 returned. Please see the Preboot Execution Environment (PXE) Specification for
483 additional details on the implementation of the Discovery sequence.
484 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
485 then the Discovery sequence is stopped and EFI_ABORTED will be returned.
486
487 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
488 @param[in] Type The type of bootstrap to perform.
489 @param[in] Layer Pointer to the boot server layer number to discover, which must be
490 PXE_BOOT_LAYER_INITIAL when a new server type is being
491 discovered.
492 @param[in] UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.
493 @param[in] Info Pointer to a data structure that contains additional information
494 on the type of discovery operation that is to be performed.
495 It is optional.
496
497 @retval EFI_SUCCESS The Discovery sequence has been completed.
498 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
499 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
500 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
501 @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.
502 @retval EFI_ABORTED The callback function aborted the Discovery sequence.
503 @retval EFI_TIMEOUT The Discovery sequence timed out.
504 @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery
505 session.
506
507 **/
508 EFI_STATUS
509 EFIAPI
510 EfiPxeBcDiscover (
511 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
512 IN UINT16 Type,
513 IN UINT16 *Layer,
514 IN BOOLEAN UseBis,
515 IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL
516 )
517 {
518 PXEBC_PRIVATE_DATA *Private;
519 EFI_PXE_BASE_CODE_MODE *Mode;
520 EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo;
521 EFI_PXE_BASE_CODE_SRVLIST *SrvList;
522 PXEBC_BOOT_SVR_ENTRY *BootSvrEntry;
523 UINT16 Index;
524 EFI_STATUS Status;
525 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;
526 EFI_PXE_BASE_CODE_DISCOVER_INFO *NewCreatedInfo;
527
528 if (This == NULL) {
529 return EFI_INVALID_PARAMETER;
530 }
531
532 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
533 Mode = Private->PxeBc.Mode;
534 Mode->IcmpErrorReceived = FALSE;
535 BootSvrEntry = NULL;
536 SrvList = NULL;
537 Status = EFI_DEVICE_ERROR;
538 Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DISCOVER;
539 NewCreatedInfo = NULL;
540
541 if (!Mode->Started) {
542 return EFI_NOT_STARTED;
543 }
544
545 //
546 // Station address should be ready before do discover.
547 //
548 if (!Private->IsAddressOk) {
549 return EFI_INVALID_PARAMETER;
550 }
551
552 if (Mode->UsingIpv6) {
553
554 //
555 // Stop Udp6Read instance
556 //
557 Private->Udp6Read->Configure (Private->Udp6Read, NULL);
558 } else {
559
560 //
561 // Stop Udp4Read instance
562 //
563 Private->Udp4Read->Configure (Private->Udp4Read, NULL);
564 }
565
566 //
567 // There are 3 methods to get the information for discover.
568 //
569 ZeroMem (&DefaultInfo, sizeof (EFI_PXE_BASE_CODE_DISCOVER_INFO));
570 if (*Layer != EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL) {
571 //
572 // 1. Take the previous setting as the discover info.
573 //
574 if (!Mode->PxeDiscoverValid ||
575 !Mode->PxeReplyReceived ||
576 (!Mode->PxeBisReplyReceived && UseBis)) {
577 Status = EFI_INVALID_PARAMETER;
578 goto ON_EXIT;
579 }
580
581 Info = &DefaultInfo;
582 Info->IpCnt = 1;
583 Info->UseUCast = TRUE;
584 SrvList = Info->SrvList;
585 SrvList[0].Type = Type;
586 SrvList[0].AcceptAnyResponse = FALSE;
587
588 CopyMem (&SrvList->IpAddr, &Private->ServerIp, sizeof (EFI_IP_ADDRESS));
589
590 } else if (Info == NULL) {
591 //
592 // 2. Extract the discover information from the cached packets if unspecified.
593 //
594 NewCreatedInfo = &DefaultInfo;
595 Status = PxeBcExtractDiscoverInfo (Private, Type, &NewCreatedInfo, &BootSvrEntry, &SrvList);
596 if (EFI_ERROR (Status)) {
597 goto ON_EXIT;
598 }
599 Info = NewCreatedInfo;
600 } else {
601 //
602 // 3. Take the pass-in information as the discover info, and validate the server list.
603 //
604 SrvList = Info->SrvList;
605
606 if (!SrvList[0].AcceptAnyResponse) {
607 for (Index = 1; Index < Info->IpCnt; Index++) {
608 if (SrvList[Index].AcceptAnyResponse) {
609 break;
610 }
611 }
612 if (Index != Info->IpCnt) {
613 //
614 // It's invalid if the first server doesn't accecpt any response
615 // but any of the other servers does accept any response.
616 //
617 Status = EFI_INVALID_PARAMETER;
618 goto ON_EXIT;
619 }
620 }
621 }
622
623 //
624 // Info and BootSvrEntry/SrvList are all ready by now, so execute discover by UniCast/BroadCast/MultiCast.
625 //
626 if ((!Info->UseUCast && !Info->UseBCast && !Info->UseMCast) ||
627 (Info->MustUseList && Info->IpCnt == 0)) {
628 Status = EFI_INVALID_PARAMETER;
629 goto ON_EXIT;
630 }
631
632 Private->IsDoDiscover = TRUE;
633
634 if (Info->UseMCast) {
635 //
636 // Do discover by multicast.
637 //
638 Status = PxeBcDiscoverBootServer (
639 Private,
640 Type,
641 Layer,
642 UseBis,
643 &Info->ServerMCastIp,
644 Info->IpCnt,
645 SrvList
646 );
647
648 } else if (Info->UseBCast) {
649 //
650 // Do discover by broadcast, but only valid for IPv4.
651 //
652 ASSERT (!Mode->UsingIpv6);
653 Status = PxeBcDiscoverBootServer (
654 Private,
655 Type,
656 Layer,
657 UseBis,
658 NULL,
659 Info->IpCnt,
660 SrvList
661 );
662
663 } else if (Info->UseUCast) {
664 //
665 // Do discover by unicast.
666 //
667 for (Index = 0; Index < Info->IpCnt; Index++) {
668 if (BootSvrEntry == NULL) {
669 CopyMem (&Private->ServerIp, &SrvList[Index].IpAddr, sizeof (EFI_IP_ADDRESS));
670 } else {
671 ASSERT (!Mode->UsingIpv6);
672 ZeroMem (&Private->ServerIp, sizeof (EFI_IP_ADDRESS));
673 CopyMem (&Private->ServerIp, &BootSvrEntry->IpAddr[Index], sizeof (EFI_IPv4_ADDRESS));
674 }
675
676 Status = PxeBcDiscoverBootServer (
677 Private,
678 Type,
679 Layer,
680 UseBis,
681 &Private->ServerIp,
682 Info->IpCnt,
683 SrvList
684 );
685 }
686 }
687
688 if (!EFI_ERROR (Status)) {
689 //
690 // Parse the cached PXE reply packet, and store it into mode data if valid.
691 //
692 if (Mode->UsingIpv6) {
693 Status = PxeBcParseDhcp6Packet (&Private->PxeReply.Dhcp6);
694 if (!EFI_ERROR (Status)) {
695 CopyMem (
696 &Mode->PxeReply.Dhcpv6,
697 &Private->PxeReply.Dhcp6.Packet.Ack.Dhcp6,
698 Private->PxeReply.Dhcp6.Packet.Ack.Length
699 );
700 Mode->PxeReplyReceived = TRUE;
701 Mode->PxeDiscoverValid = TRUE;
702 }
703 } else {
704 Status = PxeBcParseDhcp4Packet (&Private->PxeReply.Dhcp4);
705 if (!EFI_ERROR (Status)) {
706 CopyMem (
707 &Mode->PxeReply.Dhcpv4,
708 &Private->PxeReply.Dhcp4.Packet.Ack.Dhcp4,
709 Private->PxeReply.Dhcp4.Packet.Ack.Length
710 );
711 Mode->PxeReplyReceived = TRUE;
712 Mode->PxeDiscoverValid = TRUE;
713 }
714 }
715 }
716
717 ON_EXIT:
718
719 if (NewCreatedInfo != NULL && NewCreatedInfo != &DefaultInfo) {
720 FreePool (NewCreatedInfo);
721 }
722
723 if (Mode->UsingIpv6) {
724 Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);
725 } else {
726 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
727 }
728
729 //
730 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
731 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
732 //
733 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
734 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
735 This->SetIpFilter (This, &IpFilter);
736
737 return Status;
738 }
739
740
741 /**
742 Used to perform TFTP and MTFTP services.
743
744 This function is used to perform TFTP and MTFTP services. This includes the
745 TFTP operations to get the size of a file, read a directory, read a file, and
746 write a file. It also includes the MTFTP operations to get the size of a file,
747 read a directory, and read a file. The type of operation is specified by Operation.
748 If the callback function that is invoked during the TFTP/MTFTP operation does
749 not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will
750 be returned.
751 For read operations, the return data will be placed in the buffer specified by
752 BufferPtr. If BufferSize is too small to contain the entire downloaded file,
753 then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero,
754 or the size of the requested file. (NOTE: the size of the requested file is only returned
755 if the TFTP server supports TFTP options). If BufferSize is large enough for the
756 read operation, then BufferSize will be set to the size of the downloaded file,
757 and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services
758 should use the get-file-size operations to determine the size of the downloaded
759 file prior to using the read-file operations-especially when downloading large
760 (greater than 64 MB) files-instead of making two calls to the read-file operation.
761 Following this recommendation will save time if the file is larger than expected
762 and the TFTP server does not support TFTP option extensions. Without TFTP option
763 extension support, the client must download the entire file, counting and discarding
764 the received packets, to determine the file size.
765 For write operations, the data to be sent is in the buffer specified by BufferPtr.
766 BufferSize specifies the number of bytes to send. If the write operation completes
767 successfully, then EFI_SUCCESS will be returned.
768 For TFTP "get file size" operations, the size of the requested file or directory
769 is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server
770 does not support options, the file will be downloaded into a bit bucket and the
771 length of the downloaded file will be returned. For MTFTP "get file size" operations,
772 if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED
773 will be returned.
774 This function can take up to 10 seconds to timeout and return control to the caller.
775 If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.
776 If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
777 then the TFTP sequence is stopped and EFI_ABORTED will be returned.
778
779 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
780 @param[in] Operation The type of operation to perform.
781 @param[in, out] BufferPtr A pointer to the data buffer.
782 @param[in] Overwrite Only used on write file operations. TRUE if a file on a remote
783 server can be overwritten.
784 @param[in, out] BufferSize For get-file-size operations, *BufferSize returns the size of the
785 requested file.
786 @param[in] BlockSize The requested block size to be used during a TFTP transfer.
787 @param[in] ServerIp The TFTP / MTFTP server IP address.
788 @param[in] Filename A Null-terminated ASCII string that specifies a directory name
789 or a file name.
790 @param[in] Info Pointer to the MTFTP information.
791 @param[in] DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.
792
793 @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.
794 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
795 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
796 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
797 @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.
798 @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.
799 @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.
800 @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.
801 @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.
802
803 **/
804 EFI_STATUS
805 EFIAPI
806 EfiPxeBcMtftp (
807 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
808 IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation,
809 IN OUT VOID *BufferPtr OPTIONAL,
810 IN BOOLEAN Overwrite,
811 IN OUT UINT64 *BufferSize,
812 IN UINTN *BlockSize OPTIONAL,
813 IN EFI_IP_ADDRESS *ServerIp,
814 IN UINT8 *Filename,
815 IN EFI_PXE_BASE_CODE_MTFTP_INFO *Info OPTIONAL,
816 IN BOOLEAN DontUseBuffer
817 )
818 {
819 PXEBC_PRIVATE_DATA *Private;
820 EFI_PXE_BASE_CODE_MODE *Mode;
821 EFI_MTFTP4_CONFIG_DATA Mtftp4Config;
822 EFI_MTFTP6_CONFIG_DATA Mtftp6Config;
823 VOID *Config;
824 EFI_STATUS Status;
825 EFI_PXE_BASE_CODE_IP_FILTER IpFilter;
826
827
828 if ((This == NULL) ||
829 (Filename == NULL) ||
830 (BufferSize == NULL) ||
831 (ServerIp == NULL) ||
832 ((BufferPtr == NULL) && DontUseBuffer) ||
833 ((BlockSize != NULL) && (*BlockSize < PXE_MTFTP_DEFAULT_BLOCK_SIZE)) ||
834 (!NetIp4IsUnicast (NTOHL (ServerIp->Addr[0]), 0) && !NetIp6IsValidUnicast (&ServerIp->v6))) {
835 return EFI_INVALID_PARAMETER;
836 }
837
838 Config = NULL;
839 Status = EFI_DEVICE_ERROR;
840 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
841 Mode = Private->PxeBc.Mode;
842
843 if (Mode->UsingIpv6) {
844 //
845 // Set configuration data for Mtftp6 instance.
846 //
847 ZeroMem (&Mtftp6Config, sizeof (EFI_MTFTP6_CONFIG_DATA));
848 Config = &Mtftp6Config;
849 Mtftp6Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;
850 Mtftp6Config.TryCount = PXEBC_MTFTP_RETRIES;
851 CopyMem (&Mtftp6Config.StationIp, &Private->StationIp.v6, sizeof (EFI_IPv6_ADDRESS));
852 CopyMem (&Mtftp6Config.ServerIp, &ServerIp->v6, sizeof (EFI_IPv6_ADDRESS));
853 //
854 // Stop Udp6Read instance
855 //
856 Private->Udp6Read->Configure (Private->Udp6Read, NULL);
857 } else {
858 //
859 // Set configuration data for Mtftp4 instance.
860 //
861 ZeroMem (&Mtftp4Config, sizeof (EFI_MTFTP4_CONFIG_DATA));
862 Config = &Mtftp4Config;
863 Mtftp4Config.UseDefaultSetting = FALSE;
864 Mtftp4Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;
865 Mtftp4Config.TryCount = PXEBC_MTFTP_RETRIES;
866 CopyMem (&Mtftp4Config.StationIp, &Private->StationIp.v4, sizeof (EFI_IPv4_ADDRESS));
867 CopyMem (&Mtftp4Config.SubnetMask, &Private->SubnetMask.v4, sizeof (EFI_IPv4_ADDRESS));
868 CopyMem (&Mtftp4Config.GatewayIp, &Private->GatewayIp.v4, sizeof (EFI_IPv4_ADDRESS));
869 CopyMem (&Mtftp4Config.ServerIp, &ServerIp->v4, sizeof (EFI_IPv4_ADDRESS));
870 //
871 // Stop Udp4Read instance
872 //
873 Private->Udp4Read->Configure (Private->Udp4Read, NULL);
874 }
875
876 Mode->TftpErrorReceived = FALSE;
877 Mode->IcmpErrorReceived = FALSE;
878
879 switch (Operation) {
880
881 case EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE:
882 //
883 // Send TFTP request to get file size.
884 //
885 Status = PxeBcTftpGetFileSize (
886 Private,
887 Config,
888 Filename,
889 BlockSize,
890 BufferSize
891 );
892
893 break;
894
895 case EFI_PXE_BASE_CODE_TFTP_READ_FILE:
896 //
897 // Send TFTP request to read file.
898 //
899 Status = PxeBcTftpReadFile (
900 Private,
901 Config,
902 Filename,
903 BlockSize,
904 BufferPtr,
905 BufferSize,
906 DontUseBuffer
907 );
908
909 break;
910
911 case EFI_PXE_BASE_CODE_TFTP_WRITE_FILE:
912 //
913 // Send TFTP request to write file.
914 //
915 Status = PxeBcTftpWriteFile (
916 Private,
917 Config,
918 Filename,
919 Overwrite,
920 BlockSize,
921 BufferPtr,
922 BufferSize
923 );
924
925 break;
926
927 case EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY:
928 //
929 // Send TFTP request to read directory.
930 //
931 Status = PxeBcTftpReadDirectory (
932 Private,
933 Config,
934 Filename,
935 BlockSize,
936 BufferPtr,
937 BufferSize,
938 DontUseBuffer
939 );
940
941 break;
942
943 case EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE:
944 case EFI_PXE_BASE_CODE_MTFTP_READ_FILE:
945 case EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY:
946 Status = EFI_UNSUPPORTED;
947
948 break;
949
950 default:
951 Status = EFI_INVALID_PARAMETER;
952
953 break;
954 }
955
956 if (Status == EFI_ICMP_ERROR) {
957 Mode->IcmpErrorReceived = TRUE;
958 }
959
960 //
961 // Reconfigure the UDP instance with the default configuration.
962 //
963 if (Mode->UsingIpv6) {
964 Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);
965 } else {
966 Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
967 }
968 //
969 // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
970 // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
971 //
972 ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
973 IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
974 This->SetIpFilter (This, &IpFilter);
975
976 return Status;
977 }
978
979
980 /**
981 Writes a UDP packet to the network interface.
982
983 This function writes a UDP packet specified by the (optional HeaderPtr and)
984 BufferPtr parameters to the network interface. The UDP header is automatically
985 built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,
986 SrcIp, and SrcPort to build this header. If the packet is successfully built and
987 transmitted through the network interface, then EFI_SUCCESS will be returned.
988 If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will
989 be returned. If an ICMP error occurs during the transmission of the packet, then
990 the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and
991 EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
992 EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.
993
994 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
995 @param[in] OpFlags The UDP operation flags.
996 @param[in] DestIp The destination IP address.
997 @param[in] DestPort The destination UDP port number.
998 @param[in] GatewayIp The gateway IP address.
999 @param[in] SrcIp The source IP address.
1000 @param[in, out] SrcPort The source UDP port number.
1001 @param[in] HeaderSize An optional field which may be set to the length of a header
1002 at HeaderPtr to be prefixed to the data at BufferPtr.
1003 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
1004 prefixed to the data at BufferPtr.
1005 @param[in] BufferSize A pointer to the size of the data at BufferPtr.
1006 @param[in] BufferPtr A pointer to the data to be written.
1007
1008 @retval EFI_SUCCESS The UDP Write operation completed.
1009 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1010 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1011 @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.
1012 @retval EFI_ABORTED The callback function aborted the UDP Write operation.
1013 @retval EFI_TIMEOUT The UDP Write operation timed out.
1014 @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.
1015
1016 **/
1017 EFI_STATUS
1018 EFIAPI
1019 EfiPxeBcUdpWrite (
1020 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1021 IN UINT16 OpFlags,
1022 IN EFI_IP_ADDRESS *DestIp,
1023 IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,
1024 IN EFI_IP_ADDRESS *GatewayIp OPTIONAL,
1025 IN EFI_IP_ADDRESS *SrcIp OPTIONAL,
1026 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,
1027 IN UINTN *HeaderSize OPTIONAL,
1028 IN VOID *HeaderPtr OPTIONAL,
1029 IN UINTN *BufferSize,
1030 IN VOID *BufferPtr
1031 )
1032 {
1033 PXEBC_PRIVATE_DATA *Private;
1034 EFI_PXE_BASE_CODE_MODE *Mode;
1035 EFI_UDP4_SESSION_DATA Udp4Session;
1036 EFI_UDP6_SESSION_DATA Udp6Session;
1037 EFI_STATUS Status;
1038 BOOLEAN DoNotFragment;
1039
1040 if (This == NULL || DestIp == NULL || DestPort == NULL) {
1041 return EFI_INVALID_PARAMETER;
1042 }
1043
1044 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1045 Mode = Private->PxeBc.Mode;
1046
1047 if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT) != 0) {
1048 DoNotFragment = FALSE;
1049 } else {
1050 DoNotFragment = TRUE;
1051 }
1052
1053 if (!Mode->UsingIpv6 && GatewayIp != NULL && !NetIp4IsUnicast (NTOHL (GatewayIp->Addr[0]), 0)) {
1054 //
1055 // Gateway is provided but it's not a unicast IPv4 address, while it will be ignored for IPv6.
1056 //
1057 return EFI_INVALID_PARAMETER;
1058 }
1059
1060 if (HeaderSize != NULL && (*HeaderSize == 0 || HeaderPtr == NULL)) {
1061 return EFI_INVALID_PARAMETER;
1062 }
1063
1064 if (BufferSize == NULL || (*BufferSize != 0 && BufferPtr == NULL)) {
1065 return EFI_INVALID_PARAMETER;
1066 }
1067
1068 if (!Mode->Started) {
1069 return EFI_NOT_STARTED;
1070 }
1071
1072 if (!Private->IsAddressOk && SrcIp == NULL) {
1073 return EFI_INVALID_PARAMETER;
1074 }
1075
1076 if (Private->CurSrcPort == 0 ||
1077 (SrcPort != NULL && *SrcPort != Private->CurSrcPort)) {
1078 //
1079 // Reconfigure UDPv4/UDPv6 for UdpWrite if the source port changed.
1080 //
1081 if (SrcPort != NULL) {
1082 Private->CurSrcPort = *SrcPort;
1083 }
1084 }
1085
1086 if (Mode->UsingIpv6) {
1087 Status = PxeBcConfigUdp6Write (
1088 Private->Udp6Write,
1089 &Private->StationIp.v6,
1090 &Private->CurSrcPort
1091 );
1092 } else {
1093 //
1094 // Configure the UDPv4 instance with gateway information from DHCP server as default.
1095 //
1096 Status = PxeBcConfigUdp4Write (
1097 Private->Udp4Write,
1098 &Private->StationIp.v4,
1099 &Private->SubnetMask.v4,
1100 &Private->GatewayIp.v4,
1101 &Private->CurSrcPort,
1102 DoNotFragment
1103 );
1104 }
1105
1106 if (EFI_ERROR (Status)) {
1107 Private->CurSrcPort = 0;
1108 return EFI_INVALID_PARAMETER;
1109 } else if (SrcPort != NULL) {
1110 *SrcPort = Private->CurSrcPort;
1111 }
1112
1113 //
1114 // Start a timer as timeout event for this blocking API.
1115 //
1116 gBS->SetTimer (Private->UdpTimeOutEvent, TimerRelative, PXEBC_UDP_TIMEOUT);
1117
1118 if (Mode->UsingIpv6) {
1119 //
1120 // Construct UDPv6 session data.
1121 //
1122 ZeroMem (&Udp6Session, sizeof (EFI_UDP6_SESSION_DATA));
1123 CopyMem (&Udp6Session.DestinationAddress, DestIp, sizeof (EFI_IPv6_ADDRESS));
1124 Udp6Session.DestinationPort = *DestPort;
1125 if (SrcIp != NULL) {
1126 CopyMem (&Udp6Session.SourceAddress, SrcIp, sizeof (EFI_IPv6_ADDRESS));
1127 }
1128 if (SrcPort != NULL) {
1129 Udp6Session.SourcePort = *SrcPort;
1130 }
1131
1132 Status = PxeBcUdp6Write (
1133 Private->Udp6Write,
1134 &Udp6Session,
1135 Private->UdpTimeOutEvent,
1136 HeaderSize,
1137 HeaderPtr,
1138 BufferSize,
1139 BufferPtr
1140 );
1141 } else {
1142 //
1143 // Construct UDPv4 session data.
1144 //
1145 ZeroMem (&Udp4Session, sizeof (EFI_UDP4_SESSION_DATA));
1146 CopyMem (&Udp4Session.DestinationAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));
1147 Udp4Session.DestinationPort = *DestPort;
1148 if (SrcIp != NULL) {
1149 CopyMem (&Udp4Session.SourceAddress, SrcIp, sizeof (EFI_IPv4_ADDRESS));
1150 }
1151 if (SrcPort != NULL) {
1152 Udp4Session.SourcePort = *SrcPort;
1153 }
1154 //
1155 // Override the gateway information if user specified.
1156 //
1157 Status = PxeBcUdp4Write (
1158 Private->Udp4Write,
1159 &Udp4Session,
1160 Private->UdpTimeOutEvent,
1161 (EFI_IPv4_ADDRESS *) GatewayIp,
1162 HeaderSize,
1163 HeaderPtr,
1164 BufferSize,
1165 BufferPtr
1166 );
1167 }
1168
1169 gBS->SetTimer (Private->UdpTimeOutEvent, TimerCancel, 0);
1170
1171
1172 //
1173 // Reset the UdpWrite instance.
1174 //
1175 if (Mode->UsingIpv6) {
1176 Private->Udp6Write->Configure (Private->Udp6Write, NULL);
1177 } else {
1178 Private->Udp4Write->Configure (Private->Udp4Write, NULL);
1179 }
1180
1181 return Status;
1182 }
1183
1184
1185 /**
1186 Reads a UDP packet from the network interface.
1187 +
1188 This function reads a UDP packet from a network interface. The data contents
1189 are returned in (the optional HeaderPtr and) BufferPtr, and the size of the
1190 buffer received is returned in BufferSize . If the input BufferSize is smaller
1191 than the UDP packet received (less optional HeaderSize), it will be set to the
1192 required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the
1193 contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is
1194 successfully received, then EFI_SUCCESS will be returned, and the information
1195 from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if
1196 they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,
1197 SrcIp, and SrcPort input values, different types of UDP packet receive filtering
1198 will be performed. The following tables summarize these receive filter operations.
1199
1200 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1201 @param[in] OpFlags The UDP operation flags.
1202 @param[in, out] DestIp The destination IP address.
1203 @param[in, out] DestPort The destination UDP port number.
1204 @param[in, out] SrcIp The source IP address.
1205 @param[in, out] SrcPort The source UDP port number.
1206 @param[in] HeaderSize An optional field which may be set to the length of a
1207 header at HeaderPtr to be prefixed to the data at BufferPtr.
1208 @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
1209 prefixed to the data at BufferPtr.
1210 @param[in, out] BufferSize A pointer to the size of the data at BufferPtr.
1211 @param[in] BufferPtr A pointer to the data to be read.
1212
1213 @retval EFI_SUCCESS The UDP Read operation was completed.
1214 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1215 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1216 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
1217 @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.
1218 @retval EFI_ABORTED The callback function aborted the UDP Read operation.
1219 @retval EFI_TIMEOUT The UDP Read operation timed out.
1220
1221 **/
1222 EFI_STATUS
1223 EFIAPI
1224 EfiPxeBcUdpRead (
1225 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1226 IN UINT16 OpFlags,
1227 IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,
1228 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,
1229 IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,
1230 IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,
1231 IN UINTN *HeaderSize OPTIONAL,
1232 IN VOID *HeaderPtr OPTIONAL,
1233 IN OUT UINTN *BufferSize,
1234 IN VOID *BufferPtr
1235 )
1236 {
1237 PXEBC_PRIVATE_DATA *Private;
1238 EFI_PXE_BASE_CODE_MODE *Mode;
1239 EFI_UDP4_COMPLETION_TOKEN Udp4Token;
1240 EFI_UDP6_COMPLETION_TOKEN Udp6Token;
1241 EFI_UDP4_RECEIVE_DATA *Udp4Rx;
1242 EFI_UDP6_RECEIVE_DATA *Udp6Rx;
1243 EFI_STATUS Status;
1244 BOOLEAN IsDone;
1245 BOOLEAN IsMatched;
1246 UINTN CopiedLen;
1247 UINTN HeaderLen;
1248 UINTN HeaderCopiedLen;
1249 UINTN BufferCopiedLen;
1250 UINT32 FragmentLength;
1251 UINTN FragmentIndex;
1252 UINT8 *FragmentBuffer;
1253
1254 if (This == NULL || DestIp == NULL || DestPort == NULL) {
1255 return EFI_INVALID_PARAMETER;
1256 }
1257
1258 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1259 Mode = Private->PxeBc.Mode;
1260 IsDone = FALSE;
1261 IsMatched = FALSE;
1262 Udp4Rx = NULL;
1263 Udp6Rx = NULL;
1264
1265 if (((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) != 0 && DestPort == NULL) ||
1266 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP) != 0 && SrcIp == NULL) ||
1267 ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) != 0 && SrcPort == NULL)) {
1268 return EFI_INVALID_PARAMETER;
1269 }
1270
1271 if ((HeaderSize != NULL && *HeaderSize == 0) || (HeaderSize != NULL && HeaderPtr == NULL)) {
1272 return EFI_INVALID_PARAMETER;
1273 }
1274
1275 if ((BufferSize == NULL) || (BufferPtr == NULL)) {
1276 return EFI_INVALID_PARAMETER;
1277 }
1278
1279 if (!Mode->Started) {
1280 return EFI_NOT_STARTED;
1281 }
1282
1283 ZeroMem (&Udp6Token, sizeof (EFI_UDP6_COMPLETION_TOKEN));
1284 ZeroMem (&Udp4Token, sizeof (EFI_UDP4_COMPLETION_TOKEN));
1285
1286 if (Mode->UsingIpv6) {
1287 Status = gBS->CreateEvent (
1288 EVT_NOTIFY_SIGNAL,
1289 TPL_NOTIFY,
1290 PxeBcCommonNotify,
1291 &IsDone,
1292 &Udp6Token.Event
1293 );
1294 if (EFI_ERROR (Status)) {
1295 return EFI_OUT_OF_RESOURCES;
1296 }
1297 } else {
1298 Status = gBS->CreateEvent (
1299 EVT_NOTIFY_SIGNAL,
1300 TPL_NOTIFY,
1301 PxeBcCommonNotify,
1302 &IsDone,
1303 &Udp4Token.Event
1304 );
1305 if (EFI_ERROR (Status)) {
1306 return EFI_OUT_OF_RESOURCES;
1307 }
1308 }
1309
1310 //
1311 // Start a timer as timeout event for this blocking API.
1312 //
1313 gBS->SetTimer (Private->UdpTimeOutEvent, TimerRelative, PXEBC_UDP_TIMEOUT);
1314 Mode->IcmpErrorReceived = FALSE;
1315
1316 //
1317 // Read packet by Udp4Read/Udp6Read until matched or timeout.
1318 //
1319 while (!IsMatched && !EFI_ERROR (Status)) {
1320 if (Mode->UsingIpv6) {
1321 Status = PxeBcUdp6Read (
1322 Private->Udp6Read,
1323 &Udp6Token,
1324 Mode,
1325 Private->UdpTimeOutEvent,
1326 OpFlags,
1327 &IsDone,
1328 &IsMatched,
1329 DestIp,
1330 DestPort,
1331 SrcIp,
1332 SrcPort
1333 );
1334 } else {
1335 Status = PxeBcUdp4Read (
1336 Private->Udp4Read,
1337 &Udp4Token,
1338 Mode,
1339 Private->UdpTimeOutEvent,
1340 OpFlags,
1341 &IsDone,
1342 &IsMatched,
1343 DestIp,
1344 DestPort,
1345 SrcIp,
1346 SrcPort
1347 );
1348 }
1349 }
1350
1351 if (Status == EFI_ICMP_ERROR ||
1352 Status == EFI_NETWORK_UNREACHABLE ||
1353 Status == EFI_HOST_UNREACHABLE ||
1354 Status == EFI_PROTOCOL_UNREACHABLE ||
1355 Status == EFI_PORT_UNREACHABLE) {
1356 //
1357 // Get different return status for icmp error from Udp, refers to UEFI spec.
1358 //
1359 Mode->IcmpErrorReceived = TRUE;
1360 }
1361 gBS->SetTimer (Private->UdpTimeOutEvent, TimerCancel, 0);
1362
1363 if (IsMatched) {
1364 //
1365 // Copy the rececived packet to user if matched by filter.
1366 //
1367 if (Mode->UsingIpv6) {
1368 Udp6Rx = Udp6Token.Packet.RxData;
1369 ASSERT (Udp6Rx != NULL);
1370
1371 HeaderLen = 0;
1372 if (HeaderSize != NULL) {
1373 HeaderLen = MIN (*HeaderSize, Udp6Rx->DataLength);
1374 }
1375
1376 if (Udp6Rx->DataLength - HeaderLen > *BufferSize) {
1377 Status = EFI_BUFFER_TOO_SMALL;
1378 } else {
1379 if (HeaderSize != NULL) {
1380 *HeaderSize = HeaderLen;
1381 }
1382 *BufferSize = Udp6Rx->DataLength - HeaderLen;
1383
1384 HeaderCopiedLen = 0;
1385 BufferCopiedLen = 0;
1386 for (FragmentIndex = 0; FragmentIndex < Udp6Rx->FragmentCount; FragmentIndex++) {
1387 FragmentLength = Udp6Rx->FragmentTable[FragmentIndex].FragmentLength;
1388 FragmentBuffer = Udp6Rx->FragmentTable[FragmentIndex].FragmentBuffer;
1389 if (HeaderCopiedLen + FragmentLength < HeaderLen) {
1390 //
1391 // Copy the header part of received data.
1392 //
1393 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);
1394 HeaderCopiedLen += FragmentLength;
1395 } else if (HeaderCopiedLen < HeaderLen) {
1396 //
1397 // Copy the header part of received data.
1398 //
1399 CopiedLen = HeaderLen - HeaderCopiedLen;
1400 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);
1401 HeaderCopiedLen += CopiedLen;
1402
1403 //
1404 // Copy the other part of received data.
1405 //
1406 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);
1407 BufferCopiedLen += (FragmentLength - CopiedLen);
1408 } else {
1409 //
1410 // Copy the other part of received data.
1411 //
1412 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);
1413 BufferCopiedLen += FragmentLength;
1414 }
1415 }
1416 }
1417 //
1418 // Recycle the receiving buffer after copy to user.
1419 //
1420 gBS->SignalEvent (Udp6Rx->RecycleSignal);
1421 } else {
1422 Udp4Rx = Udp4Token.Packet.RxData;
1423 ASSERT (Udp4Rx != NULL);
1424
1425 HeaderLen = 0;
1426 if (HeaderSize != NULL) {
1427 HeaderLen = MIN (*HeaderSize, Udp4Rx->DataLength);
1428 }
1429
1430 if (Udp4Rx->DataLength - HeaderLen > *BufferSize) {
1431 Status = EFI_BUFFER_TOO_SMALL;
1432 } else {
1433 if (HeaderSize != NULL) {
1434 *HeaderSize = HeaderLen;
1435 }
1436 *BufferSize = Udp4Rx->DataLength - HeaderLen;
1437
1438 HeaderCopiedLen = 0;
1439 BufferCopiedLen = 0;
1440 for (FragmentIndex = 0; FragmentIndex < Udp4Rx->FragmentCount; FragmentIndex++) {
1441 FragmentLength = Udp4Rx->FragmentTable[FragmentIndex].FragmentLength;
1442 FragmentBuffer = Udp4Rx->FragmentTable[FragmentIndex].FragmentBuffer;
1443 if (HeaderCopiedLen + FragmentLength < HeaderLen) {
1444 //
1445 // Copy the header part of received data.
1446 //
1447 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);
1448 HeaderCopiedLen += FragmentLength;
1449 } else if (HeaderCopiedLen < HeaderLen) {
1450 //
1451 // Copy the header part of received data.
1452 //
1453 CopiedLen = HeaderLen - HeaderCopiedLen;
1454 CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);
1455 HeaderCopiedLen += CopiedLen;
1456
1457 //
1458 // Copy the other part of received data.
1459 //
1460 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);
1461 BufferCopiedLen += (FragmentLength - CopiedLen);
1462 } else {
1463 //
1464 // Copy the other part of received data.
1465 //
1466 CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);
1467 BufferCopiedLen += FragmentLength;
1468 }
1469 }
1470 }
1471 //
1472 // Recycle the receiving buffer after copy to user.
1473 //
1474 gBS->SignalEvent (Udp4Rx->RecycleSignal);
1475 }
1476 }
1477
1478 if (Mode->UsingIpv6) {
1479 Private->Udp6Read->Cancel (Private->Udp6Read, &Udp6Token);
1480 gBS->CloseEvent (Udp6Token.Event);
1481 } else {
1482 Private->Udp4Read->Cancel (Private->Udp4Read, &Udp4Token);
1483 gBS->CloseEvent (Udp4Token.Event);
1484 }
1485
1486 return Status;
1487 }
1488
1489
1490 /**
1491 Updates the IP receive filters of a network device and enables software filtering.
1492
1493 The NewFilter field is used to modify the network device's current IP receive
1494 filter settings and to enable a software filter. This function updates the IpFilter
1495 field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.
1496 The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().
1497 The current hardware filter remains in effect no matter what the settings of OpFlags.
1498 This is so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those
1499 packets whose reception is enabled in hardware-physical NIC address (unicast),
1500 broadcast address, logical address or addresses (multicast), or all (promiscuous).
1501 UdpRead() does not modify the IP filter settings.
1502 Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive
1503 filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
1504 If an application or driver wishes to preserve the IP receive filter settings,
1505 it will have to preserve the IP receive filter settings before these calls, and
1506 use SetIpFilter() to restore them after the calls. If incompatible filtering is
1507 requested (for example, PROMISCUOUS with anything else), or if the device does not
1508 support a requested filter setting and it cannot be accommodated in software
1509 (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.
1510 The IPlist field is used to enable IPs other than the StationIP. They may be
1511 multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,
1512 then both the StationIP and the IPs from the IPlist will be used.
1513
1514 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1515 @param[in] NewFilter Pointer to the new set of IP receive filters.
1516
1517 @retval EFI_SUCCESS The IP receive filter settings were updated.
1518 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1519 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1520
1521 **/
1522 EFI_STATUS
1523 EFIAPI
1524 EfiPxeBcSetIpFilter (
1525 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1526 IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter
1527 )
1528 {
1529 EFI_STATUS Status;
1530 PXEBC_PRIVATE_DATA *Private;
1531 EFI_PXE_BASE_CODE_MODE *Mode;
1532 EFI_UDP4_CONFIG_DATA *Udp4Cfg;
1533 EFI_UDP6_CONFIG_DATA *Udp6Cfg;
1534 UINTN Index;
1535 BOOLEAN NeedPromiscuous;
1536 BOOLEAN AcceptPromiscuous;
1537 BOOLEAN AcceptBroadcast;
1538 BOOLEAN MultiCastUpdate;
1539
1540 if (This == NULL || NewFilter == NULL) {
1541 return EFI_INVALID_PARAMETER;
1542 }
1543
1544 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1545 Mode = Private->PxeBc.Mode;
1546 Status = EFI_SUCCESS;
1547 NeedPromiscuous = FALSE;
1548
1549 if (!Mode->Started) {
1550 return EFI_NOT_STARTED;
1551 }
1552
1553 for (Index = 0; Index < NewFilter->IpCnt; Index++) {
1554 ASSERT (Index < EFI_PXE_BASE_CODE_MAX_IPCNT);
1555 if (!Mode->UsingIpv6 &&
1556 IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter->IpList[Index].v4))) {
1557 //
1558 // IPv4 broadcast address should not be in IP filter.
1559 //
1560 return EFI_INVALID_PARAMETER;
1561 }
1562 if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0 &&
1563 (NetIp4IsUnicast (EFI_IP4 (NewFilter->IpList[Index].v4), 0) ||
1564 NetIp6IsValidUnicast (&NewFilter->IpList[Index].v6))) {
1565 //
1566 // If EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP is set and IPv4/IPv6 address
1567 // is in IpList, promiscuous mode is needed.
1568 //
1569 NeedPromiscuous = TRUE;
1570 }
1571 }
1572
1573 AcceptPromiscuous = FALSE;
1574 AcceptBroadcast = FALSE;
1575 MultiCastUpdate = FALSE;
1576
1577 if (NeedPromiscuous ||
1578 (NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0 ||
1579 (NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0) {
1580 //
1581 // Configure UDPv4/UDPv6 as promiscuous mode to receive all packets.
1582 //
1583 AcceptPromiscuous = TRUE;
1584 } else if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) {
1585 //
1586 // Configure UDPv4 to receive all broadcast packets.
1587 //
1588 AcceptBroadcast = TRUE;
1589 }
1590
1591 //
1592 // In multicast condition when Promiscuous FALSE and IpCnt no-zero.
1593 // Here check if there is any update of the multicast ip address. If yes,
1594 // we need leave the old multicast group (by Config UDP instance to NULL),
1595 // and join the new multicast group.
1596 //
1597 if (!AcceptPromiscuous) {
1598 if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) {
1599 if (Mode->IpFilter.IpCnt != NewFilter->IpCnt) {
1600 MultiCastUpdate = TRUE;
1601 } else if (CompareMem (Mode->IpFilter.IpList, NewFilter->IpList, NewFilter->IpCnt * sizeof (EFI_IP_ADDRESS)) != 0 ) {
1602 MultiCastUpdate = TRUE;
1603 }
1604 }
1605 }
1606
1607 if (!Mode->UsingIpv6) {
1608 //
1609 // Check whether we need reconfigure the UDP4 instance.
1610 //
1611 Udp4Cfg = &Private->Udp4CfgData;
1612 if ((AcceptPromiscuous != Udp4Cfg->AcceptPromiscuous) ||
1613 (AcceptBroadcast != Udp4Cfg->AcceptBroadcast) || MultiCastUpdate) {
1614 //
1615 // Clear the UDP4 instance configuration, all joined groups will be left
1616 // during the operation.
1617 //
1618 Private->Udp4Read->Configure (Private->Udp4Read, NULL);
1619
1620 //
1621 // Configure the UDP instance with the new configuration.
1622 //
1623 Udp4Cfg->AcceptPromiscuous = AcceptPromiscuous;
1624 Udp4Cfg->AcceptBroadcast = AcceptBroadcast;
1625 Status = Private->Udp4Read->Configure (Private->Udp4Read, Udp4Cfg);
1626 if (EFI_ERROR (Status)) {
1627 return Status;
1628 }
1629
1630 //
1631 // In not Promiscuous mode, need to join the new multicast group.
1632 //
1633 if (!AcceptPromiscuous) {
1634 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
1635 if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {
1636 //
1637 // Join the mutilcast group.
1638 //
1639 Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);
1640 if (EFI_ERROR (Status)) {
1641 return Status;
1642 }
1643 }
1644 }
1645 }
1646 }
1647 } else {
1648 //
1649 // Check whether we need reconfigure the UDP6 instance.
1650 //
1651 Udp6Cfg = &Private->Udp6CfgData;
1652 if ((AcceptPromiscuous != Udp6Cfg->AcceptPromiscuous) || MultiCastUpdate) {
1653 //
1654 // Clear the UDP6 instance configuration, all joined groups will be left
1655 // during the operation.
1656 //
1657 Private->Udp6Read->Configure (Private->Udp6Read, NULL);
1658
1659 //
1660 // Configure the UDP instance with the new configuration.
1661 //
1662 Udp6Cfg->AcceptPromiscuous = AcceptPromiscuous;
1663 Status = Private->Udp6Read->Configure (Private->Udp6Read, Udp6Cfg);
1664 if (EFI_ERROR (Status)) {
1665 return Status;
1666 }
1667
1668 //
1669 // In not Promiscuous mode, need to join the new multicast group.
1670 //
1671 if (!AcceptPromiscuous) {
1672 for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
1673 if (IP6_IS_MULTICAST (&NewFilter->IpList[Index].v6)) {
1674 //
1675 // Join the mutilcast group.
1676 //
1677 Status = Private->Udp6Read->Groups (Private->Udp6Read, TRUE, &NewFilter->IpList[Index].v6);
1678 if (EFI_ERROR (Status)) {
1679 return Status;
1680 }
1681 }
1682 }
1683 }
1684 }
1685 }
1686
1687 //
1688 // Save the new IP filter into mode data.
1689 //
1690 CopyMem (&Mode->IpFilter, NewFilter, sizeof (Mode->IpFilter));
1691
1692 return Status;
1693 }
1694
1695
1696 /**
1697 Uses the ARP protocol to resolve a MAC address. It is not supported for IPv6.
1698
1699 This function uses the ARP protocol to resolve a MAC address. The IP address specified
1700 by IpAddr is used to resolve a MAC address. If the ARP protocol succeeds in resolving
1701 the specified address, then the ArpCacheEntries and ArpCache fields of the mode data
1702 are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved
1703 MAC address is placed there as well. If the PXE Base Code protocol is in the
1704 stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters
1705 a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is
1706 returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
1707 then EFI_ABORTED is returned.
1708
1709 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1710 @param[in] IpAddr Pointer to the IP address that is used to resolve a MAC address.
1711 @param[in] MacAddr If not NULL, a pointer to the MAC address that was resolved with the
1712 ARP protocol.
1713
1714 @retval EFI_SUCCESS The IP or MAC address was resolved.
1715 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1716 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1717 @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
1718 @retval EFI_ICMP_ERROR An error occur with the ICMP packet message.
1719
1720 **/
1721 EFI_STATUS
1722 EFIAPI
1723 EfiPxeBcArp (
1724 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1725 IN EFI_IP_ADDRESS *IpAddr,
1726 IN EFI_MAC_ADDRESS *MacAddr OPTIONAL
1727 )
1728 {
1729 PXEBC_PRIVATE_DATA *Private;
1730 EFI_PXE_BASE_CODE_MODE *Mode;
1731 EFI_EVENT ResolvedEvent;
1732 EFI_STATUS Status;
1733 EFI_MAC_ADDRESS TempMac;
1734 EFI_MAC_ADDRESS ZeroMac;
1735 BOOLEAN IsResolved;
1736
1737 if (This == NULL || IpAddr == NULL) {
1738 return EFI_INVALID_PARAMETER;
1739 }
1740
1741 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1742 Mode = Private->PxeBc.Mode;
1743 ResolvedEvent = NULL;
1744 Status = EFI_SUCCESS;
1745 IsResolved = FALSE;
1746
1747 if (!Mode->Started) {
1748 return EFI_NOT_STARTED;
1749 }
1750
1751 if (Mode->UsingIpv6) {
1752 return EFI_UNSUPPORTED;
1753 }
1754
1755 //
1756 // Station address should be ready before do arp.
1757 //
1758 if (!Private->IsAddressOk) {
1759 return EFI_INVALID_PARAMETER;
1760 }
1761
1762 Mode->IcmpErrorReceived = FALSE;
1763 ZeroMem (&TempMac, sizeof (EFI_MAC_ADDRESS));
1764 ZeroMem (&ZeroMac, sizeof (EFI_MAC_ADDRESS));
1765
1766 if (!Mode->AutoArp) {
1767 //
1768 // If AutoArp is FALSE, only search in the current Arp cache.
1769 //
1770 PxeBcArpCacheUpdate (NULL, Private);
1771 if (!PxeBcCheckArpCache (Mode, &IpAddr->v4, &TempMac)) {
1772 Status = EFI_DEVICE_ERROR;
1773 goto ON_EXIT;
1774 }
1775 } else {
1776 Status = gBS->CreateEvent (
1777 EVT_NOTIFY_SIGNAL,
1778 TPL_NOTIFY,
1779 PxeBcCommonNotify,
1780 &IsResolved,
1781 &ResolvedEvent
1782 );
1783 if (EFI_ERROR (Status)) {
1784 goto ON_EXIT;
1785 }
1786
1787 //
1788 // If AutoArp is TRUE, try to send Arp request on initiative.
1789 //
1790 Status = Private->Arp->Request (Private->Arp, &IpAddr->v4, ResolvedEvent, &TempMac);
1791 if (EFI_ERROR (Status) && Status != EFI_NOT_READY) {
1792 goto ON_EXIT;
1793 }
1794
1795 while (!IsResolved) {
1796 if (CompareMem (&TempMac, &ZeroMac, sizeof (EFI_MAC_ADDRESS)) != 0) {
1797 break;
1798 }
1799 }
1800 if (CompareMem (&TempMac, &ZeroMac, sizeof (EFI_MAC_ADDRESS)) != 0) {
1801 Status = EFI_SUCCESS;
1802 } else {
1803 Status = EFI_TIMEOUT;
1804 }
1805 }
1806
1807 //
1808 // Copy the Mac address to user if needed.
1809 //
1810 if (MacAddr != NULL && !EFI_ERROR (Status)) {
1811 CopyMem (MacAddr, &TempMac, sizeof (EFI_MAC_ADDRESS));
1812 }
1813
1814 ON_EXIT:
1815 if (ResolvedEvent != NULL) {
1816 gBS->CloseEvent (ResolvedEvent);
1817 }
1818 return Status;
1819 }
1820
1821
1822 /**
1823 Updates the parameters that affect the operation of the PXE Base Code Protocol.
1824
1825 This function sets parameters that affect the operation of the PXE Base Code Protocol.
1826 The parameter specified by NewAutoArp is used to control the generation of ARP
1827 protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated
1828 as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP
1829 Protocol packets will be generated. In this case, the only mappings that are
1830 available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.
1831 If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol
1832 service, then the service will fail. This function updates the AutoArp field of
1833 the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.
1834 The SetParameters() call must be invoked after a Callback Protocol is installed
1835 to enable the use of callbacks.
1836
1837 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1838 @param[in] NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the
1839 current value of AutoARP.
1840 @param[in] NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the
1841 current value of SendGUID.
1842 @param[in] NewTTL If not NULL, a pointer to be used in place of the current value of TTL,
1843 the "time to live" field of the IP header.
1844 @param[in] NewToS If not NULL, a pointer to be used in place of the current value of ToS,
1845 the "type of service" field of the IP header.
1846 @param[in] NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the
1847 current value of the MakeCallback field of the Mode structure.
1848
1849 @retval EFI_SUCCESS The new parameters values were updated.
1850 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1851 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1852
1853 **/
1854 EFI_STATUS
1855 EFIAPI
1856 EfiPxeBcSetParameters (
1857 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1858 IN BOOLEAN *NewAutoArp OPTIONAL,
1859 IN BOOLEAN *NewSendGUID OPTIONAL,
1860 IN UINT8 *NewTTL OPTIONAL,
1861 IN UINT8 *NewToS OPTIONAL,
1862 IN BOOLEAN *NewMakeCallback OPTIONAL
1863 )
1864 {
1865 PXEBC_PRIVATE_DATA *Private;
1866 EFI_PXE_BASE_CODE_MODE *Mode;
1867 EFI_GUID SystemGuid;
1868 EFI_STATUS Status;
1869
1870 if (This == NULL) {
1871 return EFI_INVALID_PARAMETER;
1872 }
1873
1874 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1875 Mode = Private->PxeBc.Mode;
1876
1877 if (!Mode->Started) {
1878 return EFI_NOT_STARTED;
1879 }
1880
1881 if (NewMakeCallback != NULL) {
1882 if (*NewMakeCallback) {
1883 //
1884 // Update the previous PxeBcCallback protocol.
1885 //
1886 Status = gBS->HandleProtocol (
1887 Private->Controller,
1888 &gEfiPxeBaseCodeCallbackProtocolGuid,
1889 (VOID **) &Private->PxeBcCallback
1890 );
1891
1892 if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {
1893 return EFI_INVALID_PARAMETER;
1894 }
1895 } else {
1896 Private->PxeBcCallback = NULL;
1897 }
1898 Mode->MakeCallbacks = *NewMakeCallback;
1899 }
1900
1901 if (NewSendGUID != NULL) {
1902 if (*NewSendGUID && EFI_ERROR (NetLibGetSystemGuid (&SystemGuid))) {
1903 return EFI_INVALID_PARAMETER;
1904 }
1905 Mode->SendGUID = *NewSendGUID;
1906 }
1907
1908 if (NewAutoArp != NULL) {
1909 Mode->AutoArp = *NewAutoArp;
1910 }
1911
1912 if (NewTTL != NULL) {
1913 Mode->TTL = *NewTTL;
1914 }
1915
1916 if (NewToS != NULL) {
1917 Mode->ToS = *NewToS;
1918 }
1919
1920 return EFI_SUCCESS;
1921 }
1922
1923
1924 /**
1925 Updates the station IP address and/or subnet mask values of a network device.
1926
1927 This function updates the station IP address and/or subnet mask values of a network
1928 device. The NewStationIp field is used to modify the network device's current IP address.
1929 If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,
1930 this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure
1931 with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet
1932 mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.
1933 Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE
1934 structure with NewSubnetMask.
1935
1936 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
1937 @param[in] NewStationIp Pointer to the new IP address to be used by the network device.
1938 @param[in] NewSubnetMask Pointer to the new subnet mask to be used by the network device.
1939
1940 @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.
1941 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
1942 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
1943
1944 **/
1945 EFI_STATUS
1946 EFIAPI
1947 EfiPxeBcSetStationIP (
1948 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
1949 IN EFI_IP_ADDRESS *NewStationIp OPTIONAL,
1950 IN EFI_IP_ADDRESS *NewSubnetMask OPTIONAL
1951 )
1952 {
1953 EFI_STATUS Status;
1954 PXEBC_PRIVATE_DATA *Private;
1955 EFI_PXE_BASE_CODE_MODE *Mode;
1956 EFI_ARP_CONFIG_DATA ArpConfigData;
1957
1958 if (This == NULL) {
1959 return EFI_INVALID_PARAMETER;
1960 }
1961
1962 if (NewStationIp != NULL &&
1963 (!NetIp4IsUnicast (NTOHL (NewStationIp->Addr[0]), 0) &&
1964 !NetIp6IsValidUnicast (&NewStationIp->v6))) {
1965 return EFI_INVALID_PARAMETER;
1966 }
1967
1968 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
1969 Mode = Private->PxeBc.Mode;
1970 Status = EFI_SUCCESS;
1971
1972 if (!Mode->UsingIpv6 &&
1973 NewSubnetMask != NULL &&
1974 !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask->Addr[0]))) {
1975 return EFI_INVALID_PARAMETER;
1976 }
1977
1978 if (!Mode->Started) {
1979 return EFI_NOT_STARTED;
1980 }
1981
1982 if (Mode->UsingIpv6 && NewStationIp != NULL) {
1983 //
1984 // Set the IPv6 address by Ip6Config protocol.
1985 //
1986 Status = PxeBcRegisterIp6Address (Private, &NewStationIp->v6);
1987 if (EFI_ERROR (Status)) {
1988 goto ON_EXIT;
1989 }
1990 } else if (!Mode->UsingIpv6 && NewStationIp != NULL) {
1991 //
1992 // Configure the corresponding ARP with the IPv4 address.
1993 //
1994 ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));
1995
1996 ArpConfigData.SwAddressType = 0x0800;
1997 ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);
1998 ArpConfigData.StationAddress = &NewStationIp->v4;
1999
2000 Private->Arp->Configure (Private->Arp, NULL);
2001 Private->Arp->Configure (Private->Arp, &ArpConfigData);
2002
2003 if (NewSubnetMask != NULL) {
2004 Mode->RouteTableEntries = 1;
2005 Mode->RouteTable[0].IpAddr.Addr[0] = NewStationIp->Addr[0] & NewSubnetMask->Addr[0];
2006 Mode->RouteTable[0].SubnetMask.Addr[0] = NewSubnetMask->Addr[0];
2007 Mode->RouteTable[0].GwAddr.Addr[0] = 0;
2008 }
2009
2010 Private->IsAddressOk = TRUE;
2011 }
2012
2013 if (NewStationIp != NULL) {
2014 CopyMem (&Mode->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));
2015 CopyMem (&Private->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));
2016 }
2017
2018 if (!Mode->UsingIpv6 && NewSubnetMask != NULL) {
2019 CopyMem (&Mode->SubnetMask, NewSubnetMask, sizeof (EFI_IP_ADDRESS));
2020 CopyMem (&Private->SubnetMask ,NewSubnetMask, sizeof (EFI_IP_ADDRESS));
2021 }
2022
2023 Status = PxeBcFlushStaionIp (Private, NewStationIp, NewSubnetMask);
2024 ON_EXIT:
2025 return Status;
2026 }
2027
2028
2029 /**
2030 Updates the contents of the cached DHCP and Discover packets.
2031
2032 The pointers to the new packets are used to update the contents of the cached
2033 packets in the EFI_PXE_BASE_CODE_MODE structure.
2034
2035 @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
2036 @param[in] NewDhcpDiscoverValid Pointer to a value that will replace the current
2037 DhcpDiscoverValid field.
2038 @param[in] NewDhcpAckReceived Pointer to a value that will replace the current
2039 DhcpAckReceived field.
2040 @param[in] NewProxyOfferReceived Pointer to a value that will replace the current
2041 ProxyOfferReceived field.
2042 @param[in] NewPxeDiscoverValid Pointer to a value that will replace the current
2043 ProxyOfferReceived field.
2044 @param[in] NewPxeReplyReceived Pointer to a value that will replace the current
2045 PxeReplyReceived field.
2046 @param[in] NewPxeBisReplyReceived Pointer to a value that will replace the current
2047 PxeBisReplyReceived field.
2048 @param[in] NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.
2049 @param[in] NewDhcpAck Pointer to the new cached DHCP Ack packet contents.
2050 @param[in] NewProxyOffer Pointer to the new cached Proxy Offer packet contents.
2051 @param[in] NewPxeDiscover Pointer to the new cached PXE Discover packet contents.
2052 @param[in] NewPxeReply Pointer to the new cached PXE Reply packet contents.
2053 @param[in] NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.
2054
2055 @retval EFI_SUCCESS The cached packet contents were updated.
2056 @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
2057 @retval EFI_INVALID_PARAMETER This is NULL or does not point to a valid
2058 EFI_PXE_BASE_CODE_PROTOCOL structure.
2059
2060 **/
2061 EFI_STATUS
2062 EFIAPI
2063 EfiPxeBcSetPackets (
2064 IN EFI_PXE_BASE_CODE_PROTOCOL *This,
2065 IN BOOLEAN *NewDhcpDiscoverValid OPTIONAL,
2066 IN BOOLEAN *NewDhcpAckReceived OPTIONAL,
2067 IN BOOLEAN *NewProxyOfferReceived OPTIONAL,
2068 IN BOOLEAN *NewPxeDiscoverValid OPTIONAL,
2069 IN BOOLEAN *NewPxeReplyReceived OPTIONAL,
2070 IN BOOLEAN *NewPxeBisReplyReceived OPTIONAL,
2071 IN EFI_PXE_BASE_CODE_PACKET *NewDhcpDiscover OPTIONAL,
2072 IN EFI_PXE_BASE_CODE_PACKET *NewDhcpAck OPTIONAL,
2073 IN EFI_PXE_BASE_CODE_PACKET *NewProxyOffer OPTIONAL,
2074 IN EFI_PXE_BASE_CODE_PACKET *NewPxeDiscover OPTIONAL,
2075 IN EFI_PXE_BASE_CODE_PACKET *NewPxeReply OPTIONAL,
2076 IN EFI_PXE_BASE_CODE_PACKET *NewPxeBisReply OPTIONAL
2077 )
2078 {
2079 PXEBC_PRIVATE_DATA *Private;
2080 EFI_PXE_BASE_CODE_MODE *Mode;
2081
2082 if (This == NULL) {
2083 return EFI_INVALID_PARAMETER;
2084 }
2085
2086 Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);
2087 Mode = Private->PxeBc.Mode;
2088
2089 if (!Mode->Started) {
2090 return EFI_NOT_STARTED;
2091 }
2092
2093 if (NewDhcpDiscoverValid != NULL) {
2094 Mode->DhcpDiscoverValid = *NewDhcpDiscoverValid;
2095 }
2096
2097 if (NewDhcpAckReceived != NULL) {
2098 Mode->DhcpAckReceived = *NewDhcpAckReceived;
2099 }
2100
2101 if (NewProxyOfferReceived != NULL) {
2102 Mode->ProxyOfferReceived = *NewProxyOfferReceived;
2103 }
2104
2105 if (NewPxeDiscoverValid != NULL) {
2106 Mode->PxeDiscoverValid = *NewPxeDiscoverValid;
2107 }
2108
2109 if (NewPxeReplyReceived != NULL) {
2110 Mode->PxeReplyReceived = *NewPxeReplyReceived;
2111 }
2112
2113 if (NewPxeBisReplyReceived != NULL) {
2114 Mode->PxeBisReplyReceived = *NewPxeBisReplyReceived;
2115 }
2116
2117 if (NewDhcpDiscover != NULL) {
2118 CopyMem (&Mode->DhcpDiscover, NewDhcpDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));
2119 }
2120
2121 if (NewDhcpAck != NULL) {
2122 CopyMem (&Mode->DhcpAck, NewDhcpAck, sizeof (EFI_PXE_BASE_CODE_PACKET));
2123 }
2124
2125 if (NewProxyOffer != NULL) {
2126 CopyMem (&Mode->ProxyOffer, NewProxyOffer, sizeof (EFI_PXE_BASE_CODE_PACKET));
2127 }
2128
2129 if (NewPxeDiscover != NULL) {
2130 CopyMem (&Mode->PxeDiscover, NewPxeDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));
2131 }
2132
2133 if (NewPxeReply != NULL) {
2134 CopyMem (&Mode->PxeReply, NewPxeReply, sizeof (EFI_PXE_BASE_CODE_PACKET));
2135 }
2136
2137 if (NewPxeBisReply != NULL) {
2138 CopyMem (&Mode->PxeBisReply, NewPxeBisReply, sizeof (EFI_PXE_BASE_CODE_PACKET));
2139 }
2140
2141 return EFI_SUCCESS;
2142 }
2143
2144 EFI_PXE_BASE_CODE_PROTOCOL gPxeBcProtocolTemplate = {
2145 EFI_PXE_BASE_CODE_PROTOCOL_REVISION,
2146 EfiPxeBcStart,
2147 EfiPxeBcStop,
2148 EfiPxeBcDhcp,
2149 EfiPxeBcDiscover,
2150 EfiPxeBcMtftp,
2151 EfiPxeBcUdpWrite,
2152 EfiPxeBcUdpRead,
2153 EfiPxeBcSetIpFilter,
2154 EfiPxeBcArp,
2155 EfiPxeBcSetParameters,
2156 EfiPxeBcSetStationIP,
2157 EfiPxeBcSetPackets,
2158 NULL
2159 };
2160
2161
2162 /**
2163 Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has
2164 received, or is waiting to receive a packet.
2165
2166 This function is invoked when the PXE Base Code Protocol is about to transmit, has received,
2167 or is waiting to receive a packet. Parameters Function and Received specify the type of event.
2168 Parameters PacketLen and Packet specify the packet that generated the event. If these fields
2169 are zero and NULL respectively, then this is a status update callback. If the operation specified
2170 by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation
2171 specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to
2172 the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.
2173 The SetParameters() function must be called after a Callback Protocol is installed to enable the
2174 use of callbacks.
2175
2176 @param[in] This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
2177 @param[in] Function The PXE Base Code Protocol function that is waiting for an event.
2178 @param[in] Received TRUE if the callback is being invoked due to a receive event. FALSE if
2179 the callback is being invoked due to a transmit event.
2180 @param[in] PacketLength The length, in bytes, of Packet. This field will have a value of zero if
2181 this is a wait for receive event.
2182 @param[in] PacketPtr If Received is TRUE, a pointer to the packet that was just received;
2183 otherwise a pointer to the packet that is about to be transmitted.
2184
2185 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE If Function specifies a continue operation.
2186 @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT If Function specifies an abort operation.
2187
2188 **/
2189 EFI_PXE_BASE_CODE_CALLBACK_STATUS
2190 EFIAPI
2191 EfiPxeLoadFileCallback (
2192 IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL *This,
2193 IN EFI_PXE_BASE_CODE_FUNCTION Function,
2194 IN BOOLEAN Received,
2195 IN UINT32 PacketLength,
2196 IN EFI_PXE_BASE_CODE_PACKET *PacketPtr OPTIONAL
2197 )
2198 {
2199 EFI_INPUT_KEY Key;
2200 EFI_STATUS Status;
2201
2202 //
2203 // Catch Ctrl-C or ESC to abort.
2204 //
2205 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
2206
2207 if (!EFI_ERROR (Status)) {
2208
2209 if (Key.ScanCode == SCAN_ESC || Key.UnicodeChar == (0x1F & 'c')) {
2210
2211 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT;
2212 }
2213 }
2214 //
2215 // No print if receive packet
2216 //
2217 if (Received) {
2218 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
2219 }
2220 //
2221 // Print only for three functions
2222 //
2223 switch (Function) {
2224
2225 case EFI_PXE_BASE_CODE_FUNCTION_MTFTP:
2226 //
2227 // Print only for open MTFTP packets, not every MTFTP packets
2228 //
2229 if (PacketLength != 0 && PacketPtr != NULL) {
2230 if (PacketPtr->Raw[0x1C] != 0x00 || PacketPtr->Raw[0x1D] != 0x01) {
2231 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
2232 }
2233 }
2234 break;
2235
2236 case EFI_PXE_BASE_CODE_FUNCTION_DHCP:
2237 case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER:
2238 break;
2239
2240 default:
2241 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
2242 }
2243
2244 if (PacketLength != 0 && PacketPtr != NULL) {
2245 //
2246 // Print '.' when transmit a packet
2247 //
2248 AsciiPrint (".");
2249 }
2250
2251 return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;
2252 }
2253
2254 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL gPxeBcCallBackTemplate = {
2255 EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION,
2256 EfiPxeLoadFileCallback
2257 };
2258
2259
2260 /**
2261 Causes the driver to load a specified file.
2262
2263 @param[in] This Protocol instance pointer.
2264 @param[in] FilePath The device specific path of the file to load.
2265 @param[in] BootPolicy If TRUE, indicates that the request originates from the
2266 boot manager is attempting to load FilePath as a boot
2267 selection. If FALSE, then FilePath must match an exact file
2268 to be loaded.
2269 @param[in, out] BufferSize On input the size of Buffer in bytes. On output with a return
2270 code of EFI_SUCCESS, the amount of data transferred to
2271 Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
2272 the size of Buffer required to retrieve the requested file.
2273 @param[in] Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
2274 then no the size of the requested file is returned in
2275 BufferSize.
2276
2277 @retval EFI_SUCCESS The file was loaded.
2278 @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy.
2279 @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
2280 BufferSize is NULL.
2281 @retval EFI_NO_MEDIA No medium was present to load the file.
2282 @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.
2283 @retval EFI_NO_RESPONSE The remote system did not respond.
2284 @retval EFI_NOT_FOUND The file was not found.
2285 @retval EFI_ABORTED The file load process was manually cancelled.
2286
2287 **/
2288 EFI_STATUS
2289 EFIAPI
2290 EfiPxeLoadFile (
2291 IN EFI_LOAD_FILE_PROTOCOL *This,
2292 IN EFI_DEVICE_PATH_PROTOCOL *FilePath,
2293 IN BOOLEAN BootPolicy,
2294 IN OUT UINTN *BufferSize,
2295 IN VOID *Buffer OPTIONAL
2296 )
2297 {
2298 PXEBC_PRIVATE_DATA *Private;
2299 PXEBC_VIRTUAL_NIC *VirtualNic;
2300 EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;
2301 BOOLEAN UsingIpv6;
2302 EFI_STATUS Status;
2303 BOOLEAN MediaPresent;
2304
2305 VirtualNic = PXEBC_VIRTUAL_NIC_FROM_LOADFILE (This);
2306 Private = VirtualNic->Private;
2307 PxeBc = &Private->PxeBc;
2308 UsingIpv6 = FALSE;
2309 Status = EFI_DEVICE_ERROR;
2310
2311 if (This == NULL || BufferSize == NULL) {
2312 return EFI_INVALID_PARAMETER;
2313 }
2314
2315 //
2316 // Only support BootPolicy
2317 //
2318 if (!BootPolicy) {
2319 return EFI_UNSUPPORTED;
2320 }
2321
2322 //
2323 // Check media status before PXE start
2324 //
2325 MediaPresent = TRUE;
2326 NetLibDetectMedia (Private->Controller, &MediaPresent);
2327 if (!MediaPresent) {
2328 return EFI_NO_MEDIA;
2329 }
2330
2331 //
2332 // Check whether the virtual nic is using IPv6 or not.
2333 //
2334 if (VirtualNic == Private->Ip6Nic) {
2335 UsingIpv6 = TRUE;
2336 }
2337
2338 //
2339 // Start Pxe Base Code to initialize PXE boot.
2340 //
2341 Status = PxeBc->Start (PxeBc, UsingIpv6);
2342 if (Status == EFI_ALREADY_STARTED && UsingIpv6 != PxeBc->Mode->UsingIpv6) {
2343 //
2344 // PxeBc protocol has already been started but not on the required IP version, restart it.
2345 //
2346 Status = PxeBc->Stop (PxeBc);
2347 if (!EFI_ERROR (Status)) {
2348 Status = PxeBc->Start (PxeBc, UsingIpv6);
2349 }
2350 }
2351 if (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED) {
2352 Status = PxeBcLoadBootFile (Private, BufferSize, Buffer);
2353 }
2354
2355 if (Status != EFI_SUCCESS &&
2356 Status != EFI_UNSUPPORTED &&
2357 Status != EFI_BUFFER_TOO_SMALL) {
2358 //
2359 // There are three cases, which needn't stop pxebc here.
2360 // 1. success to download file.
2361 // 2. success to get file size.
2362 // 3. unsupported.
2363 //
2364 PxeBc->Stop (PxeBc);
2365 }
2366
2367 return Status;
2368 }
2369
2370 EFI_LOAD_FILE_PROTOCOL gLoadFileProtocolTemplate = { EfiPxeLoadFile };
2371
EFI Development Kit II mirror for PVE