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