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