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