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