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