]>
Commit | Line | Data |
---|---|---|
dc361cc5 | 1 | /** @file\r |
f737cfb9 | 2 | Interface routines for PxeBc.\r |
e2851998 | 3 | \r |
e5eed7d3 HT |
4 | Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r |
5 | This program and the accompanying materials\r | |
dc361cc5 | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
dc361cc5 | 13 | **/\r |
14 | \r | |
15 | \r | |
16 | #include "PxeBcImpl.h"\r | |
17 | \r | |
434ce3fe | 18 | UINT32 mPxeDhcpTimeout[4] = { 4, 8, 16, 32 };\r |
f737cfb9 | 19 | \r |
982a9eae | 20 | /**\r |
f737cfb9 | 21 | Get and record the arp cache.\r |
982a9eae | 22 | \r |
23 | @param This Pointer to EFI_PXE_BC_PROTOCOL\r | |
24 | \r | |
25 | @retval EFI_SUCCESS Arp cache updated successfully\r | |
f737cfb9 | 26 | @retval others If error occurs when getting arp cache\r |
982a9eae | 27 | \r |
28 | **/\r | |
982a9eae | 29 | EFI_STATUS\r |
30 | UpdateArpCache (\r | |
31 | IN EFI_PXE_BASE_CODE_PROTOCOL * This\r | |
32 | )\r | |
33 | {\r | |
34 | PXEBC_PRIVATE_DATA *Private;\r | |
35 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
36 | EFI_STATUS Status;\r | |
37 | UINT32 EntryLength;\r | |
38 | UINT32 EntryCount;\r | |
39 | EFI_ARP_FIND_DATA *Entries;\r | |
40 | UINT32 Index;\r | |
41 | \r | |
42 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
43 | Mode = Private->PxeBc.Mode;\r | |
44 | \r | |
f737cfb9 | 45 | Status = Private->Arp->Find (\r |
46 | Private->Arp,\r | |
47 | TRUE,\r | |
48 | NULL,\r | |
49 | &EntryLength,\r | |
50 | &EntryCount,\r | |
51 | &Entries,\r | |
52 | TRUE\r | |
53 | );\r | |
982a9eae | 54 | if (EFI_ERROR (Status)) {\r |
55 | return Status;\r | |
56 | }\r | |
57 | \r | |
f737cfb9 | 58 | Mode->ArpCacheEntries = MIN (\r |
59 | EntryCount,\r | |
60 | EFI_PXE_BASE_CODE_MAX_ARP_ENTRIES\r | |
61 | );\r | |
982a9eae | 62 | for (Index = 0; Index < Mode->ArpCacheEntries; Index ++) {\r |
f737cfb9 | 63 | CopyMem (\r |
e2851998 | 64 | &Mode->ArpCache[Index].IpAddr,\r |
65 | Entries + 1,\r | |
f737cfb9 | 66 | Entries->SwAddressLength\r |
67 | );\r | |
68 | CopyMem (\r | |
69 | &Mode->ArpCache[Index].MacAddr,\r | |
70 | (UINT8 *) (Entries + 1) + Entries->SwAddressLength,\r | |
71 | Entries->HwAddressLength\r | |
72 | );\r | |
982a9eae | 73 | //\r |
74 | // Slip to the next FindData.\r | |
75 | //\r | |
f737cfb9 | 76 | Entries = (EFI_ARP_FIND_DATA *) ((UINT8 *) Entries + EntryLength);\r |
982a9eae | 77 | }\r |
78 | \r | |
79 | return EFI_SUCCESS;\r | |
80 | }\r | |
81 | \r | |
82 | /**\r | |
f737cfb9 | 83 | Timeout routine to update arp cache.\r |
982a9eae | 84 | \r |
85 | @param Event Pointer to EFI_PXE_BC_PROTOCOL\r | |
86 | @param Context Context of the timer event\r | |
87 | \r | |
88 | **/\r | |
982a9eae | 89 | VOID\r |
90 | EFIAPI\r | |
91 | ArpCacheUpdateTimeout (\r | |
92 | IN EFI_EVENT Event,\r | |
93 | IN VOID *Context\r | |
94 | )\r | |
95 | {\r | |
96 | UpdateArpCache ((EFI_PXE_BASE_CODE_PROTOCOL *) Context);\r | |
97 | }\r | |
98 | \r | |
99 | /**\r | |
f737cfb9 | 100 | Do arp resolution from arp cache in PxeBcMode.\r |
e2851998 | 101 | \r |
f737cfb9 | 102 | @param PxeBcMode The PXE BC mode to look into.\r |
103 | @param Ip4Addr The Ip4 address for resolution.\r | |
104 | @param MacAddress The resoluted MAC address if the resolution is successful.\r | |
105 | The value is undefined if resolution fails.\r | |
e2851998 | 106 | \r |
f737cfb9 | 107 | @retval TRUE The resolution is successful.\r |
108 | @retval FALSE Otherwise.\r | |
982a9eae | 109 | \r |
110 | **/\r | |
982a9eae | 111 | BOOLEAN\r |
112 | FindInArpCache (\r | |
f737cfb9 | 113 | IN EFI_PXE_BASE_CODE_MODE *PxeBcMode,\r |
114 | IN EFI_IPv4_ADDRESS *Ip4Addr,\r | |
115 | OUT EFI_MAC_ADDRESS *MacAddress\r | |
982a9eae | 116 | )\r |
117 | {\r | |
118 | UINT32 Index;\r | |
119 | \r | |
120 | for (Index = 0; Index < PxeBcMode->ArpCacheEntries; Index ++) {\r | |
121 | if (EFI_IP4_EQUAL (&PxeBcMode->ArpCache[Index].IpAddr.v4, Ip4Addr)) {\r | |
f737cfb9 | 122 | CopyMem (\r |
123 | MacAddress,\r | |
124 | &PxeBcMode->ArpCache[Index].MacAddr,\r | |
125 | sizeof (EFI_MAC_ADDRESS)\r | |
126 | );\r | |
982a9eae | 127 | return TRUE;\r |
128 | }\r | |
129 | }\r | |
130 | \r | |
131 | return FALSE;\r | |
132 | }\r | |
133 | \r | |
134 | /**\r | |
135 | Notify function for the ICMP receive token, used to process\r | |
136 | the received ICMP packets.\r | |
137 | \r | |
f737cfb9 | 138 | @param Context The PXEBC private data.\r |
982a9eae | 139 | \r |
982a9eae | 140 | **/\r |
982a9eae | 141 | VOID\r |
142 | EFIAPI\r | |
143 | IcmpErrorListenHandlerDpc (\r | |
144 | IN VOID *Context\r | |
145 | )\r | |
146 | {\r | |
147 | EFI_STATUS Status;\r | |
148 | EFI_IP4_RECEIVE_DATA *RxData;\r | |
149 | EFI_IP4_PROTOCOL *Ip4;\r | |
150 | PXEBC_PRIVATE_DATA *Private;\r | |
151 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
152 | UINTN Index;\r | |
153 | UINT32 CopiedLen;\r | |
154 | UINT8 *CopiedPointer;\r | |
155 | \r | |
156 | Private = (PXEBC_PRIVATE_DATA *) Context;\r | |
157 | Mode = &Private->Mode;\r | |
158 | Status = Private->IcmpErrorRcvToken.Status;\r | |
159 | RxData = Private->IcmpErrorRcvToken.Packet.RxData;\r | |
160 | Ip4 = Private->Ip4;\r | |
161 | \r | |
f737cfb9 | 162 | if (Status == EFI_ABORTED) {\r |
982a9eae | 163 | //\r |
164 | // The reception is actively aborted by the consumer, directly return.\r | |
165 | //\r | |
166 | return;\r | |
167 | }\r | |
168 | \r | |
f737cfb9 | 169 | if (EFI_ERROR (Status) || (RxData == NULL)) {\r |
982a9eae | 170 | //\r |
171 | // Only process the normal packets and the icmp error packets, if RxData is NULL\r | |
172 | // with Status == EFI_SUCCESS or EFI_ICMP_ERROR, just resume the receive although\r | |
173 | // this should be a bug of the low layer (IP).\r | |
174 | //\r | |
175 | goto Resume;\r | |
176 | }\r | |
177 | \r | |
f737cfb9 | 178 | if (EFI_IP4 (RxData->Header->SourceAddress) != 0 &&\r |
f6b7393c | 179 | !NetIp4IsUnicast (EFI_NTOHL (RxData->Header->SourceAddress), 0)) {\r |
982a9eae | 180 | //\r |
181 | // The source address is not zero and it's not a unicast IP address, discard it.\r | |
182 | //\r | |
183 | goto CleanUp;\r | |
184 | }\r | |
185 | \r | |
186 | if (!EFI_IP4_EQUAL (&RxData->Header->DestinationAddress, &Mode->StationIp.v4)) {\r | |
187 | //\r | |
188 | // The dest address is not equal to Station Ip address, discard it.\r | |
189 | //\r | |
190 | goto CleanUp;\r | |
191 | }\r | |
192 | \r | |
193 | //\r | |
194 | // Constructor ICMP error packet\r | |
195 | //\r | |
196 | CopiedLen = 0;\r | |
197 | CopiedPointer = (UINT8 *) &Mode->IcmpError;\r | |
198 | \r | |
199 | for (Index = 0; Index < RxData->FragmentCount; Index ++) {\r | |
200 | CopiedLen += RxData->FragmentTable[Index].FragmentLength;\r | |
201 | if (CopiedLen <= sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR)) {\r | |
f737cfb9 | 202 | CopyMem (\r |
203 | CopiedPointer,\r | |
204 | RxData->FragmentTable[Index].FragmentBuffer,\r | |
205 | RxData->FragmentTable[Index].FragmentLength\r | |
206 | );\r | |
982a9eae | 207 | } else {\r |
f737cfb9 | 208 | CopyMem (\r |
209 | CopiedPointer,\r | |
210 | RxData->FragmentTable[Index].FragmentBuffer,\r | |
211 | CopiedLen - sizeof (EFI_PXE_BASE_CODE_ICMP_ERROR)\r | |
212 | );\r | |
982a9eae | 213 | }\r |
214 | CopiedPointer += CopiedLen;\r | |
215 | }\r | |
216 | \r | |
217 | goto Resume;\r | |
218 | \r | |
219 | CleanUp:\r | |
220 | gBS->SignalEvent (RxData->RecycleSignal);\r | |
221 | \r | |
222 | Resume:\r | |
223 | Ip4->Receive (Ip4, &(Private->IcmpErrorRcvToken));\r | |
224 | }\r | |
225 | \r | |
226 | /**\r | |
227 | Request IcmpErrorListenHandlerDpc as a DPC at TPL_CALLBACK\r | |
228 | \r | |
229 | @param Event The event signaled.\r | |
230 | @param Context The context passed in by the event notifier.\r | |
231 | \r | |
982a9eae | 232 | **/\r |
982a9eae | 233 | VOID\r |
234 | EFIAPI\r | |
235 | IcmpErrorListenHandler (\r | |
236 | IN EFI_EVENT Event,\r | |
237 | IN VOID *Context\r | |
238 | )\r | |
239 | {\r | |
240 | //\r | |
241 | // Request IpIoListenHandlerDpc as a DPC at TPL_CALLBACK\r | |
242 | //\r | |
d8d26fb2 | 243 | QueueDpc (TPL_CALLBACK, IcmpErrorListenHandlerDpc, Context);\r |
982a9eae | 244 | }\r |
dc361cc5 | 245 | \r |
e2851998 | 246 | /**\r |
f737cfb9 | 247 | Enables the use of the PXE Base Code Protocol functions.\r |
248 | \r | |
249 | This function enables the use of the PXE Base Code Protocol functions. If the\r | |
250 | Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then\r | |
251 | EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted\r | |
252 | addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted\r | |
253 | addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported\r | |
254 | field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will\r | |
255 | be returned. If there is not enough memory or other resources to start the PXE\r | |
256 | Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the\r | |
257 | PXE Base Code Protocol will be started, and all of the fields of the EFI_PXE_BASE_CODE_MODE\r | |
258 | structure will be initialized as follows:\r | |
259 | StartedSet to TRUE.\r | |
260 | Ipv6SupportedUnchanged.\r | |
261 | Ipv6AvailableUnchanged.\r | |
262 | UsingIpv6Set to UseIpv6.\r | |
263 | BisSupportedUnchanged.\r | |
264 | BisDetectedUnchanged.\r | |
265 | AutoArpSet to TRUE.\r | |
266 | SendGUIDSet to FALSE.\r | |
267 | TTLSet to DEFAULT_TTL.\r | |
268 | ToSSet to DEFAULT_ToS.\r | |
269 | DhcpCompletedSet to FALSE.\r | |
270 | ProxyOfferReceivedSet to FALSE.\r | |
271 | StationIpSet to an address of all zeros.\r | |
272 | SubnetMaskSet to a subnet mask of all zeros.\r | |
273 | DhcpDiscoverZero-filled.\r | |
274 | DhcpAckZero-filled.\r | |
275 | ProxyOfferZero-filled.\r | |
276 | PxeDiscoverValidSet to FALSE.\r | |
277 | PxeDiscoverZero-filled.\r | |
278 | PxeReplyValidSet to FALSE.\r | |
279 | PxeReplyZero-filled.\r | |
280 | PxeBisReplyValidSet to FALSE.\r | |
281 | PxeBisReplyZero-filled.\r | |
282 | IpFilterSet the Filters field to 0 and the IpCnt field to 0.\r | |
283 | ArpCacheEntriesSet to 0.\r | |
284 | ArpCacheZero-filled.\r | |
285 | RouteTableEntriesSet to 0.\r | |
286 | RouteTableZero-filled.\r | |
287 | IcmpErrorReceivedSet to FALSE.\r | |
288 | IcmpErrorZero-filled.\r | |
289 | TftpErroReceivedSet to FALSE.\r | |
290 | TftpErrorZero-filled.\r | |
291 | MakeCallbacksSet to TRUE if the PXE Base Code Callback Protocol is available.\r | |
292 | Set to FALSE if the PXE Base Code Callback Protocol is not available.\r | |
e2851998 | 293 | \r |
f737cfb9 | 294 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
295 | @param UseIpv6 Specifies the type of IP addresses that are to be used during the session\r | |
e2851998 | 296 | that is being started. Set to TRUE for IPv6 addresses, and FALSE for\r |
297 | IPv4 addresses.\r | |
298 | \r | |
f737cfb9 | 299 | @retval EFI_SUCCESS The PXE Base Code Protocol was started.\r |
e2851998 | 300 | @retval EFI_DEVICE_ERROR The network device encountered an error during this oper\r |
f737cfb9 | 301 | @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the\r |
e2851998 | 302 | EFI_PXE_BASE_CODE_MODE structure is FALSE.\r |
303 | @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.\r | |
f737cfb9 | 304 | @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r |
e2851998 | 305 | EFI_PXE_BASE_CODE_PROTOCOL structure.\r |
306 | @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the\r | |
307 | PXE Base Code Protocol.\r | |
308 | \r | |
dc361cc5 | 309 | **/\r |
310 | EFI_STATUS\r | |
311 | EFIAPI\r | |
312 | EfiPxeBcStart (\r | |
313 | IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r | |
314 | IN BOOLEAN UseIpv6\r | |
315 | )\r | |
316 | {\r | |
317 | PXEBC_PRIVATE_DATA *Private;\r | |
318 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
319 | EFI_STATUS Status;\r | |
320 | \r | |
321 | if (This == NULL) {\r | |
322 | return EFI_INVALID_PARAMETER;\r | |
323 | }\r | |
324 | \r | |
325 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
326 | Mode = Private->PxeBc.Mode;\r | |
327 | \r | |
328 | if (Mode->Started) {\r | |
329 | return EFI_ALREADY_STARTED;\r | |
330 | }\r | |
331 | \r | |
332 | if (UseIpv6) {\r | |
333 | //\r | |
334 | // IPv6 is not supported now.\r | |
335 | //\r | |
336 | return EFI_UNSUPPORTED;\r | |
337 | }\r | |
338 | \r | |
339 | //\r | |
340 | // Configure the udp4 instance to let it receive data\r | |
341 | //\r | |
f737cfb9 | 342 | Status = Private->Udp4Read->Configure (\r |
e2851998 | 343 | Private->Udp4Read,\r |
f737cfb9 | 344 | &Private->Udp4CfgData\r |
345 | );\r | |
dc361cc5 | 346 | if (EFI_ERROR (Status)) {\r |
347 | return Status;\r | |
348 | }\r | |
349 | \r | |
cfbc1a75 | 350 | \r |
351 | //\r | |
352 | // Configure block size for TFTP as a default value to handle all link layers.\r | |
353 | // \r | |
354 | Private->BlockSize = (UINTN) (MIN (Private->Ip4MaxPacketSize, PXEBC_DEFAULT_PACKET_SIZE) - \r | |
355 | PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE);\r | |
356 | //\r | |
357 | // If PcdTftpBlockSize is set to non-zero, override the default value.\r | |
358 | //\r | |
359 | if (PcdGet64 (PcdTftpBlockSize) != 0) {\r | |
360 | Private->BlockSize = (UINTN) PcdGet64 (PcdTftpBlockSize);\r | |
361 | }\r | |
362 | \r | |
dc361cc5 | 363 | Private->AddressIsOk = FALSE;\r |
364 | \r | |
365 | ZeroMem (Mode, sizeof (EFI_PXE_BASE_CODE_MODE));\r | |
366 | \r | |
367 | Mode->Started = TRUE;\r | |
368 | Mode->TTL = DEFAULT_TTL;\r | |
369 | Mode->ToS = DEFAULT_ToS;\r | |
370 | Mode->AutoArp = TRUE;\r | |
371 | \r | |
982a9eae | 372 | //\r |
373 | // Create the event for Arp Cache checking.\r | |
374 | //\r | |
375 | Status = gBS->CreateEvent (\r | |
376 | EVT_TIMER | EVT_NOTIFY_SIGNAL,\r | |
377 | TPL_CALLBACK,\r | |
378 | ArpCacheUpdateTimeout,\r | |
379 | This,\r | |
380 | &Private->GetArpCacheEvent\r | |
381 | );\r | |
382 | if (EFI_ERROR (Status)) {\r | |
383 | goto ON_EXIT;\r | |
384 | }\r | |
385 | \r | |
386 | //\r | |
387 | // Start the timeout timer event.\r | |
388 | //\r | |
389 | Status = gBS->SetTimer (\r | |
390 | Private->GetArpCacheEvent,\r | |
391 | TimerPeriodic,\r | |
392 | TICKS_PER_SECOND\r | |
393 | );\r | |
394 | \r | |
395 | if (EFI_ERROR (Status)) {\r | |
396 | goto ON_EXIT;\r | |
397 | }\r | |
398 | \r | |
399 | //\r | |
400 | // Create ICMP error receiving event\r | |
401 | //\r | |
402 | Status = gBS->CreateEvent (\r | |
403 | EVT_NOTIFY_SIGNAL,\r | |
404 | TPL_NOTIFY,\r | |
405 | IcmpErrorListenHandler,\r | |
406 | Private,\r | |
407 | &(Private->IcmpErrorRcvToken.Event)\r | |
408 | );\r | |
409 | if (EFI_ERROR (Status)) {\r | |
410 | goto ON_EXIT;\r | |
411 | }\r | |
412 | \r | |
413 | Status = Private->Ip4->Configure (Private->Ip4, &Private->Ip4ConfigData);\r | |
414 | if (EFI_ERROR (Status)) {\r | |
415 | goto ON_EXIT;\r | |
416 | }\r | |
417 | \r | |
418 | //\r | |
419 | // start to listen incoming packet\r | |
420 | //\r | |
421 | Status = Private->Ip4->Receive (Private->Ip4, &Private->IcmpErrorRcvToken);\r | |
422 | if (!EFI_ERROR (Status)) {\r | |
423 | return Status;\r | |
424 | }\r | |
425 | \r | |
426 | ON_EXIT:\r | |
427 | Private->Ip4->Configure (Private->Ip4, NULL);\r | |
428 | \r | |
429 | if (Private->IcmpErrorRcvToken.Event != NULL) {\r | |
430 | gBS->CloseEvent (Private->IcmpErrorRcvToken.Event);\r | |
431 | }\r | |
432 | \r | |
433 | if (Private->GetArpCacheEvent != NULL) {\r | |
434 | gBS->SetTimer (Private->GetArpCacheEvent, TimerCancel, 0);\r | |
435 | gBS->CloseEvent (Private->GetArpCacheEvent);\r | |
436 | }\r | |
437 | \r | |
438 | Mode->Started = FALSE;\r | |
439 | Mode->TTL = 0;\r | |
440 | Mode->ToS = 0;\r | |
441 | Mode->AutoArp = FALSE;\r | |
442 | \r | |
443 | return Status;\r | |
dc361cc5 | 444 | }\r |
445 | \r | |
446 | \r | |
e2851998 | 447 | /**\r |
f737cfb9 | 448 | Disables the use of the PXE Base Code Protocol functions.\r |
449 | \r | |
450 | This function stops all activity on the network device. All the resources allocated\r | |
451 | in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is\r | |
452 | set to FALSE and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE\r | |
453 | structure is already FALSE, then EFI_NOT_STARTED will be returned.\r | |
e2851998 | 454 | \r |
f737cfb9 | 455 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
e2851998 | 456 | \r |
f737cfb9 | 457 | @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.\r |
e2851998 | 458 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.\r |
f737cfb9 | 459 | @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r |
e2851998 | 460 | EFI_PXE_BASE_CODE_PROTOCOL structure.\r |
461 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
462 | \r | |
dc361cc5 | 463 | **/\r |
464 | EFI_STATUS\r | |
465 | EFIAPI\r | |
466 | EfiPxeBcStop (\r | |
467 | IN EFI_PXE_BASE_CODE_PROTOCOL *This\r | |
468 | )\r | |
469 | {\r | |
470 | PXEBC_PRIVATE_DATA *Private;\r | |
471 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
472 | \r | |
473 | if (This == NULL) {\r | |
474 | return EFI_INVALID_PARAMETER;\r | |
475 | }\r | |
476 | \r | |
477 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
478 | Mode = Private->PxeBc.Mode;\r | |
479 | \r | |
480 | if (!Mode->Started) {\r | |
481 | return EFI_NOT_STARTED;\r | |
482 | }\r | |
483 | \r | |
982a9eae | 484 | Private->Ip4->Cancel (Private->Ip4, NULL);\r |
485 | //\r | |
486 | // Dispatch the DPCs queued by the NotifyFunction of the canceled rx token's\r | |
487 | // events.\r | |
488 | //\r | |
d8d26fb2 | 489 | DispatchDpc ();\r |
982a9eae | 490 | \r |
491 | Private->Ip4->Configure (Private->Ip4, NULL);\r | |
492 | \r | |
493 | //\r | |
494 | // Close the ICMP error receiving event.\r | |
495 | //\r | |
496 | gBS->CloseEvent (Private->IcmpErrorRcvToken.Event);\r | |
497 | \r | |
498 | //\r | |
499 | // Cancel the TimeoutEvent timer.\r | |
500 | //\r | |
501 | gBS->SetTimer (Private->GetArpCacheEvent, TimerCancel, 0);\r | |
502 | \r | |
503 | //\r | |
504 | // Close the TimeoutEvent event.\r | |
505 | //\r | |
506 | gBS->CloseEvent (Private->GetArpCacheEvent);\r | |
507 | \r | |
dc361cc5 | 508 | Mode->Started = FALSE;\r |
509 | \r | |
8792362f | 510 | Private->CurrentUdpSrcPort = 0;\r |
511 | Private->Udp4Write->Configure (Private->Udp4Write, NULL);\r | |
434ce3fe | 512 | Private->Udp4Read->Groups (Private->Udp4Read, FALSE, NULL);\r |
8792362f | 513 | Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r |
dc361cc5 | 514 | \r |
515 | Private->Dhcp4->Stop (Private->Dhcp4);\r | |
516 | Private->Dhcp4->Configure (Private->Dhcp4, NULL);\r | |
517 | \r | |
518 | Private->FileSize = 0;\r | |
519 | \r | |
520 | return EFI_SUCCESS;\r | |
521 | }\r | |
522 | \r | |
523 | \r | |
e2851998 | 524 | /**\r |
f737cfb9 | 525 | Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6\r |
526 | S.A.R.R (solicit / advertise / request / reply) sequence.\r | |
527 | \r | |
528 | This function attempts to complete the DHCP sequence. If this sequence is completed,\r | |
529 | then EFI_SUCCESS is returned, and the DhcpCompleted, ProxyOfferReceived, StationIp,\r | |
530 | SubnetMask, DhcpDiscover, DhcpAck, and ProxyOffer fields of the EFI_PXE_BASE_CODE_MODE\r | |
531 | structure are filled in.\r | |
532 | If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before\r | |
533 | they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will\r | |
534 | be tried in the order in which they are received. Please see the Preboot Execution\r | |
535 | Environment (PXE) Specification for additional details on the implementation of DHCP.\r | |
536 | This function can take at least 31 seconds to timeout and return control to the\r | |
537 | caller. If the DHCP sequence does not complete, then EFI_TIMEOUT will be returned.\r | |
538 | If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r | |
539 | then the DHCP sequence will be stopped and EFI_ABORTED will be returned.\r | |
e2851998 | 540 | \r |
f737cfb9 | 541 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
542 | @param SortOffers TRUE if the offers received should be sorted. Set to FALSE to try the\r | |
e2851998 | 543 | offers in the order that they are received.\r |
544 | \r | |
f737cfb9 | 545 | @retval EFI_SUCCESS Valid DHCP has completed.\r |
546 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
547 | @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid\r | |
e2851998 | 548 | EFI_PXE_BASE_CODE_PROTOCOL structure.\r |
549 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
f737cfb9 | 550 | @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.\r |
551 | @retval EFI_ABORTED The callback function aborted the DHCP Protocol.\r | |
552 | @retval EFI_TIMEOUT The DHCP Protocol timed out.\r | |
553 | @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.\r | |
554 | @retval EFI_NO_RESPONSE Valid PXE offer was not received.\r | |
e2851998 | 555 | \r |
dc361cc5 | 556 | **/\r |
557 | EFI_STATUS\r | |
558 | EFIAPI\r | |
559 | EfiPxeBcDhcp (\r | |
560 | IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r | |
561 | IN BOOLEAN SortOffers\r | |
562 | )\r | |
563 | {\r | |
8730386e | 564 | PXEBC_PRIVATE_DATA *Private;\r |
565 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
566 | EFI_DHCP4_PROTOCOL *Dhcp4;\r | |
567 | EFI_DHCP4_CONFIG_DATA Dhcp4CfgData;\r | |
568 | EFI_DHCP4_MODE_DATA Dhcp4Mode;\r | |
569 | EFI_DHCP4_PACKET_OPTION *OptList[PXEBC_DHCP4_MAX_OPTION_NUM];\r | |
570 | UINT32 OptCount;\r | |
571 | EFI_STATUS Status;\r | |
572 | EFI_ARP_CONFIG_DATA ArpConfigData;\r | |
573 | EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r | |
dc361cc5 | 574 | \r |
575 | if (This == NULL) {\r | |
576 | return EFI_INVALID_PARAMETER;\r | |
577 | }\r | |
578 | \r | |
579 | Status = EFI_SUCCESS;\r | |
580 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
581 | Mode = Private->PxeBc.Mode;\r | |
582 | Dhcp4 = Private->Dhcp4;\r | |
583 | Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DHCP;\r | |
584 | Private->SortOffers = SortOffers;\r | |
585 | \r | |
586 | if (!Mode->Started) {\r | |
587 | return EFI_NOT_STARTED;\r | |
588 | }\r | |
982a9eae | 589 | \r |
590 | Mode->IcmpErrorReceived = FALSE;\r | |
591 | \r | |
8730386e | 592 | //\r |
593 | // Stop Udp4Read instance\r | |
594 | //\r | |
595 | Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r | |
596 | \r | |
dc361cc5 | 597 | //\r |
598 | // Initialize the DHCP options and build the option list\r | |
599 | //\r | |
600 | OptCount = PxeBcBuildDhcpOptions (Private, OptList, TRUE);\r | |
601 | \r | |
602 | //\r | |
603 | // Set the DHCP4 config data.\r | |
434ce3fe | 604 | // The four discovery timeouts are 4, 8, 16, 32 seconds respectively.\r |
dc361cc5 | 605 | //\r |
e48e37fc | 606 | ZeroMem (&Dhcp4CfgData, sizeof (EFI_DHCP4_CONFIG_DATA));\r |
dc361cc5 | 607 | Dhcp4CfgData.OptionCount = OptCount;\r |
608 | Dhcp4CfgData.OptionList = OptList;\r | |
609 | Dhcp4CfgData.Dhcp4Callback = PxeBcDhcpCallBack;\r | |
610 | Dhcp4CfgData.CallbackContext = Private;\r | |
434ce3fe | 611 | Dhcp4CfgData.DiscoverTryCount = 4;\r |
612 | Dhcp4CfgData.DiscoverTimeout = mPxeDhcpTimeout;\r | |
dc361cc5 | 613 | \r |
434ce3fe | 614 | Status = Dhcp4->Configure (Dhcp4, &Dhcp4CfgData);\r |
615 | if (EFI_ERROR (Status)) {\r | |
616 | goto ON_EXIT;\r | |
617 | }\r | |
e2851998 | 618 | \r |
434ce3fe | 619 | //\r |
620 | // Zero those arrays to record the varies numbers of DHCP OFFERS.\r | |
621 | //\r | |
622 | Private->GotProxyOffer = FALSE;\r | |
623 | Private->NumOffers = 0;\r | |
624 | Private->BootpIndex = 0;\r | |
625 | ZeroMem (Private->ServerCount, sizeof (Private->ServerCount));\r | |
626 | ZeroMem (Private->ProxyIndex, sizeof (Private->ProxyIndex));\r | |
dc361cc5 | 627 | \r |
434ce3fe | 628 | Status = Dhcp4->Start (Dhcp4, NULL);\r |
629 | if (EFI_ERROR (Status)) {\r | |
630 | if (Status == EFI_ICMP_ERROR) {\r | |
631 | Mode->IcmpErrorReceived = TRUE;\r | |
dc361cc5 | 632 | }\r |
434ce3fe | 633 | goto ON_EXIT;\r |
634 | }\r | |
dc361cc5 | 635 | \r |
434ce3fe | 636 | Status = Dhcp4->GetModeData (Dhcp4, &Dhcp4Mode);\r |
637 | if (EFI_ERROR (Status)) {\r | |
638 | goto ON_EXIT;\r | |
639 | }\r | |
dc361cc5 | 640 | \r |
434ce3fe | 641 | ASSERT (Dhcp4Mode.State == Dhcp4Bound);\r |
dc361cc5 | 642 | \r |
434ce3fe | 643 | CopyMem (&Private->StationIp, &Dhcp4Mode.ClientAddress, sizeof (EFI_IPv4_ADDRESS));\r |
644 | CopyMem (&Private->SubnetMask, &Dhcp4Mode.SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r | |
645 | CopyMem (&Private->GatewayIp, &Dhcp4Mode.RouterAddress, sizeof (EFI_IPv4_ADDRESS));\r | |
319075ff | 646 | \r |
434ce3fe | 647 | CopyMem (&Mode->StationIp, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r |
648 | CopyMem (&Mode->SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r | |
dc361cc5 | 649 | \r |
434ce3fe | 650 | //\r |
651 | // Check the selected offer to see whether BINL is required, if no or BINL is\r | |
652 | // finished, set the various Mode members.\r | |
653 | //\r | |
654 | Status = PxeBcCheckSelectedOffer (Private);\r | |
655 | if (!EFI_ERROR (Status)) {\r | |
656 | goto ON_EXIT;\r | |
dc361cc5 | 657 | }\r |
658 | \r | |
434ce3fe | 659 | ON_EXIT:\r |
dc361cc5 | 660 | if (EFI_ERROR (Status)) {\r |
661 | Dhcp4->Stop (Dhcp4);\r | |
662 | Dhcp4->Configure (Dhcp4, NULL);\r | |
663 | } else {\r | |
664 | //\r | |
665 | // Remove the previously configured option list and callback function\r | |
666 | //\r | |
e48e37fc | 667 | ZeroMem (&Dhcp4CfgData, sizeof (EFI_DHCP4_CONFIG_DATA));\r |
dc361cc5 | 668 | Dhcp4->Configure (Dhcp4, &Dhcp4CfgData);\r |
669 | \r | |
670 | Private->AddressIsOk = TRUE;\r | |
8d285ec0 | 671 | \r |
672 | if (!Mode->UsingIpv6) {\r | |
673 | //\r | |
674 | // If in IPv4 mode, configure the corresponding ARP with this new\r | |
675 | // station IP address.\r | |
676 | //\r | |
677 | ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));\r | |
678 | \r | |
679 | ArpConfigData.SwAddressType = 0x0800;\r | |
680 | ArpConfigData.SwAddressLength = sizeof (EFI_IPv4_ADDRESS);\r | |
681 | ArpConfigData.StationAddress = &Private->StationIp.v4;\r | |
682 | \r | |
683 | Private->Arp->Configure (Private->Arp, NULL);\r | |
684 | Private->Arp->Configure (Private->Arp, &ArpConfigData);\r | |
982a9eae | 685 | \r |
686 | //\r | |
687 | // Updated the route table. Fill the first entry.\r | |
688 | //\r | |
689 | Mode->RouteTableEntries = 1;\r | |
690 | Mode->RouteTable[0].IpAddr.Addr[0] = Private->StationIp.Addr[0] & Private->SubnetMask.Addr[0];\r | |
691 | Mode->RouteTable[0].SubnetMask.Addr[0] = Private->SubnetMask.Addr[0];\r | |
692 | Mode->RouteTable[0].GwAddr.Addr[0] = 0;\r | |
693 | \r | |
694 | //\r | |
695 | // Create the default route entry if there is a default router.\r | |
696 | //\r | |
697 | if (Private->GatewayIp.Addr[0] != 0) {\r | |
698 | Mode->RouteTableEntries = 2;\r | |
699 | Mode->RouteTable[1].IpAddr.Addr[0] = 0;\r | |
700 | Mode->RouteTable[1].SubnetMask.Addr[0] = 0;\r | |
701 | Mode->RouteTable[1].GwAddr.Addr[0] = Private->GatewayIp.Addr[0];\r | |
702 | }\r | |
8730386e | 703 | \r |
704 | //\r | |
705 | // Flush new station IP address into Udp4CfgData and Ip4ConfigData\r | |
706 | //\r | |
707 | CopyMem (&Private->Udp4CfgData.StationAddress, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r | |
708 | CopyMem (&Private->Udp4CfgData.SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r | |
709 | CopyMem (&Private->Ip4ConfigData.StationAddress, &Private->StationIp, sizeof (EFI_IPv4_ADDRESS));\r | |
710 | CopyMem (&Private->Ip4ConfigData.SubnetMask, &Private->SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r | |
711 | \r | |
712 | //\r | |
713 | // Reconfigure the Ip4 instance to capture background ICMP packets with new station Ip address.\r | |
714 | //\r | |
715 | Private->Ip4->Cancel (Private->Ip4, &Private->IcmpErrorRcvToken);\r | |
716 | Private->Ip4->Configure (Private->Ip4, NULL);\r | |
717 | \r | |
718 | Status = Private->Ip4->Configure (Private->Ip4, &Private->Ip4ConfigData);\r | |
719 | if (EFI_ERROR (Status)) {\r | |
720 | goto ON_EXIT;\r | |
721 | }\r | |
722 | \r | |
723 | Status = Private->Ip4->Receive (Private->Ip4, &Private->IcmpErrorRcvToken);\r | |
724 | if (EFI_ERROR (Status)) {\r | |
725 | goto ON_EXIT;\r | |
726 | } \r | |
8d285ec0 | 727 | }\r |
dc361cc5 | 728 | }\r |
729 | \r | |
8730386e | 730 | //\r |
731 | // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP \r | |
732 | // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r | |
733 | //\r | |
734 | ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r | |
735 | IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r | |
736 | This->SetIpFilter (This, &IpFilter);\r | |
737 | \r | |
dc361cc5 | 738 | return Status;\r |
739 | }\r | |
740 | \r | |
741 | \r | |
e2851998 | 742 | /**\r |
f737cfb9 | 743 | Attempts to complete the PXE Boot Server and/or boot image discovery sequence.\r |
744 | \r | |
745 | This function attempts to complete the PXE Boot Server and/or boot image discovery\r | |
746 | sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the\r | |
747 | PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the\r | |
748 | EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the\r | |
749 | PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure\r | |
750 | will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.\r | |
751 | In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],\r | |
752 | has two uses: It is the Boot Server IP address list used for unicast discovery\r | |
753 | (if the UseUCast field is TRUE), and it is the list used for Boot Server verification\r | |
754 | (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure\r | |
755 | is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot\r | |
756 | Server reply of that type will be accepted. If the AcceptAnyResponse field is\r | |
757 | FALSE, only responses from Boot Servers with matching IP addresses will be accepted.\r | |
758 | This function can take at least 10 seconds to timeout and return control to the\r | |
759 | caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be\r | |
760 | returned. Please see the Preboot Execution Environment (PXE) Specification for\r | |
761 | additional details on the implementation of the Discovery sequence.\r | |
762 | If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r | |
763 | then the Discovery sequence is stopped and EFI_ABORTED will be returned.\r | |
e2851998 | 764 | \r |
f737cfb9 | 765 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
766 | @param Type The type of bootstrap to perform.\r | |
767 | @param Layer Pointer to the boot server layer number to discover, which must be\r | |
e2851998 | 768 | PXE_BOOT_LAYER_INITIAL when a new server type is being\r |
769 | discovered.\r | |
770 | @param UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.\r | |
f737cfb9 | 771 | @param Info Pointer to a data structure that contains additional information on the\r |
e2851998 | 772 | type of discovery operation that is to be performed.\r |
773 | \r | |
f737cfb9 | 774 | @retval EFI_SUCCESS The Discovery sequence has been completed.\r |
775 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
e2851998 | 776 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
777 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
f737cfb9 | 778 | @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.\r |
779 | @retval EFI_ABORTED The callback function aborted the Discovery sequence.\r | |
780 | @retval EFI_TIMEOUT The Discovery sequence timed out.\r | |
781 | @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery\r | |
e2851998 | 782 | session.\r |
783 | \r | |
dc361cc5 | 784 | **/\r |
785 | EFI_STATUS\r | |
786 | EFIAPI\r | |
787 | EfiPxeBcDiscover (\r | |
788 | IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r | |
789 | IN UINT16 Type,\r | |
790 | IN UINT16 *Layer,\r | |
791 | IN BOOLEAN UseBis,\r | |
792 | IN EFI_PXE_BASE_CODE_DISCOVER_INFO *Info OPTIONAL\r | |
793 | )\r | |
794 | {\r | |
795 | PXEBC_PRIVATE_DATA *Private;\r | |
796 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
797 | EFI_PXE_BASE_CODE_DISCOVER_INFO DefaultInfo;\r | |
29a4f92d | 798 | EFI_PXE_BASE_CODE_DISCOVER_INFO *CreatedInfo;\r |
dc361cc5 | 799 | EFI_PXE_BASE_CODE_SRVLIST *SrvList;\r |
800 | EFI_PXE_BASE_CODE_SRVLIST DefaultSrvList;\r | |
801 | PXEBC_CACHED_DHCP4_PACKET *Packet;\r | |
f737cfb9 | 802 | PXEBC_VENDOR_OPTION *VendorOpt;\r |
dc361cc5 | 803 | UINT16 Index;\r |
804 | EFI_STATUS Status;\r | |
805 | PXEBC_BOOT_SVR_ENTRY *BootSvrEntry;\r | |
8730386e | 806 | EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r |
dc361cc5 | 807 | \r |
808 | if (This == NULL) {\r | |
809 | return EFI_INVALID_PARAMETER;\r | |
810 | }\r | |
811 | \r | |
812 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
813 | Mode = Private->PxeBc.Mode;\r | |
814 | BootSvrEntry = NULL;\r | |
815 | SrvList = NULL;\r | |
29a4f92d | 816 | CreatedInfo = NULL;\r |
dc361cc5 | 817 | Status = EFI_DEVICE_ERROR;\r |
818 | Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DISCOVER;\r | |
819 | \r | |
820 | if (!Private->AddressIsOk) {\r | |
821 | return EFI_INVALID_PARAMETER;\r | |
822 | }\r | |
823 | \r | |
824 | if (!Mode->Started) {\r | |
825 | return EFI_NOT_STARTED;\r | |
826 | }\r | |
827 | \r | |
8730386e | 828 | //\r |
829 | // Stop Udp4Read instance\r | |
830 | //\r | |
831 | Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r | |
832 | \r | |
982a9eae | 833 | Mode->IcmpErrorReceived = FALSE;\r |
834 | \r | |
dc361cc5 | 835 | //\r |
836 | // If layer isn't EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL,\r | |
837 | // use the previous setting;\r | |
838 | // If info isn't offered,\r | |
839 | // use the cached DhcpAck and ProxyOffer packets.\r | |
840 | //\r | |
841 | if (*Layer != EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL) {\r | |
842 | \r | |
843 | if (!Mode->PxeDiscoverValid || !Mode->PxeReplyReceived || (!Mode->PxeBisReplyReceived && UseBis)) {\r | |
844 | \r | |
8730386e | 845 | Status = EFI_INVALID_PARAMETER;\r |
846 | goto ON_EXIT; \r | |
dc361cc5 | 847 | }\r |
848 | \r | |
849 | DefaultInfo.IpCnt = 1;\r | |
850 | DefaultInfo.UseUCast = TRUE;\r | |
851 | \r | |
852 | DefaultSrvList.Type = Type;\r | |
853 | DefaultSrvList.AcceptAnyResponse = FALSE;\r | |
854 | DefaultSrvList.IpAddr.Addr[0] = Private->ServerIp.Addr[0];\r | |
855 | \r | |
856 | SrvList = &DefaultSrvList;\r | |
857 | Info = &DefaultInfo;\r | |
858 | } else if (Info == NULL) {\r | |
859 | //\r | |
860 | // Create info by the cached packet before\r | |
861 | //\r | |
862 | Packet = (Mode->ProxyOfferReceived) ? &Private->ProxyOffer : &Private->Dhcp4Ack;\r | |
863 | VendorOpt = &Packet->PxeVendorOption;\r | |
864 | \r | |
865 | if (!Mode->DhcpAckReceived || !IS_VALID_DISCOVER_VENDOR_OPTION (VendorOpt->BitMap)) {\r | |
866 | //\r | |
867 | // Address is not acquired or no discovery options.\r | |
868 | //\r | |
8730386e | 869 | Status = EFI_INVALID_PARAMETER;\r |
870 | goto ON_EXIT; \r | |
dc361cc5 | 871 | }\r |
872 | \r | |
873 | DefaultInfo.UseMCast = (BOOLEAN)!IS_DISABLE_MCAST_DISCOVER (VendorOpt->DiscoverCtrl);\r | |
874 | DefaultInfo.UseBCast = (BOOLEAN)!IS_DISABLE_BCAST_DISCOVER (VendorOpt->DiscoverCtrl);\r | |
875 | DefaultInfo.MustUseList = (BOOLEAN) IS_ENABLE_USE_SERVER_LIST (VendorOpt->DiscoverCtrl);\r | |
876 | DefaultInfo.UseUCast = DefaultInfo.MustUseList;\r | |
877 | \r | |
878 | if (DefaultInfo.UseMCast) {\r | |
879 | //\r | |
880 | // Get the multicast discover ip address from vendor option.\r | |
881 | //\r | |
f737cfb9 | 882 | CopyMem (\r |
e2851998 | 883 | &DefaultInfo.ServerMCastIp.Addr,\r |
884 | &VendorOpt->DiscoverMcastIp,\r | |
f737cfb9 | 885 | sizeof (EFI_IPv4_ADDRESS)\r |
886 | );\r | |
dc361cc5 | 887 | }\r |
888 | \r | |
889 | DefaultInfo.IpCnt = 0;\r | |
29a4f92d | 890 | Info = &DefaultInfo;\r |
891 | SrvList = Info->SrvList;\r | |
dc361cc5 | 892 | \r |
893 | if (DefaultInfo.MustUseList) {\r | |
894 | BootSvrEntry = VendorOpt->BootSvr;\r | |
895 | Status = EFI_INVALID_PARAMETER;\r | |
896 | \r | |
897 | while (((UINT8) (BootSvrEntry - VendorOpt->BootSvr)) < VendorOpt->BootSvrLen) {\r | |
898 | \r | |
899 | if (BootSvrEntry->Type == HTONS (Type)) {\r | |
900 | Status = EFI_SUCCESS;\r | |
901 | break;\r | |
902 | }\r | |
903 | \r | |
904 | BootSvrEntry = GET_NEXT_BOOT_SVR_ENTRY (BootSvrEntry);\r | |
905 | }\r | |
906 | \r | |
907 | if (EFI_ERROR (Status)) {\r | |
8730386e | 908 | goto ON_EXIT;\r |
dc361cc5 | 909 | }\r |
910 | \r | |
911 | DefaultInfo.IpCnt = BootSvrEntry->IpCnt;\r | |
29a4f92d | 912 | \r |
913 | if (DefaultInfo.IpCnt >= 1) {\r | |
914 | CreatedInfo = AllocatePool (sizeof (DefaultInfo) + (DefaultInfo.IpCnt - 1) * sizeof (*SrvList));\r | |
915 | if (CreatedInfo == NULL) {\r | |
8730386e | 916 | Status = EFI_OUT_OF_RESOURCES;\r |
917 | goto ON_EXIT;\r | |
918 | \r | |
29a4f92d | 919 | } \r |
920 | \r | |
921 | CopyMem (CreatedInfo, &DefaultInfo, sizeof (DefaultInfo));\r | |
922 | Info = CreatedInfo;\r | |
923 | SrvList = Info->SrvList;\r | |
924 | }\r | |
925 | \r | |
926 | for (Index = 0; Index < DefaultInfo.IpCnt; Index++) {\r | |
927 | CopyMem (&SrvList[Index].IpAddr, &BootSvrEntry->IpAddr[Index], sizeof (EFI_IPv4_ADDRESS));\r | |
928 | SrvList[Index].AcceptAnyResponse = FALSE;\r | |
929 | SrvList[Index].Type = BootSvrEntry->Type;\r | |
930 | }\r | |
dc361cc5 | 931 | }\r |
932 | \r | |
dc361cc5 | 933 | } else {\r |
934 | \r | |
935 | SrvList = Info->SrvList;\r | |
936 | \r | |
937 | if (!SrvList[0].AcceptAnyResponse) {\r | |
938 | \r | |
939 | for (Index = 1; Index < Info->IpCnt; Index++) {\r | |
940 | if (SrvList[Index].AcceptAnyResponse) {\r | |
941 | break;\r | |
942 | }\r | |
943 | }\r | |
944 | \r | |
945 | if (Index != Info->IpCnt) {\r | |
8730386e | 946 | Status = EFI_INVALID_PARAMETER;\r |
947 | goto ON_EXIT; \r | |
dc361cc5 | 948 | }\r |
949 | }\r | |
950 | }\r | |
951 | \r | |
952 | if ((!Info->UseUCast && !Info->UseBCast && !Info->UseMCast) || (Info->MustUseList && Info->IpCnt == 0)) {\r | |
953 | \r | |
8730386e | 954 | Status = EFI_INVALID_PARAMETER;\r |
955 | goto ON_EXIT;\r | |
dc361cc5 | 956 | }\r |
957 | //\r | |
958 | // Execute discover by UniCast/BroadCast/MultiCast\r | |
959 | //\r | |
960 | if (Info->UseUCast) {\r | |
961 | \r | |
962 | for (Index = 0; Index < Info->IpCnt; Index++) {\r | |
963 | \r | |
964 | if (BootSvrEntry == NULL) {\r | |
965 | Private->ServerIp.Addr[0] = SrvList[Index].IpAddr.Addr[0];\r | |
966 | } else {\r | |
f737cfb9 | 967 | CopyMem (\r |
e2851998 | 968 | &Private->ServerIp,\r |
969 | &BootSvrEntry->IpAddr[Index],\r | |
f737cfb9 | 970 | sizeof (EFI_IPv4_ADDRESS)\r |
971 | );\r | |
dc361cc5 | 972 | }\r |
973 | \r | |
974 | Status = PxeBcDiscvBootService (\r | |
975 | Private,\r | |
976 | Type,\r | |
977 | Layer,\r | |
978 | UseBis,\r | |
979 | &SrvList[Index].IpAddr,\r | |
980 | 0,\r | |
981 | NULL,\r | |
982 | TRUE,\r | |
983 | &Private->PxeReply.Packet.Ack\r | |
984 | );\r | |
29a4f92d | 985 | if (!EFI_ERROR (Status)) {\r |
986 | break;\r | |
987 | } \r | |
dc361cc5 | 988 | }\r |
989 | \r | |
990 | } else if (Info->UseMCast) {\r | |
991 | \r | |
992 | Status = PxeBcDiscvBootService (\r | |
993 | Private,\r | |
994 | Type,\r | |
995 | Layer,\r | |
996 | UseBis,\r | |
997 | &Info->ServerMCastIp,\r | |
998 | 0,\r | |
999 | NULL,\r | |
1000 | TRUE,\r | |
1001 | &Private->PxeReply.Packet.Ack\r | |
1002 | );\r | |
1003 | \r | |
1004 | } else if (Info->UseBCast) {\r | |
1005 | \r | |
1006 | Status = PxeBcDiscvBootService (\r | |
1007 | Private,\r | |
1008 | Type,\r | |
1009 | Layer,\r | |
1010 | UseBis,\r | |
1011 | NULL,\r | |
1012 | Info->IpCnt,\r | |
1013 | SrvList,\r | |
1014 | TRUE,\r | |
1015 | &Private->PxeReply.Packet.Ack\r | |
1016 | );\r | |
1017 | }\r | |
1018 | \r | |
1019 | if (EFI_ERROR (Status) || !Mode->PxeReplyReceived || (!Mode->PxeBisReplyReceived && UseBis)) {\r | |
982a9eae | 1020 | if (Status == EFI_ICMP_ERROR) {\r |
1021 | Mode->IcmpErrorReceived = TRUE;\r | |
1022 | } else {\r | |
1023 | Status = EFI_DEVICE_ERROR;\r | |
1024 | }\r | |
dc361cc5 | 1025 | } else {\r |
1026 | PxeBcParseCachedDhcpPacket (&Private->PxeReply);\r | |
1027 | }\r | |
1028 | \r | |
1029 | if (Mode->PxeBisReplyReceived) {\r | |
f737cfb9 | 1030 | CopyMem (\r |
e2851998 | 1031 | &Private->ServerIp,\r |
1032 | &Mode->PxeReply.Dhcpv4.BootpSiAddr,\r | |
f737cfb9 | 1033 | sizeof (EFI_IPv4_ADDRESS)\r |
1034 | );\r | |
dc361cc5 | 1035 | }\r |
1036 | \r | |
29a4f92d | 1037 | if (CreatedInfo != NULL) {\r |
1038 | FreePool (CreatedInfo);\r | |
1039 | }\r | |
8730386e | 1040 | \r |
1041 | ON_EXIT:\r | |
1042 | \r | |
1043 | //\r | |
1044 | // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP \r | |
1045 | // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r | |
1046 | //\r | |
1047 | ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r | |
1048 | IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r | |
1049 | This->SetIpFilter (This, &IpFilter);\r | |
29a4f92d | 1050 | \r |
dc361cc5 | 1051 | return Status;\r |
1052 | }\r | |
1053 | \r | |
1054 | \r | |
e2851998 | 1055 | /**\r |
f737cfb9 | 1056 | Used to perform TFTP and MTFTP services.\r |
1057 | \r | |
1058 | This function is used to perform TFTP and MTFTP services. This includes the\r | |
1059 | TFTP operations to get the size of a file, read a directory, read a file, and\r | |
1060 | write a file. It also includes the MTFTP operations to get the size of a file,\r | |
1061 | read a directory, and read a file. The type of operation is specified by Operation.\r | |
1062 | If the callback function that is invoked during the TFTP/MTFTP operation does\r | |
1063 | not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will\r | |
1064 | be returned.\r | |
1065 | For read operations, the return data will be placed in the buffer specified by\r | |
1066 | BufferPtr. If BufferSize is too small to contain the entire downloaded file,\r | |
1067 | then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero\r | |
1068 | or the size of the requested file (the size of the requested file is only returned\r | |
1069 | if the TFTP server supports TFTP options). If BufferSize is large enough for the\r | |
1070 | read operation, then BufferSize will be set to the size of the downloaded file,\r | |
1071 | and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services\r | |
1072 | should use the get-file-size operations to determine the size of the downloaded\r | |
1073 | file prior to using the read-file operations-especially when downloading large\r | |
1074 | (greater than 64 MB) files-instead of making two calls to the read-file operation.\r | |
1075 | Following this recommendation will save time if the file is larger than expected\r | |
1076 | and the TFTP server does not support TFTP option extensions. Without TFTP option\r | |
1077 | extension support, the client has to download the entire file, counting and discarding\r | |
1078 | the received packets, to determine the file size.\r | |
1079 | For write operations, the data to be sent is in the buffer specified by BufferPtr.\r | |
1080 | BufferSize specifies the number of bytes to send. If the write operation completes\r | |
1081 | successfully, then EFI_SUCCESS will be returned.\r | |
1082 | For TFTP "get file size" operations, the size of the requested file or directory\r | |
1083 | is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server\r | |
1084 | does not support options, the file will be downloaded into a bit bucket and the\r | |
1085 | length of the downloaded file will be returned. For MTFTP "get file size" operations,\r | |
1086 | if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED\r | |
1087 | will be returned.\r | |
1088 | This function can take up to 10 seconds to timeout and return control to the caller.\r | |
1089 | If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.\r | |
1090 | If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r | |
1091 | then the TFTP sequence is stopped and EFI_ABORTED will be returned.\r | |
1092 | The format of the data returned from a TFTP read directory operation is a null-terminated\r | |
1093 | filename followed by a null-terminated information string, of the form\r | |
1094 | "size year-month-day hour:minute:second" (i.e. %d %d-%d-%d %d:%d:%f - note that\r | |
1095 | the seconds field can be a decimal number), where the date and time are UTC. For\r | |
1096 | an MTFTP read directory command, there is additionally a null-terminated multicast\r | |
1097 | IP address preceding the filename of the form %d.%d.%d.%d for IP v4. The final\r | |
1098 | entry is itself null-terminated, so that the final information string is terminated\r | |
1099 | with two null octets.\r | |
e2851998 | 1100 | \r |
f737cfb9 | 1101 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
1102 | @param Operation The type of operation to perform.\r | |
e2851998 | 1103 | @param BufferPtr A pointer to the data buffer.\r |
f737cfb9 | 1104 | @param Overwrite Only used on write file operations. TRUE if a file on a remote server can\r |
e2851998 | 1105 | be overwritten.\r |
f737cfb9 | 1106 | @param BufferSize For get-file-size operations, *BufferSize returns the size of the\r |
e2851998 | 1107 | requested file.\r |
f737cfb9 | 1108 | @param BlockSize The requested block size to be used during a TFTP transfer.\r |
1109 | @param ServerIp The TFTP / MTFTP server IP address.\r | |
1110 | @param Filename A Null-terminated ASCII string that specifies a directory name or a file\r | |
e2851998 | 1111 | name.\r |
f737cfb9 | 1112 | @param Info Pointer to the MTFTP information.\r |
e2851998 | 1113 | @param DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.\r |
1114 | \r | |
f737cfb9 | 1115 | @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.\r |
1116 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
e2851998 | 1117 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
1118 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
1119 | @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.\r | |
f737cfb9 | 1120 | @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.\r |
1121 | @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.\r | |
1122 | @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.\r | |
1123 | @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.\r | |
e2851998 | 1124 | \r |
dc361cc5 | 1125 | **/\r |
1126 | EFI_STATUS\r | |
1127 | EFIAPI\r | |
1128 | EfiPxeBcMtftp (\r | |
1129 | IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r | |
1130 | IN EFI_PXE_BASE_CODE_TFTP_OPCODE Operation,\r | |
1131 | IN OUT VOID *BufferPtr,\r | |
1132 | IN BOOLEAN Overwrite,\r | |
1133 | IN OUT UINT64 *BufferSize,\r | |
1134 | IN UINTN *BlockSize OPTIONAL,\r | |
1135 | IN EFI_IP_ADDRESS *ServerIp,\r | |
1136 | IN UINT8 *Filename,\r | |
1137 | IN EFI_PXE_BASE_CODE_MTFTP_INFO *Info OPTIONAL,\r | |
1138 | IN BOOLEAN DontUseBuffer\r | |
1139 | )\r | |
1140 | {\r | |
8730386e | 1141 | PXEBC_PRIVATE_DATA *Private;\r |
1142 | EFI_MTFTP4_CONFIG_DATA Mtftp4Config;\r | |
1143 | EFI_STATUS Status;\r | |
1144 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
1145 | EFI_MAC_ADDRESS TempMacAddr;\r | |
1146 | EFI_PXE_BASE_CODE_IP_FILTER IpFilter;\r | |
dc361cc5 | 1147 | \r |
f6b7393c | 1148 | if ((This == NULL) ||\r |
1149 | (Filename == NULL) ||\r | |
1150 | (BufferSize == NULL) ||\r | |
1151 | ((ServerIp == NULL) || !NetIp4IsUnicast (NTOHL (ServerIp->Addr[0]), 0)) ||\r | |
1152 | ((BufferPtr == NULL) && DontUseBuffer) ||\r | |
dc361cc5 | 1153 | ((BlockSize != NULL) && (*BlockSize < 512))) {\r |
1154 | \r | |
1155 | return EFI_INVALID_PARAMETER;\r | |
1156 | }\r | |
1157 | \r | |
1158 | Status = EFI_DEVICE_ERROR;\r | |
1159 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
982a9eae | 1160 | Mode = &Private->Mode;\r |
1161 | \r | |
1162 | if (!Mode->AutoArp) {\r | |
1163 | //\r | |
1164 | // If AutoArp is set false, check arp cache\r | |
1165 | //\r | |
1166 | UpdateArpCache (This);\r | |
1167 | if (!FindInArpCache (Mode, &ServerIp->v4, &TempMacAddr)) {\r | |
1168 | return EFI_DEVICE_ERROR;\r | |
1169 | }\r | |
1170 | }\r | |
1171 | \r | |
8730386e | 1172 | //\r |
1173 | // Stop Udp4Read instance\r | |
1174 | //\r | |
1175 | Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r | |
1176 | \r | |
982a9eae | 1177 | Mode->TftpErrorReceived = FALSE;\r |
1178 | Mode->IcmpErrorReceived = FALSE;\r | |
dc361cc5 | 1179 | \r |
1180 | Mtftp4Config.UseDefaultSetting = FALSE;\r | |
1181 | Mtftp4Config.TimeoutValue = PXEBC_MTFTP_TIMEOUT;\r | |
1182 | Mtftp4Config.TryCount = PXEBC_MTFTP_RETRIES;\r | |
1183 | \r | |
f737cfb9 | 1184 | CopyMem (\r |
e2851998 | 1185 | &Mtftp4Config.StationIp,\r |
1186 | &Private->StationIp,\r | |
f737cfb9 | 1187 | sizeof (EFI_IPv4_ADDRESS)\r |
1188 | );\r | |
1189 | CopyMem (\r | |
e2851998 | 1190 | &Mtftp4Config.SubnetMask,\r |
1191 | &Private->SubnetMask,\r | |
f737cfb9 | 1192 | sizeof (EFI_IPv4_ADDRESS)\r |
1193 | );\r | |
1194 | CopyMem (\r | |
e2851998 | 1195 | &Mtftp4Config.GatewayIp,\r |
1196 | &Private->GatewayIp,\r | |
f737cfb9 | 1197 | sizeof (EFI_IPv4_ADDRESS)\r |
1198 | );\r | |
1199 | CopyMem (\r | |
e2851998 | 1200 | &Mtftp4Config.ServerIp,\r |
1201 | ServerIp,\r | |
f737cfb9 | 1202 | sizeof (EFI_IPv4_ADDRESS)\r |
1203 | );\r | |
dc361cc5 | 1204 | \r |
1205 | switch (Operation) {\r | |
1206 | \r | |
1207 | case EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE:\r | |
1208 | \r | |
1209 | Status = PxeBcTftpGetFileSize (\r | |
1210 | Private,\r | |
1211 | &Mtftp4Config,\r | |
1212 | Filename,\r | |
1213 | BlockSize,\r | |
1214 | BufferSize\r | |
1215 | );\r | |
1216 | \r | |
dc361cc5 | 1217 | break;\r |
1218 | \r | |
1219 | case EFI_PXE_BASE_CODE_TFTP_READ_FILE:\r | |
1220 | \r | |
1221 | Status = PxeBcTftpReadFile (\r | |
1222 | Private,\r | |
1223 | &Mtftp4Config,\r | |
1224 | Filename,\r | |
1225 | BlockSize,\r | |
1226 | BufferPtr,\r | |
1227 | BufferSize,\r | |
1228 | DontUseBuffer\r | |
1229 | );\r | |
1230 | \r | |
1231 | break;\r | |
1232 | \r | |
1233 | case EFI_PXE_BASE_CODE_TFTP_WRITE_FILE:\r | |
1234 | \r | |
1235 | Status = PxeBcTftpWriteFile (\r | |
1236 | Private,\r | |
1237 | &Mtftp4Config,\r | |
1238 | Filename,\r | |
1239 | Overwrite,\r | |
1240 | BlockSize,\r | |
1241 | BufferPtr,\r | |
1242 | BufferSize\r | |
1243 | );\r | |
1244 | \r | |
1245 | break;\r | |
1246 | \r | |
1247 | case EFI_PXE_BASE_CODE_TFTP_READ_DIRECTORY:\r | |
1248 | \r | |
1249 | Status = PxeBcTftpReadDirectory (\r | |
1250 | Private,\r | |
1251 | &Mtftp4Config,\r | |
1252 | Filename,\r | |
1253 | BlockSize,\r | |
1254 | BufferPtr,\r | |
1255 | BufferSize,\r | |
1256 | DontUseBuffer\r | |
1257 | );\r | |
1258 | \r | |
1259 | break;\r | |
1260 | \r | |
1261 | case EFI_PXE_BASE_CODE_MTFTP_GET_FILE_SIZE:\r | |
1262 | case EFI_PXE_BASE_CODE_MTFTP_READ_FILE:\r | |
1263 | case EFI_PXE_BASE_CODE_MTFTP_READ_DIRECTORY:\r | |
1264 | Status = EFI_UNSUPPORTED;\r | |
1265 | break;\r | |
1266 | \r | |
1267 | default:\r | |
1268 | \r | |
1269 | Status = EFI_INVALID_PARAMETER;\r | |
1270 | break;\r | |
1271 | }\r | |
1272 | \r | |
982a9eae | 1273 | if (Status == EFI_ICMP_ERROR) {\r |
1274 | Mode->IcmpErrorReceived = TRUE;\r | |
1275 | }\r | |
1276 | \r | |
8730386e | 1277 | //\r |
1278 | // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP \r | |
1279 | // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r | |
1280 | //\r | |
1281 | ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));\r | |
1282 | IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;\r | |
1283 | This->SetIpFilter (This, &IpFilter);\r | |
1284 | \r | |
dc361cc5 | 1285 | return Status;\r |
1286 | }\r | |
1287 | \r | |
1288 | \r | |
e2851998 | 1289 | /**\r |
f737cfb9 | 1290 | Writes a UDP packet to the network interface.\r |
1291 | \r | |
1292 | This function writes a UDP packet specified by the (optional HeaderPtr and)\r | |
1293 | BufferPtr parameters to the network interface. The UDP header is automatically\r | |
1294 | built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,\r | |
1295 | SrcIp, and SrcPort to build this header. If the packet is successfully built and\r | |
1296 | transmitted through the network interface, then EFI_SUCCESS will be returned.\r | |
1297 | If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will\r | |
1298 | be returned. If an ICMP error occurs during the transmission of the packet, then\r | |
1299 | the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and\r | |
1300 | EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return\r | |
1301 | EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.\r | |
e2851998 | 1302 | \r |
f737cfb9 | 1303 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
e2851998 | 1304 | @param OpFlags The UDP operation flags.\r |
f737cfb9 | 1305 | @param DestIp The destination IP address.\r |
e2851998 | 1306 | @param DestPort The destination UDP port number.\r |
1307 | @param GatewayIp The gateway IP address.\r | |
f737cfb9 | 1308 | @param SrcIp The source IP address.\r |
1309 | @param SrcPort The source UDP port number.\r | |
1310 | @param HeaderSize An optional field which may be set to the length of a header at\r | |
e2851998 | 1311 | HeaderPtr to be prefixed to the data at BufferPtr.\r |
f737cfb9 | 1312 | @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r |
e2851998 | 1313 | data at BufferPtr.\r |
f737cfb9 | 1314 | @param BufferSize A pointer to the size of the data at BufferPtr.\r |
1315 | @param BufferPtr A pointer to the data to be written.\r | |
e2851998 | 1316 | \r |
f737cfb9 | 1317 | @retval EFI_SUCCESS The UDP Write operation was completed.\r |
1318 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
e2851998 | 1319 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
1320 | @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.\r | |
f737cfb9 | 1321 | @retval EFI_ABORTED The callback function aborted the UDP Write operation.\r |
1322 | @retval EFI_TIMEOUT The UDP Write operation timed out.\r | |
e2851998 | 1323 | @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.\r |
1324 | \r | |
dc361cc5 | 1325 | **/\r |
1326 | EFI_STATUS\r | |
1327 | EFIAPI\r | |
1328 | EfiPxeBcUdpWrite (\r | |
1329 | IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r | |
1330 | IN UINT16 OpFlags,\r | |
1331 | IN EFI_IP_ADDRESS *DestIp,\r | |
1332 | IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,\r | |
1333 | IN EFI_IP_ADDRESS *GatewayIp OPTIONAL,\r | |
1334 | IN EFI_IP_ADDRESS *SrcIp OPTIONAL,\r | |
1335 | IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,\r | |
1336 | IN UINTN *HeaderSize OPTIONAL,\r | |
1337 | IN VOID *HeaderPtr OPTIONAL,\r | |
1338 | IN UINTN *BufferSize,\r | |
1339 | IN VOID *BufferPtr\r | |
1340 | )\r | |
1341 | {\r | |
1342 | PXEBC_PRIVATE_DATA *Private;\r | |
1343 | EFI_UDP4_PROTOCOL *Udp4;\r | |
1344 | EFI_UDP4_COMPLETION_TOKEN Token;\r | |
1345 | EFI_UDP4_TRANSMIT_DATA *Udp4TxData;\r | |
1346 | UINT32 FragCount;\r | |
1347 | UINT32 DataLength;\r | |
1348 | EFI_UDP4_SESSION_DATA Udp4Session;\r | |
1349 | EFI_STATUS Status;\r | |
1350 | BOOLEAN IsDone;\r | |
982a9eae | 1351 | EFI_PXE_BASE_CODE_MODE *Mode;\r |
1352 | EFI_MAC_ADDRESS TempMacAddr;\r | |
dc361cc5 | 1353 | \r |
1354 | IsDone = FALSE;\r | |
1355 | \r | |
1356 | if ((This == NULL) || (DestIp == NULL) || (DestPort == NULL)) {\r | |
1357 | return EFI_INVALID_PARAMETER;\r | |
1358 | }\r | |
1359 | \r | |
f6b7393c | 1360 | if ((GatewayIp != NULL) && !NetIp4IsUnicast (NTOHL (GatewayIp->Addr[0]), 0)) {\r |
dc361cc5 | 1361 | //\r |
1362 | // Gateway is provided but it's not a unicast IP address.\r | |
1363 | //\r | |
1364 | return EFI_INVALID_PARAMETER;\r | |
1365 | }\r | |
1366 | \r | |
1367 | if ((HeaderSize != NULL) && ((*HeaderSize == 0) || (HeaderPtr == NULL))) {\r | |
1368 | //\r | |
1369 | // The HeaderSize ptr isn't NULL and: 1. the value is zero; or 2. the HeaderPtr\r | |
1370 | // is NULL.\r | |
1371 | //\r | |
1372 | return EFI_INVALID_PARAMETER;\r | |
1373 | }\r | |
1374 | \r | |
1375 | if ((BufferSize == NULL) || ((*BufferSize != 0) && (BufferPtr == NULL))) {\r | |
1376 | return EFI_INVALID_PARAMETER;\r | |
1377 | }\r | |
1378 | \r | |
1379 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
8792362f | 1380 | Udp4 = Private->Udp4Write;\r |
982a9eae | 1381 | Mode = &Private->Mode;\r |
8792362f | 1382 | if (!Mode->Started) {\r |
1383 | return EFI_NOT_STARTED;\r | |
1384 | }\r | |
dc361cc5 | 1385 | \r |
1386 | if (!Private->AddressIsOk && (SrcIp == NULL)) {\r | |
1387 | return EFI_INVALID_PARAMETER;\r | |
1388 | }\r | |
1389 | \r | |
982a9eae | 1390 | if (!Mode->AutoArp) {\r |
1391 | //\r | |
1392 | // If AutoArp is set false, check arp cache\r | |
1393 | //\r | |
1394 | UpdateArpCache (This);\r | |
1395 | if (!FindInArpCache (Mode, &DestIp->v4, &TempMacAddr)) {\r | |
1396 | return EFI_DEVICE_ERROR;\r | |
1397 | }\r | |
1398 | }\r | |
1399 | \r | |
1400 | Mode->IcmpErrorReceived = FALSE;\r | |
1401 | \r | |
8792362f | 1402 | if ((Private->CurrentUdpSrcPort == 0) ||\r |
f737cfb9 | 1403 | ((SrcPort != NULL) && (*SrcPort != Private->CurrentUdpSrcPort))) {\r |
8792362f | 1404 | //\r |
1405 | // Port is changed, (re)configure the Udp4Write instance\r | |
1406 | //\r | |
1407 | if (SrcPort != NULL) {\r | |
1408 | Private->CurrentUdpSrcPort = *SrcPort;\r | |
dc361cc5 | 1409 | }\r |
dc361cc5 | 1410 | }\r |
1411 | \r | |
2e4c2a04 | 1412 | Status = PxeBcConfigureUdpWriteInstance (\r |
1413 | Udp4,\r | |
1414 | &Private->StationIp.v4,\r | |
1415 | &Private->SubnetMask.v4,\r | |
1416 | &Private->GatewayIp.v4,\r | |
1417 | &Private->CurrentUdpSrcPort\r | |
1418 | );\r | |
1419 | if (EFI_ERROR (Status)) {\r | |
1420 | Private->CurrentUdpSrcPort = 0;\r | |
1421 | return EFI_INVALID_PARAMETER;\r | |
1422 | }\r | |
1423 | \r | |
dc361cc5 | 1424 | ZeroMem (&Token, sizeof (EFI_UDP4_COMPLETION_TOKEN));\r |
1425 | ZeroMem (&Udp4Session, sizeof (EFI_UDP4_SESSION_DATA));\r | |
1426 | \r | |
e48e37fc | 1427 | CopyMem (&Udp4Session.DestinationAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));\r |
dc361cc5 | 1428 | Udp4Session.DestinationPort = *DestPort;\r |
8792362f | 1429 | if (SrcIp != NULL) {\r |
1430 | CopyMem (&Udp4Session.SourceAddress, SrcIp, sizeof (EFI_IPv4_ADDRESS));\r | |
1431 | }\r | |
1432 | if (SrcPort != NULL) {\r | |
1433 | Udp4Session.SourcePort = *SrcPort;\r | |
1434 | }\r | |
dc361cc5 | 1435 | \r |
1436 | FragCount = (HeaderSize != NULL) ? 2 : 1;\r | |
05c0e3cb | 1437 | Udp4TxData = (EFI_UDP4_TRANSMIT_DATA *) AllocateZeroPool (sizeof (EFI_UDP4_TRANSMIT_DATA) + (FragCount - 1) * sizeof (EFI_UDP4_FRAGMENT_DATA));\r |
dc361cc5 | 1438 | if (Udp4TxData == NULL) {\r |
1439 | return EFI_OUT_OF_RESOURCES;\r | |
1440 | }\r | |
1441 | \r | |
1442 | Udp4TxData->FragmentCount = FragCount;\r | |
1443 | Udp4TxData->FragmentTable[FragCount - 1].FragmentLength = (UINT32) *BufferSize;\r | |
1444 | Udp4TxData->FragmentTable[FragCount - 1].FragmentBuffer = BufferPtr;\r | |
1445 | DataLength = (UINT32) *BufferSize;\r | |
1446 | \r | |
1447 | if (FragCount == 2) {\r | |
1448 | \r | |
1449 | Udp4TxData->FragmentTable[0].FragmentLength = (UINT32) *HeaderSize;\r | |
1450 | Udp4TxData->FragmentTable[0].FragmentBuffer = HeaderPtr;\r | |
1451 | DataLength += (UINT32) *HeaderSize;\r | |
1452 | }\r | |
1453 | \r | |
8792362f | 1454 | if (GatewayIp != NULL) {\r |
1455 | Udp4TxData->GatewayAddress = (EFI_IPv4_ADDRESS *) GatewayIp;\r | |
1456 | }\r | |
dc361cc5 | 1457 | Udp4TxData->UdpSessionData = &Udp4Session;\r |
1458 | Udp4TxData->DataLength = DataLength;\r | |
1459 | Token.Packet.TxData = Udp4TxData;\r | |
1460 | \r | |
1461 | Status = gBS->CreateEvent (\r | |
1462 | EVT_NOTIFY_SIGNAL,\r | |
e48e37fc | 1463 | TPL_NOTIFY,\r |
dc361cc5 | 1464 | PxeBcCommonNotify,\r |
1465 | &IsDone,\r | |
1466 | &Token.Event\r | |
1467 | );\r | |
1468 | if (EFI_ERROR (Status)) {\r | |
1469 | goto ON_EXIT;\r | |
1470 | }\r | |
1471 | \r | |
1472 | Status = Udp4->Transmit (Udp4, &Token);\r | |
1473 | if (EFI_ERROR (Status)) {\r | |
982a9eae | 1474 | if (Status == EFI_ICMP_ERROR) {\r |
1475 | Mode->IcmpErrorReceived = TRUE;\r | |
1476 | }\r | |
dc361cc5 | 1477 | goto ON_EXIT;\r |
1478 | }\r | |
1479 | \r | |
1480 | while (!IsDone) {\r | |
1481 | \r | |
1482 | Udp4->Poll (Udp4);\r | |
1483 | }\r | |
1484 | \r | |
1485 | Status = Token.Status;\r | |
1486 | \r | |
1487 | ON_EXIT:\r | |
1488 | \r | |
1489 | if (Token.Event != NULL) {\r | |
1490 | gBS->CloseEvent (Token.Event);\r | |
1491 | }\r | |
1492 | \r | |
766c7483 | 1493 | FreePool (Udp4TxData);\r |
dc361cc5 | 1494 | \r |
2e4c2a04 | 1495 | //\r |
1496 | // Reset the instance.\r | |
1497 | //\r | |
1498 | Udp4->Configure (Udp4, NULL);\r | |
dc361cc5 | 1499 | return Status;\r |
1500 | }\r | |
1501 | \r | |
8d285ec0 | 1502 | /**\r |
f737cfb9 | 1503 | Decide whether the incoming UDP packet is acceptable per IP filter settings\r |
1504 | in provided PxeBcMode.\r | |
8d285ec0 | 1505 | \r |
f737cfb9 | 1506 | @param PxeBcMode Pointer to EFI_PXE_BASE_CODE_MODE.\r |
1507 | @param Session Received UDP session.\r | |
8d285ec0 | 1508 | \r |
f737cfb9 | 1509 | @retval TRUE The UDP package matches IP filters.\r |
1510 | @retval FALSE The UDP package doesn't matches IP filters.\r | |
8d285ec0 | 1511 | \r |
1512 | **/\r | |
8d285ec0 | 1513 | BOOLEAN\r |
1514 | CheckIpByFilter (\r | |
f737cfb9 | 1515 | IN EFI_PXE_BASE_CODE_MODE *PxeBcMode,\r |
1516 | IN EFI_UDP4_SESSION_DATA *Session\r | |
8d285ec0 | 1517 | )\r |
1518 | {\r | |
1519 | UINTN Index;\r | |
1520 | EFI_IPv4_ADDRESS Ip4Address;\r | |
1521 | EFI_IPv4_ADDRESS DestIp4Address;\r | |
1522 | \r | |
f737cfb9 | 1523 | if ((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0) {\r |
8d285ec0 | 1524 | return TRUE;\r |
1525 | }\r | |
1526 | \r | |
1527 | CopyMem (&DestIp4Address, &Session->DestinationAddress, sizeof (DestIp4Address));\r | |
e2851998 | 1528 | if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0) &&\r |
982a9eae | 1529 | IP4_IS_MULTICAST (EFI_NTOHL (DestIp4Address))\r |
8d285ec0 | 1530 | ) {\r |
1531 | return TRUE;\r | |
1532 | }\r | |
1533 | \r | |
e2851998 | 1534 | if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) &&\r |
8d285ec0 | 1535 | IP4_IS_LOCAL_BROADCAST (EFI_NTOHL (DestIp4Address))\r |
1536 | ) {\r | |
1537 | return TRUE;\r | |
1538 | }\r | |
1539 | \r | |
1540 | CopyMem (&Ip4Address, &PxeBcMode->StationIp.v4, sizeof (Ip4Address));\r | |
e2851998 | 1541 | if (((PxeBcMode->IpFilter.Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) &&\r |
982a9eae | 1542 | EFI_IP4_EQUAL (&Ip4Address, &DestIp4Address)\r |
8d285ec0 | 1543 | ) {\r |
1544 | return TRUE;\r | |
1545 | }\r | |
1546 | \r | |
894d038a | 1547 | ASSERT (PxeBcMode->IpFilter.IpCnt < EFI_PXE_BASE_CODE_MAX_IPCNT);\r |
1548 | \r | |
f737cfb9 | 1549 | for (Index = 0; Index < PxeBcMode->IpFilter.IpCnt; Index++) {\r |
1550 | CopyMem (\r | |
e2851998 | 1551 | &Ip4Address,\r |
1552 | &PxeBcMode->IpFilter.IpList[Index].v4,\r | |
f737cfb9 | 1553 | sizeof (Ip4Address)\r |
1554 | );\r | |
8d285ec0 | 1555 | if (EFI_IP4_EQUAL (&Ip4Address, &DestIp4Address)) {\r |
1556 | return TRUE;\r | |
1557 | }\r | |
1558 | }\r | |
1559 | \r | |
1560 | return FALSE;\r | |
1561 | }\r | |
dc361cc5 | 1562 | \r |
e2851998 | 1563 | /**\r |
f737cfb9 | 1564 | Reads a UDP packet from the network interface.\r |
1565 | \r | |
1566 | This function reads a UDP packet from a network interface. The data contents\r | |
1567 | are returned in (the optional HeaderPtr and) BufferPtr, and the size of the\r | |
1568 | buffer received is returned in BufferSize . If the input BufferSize is smaller\r | |
1569 | than the UDP packet received (less optional HeaderSize), it will be set to the\r | |
1570 | required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the\r | |
1571 | contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is\r | |
1572 | successfully received, then EFI_SUCCESS will be returned, and the information\r | |
1573 | from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if\r | |
e2851998 | 1574 | they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,\r |
1575 | SrcIp, and SrcPort input values, different types of UDP packet receive filtering\r | |
f737cfb9 | 1576 | will be performed. The following tables summarize these receive filter operations.\r |
e2851998 | 1577 | \r |
f737cfb9 | 1578 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
e2851998 | 1579 | @param OpFlags The UDP operation flags.\r |
f737cfb9 | 1580 | @param DestIp The destination IP address.\r |
1581 | @param DestPort The destination UDP port number.\r | |
1582 | @param SrcIp The source IP address.\r | |
1583 | @param SrcPort The source UDP port number.\r | |
1584 | @param HeaderSize An optional field which may be set to the length of a header at\r | |
e2851998 | 1585 | HeaderPtr to be prefixed to the data at BufferPtr.\r |
f737cfb9 | 1586 | @param HeaderPtr If HeaderSize is not NULL, a pointer to a header to be prefixed to the\r |
e2851998 | 1587 | data at BufferPtr.\r |
f737cfb9 | 1588 | @param BufferSize A pointer to the size of the data at BufferPtr.\r |
1589 | @param BufferPtr A pointer to the data to be read.\r | |
e2851998 | 1590 | \r |
f737cfb9 | 1591 | @retval EFI_SUCCESS The UDP Read operation was completed.\r |
1592 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
e2851998 | 1593 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
f737cfb9 | 1594 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r |
1595 | @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.\r | |
1596 | @retval EFI_ABORTED The callback function aborted the UDP Read operation.\r | |
e2851998 | 1597 | @retval EFI_TIMEOUT The UDP Read operation timed out.\r |
1598 | \r | |
dc361cc5 | 1599 | **/\r |
1600 | EFI_STATUS\r | |
1601 | EFIAPI\r | |
1602 | EfiPxeBcUdpRead (\r | |
f737cfb9 | 1603 | IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r |
1604 | IN UINT16 OpFlags,\r | |
1605 | IN OUT EFI_IP_ADDRESS *DestIp OPTIONAL,\r | |
1606 | IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,\r | |
1607 | IN OUT EFI_IP_ADDRESS *SrcIp OPTIONAL,\r | |
1608 | IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,\r | |
1609 | IN UINTN *HeaderSize OPTIONAL,\r | |
1610 | IN VOID *HeaderPtr OPTIONAL,\r | |
1611 | IN OUT UINTN *BufferSize,\r | |
1612 | IN VOID *BufferPtr\r | |
dc361cc5 | 1613 | )\r |
1614 | {\r | |
1615 | PXEBC_PRIVATE_DATA *Private;\r | |
1616 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
1617 | EFI_UDP4_PROTOCOL *Udp4;\r | |
1618 | EFI_UDP4_COMPLETION_TOKEN Token;\r | |
1619 | EFI_UDP4_RECEIVE_DATA *RxData;\r | |
1620 | EFI_UDP4_SESSION_DATA *Session;\r | |
1621 | EFI_STATUS Status;\r | |
1622 | BOOLEAN IsDone;\r | |
1623 | BOOLEAN Matched;\r | |
1624 | UINTN CopyLen;\r | |
1625 | \r | |
1626 | if (This == NULL || DestIp == NULL || DestPort == NULL) {\r | |
1627 | return EFI_INVALID_PARAMETER;\r | |
1628 | }\r | |
1629 | \r | |
f737cfb9 | 1630 | if (((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && (DestPort == NULL)) ||\r |
1631 | ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) == 0 && (SrcIp == NULL)) ||\r | |
1632 | ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) == 0 && (SrcPort == NULL))) {\r | |
dc361cc5 | 1633 | return EFI_INVALID_PARAMETER;\r |
1634 | }\r | |
1635 | \r | |
8792362f | 1636 | if (((HeaderSize != NULL) && (*HeaderSize == 0)) || ((HeaderSize != NULL) && (HeaderPtr == NULL))) {\r |
dc361cc5 | 1637 | return EFI_INVALID_PARAMETER;\r |
1638 | }\r | |
1639 | \r | |
29a4f92d | 1640 | if ((BufferSize == NULL) || (BufferPtr == NULL)) {\r |
dc361cc5 | 1641 | return EFI_INVALID_PARAMETER;\r |
1642 | }\r | |
1643 | \r | |
1644 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
1645 | Mode = Private->PxeBc.Mode;\r | |
8792362f | 1646 | Udp4 = Private->Udp4Read;\r |
dc361cc5 | 1647 | \r |
1648 | if (!Mode->Started) {\r | |
1649 | return EFI_NOT_STARTED;\r | |
1650 | }\r | |
1651 | \r | |
982a9eae | 1652 | Mode->IcmpErrorReceived = FALSE;\r |
1653 | \r | |
dc361cc5 | 1654 | Status = gBS->CreateEvent (\r |
1655 | EVT_NOTIFY_SIGNAL,\r | |
e48e37fc | 1656 | TPL_NOTIFY,\r |
dc361cc5 | 1657 | PxeBcCommonNotify,\r |
1658 | &IsDone,\r | |
1659 | &Token.Event\r | |
1660 | );\r | |
1661 | if (EFI_ERROR (Status)) {\r | |
1662 | return EFI_OUT_OF_RESOURCES;\r | |
1663 | }\r | |
1664 | \r | |
8792362f | 1665 | TRY_AGAIN:\r |
1666 | \r | |
dc361cc5 | 1667 | IsDone = FALSE;\r |
1668 | Status = Udp4->Receive (Udp4, &Token);\r | |
1669 | if (EFI_ERROR (Status)) {\r | |
982a9eae | 1670 | if (Status == EFI_ICMP_ERROR) {\r |
1671 | Mode->IcmpErrorReceived = TRUE;\r | |
1672 | }\r | |
dc361cc5 | 1673 | goto ON_EXIT;\r |
1674 | }\r | |
1675 | \r | |
1676 | Udp4->Poll (Udp4);\r | |
1677 | \r | |
1678 | if (!IsDone) {\r | |
1679 | Status = EFI_TIMEOUT;\r | |
1680 | } else {\r | |
1681 | \r | |
1682 | //\r | |
1683 | // check whether this packet matches the filters\r | |
1684 | //\r | |
1685 | if (EFI_ERROR (Token.Status)){\r | |
1686 | goto ON_EXIT;\r | |
1687 | }\r | |
1688 | \r | |
1689 | RxData = Token.Packet.RxData;\r | |
1690 | Session = &RxData->UdpSession;\r | |
1691 | \r | |
319075ff | 1692 | Matched = TRUE;\r |
dc361cc5 | 1693 | \r |
f737cfb9 | 1694 | if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_USE_FILTER) != 0) {\r |
319075ff | 1695 | Matched = FALSE;\r |
8d285ec0 | 1696 | //\r |
1697 | // Check UDP package by IP filter settings\r | |
1698 | //\r | |
1699 | if (CheckIpByFilter (Mode, Session)) {\r | |
1700 | Matched = TRUE;\r | |
dc361cc5 | 1701 | }\r |
8d285ec0 | 1702 | }\r |
1703 | \r | |
1704 | if (Matched) {\r | |
8792362f | 1705 | Matched = FALSE;\r |
1706 | \r | |
8d285ec0 | 1707 | //\r |
1708 | // Match the destination ip of the received udp dgram\r | |
1709 | //\r | |
f737cfb9 | 1710 | if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_IP) != 0) {\r |
8d285ec0 | 1711 | Matched = TRUE;\r |
1712 | \r | |
1713 | if (DestIp != NULL) {\r | |
1714 | CopyMem (DestIp, &Session->DestinationAddress, sizeof (EFI_IPv4_ADDRESS));\r | |
dc361cc5 | 1715 | }\r |
1716 | } else {\r | |
8d285ec0 | 1717 | if (DestIp != NULL) {\r |
1718 | if (EFI_IP4_EQUAL (DestIp, &Session->DestinationAddress)) {\r | |
1719 | Matched = TRUE;\r | |
1720 | }\r | |
1721 | } else {\r | |
1722 | if (EFI_IP4_EQUAL (&Private->StationIp, &Session->DestinationAddress)) {\r | |
1723 | Matched = TRUE;\r | |
1724 | }\r | |
dc361cc5 | 1725 | }\r |
1726 | }\r | |
1727 | }\r | |
1728 | \r | |
1729 | if (Matched) {\r | |
1730 | //\r | |
1731 | // Match the destination port of the received udp dgram\r | |
1732 | //\r | |
f737cfb9 | 1733 | if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) != 0) {\r |
dc361cc5 | 1734 | \r |
1735 | if (DestPort != NULL) {\r | |
1736 | *DestPort = Session->DestinationPort;\r | |
1737 | }\r | |
1738 | } else {\r | |
1739 | \r | |
1740 | if (*DestPort != Session->DestinationPort) {\r | |
1741 | Matched = FALSE;\r | |
1742 | }\r | |
1743 | }\r | |
1744 | }\r | |
1745 | \r | |
1746 | if (Matched) {\r | |
1747 | //\r | |
1748 | // Match the source ip of the received udp dgram\r | |
1749 | //\r | |
f737cfb9 | 1750 | if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP) != 0) {\r |
dc361cc5 | 1751 | \r |
1752 | if (SrcIp != NULL) {\r | |
e48e37fc | 1753 | CopyMem (SrcIp, &Session->SourceAddress, sizeof (EFI_IPv4_ADDRESS));\r |
dc361cc5 | 1754 | }\r |
1755 | } else {\r | |
1756 | \r | |
1757 | if (!EFI_IP4_EQUAL (SrcIp, &Session->SourceAddress)) {\r | |
1758 | Matched = FALSE;\r | |
1759 | }\r | |
1760 | }\r | |
1761 | }\r | |
1762 | \r | |
1763 | if (Matched) {\r | |
1764 | //\r | |
1765 | // Match the source port of the received udp dgram\r | |
1766 | //\r | |
f737cfb9 | 1767 | if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) != 0) {\r |
dc361cc5 | 1768 | \r |
1769 | if (SrcPort != NULL) {\r | |
1770 | *SrcPort = Session->SourcePort;\r | |
1771 | }\r | |
1772 | } else {\r | |
1773 | \r | |
1774 | if (*SrcPort != Session->SourcePort) {\r | |
1775 | Matched = FALSE;\r | |
1776 | }\r | |
1777 | }\r | |
1778 | }\r | |
1779 | \r | |
1780 | if (Matched) {\r | |
1781 | \r | |
1782 | CopyLen = 0;\r | |
1783 | \r | |
1784 | if (HeaderSize != NULL) {\r | |
1785 | CopyLen = MIN (*HeaderSize, RxData->DataLength);\r | |
e48e37fc | 1786 | CopyMem (HeaderPtr, RxData->FragmentTable[0].FragmentBuffer, CopyLen);\r |
dc361cc5 | 1787 | *HeaderSize = CopyLen;\r |
1788 | }\r | |
1789 | \r | |
1790 | if (RxData->DataLength - CopyLen > *BufferSize) {\r | |
1791 | \r | |
1792 | Status = EFI_BUFFER_TOO_SMALL;\r | |
1793 | } else {\r | |
1794 | \r | |
1795 | *BufferSize = RxData->DataLength - CopyLen;\r | |
f737cfb9 | 1796 | CopyMem (\r |
e2851998 | 1797 | BufferPtr,\r |
1798 | (UINT8 *) RxData->FragmentTable[0].FragmentBuffer + CopyLen,\r | |
f737cfb9 | 1799 | *BufferSize\r |
1800 | );\r | |
dc361cc5 | 1801 | }\r |
1802 | } else {\r | |
1803 | \r | |
1804 | Status = EFI_TIMEOUT;\r | |
1805 | }\r | |
1806 | \r | |
1807 | //\r | |
1808 | // Recycle the RxData\r | |
1809 | //\r | |
1810 | gBS->SignalEvent (RxData->RecycleSignal);\r | |
8792362f | 1811 | \r |
1812 | if (!Matched) {\r | |
1813 | goto TRY_AGAIN;\r | |
1814 | }\r | |
dc361cc5 | 1815 | }\r |
1816 | \r | |
1817 | ON_EXIT:\r | |
1818 | \r | |
1819 | Udp4->Cancel (Udp4, &Token);\r | |
1820 | \r | |
1821 | gBS->CloseEvent (Token.Event);\r | |
1822 | \r | |
1823 | return Status;\r | |
1824 | }\r | |
1825 | \r | |
e2851998 | 1826 | /**\r |
f737cfb9 | 1827 | Updates the IP receive filters of a network device and enables software filtering.\r |
e2851998 | 1828 | \r |
f737cfb9 | 1829 | The NewFilter field is used to modify the network device's current IP receive\r |
1830 | filter settings and to enable a software filter. This function updates the IpFilter\r | |
1831 | field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.\r | |
1832 | The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().\r | |
1833 | The current hardware filter remains in effect no matter what the settings of OpFlags\r | |
1834 | are, so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those\r | |
1835 | packets whose reception is enabled in hardware-physical NIC address (unicast),\r | |
1836 | broadcast address, logical address or addresses (multicast), or all (promiscuous).\r | |
1837 | UdpRead() does not modify the IP filter settings.\r | |
1838 | Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive\r | |
1839 | filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.\r | |
1840 | If an application or driver wishes to preserve the IP receive filter settings,\r | |
1841 | it will have to preserve the IP receive filter settings before these calls, and\r | |
1842 | use SetIpFilter() to restore them after the calls. If incompatible filtering is\r | |
1843 | requested (for example, PROMISCUOUS with anything else) or if the device does not\r | |
1844 | support a requested filter setting and it cannot be accommodated in software\r | |
1845 | (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.\r | |
1846 | The IPlist field is used to enable IPs other than the StationIP. They may be\r | |
1847 | multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,\r | |
1848 | then both the StationIP and the IPs from the IPlist will be used.\r | |
e2851998 | 1849 | \r |
f737cfb9 | 1850 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
1851 | @param NewFilter Pointer to the new set of IP receive filters.\r | |
e2851998 | 1852 | \r |
f737cfb9 | 1853 | @retval EFI_SUCCESS The IP receive filter settings were updated.\r |
1854 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
e2851998 | 1855 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
1856 | \r | |
dc361cc5 | 1857 | **/\r |
1858 | EFI_STATUS\r | |
1859 | EFIAPI\r | |
1860 | EfiPxeBcSetIpFilter (\r | |
1861 | IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r | |
1862 | IN EFI_PXE_BASE_CODE_IP_FILTER *NewFilter\r | |
1863 | )\r | |
1864 | {\r | |
8d285ec0 | 1865 | EFI_STATUS Status;\r |
1866 | PXEBC_PRIVATE_DATA *Private;\r | |
1867 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
1868 | UINTN Index;\r | |
1869 | BOOLEAN PromiscuousNeed;\r | |
1870 | \r | |
1871 | if (This == NULL) {\r | |
894d038a | 1872 | DEBUG ((EFI_D_ERROR, "This == NULL.\n"));\r |
8d285ec0 | 1873 | return EFI_INVALID_PARAMETER;\r |
1874 | }\r | |
1875 | \r | |
1876 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
1877 | Mode = Private->PxeBc.Mode;\r | |
1878 | \r | |
894d038a | 1879 | if (NewFilter == NULL) {\r |
1880 | DEBUG ((EFI_D_ERROR, "NewFilter == NULL.\n"));\r | |
8d285ec0 | 1881 | return EFI_INVALID_PARAMETER;\r |
1882 | }\r | |
1883 | \r | |
894d038a | 1884 | if (NewFilter->IpCnt > EFI_PXE_BASE_CODE_MAX_IPCNT) {\r |
1885 | DEBUG ((EFI_D_ERROR, "NewFilter->IpCnt > %d.\n", EFI_PXE_BASE_CODE_MAX_IPCNT));\r | |
8d285ec0 | 1886 | return EFI_INVALID_PARAMETER;\r |
1887 | }\r | |
1888 | \r | |
1889 | if (!Mode->Started) {\r | |
1890 | DEBUG ((EFI_D_ERROR, "BC was not started.\n"));\r | |
1891 | return EFI_NOT_STARTED;\r | |
1892 | }\r | |
1893 | \r | |
1894 | PromiscuousNeed = FALSE;\r | |
894d038a | 1895 | \r |
8d285ec0 | 1896 | for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r |
1897 | if (IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter->IpList[Index].v4))) {\r | |
1898 | //\r | |
1899 | // The IP is a broadcast address.\r | |
1900 | //\r | |
1901 | DEBUG ((EFI_D_ERROR, "There is broadcast address in NewFilter.\n"));\r | |
1902 | return EFI_INVALID_PARAMETER;\r | |
1903 | }\r | |
f6b7393c | 1904 | if (NetIp4IsUnicast (EFI_IP4 (NewFilter->IpList[Index].v4), 0) &&\r |
e2851998 | 1905 | ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0)\r |
8d285ec0 | 1906 | ) {\r |
1907 | //\r | |
1908 | // If EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP is set and IP4 address is in IpList,\r | |
1909 | // promiscuous mode is needed.\r | |
1910 | //\r | |
1911 | PromiscuousNeed = TRUE;\r | |
1912 | }\r | |
1913 | }\r | |
1914 | \r | |
1915 | //\r | |
1916 | // Clear the UDP instance configuration, all joined groups will be left\r | |
1917 | // during the operation.\r | |
1918 | //\r | |
8792362f | 1919 | Private->Udp4Read->Configure (Private->Udp4Read, NULL);\r |
8d285ec0 | 1920 | Private->Udp4CfgData.AcceptPromiscuous = FALSE;\r |
1921 | Private->Udp4CfgData.AcceptBroadcast = FALSE;\r | |
1922 | \r | |
1923 | if (PromiscuousNeed ||\r | |
e2851998 | 1924 | ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0) ||\r |
1925 | ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0)\r | |
8d285ec0 | 1926 | ) {\r |
1927 | //\r | |
1928 | // Configure the udp4 filter to receive all packages\r | |
1929 | //\r | |
1930 | Private->Udp4CfgData.AcceptPromiscuous = TRUE;\r | |
1931 | \r | |
1932 | //\r | |
1933 | // Configure the UDP instance with the new configuration.\r | |
1934 | //\r | |
8792362f | 1935 | Status = Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r |
8d285ec0 | 1936 | if (EFI_ERROR (Status)) {\r |
1937 | return Status;\r | |
1938 | }\r | |
1939 | \r | |
1940 | } else {\r | |
1941 | \r | |
e2851998 | 1942 | if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) {\r |
8d285ec0 | 1943 | //\r |
1944 | // Configure the udp4 filter to receive all broadcast packages\r | |
1945 | //\r | |
1946 | Private->Udp4CfgData.AcceptBroadcast = TRUE;\r | |
1947 | }\r | |
1948 | \r | |
1949 | //\r | |
1950 | // Configure the UDP instance with the new configuration.\r | |
1951 | //\r | |
8792362f | 1952 | Status = Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);\r |
8d285ec0 | 1953 | if (EFI_ERROR (Status)) {\r |
1954 | return Status;\r | |
1955 | }\r | |
1956 | \r | |
e2851998 | 1957 | if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) {\r |
8d285ec0 | 1958 | \r |
1959 | for (Index = 0; Index < NewFilter->IpCnt; ++Index) {\r | |
1960 | if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {\r | |
1961 | //\r | |
1962 | // Join the mutilcast group\r | |
1963 | //\r | |
8792362f | 1964 | Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);\r |
8d285ec0 | 1965 | if (EFI_ERROR (Status)) {\r |
1966 | return Status;\r | |
1967 | }\r | |
1968 | }\r | |
1969 | }\r | |
1970 | }\r | |
1971 | }\r | |
1972 | \r | |
1973 | \r | |
1974 | //\r | |
1975 | // Save the new filter.\r | |
1976 | //\r | |
1977 | CopyMem (&Mode->IpFilter, NewFilter, sizeof (Mode->IpFilter));\r | |
1978 | \r | |
1979 | return EFI_SUCCESS;\r | |
dc361cc5 | 1980 | }\r |
1981 | \r | |
1982 | \r | |
e2851998 | 1983 | /**\r |
f737cfb9 | 1984 | Uses the ARP protocol to resolve a MAC address.\r |
e2851998 | 1985 | \r |
f737cfb9 | 1986 | This function uses the ARP protocol to resolve a MAC address. The UsingIpv6 field\r |
1987 | of the EFI_PXE_BASE_CODE_MODE structure is used to determine if IPv4 or IPv6\r | |
1988 | addresses are being used. The IP address specified by IpAddr is used to resolve\r | |
1989 | a MAC address. If the ARP protocol succeeds in resolving the specified address,\r | |
1990 | then the ArpCacheEntries and ArpCache fields of the EFI_PXE_BASE_CODE_MODE structure\r | |
1991 | are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved\r | |
e2851998 | 1992 | MAC address is placed there as well. If the PXE Base Code protocol is in the\r |
1993 | stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters\r | |
1994 | a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is\r | |
1995 | returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r | |
f737cfb9 | 1996 | then EFI_ABORTED is returned.\r |
e2851998 | 1997 | \r |
f737cfb9 | 1998 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
1999 | @param IpAddr Pointer to the IP address that is used to resolve a MAC address.\r | |
2000 | @param MacAddr If not NULL, a pointer to the MAC address that was resolved with the\r | |
e2851998 | 2001 | ARP protocol.\r |
2002 | \r | |
f737cfb9 | 2003 | @retval EFI_SUCCESS The IP or MAC address was resolved.\r |
2004 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
e2851998 | 2005 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
2006 | @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.\r | |
2007 | @retval EFI_ICMP_ERROR Something error occur with the ICMP packet message.\r | |
2008 | \r | |
dc361cc5 | 2009 | **/\r |
2010 | EFI_STATUS\r | |
2011 | EFIAPI\r | |
2012 | EfiPxeBcArp (\r | |
2013 | IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r | |
2014 | IN EFI_IP_ADDRESS * IpAddr,\r | |
2015 | IN EFI_MAC_ADDRESS * MacAddr OPTIONAL\r | |
2016 | )\r | |
2017 | {\r | |
8d285ec0 | 2018 | PXEBC_PRIVATE_DATA *Private;\r |
2019 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
2020 | EFI_STATUS Status;\r | |
2021 | EFI_MAC_ADDRESS TempMacAddr;\r | |
2022 | \r | |
2023 | if (This == NULL || IpAddr == NULL) {\r | |
2024 | return EFI_INVALID_PARAMETER;\r | |
2025 | }\r | |
2026 | \r | |
2027 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
2028 | Mode = Private->PxeBc.Mode;\r | |
2029 | \r | |
2030 | if (!Mode->Started) {\r | |
2031 | return EFI_NOT_STARTED;\r | |
2032 | }\r | |
2033 | \r | |
2034 | if (!Private->AddressIsOk || Mode->UsingIpv6) {\r | |
2035 | //\r | |
2036 | // We can't resolve the IP address if we don't have a local address now.\r | |
2037 | // Don't have ARP for IPv6.\r | |
2038 | //\r | |
2039 | return EFI_INVALID_PARAMETER;\r | |
2040 | }\r | |
2041 | \r | |
982a9eae | 2042 | Mode->IcmpErrorReceived = FALSE;\r |
2043 | \r | |
2044 | if (!Mode->AutoArp) {\r | |
2045 | //\r | |
2046 | // If AutoArp is set false, check arp cache\r | |
2047 | //\r | |
2048 | UpdateArpCache (This);\r | |
2049 | if (!FindInArpCache (Mode, &IpAddr->v4, &TempMacAddr)) {\r | |
2050 | return EFI_DEVICE_ERROR;\r | |
2051 | }\r | |
2052 | } else {\r | |
2053 | Status = Private->Arp->Request (Private->Arp, &IpAddr->v4, NULL, &TempMacAddr);\r | |
2054 | if (EFI_ERROR (Status)) {\r | |
2055 | if (Status == EFI_ICMP_ERROR) {\r | |
2056 | Mode->IcmpErrorReceived = TRUE;\r | |
2057 | }\r | |
2058 | return Status;\r | |
2059 | }\r | |
8d285ec0 | 2060 | }\r |
2061 | \r | |
2062 | if (MacAddr != NULL) {\r | |
2063 | CopyMem (MacAddr, &TempMacAddr, sizeof (EFI_MAC_ADDRESS));\r | |
2064 | }\r | |
2065 | \r | |
2066 | return EFI_SUCCESS;\r | |
dc361cc5 | 2067 | }\r |
2068 | \r | |
e2851998 | 2069 | /**\r |
f737cfb9 | 2070 | Updates the parameters that affect the operation of the PXE Base Code Protocol.\r |
e2851998 | 2071 | \r |
f737cfb9 | 2072 | This function sets parameters that affect the operation of the PXE Base Code Protocol.\r |
2073 | The parameter specified by NewAutoArp is used to control the generation of ARP\r | |
2074 | protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated\r | |
2075 | as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP\r | |
2076 | Protocol packets will be generated. In this case, the only mappings that are\r | |
2077 | available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.\r | |
2078 | If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol\r | |
2079 | service, then the service will fail. This function updates the AutoArp field of\r | |
2080 | the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.\r | |
2081 | The SetParameters() call must be invoked after a Callback Protocol is installed\r | |
2082 | to enable the use of callbacks.\r | |
e2851998 | 2083 | \r |
f737cfb9 | 2084 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
2085 | @param NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the\r | |
e2851998 | 2086 | current value of AutoARP.\r |
f737cfb9 | 2087 | @param NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the\r |
e2851998 | 2088 | current value of SendGUID.\r |
f737cfb9 | 2089 | @param NewTTL If not NULL, a pointer to be used in place of the current value of TTL,\r |
e2851998 | 2090 | the "time to live" field of the IP header.\r |
f737cfb9 | 2091 | @param NewToS If not NULL, a pointer to be used in place of the current value of ToS,\r |
e2851998 | 2092 | the "type of service" field of the IP header.\r |
f737cfb9 | 2093 | @param NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the\r |
e2851998 | 2094 | current value of the MakeCallback field of the Mode structure.\r |
2095 | \r | |
f737cfb9 | 2096 | @retval EFI_SUCCESS The new parameters values were updated.\r |
2097 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
e2851998 | 2098 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
2099 | \r | |
dc361cc5 | 2100 | **/\r |
2101 | EFI_STATUS\r | |
2102 | EFIAPI\r | |
2103 | EfiPxeBcSetParameters (\r | |
2104 | IN EFI_PXE_BASE_CODE_PROTOCOL *This,\r | |
f737cfb9 | 2105 | IN BOOLEAN *NewAutoArp OPTIONAL,\r |
2106 | IN BOOLEAN *NewSendGUID OPTIONAL,\r | |
2107 | IN UINT8 *NewTTL OPTIONAL,\r | |
2108 | IN UINT8 *NewToS OPTIONAL,\r | |
dc361cc5 | 2109 | IN BOOLEAN *NewMakeCallback // OPTIONAL\r |
2110 | )\r | |
2111 | {\r | |
2112 | PXEBC_PRIVATE_DATA *Private;\r | |
2113 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
2114 | EFI_STATUS Status;\r | |
2115 | \r | |
2116 | Status = EFI_SUCCESS;\r | |
2117 | \r | |
2118 | if (This == NULL) {\r | |
2119 | Status = EFI_INVALID_PARAMETER;\r | |
2120 | goto ON_EXIT;\r | |
2121 | }\r | |
2122 | \r | |
2123 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
2124 | Mode = Private->PxeBc.Mode;\r | |
2125 | \r | |
f737cfb9 | 2126 | if (NewSendGUID != NULL && *NewSendGUID) {\r |
dc361cc5 | 2127 | //\r |
2128 | // FixMe, cann't locate SendGuid\r | |
2129 | //\r | |
2130 | }\r | |
2131 | \r | |
f737cfb9 | 2132 | if (NewMakeCallback != NULL && *NewMakeCallback) {\r |
dc361cc5 | 2133 | \r |
2134 | Status = gBS->HandleProtocol (\r | |
2135 | Private->Controller,\r | |
2136 | &gEfiPxeBaseCodeCallbackProtocolGuid,\r | |
2137 | (VOID **) &Private->PxeBcCallback\r | |
2138 | );\r | |
2139 | if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {\r | |
2140 | \r | |
2141 | Status = EFI_INVALID_PARAMETER;\r | |
2142 | goto ON_EXIT;\r | |
2143 | }\r | |
2144 | }\r | |
2145 | \r | |
2146 | if (!Mode->Started) {\r | |
2147 | Status = EFI_NOT_STARTED;\r | |
2148 | goto ON_EXIT;\r | |
2149 | }\r | |
2150 | \r | |
2151 | if (NewMakeCallback != NULL) {\r | |
2152 | \r | |
2153 | if (*NewMakeCallback) {\r | |
2154 | //\r | |
2155 | // Update the Callback protocol.\r | |
2156 | //\r | |
2157 | Status = gBS->HandleProtocol (\r | |
2158 | Private->Controller,\r | |
2159 | &gEfiPxeBaseCodeCallbackProtocolGuid,\r | |
2160 | (VOID **) &Private->PxeBcCallback\r | |
2161 | );\r | |
2162 | \r | |
2163 | if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {\r | |
2164 | Status = EFI_INVALID_PARAMETER;\r | |
2165 | goto ON_EXIT;\r | |
2166 | }\r | |
2167 | } else {\r | |
2168 | Private->PxeBcCallback = NULL;\r | |
2169 | }\r | |
2170 | \r | |
2171 | Mode->MakeCallbacks = *NewMakeCallback;\r | |
2172 | }\r | |
2173 | \r | |
2174 | if (NewAutoArp != NULL) {\r | |
2175 | Mode->AutoArp = *NewAutoArp;\r | |
2176 | }\r | |
2177 | \r | |
2178 | if (NewSendGUID != NULL) {\r | |
2179 | Mode->SendGUID = *NewSendGUID;\r | |
2180 | }\r | |
2181 | \r | |
2182 | if (NewTTL != NULL) {\r | |
2183 | Mode->TTL = *NewTTL;\r | |
2184 | }\r | |
2185 | \r | |
2186 | if (NewToS != NULL) {\r | |
2187 | Mode->ToS = *NewToS;\r | |
2188 | }\r | |
2189 | \r | |
2190 | ON_EXIT:\r | |
2191 | return Status;\r | |
2192 | }\r | |
2193 | \r | |
e2851998 | 2194 | /**\r |
f737cfb9 | 2195 | Updates the station IP address and/or subnet mask values of a network device.\r |
e2851998 | 2196 | \r |
f737cfb9 | 2197 | This function updates the station IP address and/or subnet mask values of a network\r |
2198 | device. The NewStationIp field is used to modify the network device's current IP address.\r | |
2199 | If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,\r | |
2200 | this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure\r | |
2201 | with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet\r | |
2202 | mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.\r | |
2203 | Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE\r | |
2204 | structure with NewSubnetMask.\r | |
e2851998 | 2205 | \r |
f737cfb9 | 2206 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
e2851998 | 2207 | @param NewStationIp Pointer to the new IP address to be used by the network device.\r |
2208 | @param NewSubnetMask Pointer to the new subnet mask to be used by the network device.\r | |
2209 | \r | |
f737cfb9 | 2210 | @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.\r |
2211 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
e2851998 | 2212 | @retval EFI_INVALID_PARAMETER One or more parameters are invalid.\r |
2213 | \r | |
dc361cc5 | 2214 | **/\r |
2215 | EFI_STATUS\r | |
2216 | EFIAPI\r | |
2217 | EfiPxeBcSetStationIP (\r | |
2218 | IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r | |
f737cfb9 | 2219 | IN EFI_IP_ADDRESS * NewStationIp OPTIONAL,\r |
dc361cc5 | 2220 | IN EFI_IP_ADDRESS * NewSubnetMask OPTIONAL\r |
2221 | )\r | |
2222 | {\r | |
2223 | PXEBC_PRIVATE_DATA *Private;\r | |
2224 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
8d285ec0 | 2225 | EFI_ARP_CONFIG_DATA ArpConfigData;\r |
dc361cc5 | 2226 | \r |
2227 | if (This == NULL) {\r | |
2228 | return EFI_INVALID_PARAMETER;\r | |
2229 | }\r | |
2230 | \r | |
f6b7393c | 2231 | if (NewStationIp != NULL && !NetIp4IsUnicast (NTOHL (NewStationIp->Addr[0]), 0)) {\r |
dc361cc5 | 2232 | return EFI_INVALID_PARAMETER;\r |
2233 | }\r | |
2234 | \r | |
2235 | if (NewSubnetMask != NULL && !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask->Addr[0]))) {\r | |
2236 | return EFI_INVALID_PARAMETER;\r | |
2237 | }\r | |
2238 | \r | |
2239 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
2240 | Mode = Private->PxeBc.Mode;\r | |
2241 | \r | |
2242 | if (!Mode->Started) {\r | |
2243 | return EFI_NOT_STARTED;\r | |
2244 | }\r | |
2245 | \r | |
2246 | if (NewStationIp != NULL) {\r | |
555e76f8 | 2247 | CopyMem (&Mode->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));\r |
2248 | CopyMem (&Private->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));\r | |
dc361cc5 | 2249 | }\r |
2250 | \r | |
2251 | if (NewSubnetMask != NULL) {\r | |
555e76f8 | 2252 | CopyMem (&Mode->SubnetMask, NewSubnetMask, sizeof (EFI_IP_ADDRESS));\r |
2253 | CopyMem (&Private->SubnetMask ,NewSubnetMask, sizeof (EFI_IP_ADDRESS));\r | |
dc361cc5 | 2254 | }\r |
2255 | \r | |
2256 | Private->AddressIsOk = TRUE;\r | |
2257 | \r | |
8d285ec0 | 2258 | if (!Mode->UsingIpv6) {\r |
2259 | //\r | |
2260 | // If in IPv4 mode, configure the corresponding ARP with this new\r | |
2261 | // station IP address.\r | |
2262 | //\r | |
2263 | ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));\r | |
2264 | \r | |
2265 | ArpConfigData.SwAddressType = 0x0800;\r | |
2266 | ArpConfigData.SwAddressLength = sizeof (EFI_IPv4_ADDRESS);\r | |
2267 | ArpConfigData.StationAddress = &Private->StationIp.v4;\r | |
2268 | \r | |
2269 | Private->Arp->Configure (Private->Arp, NULL);\r | |
2270 | Private->Arp->Configure (Private->Arp, &ArpConfigData);\r | |
982a9eae | 2271 | \r |
2272 | //\r | |
2273 | // Update the route table.\r | |
2274 | //\r | |
2275 | Mode->RouteTableEntries = 1;\r | |
2276 | Mode->RouteTable[0].IpAddr.Addr[0] = Private->StationIp.Addr[0] & Private->SubnetMask.Addr[0];\r | |
2277 | Mode->RouteTable[0].SubnetMask.Addr[0] = Private->SubnetMask.Addr[0];\r | |
2278 | Mode->RouteTable[0].GwAddr.Addr[0] = 0;\r | |
8d285ec0 | 2279 | }\r |
2280 | \r | |
dc361cc5 | 2281 | return EFI_SUCCESS;\r |
2282 | }\r | |
2283 | \r | |
e2851998 | 2284 | /**\r |
f737cfb9 | 2285 | Updates the contents of the cached DHCP and Discover packets.\r |
e2851998 | 2286 | \r |
f737cfb9 | 2287 | The pointers to the new packets are used to update the contents of the cached\r |
2288 | packets in the EFI_PXE_BASE_CODE_MODE structure.\r | |
e2851998 | 2289 | \r |
f737cfb9 | 2290 | @param This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.\r |
2291 | @param NewDhcpDiscoverValid Pointer to a value that will replace the current\r | |
e2851998 | 2292 | DhcpDiscoverValid field.\r |
f737cfb9 | 2293 | @param NewDhcpAckReceived Pointer to a value that will replace the current\r |
e2851998 | 2294 | DhcpAckReceived field.\r |
f737cfb9 | 2295 | @param NewProxyOfferReceived Pointer to a value that will replace the current\r |
e2851998 | 2296 | ProxyOfferReceived field.\r |
2297 | @param NewPxeDiscoverValid Pointer to a value that will replace the current\r | |
2298 | ProxyOfferReceived field.\r | |
f737cfb9 | 2299 | @param NewPxeReplyReceived Pointer to a value that will replace the current\r |
e2851998 | 2300 | PxeReplyReceived field.\r |
f737cfb9 | 2301 | @param NewPxeBisReplyReceived Pointer to a value that will replace the current\r |
e2851998 | 2302 | PxeBisReplyReceived field.\r |
2303 | @param NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.\r | |
f737cfb9 | 2304 | @param NewDhcpAck Pointer to the new cached DHCP Ack packet contents.\r |
2305 | @param NewProxyOffer Pointer to the new cached Proxy Offer packet contents.\r | |
2306 | @param NewPxeDiscover Pointer to the new cached PXE Discover packet contents.\r | |
2307 | @param NewPxeReply Pointer to the new cached PXE Reply packet contents.\r | |
2308 | @param NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.\r | |
e2851998 | 2309 | \r |
f737cfb9 | 2310 | @retval EFI_SUCCESS The cached packet contents were updated.\r |
2311 | @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.\r | |
2312 | @retval EFI_INVALID_PARAMETER This is NULL or not point to a valid EFI_PXE_BASE_CODE_PROTOCOL structure.\r | |
e2851998 | 2313 | \r |
dc361cc5 | 2314 | **/\r |
2315 | EFI_STATUS\r | |
2316 | EFIAPI\r | |
2317 | EfiPxeBcSetPackets (\r | |
2318 | IN EFI_PXE_BASE_CODE_PROTOCOL * This,\r | |
f737cfb9 | 2319 | IN BOOLEAN * NewDhcpDiscoverValid OPTIONAL,\r |
2320 | IN BOOLEAN * NewDhcpAckReceived OPTIONAL,\r | |
2321 | IN BOOLEAN * NewProxyOfferReceived OPTIONAL,\r | |
2322 | IN BOOLEAN * NewPxeDiscoverValid OPTIONAL,\r | |
2323 | IN BOOLEAN * NewPxeReplyReceived OPTIONAL,\r | |
2324 | IN BOOLEAN * NewPxeBisReplyReceived OPTIONAL,\r | |
2325 | IN EFI_PXE_BASE_CODE_PACKET * NewDhcpDiscover OPTIONAL,\r | |
2326 | IN EFI_PXE_BASE_CODE_PACKET * NewDhcpAck OPTIONAL,\r | |
2327 | IN EFI_PXE_BASE_CODE_PACKET * NewProxyOffer OPTIONAL,\r | |
2328 | IN EFI_PXE_BASE_CODE_PACKET * NewPxeDiscover OPTIONAL,\r | |
2329 | IN EFI_PXE_BASE_CODE_PACKET * NewPxeReply OPTIONAL,\r | |
dc361cc5 | 2330 | IN EFI_PXE_BASE_CODE_PACKET * NewPxeBisReply OPTIONAL\r |
2331 | )\r | |
2332 | {\r | |
2333 | PXEBC_PRIVATE_DATA *Private;\r | |
2334 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
2335 | \r | |
2336 | if (This == NULL) {\r | |
2337 | return EFI_INVALID_PARAMETER;\r | |
2338 | }\r | |
2339 | \r | |
2340 | Private = PXEBC_PRIVATE_DATA_FROM_PXEBC (This);\r | |
2341 | Mode = Private->PxeBc.Mode;\r | |
2342 | \r | |
2343 | if (!Mode->Started) {\r | |
2344 | return EFI_NOT_STARTED;\r | |
2345 | }\r | |
2346 | \r | |
dc361cc5 | 2347 | if (NewDhcpDiscoverValid != NULL) {\r |
2348 | Mode->DhcpDiscoverValid = *NewDhcpDiscoverValid;\r | |
2349 | }\r | |
2350 | \r | |
2351 | if (NewDhcpAckReceived != NULL) {\r | |
2352 | Mode->DhcpAckReceived = *NewDhcpAckReceived;\r | |
2353 | }\r | |
2354 | \r | |
2355 | if (NewProxyOfferReceived != NULL) {\r | |
2356 | Mode->ProxyOfferReceived = *NewProxyOfferReceived;\r | |
2357 | }\r | |
2358 | \r | |
2359 | if (NewPxeDiscoverValid != NULL) {\r | |
2360 | Mode->PxeDiscoverValid = *NewPxeDiscoverValid;\r | |
2361 | }\r | |
2362 | \r | |
2363 | if (NewPxeReplyReceived != NULL) {\r | |
2364 | Mode->PxeReplyReceived = *NewPxeReplyReceived;\r | |
2365 | }\r | |
2366 | \r | |
2367 | if (NewPxeBisReplyReceived != NULL) {\r | |
2368 | Mode->PxeBisReplyReceived = *NewPxeBisReplyReceived;\r | |
2369 | }\r | |
2370 | \r | |
2371 | if (NewDhcpDiscover != NULL) {\r | |
e48e37fc | 2372 | CopyMem (&Mode->DhcpDiscover, NewDhcpDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));\r |
dc361cc5 | 2373 | }\r |
2374 | \r | |
2375 | if (NewDhcpAck != NULL) {\r | |
e48e37fc | 2376 | CopyMem (&Mode->DhcpAck, NewDhcpAck, sizeof (EFI_PXE_BASE_CODE_PACKET));\r |
dc361cc5 | 2377 | }\r |
2378 | \r | |
2379 | if (NewProxyOffer != NULL) {\r | |
e48e37fc | 2380 | CopyMem (&Mode->ProxyOffer, NewProxyOffer, sizeof (EFI_PXE_BASE_CODE_PACKET));\r |
dc361cc5 | 2381 | }\r |
2382 | \r | |
2383 | if (NewPxeDiscover != NULL) {\r | |
e48e37fc | 2384 | CopyMem (&Mode->PxeDiscover, NewPxeDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));\r |
dc361cc5 | 2385 | }\r |
2386 | \r | |
2387 | if (NewPxeReply != NULL) {\r | |
e48e37fc | 2388 | CopyMem (&Mode->PxeReply, NewPxeReply, sizeof (EFI_PXE_BASE_CODE_PACKET));\r |
dc361cc5 | 2389 | }\r |
2390 | \r | |
2391 | if (NewPxeBisReply != NULL) {\r | |
e48e37fc | 2392 | CopyMem (&Mode->PxeBisReply, NewPxeBisReply, sizeof (EFI_PXE_BASE_CODE_PACKET));\r |
dc361cc5 | 2393 | }\r |
2394 | \r | |
2395 | return EFI_SUCCESS;\r | |
2396 | }\r | |
2397 | \r | |
2398 | EFI_PXE_BASE_CODE_PROTOCOL mPxeBcProtocolTemplate = {\r | |
2399 | EFI_PXE_BASE_CODE_PROTOCOL_REVISION,\r | |
2400 | EfiPxeBcStart,\r | |
2401 | EfiPxeBcStop,\r | |
2402 | EfiPxeBcDhcp,\r | |
2403 | EfiPxeBcDiscover,\r | |
2404 | EfiPxeBcMtftp,\r | |
2405 | EfiPxeBcUdpWrite,\r | |
2406 | EfiPxeBcUdpRead,\r | |
2407 | EfiPxeBcSetIpFilter,\r | |
2408 | EfiPxeBcArp,\r | |
2409 | EfiPxeBcSetParameters,\r | |
2410 | EfiPxeBcSetStationIP,\r | |
2411 | EfiPxeBcSetPackets,\r | |
2412 | NULL\r | |
2413 | };\r | |
2414 | \r | |
e2851998 | 2415 | /**\r |
f737cfb9 | 2416 | Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has\r |
e2851998 | 2417 | received, or is waiting to receive a packet.\r |
2418 | \r | |
f737cfb9 | 2419 | This function is invoked when the PXE Base Code Protocol is about to transmit, has received,\r |
2420 | or is waiting to receive a packet. Parameters Function and Received specify the type of event.\r | |
2421 | Parameters PacketLen and Packet specify the packet that generated the event. If these fields\r | |
2422 | are zero and NULL respectively, then this is a status update callback. If the operation specified\r | |
2423 | by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation\r | |
2424 | specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to\r | |
2425 | the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.\r | |
2426 | The SetParameters() function must be called after a Callback Protocol is installed to enable the\r | |
2427 | use of callbacks.\r | |
e2851998 | 2428 | \r |
f737cfb9 | 2429 | @param This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.\r |
e2851998 | 2430 | @param Function The PXE Base Code Protocol function that is waiting for an event.\r |
f737cfb9 | 2431 | @param Received TRUE if the callback is being invoked due to a receive event. FALSE if\r |
e2851998 | 2432 | the callback is being invoked due to a transmit event.\r |
f737cfb9 | 2433 | @param PacketLength The length, in bytes, of Packet. This field will have a value of zero if\r |
e2851998 | 2434 | this is a wait for receive event.\r |
f737cfb9 | 2435 | @param PacketPtr If Received is TRUE, a pointer to the packet that was just received;\r |
e2851998 | 2436 | otherwise a pointer to the packet that is about to be transmitted.\r |
2437 | \r | |
2438 | @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE if Function specifies a continue operation\r | |
f737cfb9 | 2439 | @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT if Function specifies an abort operation\r |
e2851998 | 2440 | \r |
dc361cc5 | 2441 | **/\r |
2442 | EFI_PXE_BASE_CODE_CALLBACK_STATUS\r | |
2443 | EFIAPI\r | |
2444 | EfiPxeLoadFileCallback (\r | |
2445 | IN EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL * This,\r | |
2446 | IN EFI_PXE_BASE_CODE_FUNCTION Function,\r | |
2447 | IN BOOLEAN Received,\r | |
2448 | IN UINT32 PacketLength,\r | |
2449 | IN EFI_PXE_BASE_CODE_PACKET * PacketPtr OPTIONAL\r | |
2450 | )\r | |
2451 | {\r | |
2452 | EFI_INPUT_KEY Key;\r | |
2453 | EFI_STATUS Status;\r | |
2454 | \r | |
2455 | //\r | |
2456 | // Catch Ctrl-C or ESC to abort.\r | |
2457 | //\r | |
2458 | Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r | |
2459 | \r | |
2460 | if (!EFI_ERROR (Status)) {\r | |
2461 | \r | |
2462 | if (Key.ScanCode == SCAN_ESC || Key.UnicodeChar == (0x1F & 'c')) {\r | |
2463 | \r | |
2464 | return EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT;\r | |
2465 | }\r | |
2466 | }\r | |
2467 | //\r | |
2468 | // No print if receive packet\r | |
2469 | //\r | |
2470 | if (Received) {\r | |
2471 | return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r | |
2472 | }\r | |
2473 | //\r | |
2474 | // Print only for three functions\r | |
2475 | //\r | |
2476 | switch (Function) {\r | |
2477 | \r | |
2478 | case EFI_PXE_BASE_CODE_FUNCTION_MTFTP:\r | |
2479 | //\r | |
2480 | // Print only for open MTFTP packets, not every MTFTP packets\r | |
2481 | //\r | |
2482 | if (PacketLength != 0 && PacketPtr != NULL) {\r | |
2483 | if (PacketPtr->Raw[0x1C] != 0x00 || PacketPtr->Raw[0x1D] != 0x01) {\r | |
2484 | return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r | |
2485 | }\r | |
2486 | }\r | |
2487 | break;\r | |
2488 | \r | |
2489 | case EFI_PXE_BASE_CODE_FUNCTION_DHCP:\r | |
2490 | case EFI_PXE_BASE_CODE_FUNCTION_DISCOVER:\r | |
2491 | break;\r | |
2492 | \r | |
2493 | default:\r | |
2494 | return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r | |
2495 | }\r | |
2496 | \r | |
2497 | if (PacketLength != 0 && PacketPtr != NULL) {\r | |
2498 | //\r | |
2499 | // Print '.' when transmit a packet\r | |
2500 | //\r | |
2501 | AsciiPrint (".");\r | |
2502 | \r | |
2503 | }\r | |
2504 | \r | |
2505 | return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE;\r | |
2506 | }\r | |
2507 | \r | |
2508 | EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL mPxeBcCallBackTemplate = {\r | |
2509 | EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION,\r | |
2510 | EfiPxeLoadFileCallback\r | |
2511 | };\r | |
2512 | \r | |
2513 | \r | |
2514 | /**\r | |
f737cfb9 | 2515 | Find the boot file.\r |
dc361cc5 | 2516 | \r |
e2851998 | 2517 | @param Private Pointer to PxeBc private data.\r |
2518 | @param BufferSize Pointer to buffer size.\r | |
2519 | @param Buffer Pointer to buffer.\r | |
dc361cc5 | 2520 | \r |
f737cfb9 | 2521 | @retval EFI_SUCCESS Discover the boot file successfully.\r |
2522 | @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.\r | |
2523 | @retval EFI_ABORTED PXE bootstrap server, so local boot need abort.\r | |
2524 | @retval EFI_BUFFER_TOO_SMALL The buffer is too small to load the boot file.\r | |
e2851998 | 2525 | \r |
dc361cc5 | 2526 | **/\r |
2527 | EFI_STATUS\r | |
2528 | DiscoverBootFile (\r | |
2529 | IN PXEBC_PRIVATE_DATA *Private,\r | |
2530 | IN OUT UINT64 *BufferSize,\r | |
2531 | IN VOID *Buffer\r | |
2532 | )\r | |
2533 | {\r | |
2534 | EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;\r | |
2535 | EFI_PXE_BASE_CODE_MODE *Mode;\r | |
2536 | EFI_STATUS Status;\r | |
2537 | UINT16 Type;\r | |
2538 | UINT16 Layer;\r | |
2539 | BOOLEAN UseBis;\r | |
dc361cc5 | 2540 | PXEBC_CACHED_DHCP4_PACKET *Packet;\r |
2541 | UINT16 Value;\r | |
2542 | \r | |
2543 | PxeBc = &Private->PxeBc;\r | |
2544 | Mode = PxeBc->Mode;\r | |
2545 | Type = EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP;\r | |
2546 | Layer = EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL;\r | |
2547 | \r | |
2548 | //\r | |
2549 | // do DHCP.\r | |
2550 | //\r | |
2551 | Status = PxeBc->Dhcp (PxeBc, TRUE);\r | |
2552 | if (EFI_ERROR (Status)) {\r | |
2553 | return Status;\r | |
2554 | }\r | |
2555 | \r | |
2556 | //\r | |
2557 | // Select a boot server\r | |
2558 | //\r | |
2559 | Status = PxeBcSelectBootPrompt (Private);\r | |
2560 | \r | |
2561 | if (Status == EFI_SUCCESS) {\r | |
2562 | Status = PxeBcSelectBootMenu (Private, &Type, TRUE);\r | |
2563 | } else if (Status == EFI_TIMEOUT) {\r | |
2564 | Status = PxeBcSelectBootMenu (Private, &Type, FALSE);\r | |
2565 | }\r | |
2566 | \r | |
2567 | if (!EFI_ERROR (Status)) {\r | |
2568 | \r | |
2569 | if (Type == EFI_PXE_BASE_CODE_BOOT_TYPE_BOOTSTRAP) {\r | |
2570 | //\r | |
2571 | // Local boot(PXE bootstrap server) need abort\r | |
2572 | //\r | |
2573 | return EFI_ABORTED;\r | |
2574 | }\r | |
2575 | \r | |
2576 | UseBis = (BOOLEAN) (Mode->BisSupported && Mode->BisDetected);\r | |
2577 | Status = PxeBc->Discover (PxeBc, Type, &Layer, UseBis, NULL);\r | |
2578 | if (EFI_ERROR (Status)) {\r | |
2579 | return Status;\r | |
2580 | }\r | |
2581 | }\r | |
2582 | \r | |
2583 | *BufferSize = 0;\r | |
dc361cc5 | 2584 | \r |
2585 | //\r | |
2586 | // Get bootfile name and (m)tftp server ip addresss\r | |
2587 | //\r | |
2588 | if (Mode->PxeReplyReceived) {\r | |
2589 | Packet = &Private->PxeReply;\r | |
2590 | } else if (Mode->ProxyOfferReceived) {\r | |
2591 | Packet = &Private->ProxyOffer;\r | |
2592 | } else {\r | |
2593 | Packet = &Private->Dhcp4Ack;\r | |
2594 | }\r | |
2595 | \r | |
319075ff | 2596 | //\r |
2ce5c88a | 2597 | // Use siaddr(next server) in DHCPOFFER packet header, if zero, use option 54(server identifier)\r |
2598 | // in DHCPOFFER packet.\r | |
2599 | // (It does not comply with PXE Spec, Ver2.1)\r | |
319075ff | 2600 | //\r |
2ce5c88a | 2601 | if (EFI_IP4_EQUAL (&Packet->Packet.Offer.Dhcp4.Header.ServerAddr, &mZeroIp4Addr)) {\r |
e48e37fc | 2602 | CopyMem (\r |
dc361cc5 | 2603 | &Private->ServerIp,\r |
2604 | Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_SERVER_ID]->Data,\r | |
2605 | sizeof (EFI_IPv4_ADDRESS)\r | |
2606 | );\r | |
319075ff | 2607 | } else {\r |
2608 | CopyMem (\r | |
e2851998 | 2609 | &Private->ServerIp,\r |
2610 | &Packet->Packet.Offer.Dhcp4.Header.ServerAddr,\r | |
319075ff | 2611 | sizeof (EFI_IPv4_ADDRESS)\r |
2612 | );\r | |
2613 | }\r | |
2614 | if (Private->ServerIp.Addr[0] == 0) {\r | |
2615 | return EFI_DEVICE_ERROR;\r | |
dc361cc5 | 2616 | }\r |
2617 | \r | |
2618 | ASSERT (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE] != NULL);\r | |
2619 | \r | |
2620 | //\r | |
2621 | // bootlfile name\r | |
2622 | //\r | |
2623 | Private->BootFileName = (CHAR8 *) (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE]->Data);\r | |
2624 | \r | |
2625 | if (Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN] != NULL) {\r | |
2626 | //\r | |
2627 | // Already have the bootfile length option, compute the file size\r | |
2628 | //\r | |
e48e37fc | 2629 | CopyMem (&Value, Packet->Dhcp4Option[PXEBC_DHCP4_TAG_INDEX_BOOTFILE_LEN]->Data, sizeof (Value));\r |
dc361cc5 | 2630 | Value = NTOHS (Value);\r |
2631 | *BufferSize = 512 * Value;\r | |
2632 | Status = EFI_BUFFER_TOO_SMALL;\r | |
2633 | } else {\r | |
2634 | //\r | |
2635 | // Get the bootfile size from tftp\r | |
2636 | //\r | |
2637 | Status = PxeBc->Mtftp (\r | |
2638 | PxeBc,\r | |
2639 | EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,\r | |
2640 | Buffer,\r | |
2641 | FALSE,\r | |
2642 | BufferSize,\r | |
fa6d3ee4 | 2643 | &Private->BlockSize,\r |
dc361cc5 | 2644 | &Private->ServerIp,\r |
2645 | (UINT8 *) Private->BootFileName,\r | |
2646 | NULL,\r | |
2647 | FALSE\r | |
2648 | );\r | |
2649 | }\r | |
2650 | \r | |
2651 | Private->FileSize = (UINTN) *BufferSize;\r | |
2652 | \r | |
2653 | return Status;\r | |
2654 | }\r | |
2655 | \r | |
dc361cc5 | 2656 | /**\r |
f737cfb9 | 2657 | Causes the driver to load a specified file.\r |
2658 | \r | |
2659 | @param This Protocol instance pointer.\r | |
2660 | @param FilePath The device specific path of the file to load.\r | |
e2851998 | 2661 | @param BootPolicy If TRUE, indicates that the request originates from the\r |
f737cfb9 | 2662 | boot manager is attempting to load FilePath as a boot\r |
2663 | selection. If FALSE, then FilePath must match as exact file\r | |
2664 | to be loaded.\r | |
2665 | @param BufferSize On input the size of Buffer in bytes. On output with a return\r | |
e2851998 | 2666 | code of EFI_SUCCESS, the amount of data transferred to\r |
f737cfb9 | 2667 | Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,\r |
2668 | the size of Buffer required to retrieve the requested file.\r | |
2669 | @param Buffer The memory buffer to transfer the file to. IF Buffer is NULL,\r | |
e2851998 | 2670 | then no the size of the requested file is returned in\r |
f737cfb9 | 2671 | BufferSize.\r |
2672 | \r | |
2673 | @retval EFI_SUCCESS The file was loaded.\r | |
2674 | @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy\r | |
e2851998 | 2675 | @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or\r |
f737cfb9 | 2676 | BufferSize is NULL.\r |
2677 | @retval EFI_NO_MEDIA No medium was present to load the file.\r | |
2678 | @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.\r | |
2679 | @retval EFI_NO_RESPONSE The remote system did not respond.\r | |
2680 | @retval EFI_NOT_FOUND The file was not found.\r | |
2681 | @retval EFI_ABORTED The file load process was manually cancelled.\r | |
dc361cc5 | 2682 | \r |
2683 | **/\r | |
2684 | EFI_STATUS\r | |
2685 | EFIAPI\r | |
2686 | EfiPxeLoadFile (\r | |
2687 | IN EFI_LOAD_FILE_PROTOCOL * This,\r | |
2688 | IN EFI_DEVICE_PATH_PROTOCOL * FilePath,\r | |
2689 | IN BOOLEAN BootPolicy,\r | |
2690 | IN OUT UINTN *BufferSize,\r | |
2691 | IN VOID *Buffer OPTIONAL\r | |
2692 | )\r | |
2693 | {\r | |
2694 | PXEBC_PRIVATE_DATA *Private;\r | |
2695 | EFI_PXE_BASE_CODE_PROTOCOL *PxeBc;\r | |
2696 | BOOLEAN NewMakeCallback;\r | |
dc361cc5 | 2697 | EFI_STATUS Status;\r |
2698 | UINT64 TmpBufSize;\r | |
dd29f3ed | 2699 | BOOLEAN MediaPresent;\r |
dc361cc5 | 2700 | \r |
2701 | Private = PXEBC_PRIVATE_DATA_FROM_LOADFILE (This);\r | |
2702 | PxeBc = &Private->PxeBc;\r | |
2703 | NewMakeCallback = FALSE;\r | |
dc361cc5 | 2704 | Status = EFI_DEVICE_ERROR;\r |
2705 | \r | |
2706 | if (This == NULL || BufferSize == NULL) {\r | |
2707 | \r | |
2708 | return EFI_INVALID_PARAMETER;\r | |
2709 | }\r | |
2710 | \r | |
2711 | //\r | |
2712 | // Only support BootPolicy\r | |
2713 | //\r | |
2714 | if (!BootPolicy) {\r | |
2715 | return EFI_UNSUPPORTED;\r | |
2716 | }\r | |
2717 | \r | |
dd29f3ed | 2718 | //\r |
2719 | // Check media status before PXE start\r | |
2720 | //\r | |
2721 | MediaPresent = TRUE;\r | |
2722 | NetLibDetectMedia (Private->Controller, &MediaPresent);\r | |
2723 | if (!MediaPresent) {\r | |
2724 | return EFI_NO_MEDIA;\r | |
2725 | }\r | |
2726 | \r | |
dc361cc5 | 2727 | Status = PxeBc->Start (PxeBc, FALSE);\r |
2728 | if (EFI_ERROR (Status) && (Status != EFI_ALREADY_STARTED)) {\r | |
2729 | return Status;\r | |
2730 | }\r | |
2731 | \r | |
2732 | Status = gBS->HandleProtocol (\r | |
2733 | Private->Controller,\r | |
2734 | &gEfiPxeBaseCodeCallbackProtocolGuid,\r | |
2735 | (VOID **) &Private->PxeBcCallback\r | |
2736 | );\r | |
2737 | if (Status == EFI_UNSUPPORTED) {\r | |
2738 | \r | |
2739 | CopyMem (&Private->LoadFileCallback, &mPxeBcCallBackTemplate, sizeof (Private->LoadFileCallback));\r | |
2740 | \r | |
2741 | Status = gBS->InstallProtocolInterface (\r | |
2742 | &Private->Controller,\r | |
2743 | &gEfiPxeBaseCodeCallbackProtocolGuid,\r | |
2744 | EFI_NATIVE_INTERFACE,\r | |
2745 | &Private->LoadFileCallback\r | |
2746 | );\r | |
2747 | \r | |
2748 | NewMakeCallback = (BOOLEAN) (Status == EFI_SUCCESS);\r | |
2749 | \r | |
2750 | Status = PxeBc->SetParameters (PxeBc, NULL, NULL, NULL, NULL, &NewMakeCallback);\r | |
2751 | if (EFI_ERROR (Status)) {\r | |
2752 | PxeBc->Stop (PxeBc);\r | |
2753 | return Status;\r | |
2754 | }\r | |
2755 | }\r | |
2756 | \r | |
2757 | if (Private->FileSize == 0) {\r | |
2758 | TmpBufSize = 0;\r | |
2759 | Status = DiscoverBootFile (Private, &TmpBufSize, Buffer);\r | |
2760 | \r | |
2761 | if (sizeof (UINTN) < sizeof (UINT64) && (TmpBufSize > 0xFFFFFFFF)) {\r | |
2762 | Status = EFI_DEVICE_ERROR;\r | |
39941daf | 2763 | } else if (TmpBufSize > 0 && *BufferSize >= (UINTN) TmpBufSize && Buffer != NULL) {\r |
319075ff | 2764 | *BufferSize = (UINTN) TmpBufSize;\r |
2765 | Status = PxeBc->Mtftp (\r | |
2766 | PxeBc,\r | |
2767 | EFI_PXE_BASE_CODE_TFTP_READ_FILE,\r | |
2768 | Buffer,\r | |
2769 | FALSE,\r | |
2770 | &TmpBufSize,\r | |
fa6d3ee4 | 2771 | &Private->BlockSize,\r |
319075ff | 2772 | &Private->ServerIp,\r |
2773 | (UINT8 *) Private->BootFileName,\r | |
2774 | NULL,\r | |
2775 | FALSE\r | |
2776 | );\r | |
39941daf | 2777 | } else if (TmpBufSize > 0) {\r |
dc361cc5 | 2778 | *BufferSize = (UINTN) TmpBufSize;\r |
319075ff | 2779 | Status = EFI_BUFFER_TOO_SMALL;\r |
dc361cc5 | 2780 | }\r |
319075ff | 2781 | } else if (Buffer == NULL || Private->FileSize > *BufferSize) {\r |
dc361cc5 | 2782 | *BufferSize = Private->FileSize;\r |
2783 | Status = EFI_BUFFER_TOO_SMALL;\r | |
2784 | } else {\r | |
2785 | //\r | |
2786 | // Download the file.\r | |
2787 | //\r | |
2788 | TmpBufSize = (UINT64) (*BufferSize);\r | |
2789 | Status = PxeBc->Mtftp (\r | |
2790 | PxeBc,\r | |
2791 | EFI_PXE_BASE_CODE_TFTP_READ_FILE,\r | |
2792 | Buffer,\r | |
2793 | FALSE,\r | |
2794 | &TmpBufSize,\r | |
fa6d3ee4 | 2795 | &Private->BlockSize,\r |
dc361cc5 | 2796 | &Private->ServerIp,\r |
2797 | (UINT8 *) Private->BootFileName,\r | |
2798 | NULL,\r | |
2799 | FALSE\r | |
2800 | );\r | |
2801 | }\r | |
2802 | //\r | |
2803 | // If we added a callback protocol, now is the time to remove it.\r | |
2804 | //\r | |
2805 | if (NewMakeCallback) {\r | |
2806 | \r | |
2807 | NewMakeCallback = FALSE;\r | |
2808 | \r | |
2809 | PxeBc->SetParameters (PxeBc, NULL, NULL, NULL, NULL, &NewMakeCallback);\r | |
2810 | \r | |
2811 | gBS->UninstallProtocolInterface (\r | |
2812 | Private->Controller,\r | |
2813 | &gEfiPxeBaseCodeCallbackProtocolGuid,\r | |
2814 | &Private->LoadFileCallback\r | |
2815 | );\r | |
2816 | }\r | |
619eff3f | 2817 | \r |
dc361cc5 | 2818 | //\r |
2819 | // Check download status\r | |
2820 | //\r | |
619eff3f | 2821 | if (Status == EFI_SUCCESS) {\r |
6ee21b60 | 2822 | //\r |
2823 | // The functionality of PXE Base Code protocol will not be stopped,\r | |
2824 | // when downloading is successfully.\r | |
2825 | //\r | |
8792362f | 2826 | return EFI_SUCCESS;\r |
dc361cc5 | 2827 | \r |
619eff3f | 2828 | } else if (Status == EFI_BUFFER_TOO_SMALL) {\r |
dc361cc5 | 2829 | if (Buffer != NULL) {\r |
2830 | AsciiPrint ("PXE-E05: Download buffer is smaller than requested file.\n");\r | |
2831 | } else {\r | |
ee6e8714 | 2832 | //\r |
2833 | // The functionality of PXE Base Code protocol will not be stopped.\r | |
2834 | //\r | |
dc361cc5 | 2835 | return Status;\r |
2836 | }\r | |
dc361cc5 | 2837 | \r |
619eff3f | 2838 | } else if (Status == EFI_DEVICE_ERROR) {\r |
dc361cc5 | 2839 | AsciiPrint ("PXE-E07: Network device error.\n");\r |
dc361cc5 | 2840 | \r |
619eff3f | 2841 | } else if (Status == EFI_OUT_OF_RESOURCES) {\r |
dc361cc5 | 2842 | AsciiPrint ("PXE-E09: Could not allocate I/O buffers.\n");\r |
dc361cc5 | 2843 | \r |
619eff3f | 2844 | } else if (Status == EFI_NO_MEDIA) {\r |
dc361cc5 | 2845 | AsciiPrint ("PXE-E12: Could not detect network connection.\n");\r |
dc361cc5 | 2846 | \r |
619eff3f | 2847 | } else if (Status == EFI_NO_RESPONSE) {\r |
dc361cc5 | 2848 | AsciiPrint ("PXE-E16: No offer received.\n");\r |
dc361cc5 | 2849 | \r |
619eff3f | 2850 | } else if (Status == EFI_TIMEOUT) {\r |
dc361cc5 | 2851 | AsciiPrint ("PXE-E18: Server response timeout.\n");\r |
dc361cc5 | 2852 | \r |
619eff3f | 2853 | } else if (Status == EFI_ABORTED) {\r |
dc361cc5 | 2854 | AsciiPrint ("PXE-E21: Remote boot cancelled.\n");\r |
dc361cc5 | 2855 | \r |
619eff3f | 2856 | } else if (Status == EFI_ICMP_ERROR) {\r |
dc361cc5 | 2857 | AsciiPrint ("PXE-E22: Client received ICMP error from server.\n");\r |
dc361cc5 | 2858 | \r |
619eff3f | 2859 | } else if (Status == EFI_TFTP_ERROR) {\r |
dc361cc5 | 2860 | AsciiPrint ("PXE-E23: Client received TFTP error from server.\n");\r |
dc361cc5 | 2861 | \r |
619eff3f | 2862 | } else {\r |
dc361cc5 | 2863 | AsciiPrint ("PXE-E99: Unexpected network error.\n");\r |
dc361cc5 | 2864 | }\r |
2865 | \r | |
2866 | PxeBc->Stop (PxeBc);\r | |
2867 | \r | |
2868 | return Status;\r | |
2869 | }\r | |
2870 | \r | |
434ce3fe | 2871 | EFI_LOAD_FILE_PROTOCOL mLoadFileProtocolTemplate = { EfiPxeLoadFile };\r |
2872 | \r |