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