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