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