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