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