]> git.proxmox.com Git - mirror_edk2.git/blob - NetworkPkg/HttpBootDxe/HttpBootDhcp6.c
projects / mirror_edk2.git / blob
? search:


9ea421d758ecbe974b9ced885cab355302820d09
[mirror_edk2.git] / NetworkPkg / HttpBootDxe / HttpBootDhcp6.c
1 /** @file
2 Functions implementation related with DHCPv6 for HTTP boot driver.
3
4 Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "HttpBootDxe.h"
16
17 /**
18 Build the options buffer for the DHCPv6 request packet.
19
20 @param[in] Private The pointer to HTTP BOOT driver private data.
21 @param[out] OptList The pointer to the option pointer array.
22 @param[in] Buffer The pointer to the buffer to contain the option list.
23
24 @return Index The count of the built-in options.
25
26 **/
27 UINT32
28 HttpBootBuildDhcp6Options (
29 IN HTTP_BOOT_PRIVATE_DATA *Private,
30 OUT EFI_DHCP6_PACKET_OPTION **OptList,
31 IN UINT8 *Buffer
32 )
33 {
34 HTTP_BOOT_DHCP6_OPTION_ENTRY OptEnt;
35 UINT16 Value;
36 UINT32 Index;
37
38 Index = 0;
39 OptList[0] = (EFI_DHCP6_PACKET_OPTION *) Buffer;
40
41 //
42 // Append client option request option
43 //
44 OptList[Index]->OpCode = HTONS (HTTP_BOOT_DHCP6_OPT_ORO);
45 OptList[Index]->OpLen = HTONS (8);
46 OptEnt.Oro = (HTTP_BOOT_DHCP6_OPTION_ORO *) OptList[Index]->Data;
47 OptEnt.Oro->OpCode[0] = HTONS(HTTP_BOOT_DHCP6_OPT_BOOT_FILE_URL);
48 OptEnt.Oro->OpCode[1] = HTONS(HTTP_BOOT_DHCP6_OPT_BOOT_FILE_PARAM);
49 OptEnt.Oro->OpCode[2] = HTONS(HTTP_BOOT_DHCP6_OPT_DNS_SERVERS);
50 OptEnt.Oro->OpCode[3] = HTONS(HTTP_BOOT_DHCP6_OPT_VENDOR_CLASS);
51 Index++;
52 OptList[Index] = GET_NEXT_DHCP6_OPTION (OptList[Index - 1]);
53
54 //
55 // Append client network device interface option
56 //
57 OptList[Index]->OpCode = HTONS (HTTP_BOOT_DHCP6_OPT_UNDI);
58 OptList[Index]->OpLen = HTONS ((UINT16)3);
59 OptEnt.Undi = (HTTP_BOOT_DHCP6_OPTION_UNDI *) OptList[Index]->Data;
60
61 if (Private->Nii != NULL) {
62 OptEnt.Undi->Type = Private->Nii->Type;
63 OptEnt.Undi->MajorVer = Private->Nii->MajorVer;
64 OptEnt.Undi->MinorVer = Private->Nii->MinorVer;
65 } else {
66 OptEnt.Undi->Type = DEFAULT_UNDI_TYPE;
67 OptEnt.Undi->MajorVer = DEFAULT_UNDI_MAJOR;
68 OptEnt.Undi->MinorVer = DEFAULT_UNDI_MINOR;
69 }
70
71 Index++;
72 OptList[Index] = GET_NEXT_DHCP6_OPTION (OptList[Index - 1]);
73
74 //
75 // Append client system architecture option
76 //
77 OptList[Index]->OpCode = HTONS (HTTP_BOOT_DHCP6_OPT_ARCH);
78 OptList[Index]->OpLen = HTONS ((UINT16) sizeof (HTTP_BOOT_DHCP6_OPTION_ARCH));
79 OptEnt.Arch = (HTTP_BOOT_DHCP6_OPTION_ARCH *) OptList[Index]->Data;
80 Value = HTONS (EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE);
81 CopyMem (&OptEnt.Arch->Type, &Value, sizeof (UINT16));
82 Index++;
83 OptList[Index] = GET_NEXT_DHCP6_OPTION (OptList[Index - 1]);
84
85 //
86 // Append vendor class identify option.
87 //
88 OptList[Index]->OpCode = HTONS (HTTP_BOOT_DHCP6_OPT_VENDOR_CLASS);
89 OptList[Index]->OpLen = HTONS ((UINT16) sizeof (HTTP_BOOT_DHCP6_OPTION_VENDOR_CLASS));
90 OptEnt.VendorClass = (HTTP_BOOT_DHCP6_OPTION_VENDOR_CLASS *) OptList[Index]->Data;
91 OptEnt.VendorClass->Vendor = HTONL (HTTP_BOOT_DHCP6_ENTERPRISE_NUM);
92 OptEnt.VendorClass->ClassLen = HTONS ((UINT16) sizeof (HTTP_BOOT_CLASS_ID));
93 CopyMem (
94 &OptEnt.VendorClass->ClassId,
95 DEFAULT_CLASS_ID_DATA,
96 sizeof (HTTP_BOOT_CLASS_ID)
97 );
98 HttpBootUintnToAscDecWithFormat (
99 EFI_HTTP_BOOT_CLIENT_SYSTEM_ARCHITECTURE,
100 OptEnt.VendorClass->ClassId.ArchitectureType,
101 sizeof (OptEnt.VendorClass->ClassId.ArchitectureType)
102 );
103
104 if (Private->Nii != NULL) {
105 CopyMem (
106 OptEnt.VendorClass->ClassId.InterfaceName,
107 Private->Nii->StringId,
108 sizeof (OptEnt.VendorClass->ClassId.InterfaceName)
109 );
110 HttpBootUintnToAscDecWithFormat (
111 Private->Nii->MajorVer,
112 OptEnt.VendorClass->ClassId.UndiMajor,
113 sizeof (OptEnt.VendorClass->ClassId.UndiMajor)
114 );
115 HttpBootUintnToAscDecWithFormat (
116 Private->Nii->MinorVer,
117 OptEnt.VendorClass->ClassId.UndiMinor,
118 sizeof (OptEnt.VendorClass->ClassId.UndiMinor)
119 );
120 }
121
122 Index++;
123
124 return Index;
125 }
126
127 /**
128 Parse out a DHCPv6 option by OptTag, and find the position in buffer.
129
130 @param[in] Buffer The pointer to the option buffer.
131 @param[in] Length Length of the option buffer.
132 @param[in] OptTag The required option tag.
133
134 @retval NULL Failed to parse the required option.
135 @retval Others The postion of the required option in buffer.
136
137 **/
138 EFI_DHCP6_PACKET_OPTION *
139 HttpBootParseDhcp6Options (
140 IN UINT8 *Buffer,
141 IN UINT32 Length,
142 IN UINT16 OptTag
143 )
144 {
145 EFI_DHCP6_PACKET_OPTION *Option;
146 UINT32 Offset;
147
148 Option = (EFI_DHCP6_PACKET_OPTION *) Buffer;
149 Offset = 0;
150
151 //
152 // OpLen and OpCode here are both stored in network order.
153 //
154 while (Offset < Length) {
155
156 if (NTOHS (Option->OpCode) == OptTag) {
157
158 return Option;
159 }
160
161 Offset += (NTOHS(Option->OpLen) + 4);
162 Option = (EFI_DHCP6_PACKET_OPTION *) (Buffer + Offset);
163 }
164
165 return NULL;
166
167 }
168
169 /**
170 Parse the cached DHCPv6 packet, including all the options.
171
172 @param[in] Cache6 The pointer to a cached DHCPv6 packet.
173
174 @retval EFI_SUCCESS Parsed the DHCPv6 packet successfully.
175 @retval EFI_DEVICE_ERROR Failed to parse and invalid the packet.
176
177 **/
178 EFI_STATUS
179 HttpBootParseDhcp6Packet (
180 IN HTTP_BOOT_DHCP6_PACKET_CACHE *Cache6
181 )
182 {
183 EFI_DHCP6_PACKET *Offer;
184 EFI_DHCP6_PACKET_OPTION **Options;
185 EFI_DHCP6_PACKET_OPTION *Option;
186 HTTP_BOOT_OFFER_TYPE OfferType;
187 EFI_IPv6_ADDRESS IpAddr;
188 BOOLEAN IsProxyOffer;
189 BOOLEAN IsHttpOffer;
190 BOOLEAN IsDnsOffer;
191 BOOLEAN IpExpressedUri;
192 EFI_STATUS Status;
193 UINT32 Offset;
194 UINT32 Length;
195
196 IsDnsOffer = FALSE;
197 IpExpressedUri = FALSE;
198 IsProxyOffer = TRUE;
199 IsHttpOffer = FALSE;
200 Offer = &Cache6->Packet.Offer;
201 Options = Cache6->OptList;
202
203 ZeroMem (Cache6->OptList, sizeof (Cache6->OptList));
204
205 Option = (EFI_DHCP6_PACKET_OPTION *) (Offer->Dhcp6.Option);
206 Offset = 0;
207 Length = GET_DHCP6_OPTION_SIZE (Offer);
208
209 //
210 // OpLen and OpCode here are both stored in network order, since they are from original packet.
211 //
212 while (Offset < Length) {
213
214 if (NTOHS (Option->OpCode) == HTTP_BOOT_DHCP6_OPT_IA_NA) {
215 Options[HTTP_BOOT_DHCP6_IDX_IA_NA] = Option;
216 } else if (NTOHS (Option->OpCode) == HTTP_BOOT_DHCP6_OPT_BOOT_FILE_URL) {
217 //
218 // The server sends this option to inform the client about an URL to a boot file.
219 //
220 Options[HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL] = Option;
221 } else if (NTOHS (Option->OpCode) == HTTP_BOOT_DHCP6_OPT_BOOT_FILE_PARAM) {
222 Options[HTTP_BOOT_DHCP6_IDX_BOOT_FILE_PARAM] = Option;
223 } else if (NTOHS (Option->OpCode) == HTTP_BOOT_DHCP6_OPT_VENDOR_CLASS) {
224 Options[HTTP_BOOT_DHCP6_IDX_VENDOR_CLASS] = Option;
225 } else if (NTOHS (Option->OpCode) == HTTP_BOOT_DHCP6_OPT_DNS_SERVERS) {
226 Options[HTTP_BOOT_DHCP6_IDX_DNS_SERVER] = Option;
227 }
228
229 Offset += (NTOHS (Option->OpLen) + 4);
230 Option = (EFI_DHCP6_PACKET_OPTION *) (Offer->Dhcp6.Option + Offset);
231 }
232 //
233 // The offer with assigned client address is NOT a proxy offer.
234 // An ia_na option, embeded with valid ia_addr option and a status_code of success.
235 //
236 Option = Options[HTTP_BOOT_DHCP6_IDX_IA_NA];
237 if (Option != NULL) {
238 Option = HttpBootParseDhcp6Options (
239 Option->Data + 12,
240 NTOHS (Option->OpLen),
241 HTTP_BOOT_DHCP6_OPT_STATUS_CODE
242 );
243 if ((Option != NULL && Option->Data[0] == 0) || (Option == NULL)) {
244 IsProxyOffer = FALSE;
245 }
246 }
247
248 //
249 // The offer with "HTTPClient" is a Http offer.
250 //
251 Option = Options[HTTP_BOOT_DHCP6_IDX_VENDOR_CLASS];
252
253 if (Option != NULL &&
254 NTOHS(Option->OpLen) >= 16 &&
255 CompareMem ((Option->Data + 6), DEFAULT_CLASS_ID_DATA, 10) == 0) {
256 IsHttpOffer = TRUE;
257 }
258
259 //
260 // The offer with Domain Server is a DNS offer.
261 //
262 Option = Options[HTTP_BOOT_DHCP6_IDX_DNS_SERVER];
263 if (Option != NULL) {
264 IsDnsOffer = TRUE;
265 }
266
267 //
268 // Http offer must have a boot URI.
269 //
270 if (IsHttpOffer && Options[HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL] == NULL) {
271 return EFI_DEVICE_ERROR;
272 }
273
274 //
275 // Try to retrieve the IP of HTTP server from URI.
276 //
277 if (IsHttpOffer) {
278 Status = HttpParseUrl (
279 (CHAR8*) Options[HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL]->Data,
280 (UINT32) AsciiStrLen ((CHAR8*) Options[HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL]->Data),
281 FALSE,
282 &Cache6->UriParser
283 );
284 if (EFI_ERROR (Status)) {
285 return EFI_DEVICE_ERROR;
286 }
287
288 Status = HttpUrlGetIp6 (
289 (CHAR8*) Options[HTTP_BOOT_DHCP6_IDX_BOOT_FILE_URL]->Data,
290 Cache6->UriParser,
291 &IpAddr
292 );
293 IpExpressedUri = !EFI_ERROR (Status);
294 }
295
296 //
297 // Determine offer type of the DHCPv6 packet.
298 //
299 if (IsHttpOffer) {
300 if (IpExpressedUri) {
301 if (IsProxyOffer) {
302 OfferType = HttpOfferTypeProxyIpUri;
303 } else {
304 OfferType = IsDnsOffer ? HttpOfferTypeDhcpIpUriDns : HttpOfferTypeDhcpIpUri;
305 }
306 } else {
307 if (!IsProxyOffer) {
308 OfferType = IsDnsOffer ? HttpOfferTypeDhcpNameUriDns : HttpOfferTypeDhcpNameUri;
309 } else {
310 OfferType = HttpOfferTypeProxyNameUri;
311 }
312 }
313
314 } else {
315 if (!IsProxyOffer) {
316 OfferType = IsDnsOffer ? HttpOfferTypeDhcpDns : HttpOfferTypeDhcpOnly;
317 } else {
318 return EFI_DEVICE_ERROR;
319 }
320 }
321
322 Cache6->OfferType = OfferType;
323 return EFI_SUCCESS;
324 }
325
326 /**
327 Cache the DHCPv6 packet.
328
329 @param[in] Dst The pointer to the cache buffer for DHCPv6 packet.
330 @param[in] Src The pointer to the DHCPv6 packet to be cached.
331
332 **/
333 VOID
334 HttpBootCacheDhcp6Packet (
335 IN EFI_DHCP6_PACKET *Dst,
336 IN EFI_DHCP6_PACKET *Src
337 )
338 {
339 ASSERT (Dst->Size >= Src->Length);
340
341 CopyMem (&Dst->Dhcp6, &Src->Dhcp6, Src->Length);
342 Dst->Length = Src->Length;
343 }
344
345 /**
346 Cache all the received DHCPv6 offers, and set OfferIndex and OfferCount.
347
348 @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
349 @param[in] RcvdOffer The pointer to the received offer packet.
350
351 **/
352 VOID
353 HttpBootCacheDhcp6Offer (
354 IN HTTP_BOOT_PRIVATE_DATA *Private,
355 IN EFI_DHCP6_PACKET *RcvdOffer
356 )
357 {
358 HTTP_BOOT_DHCP6_PACKET_CACHE *Cache6;
359 EFI_DHCP6_PACKET *Offer;
360 HTTP_BOOT_OFFER_TYPE OfferType;
361
362 Cache6 = &Private->OfferBuffer[Private->OfferNum].Dhcp6;
363 Offer = &Cache6->Packet.Offer;
364
365 //
366 // Cache the content of DHCPv6 packet firstly.
367 //
368 HttpBootCacheDhcp6Packet(Offer, RcvdOffer);
369
370 //
371 // Validate the DHCPv6 packet, and parse the options and offer type.
372 //
373 if (EFI_ERROR (HttpBootParseDhcp6Packet (Cache6))) {
374 return ;
375 }
376
377 //
378 // Determine whether cache the current offer by type, and record OfferIndex and OfferCount.
379 //
380 OfferType = Cache6->OfferType;
381 ASSERT (OfferType < HttpOfferTypeMax);
382 ASSERT (Private->OfferCount[OfferType] < HTTP_BOOT_OFFER_MAX_NUM);
383 Private->OfferIndex[OfferType][Private->OfferCount[OfferType]] = Private->OfferNum;
384 Private->OfferCount[OfferType]++;
385 Private->OfferNum++;
386 }
387
388 /**
389 EFI_DHCP6_CALLBACK is provided by the consumer of the EFI DHCPv6 Protocol driver
390 to intercept events that occurred in the configuration process.
391
392 @param[in] This The pointer to the EFI DHCPv6 Protocol.
393 @param[in] Context The pointer to the context set by EFI_DHCP6_PROTOCOL.Configure().
394 @param[in] CurrentState The current operational state of the EFI DHCPv Protocol driver.
395 @param[in] Dhcp6Event The event that occurs in the current state, which usually means a
396 state transition.
397 @param[in] Packet The DHCPv6 packet that is going to be sent or was already received.
398 @param[out] NewPacket The packet that is used to replace the Packet above.
399
400 @retval EFI_SUCCESS Told the EFI DHCPv6 Protocol driver to continue the DHCP process.
401 @retval EFI_NOT_READY Only used in the Dhcp6Selecting state. The EFI DHCPv6 Protocol
402 driver will continue to wait for more packets.
403 @retval EFI_ABORTED Told the EFI DHCPv6 Protocol driver to abort the current process.
404 @retval EFI_OUT_OF_RESOURCES There are not enough resources.
405
406 **/
407 EFI_STATUS
408 EFIAPI
409 HttpBootDhcp6CallBack (
410 IN EFI_DHCP6_PROTOCOL *This,
411 IN VOID *Context,
412 IN EFI_DHCP6_STATE CurrentState,
413 IN EFI_DHCP6_EVENT Dhcp6Event,
414 IN EFI_DHCP6_PACKET *Packet,
415 OUT EFI_DHCP6_PACKET **NewPacket OPTIONAL
416 )
417 {
418 HTTP_BOOT_PRIVATE_DATA *Private;
419 EFI_DHCP6_PACKET *SelectAd;
420 EFI_STATUS Status;
421 if ((Dhcp6Event != Dhcp6RcvdAdvertise) && (Dhcp6Event != Dhcp6SelectAdvertise)) {
422 return EFI_SUCCESS;
423 }
424
425 ASSERT (Packet != NULL);
426
427 Private = (HTTP_BOOT_PRIVATE_DATA *) Context;
428 Status = EFI_SUCCESS;
429 switch (Dhcp6Event) {
430
431 case Dhcp6RcvdAdvertise:
432 Status = EFI_NOT_READY;
433 if (Private->OfferNum < HTTP_BOOT_OFFER_MAX_NUM) {
434 //
435 // Cache the dhcp offers to OfferBuffer[] for select later, and record
436 // the OfferIndex and OfferCount.
437 //
438 HttpBootCacheDhcp6Offer (Private, Packet);
439 }
440 break;
441
442 case Dhcp6SelectAdvertise:
443 //
444 // Select offer by the default policy or by order, and record the SelectIndex
445 // and SelectProxyType.
446 //
447 HttpBootSelectDhcpOffer (Private);
448
449 if (Private->SelectIndex == 0) {
450 Status = EFI_ABORTED;
451 } else {
452 ASSERT (NewPacket != NULL);
453 SelectAd = &Private->OfferBuffer[Private->SelectIndex - 1].Dhcp6.Packet.Offer;
454 *NewPacket = AllocateZeroPool (SelectAd->Size);
455 if (*NewPacket == NULL) {
456 return EFI_OUT_OF_RESOURCES;
457 }
458 CopyMem (*NewPacket, SelectAd, SelectAd->Size);
459 }
460 break;
461
462 default:
463 break;
464 }
465
466 return Status;
467 }
468
469 /**
470 Check whether IP driver could route the message which will be sent to ServerIp address.
471
472 This function will check the IP6 route table every 1 seconds until specified timeout is expired, if a valid
473 route is found in IP6 route table, the address will be filed in GatewayAddr and return.
474
475 @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
476 @param[in] TimeOutInSecond Timeout value in seconds.
477 @param[out] GatewayAddr Pointer to store the gateway IP address.
478
479 @retval EFI_SUCCESS Found a valid gateway address successfully.
480 @retval EFI_TIMEOUT The operation is time out.
481 @retval Other Unexpect error happened.
482
483 **/
484 EFI_STATUS
485 HttpBootCheckRouteTable (
486 IN HTTP_BOOT_PRIVATE_DATA *Private,
487 IN UINTN TimeOutInSecond,
488 OUT EFI_IPv6_ADDRESS *GatewayAddr
489 )
490 {
491 EFI_STATUS Status;
492 EFI_IP6_PROTOCOL *Ip6;
493 EFI_IP6_MODE_DATA Ip6ModeData;
494 UINTN Index;
495 EFI_EVENT TimeOutEvt;
496 UINTN RetryCount;
497 BOOLEAN GatewayIsFound;
498
499 ASSERT (GatewayAddr != NULL);
500 ASSERT (Private != NULL);
501
502 Ip6 = Private->Ip6;
503 GatewayIsFound = FALSE;
504 RetryCount = 0;
505 TimeOutEvt = NULL;
506 Status = EFI_SUCCESS;
507 ZeroMem (GatewayAddr, sizeof (EFI_IPv6_ADDRESS));
508
509 while (TRUE) {
510 Status = Ip6->GetModeData (Ip6, &Ip6ModeData, NULL, NULL);
511 if (EFI_ERROR (Status)) {
512 goto ON_EXIT;
513 }
514
515 //
516 // Find out the gateway address which can route the message which send to ServerIp.
517 //
518 for (Index = 0; Index < Ip6ModeData.RouteCount; Index++) {
519 if (NetIp6IsNetEqual (&Private->ServerIp.v6, &Ip6ModeData.RouteTable[Index].Destination, Ip6ModeData.RouteTable[Index].PrefixLength)) {
520 IP6_COPY_ADDRESS (GatewayAddr, &Ip6ModeData.RouteTable[Index].Gateway);
521 GatewayIsFound = TRUE;
522 break;
523 }
524 }
525
526 if (Ip6ModeData.AddressList != NULL) {
527 FreePool (Ip6ModeData.AddressList);
528 }
529 if (Ip6ModeData.GroupTable != NULL) {
530 FreePool (Ip6ModeData.GroupTable);
531 }
532 if (Ip6ModeData.RouteTable != NULL) {
533 FreePool (Ip6ModeData.RouteTable);
534 }
535 if (Ip6ModeData.NeighborCache != NULL) {
536 FreePool (Ip6ModeData.NeighborCache);
537 }
538 if (Ip6ModeData.PrefixTable != NULL) {
539 FreePool (Ip6ModeData.PrefixTable);
540 }
541 if (Ip6ModeData.IcmpTypeList != NULL) {
542 FreePool (Ip6ModeData.IcmpTypeList);
543 }
544
545 if (GatewayIsFound || RetryCount == TimeOutInSecond) {
546 break;
547 }
548
549 RetryCount++;
550
551 //
552 // Delay 1 second then recheck it again.
553 //
554 if (TimeOutEvt == NULL) {
555 Status = gBS->CreateEvent (
556 EVT_TIMER,
557 TPL_CALLBACK,
558 NULL,
559 NULL,
560 &TimeOutEvt
561 );
562 if (EFI_ERROR (Status)) {
563 goto ON_EXIT;
564 }
565 }
566
567 Status = gBS->SetTimer (TimeOutEvt, TimerRelative, TICKS_PER_SECOND);
568 if (EFI_ERROR (Status)) {
569 goto ON_EXIT;
570 }
571 while (EFI_ERROR (gBS->CheckEvent (TimeOutEvt))) {
572 Ip6->Poll (Ip6);
573 }
574 }
575
576 ON_EXIT:
577 if (TimeOutEvt != NULL) {
578 gBS->CloseEvent (TimeOutEvt);
579 }
580
581 if (GatewayIsFound) {
582 Status = EFI_SUCCESS;
583 } else if (RetryCount == TimeOutInSecond) {
584 Status = EFI_TIMEOUT;
585 }
586
587 return Status;
588 }
589
590 /**
591 Set the IP6 policy to Automatic.
592
593 @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
594
595 @retval EFI_SUCCESS Switch the IP policy succesfully.
596 @retval Others Unexpect error happened.
597
598 **/
599 EFI_STATUS
600 HttpBootSetIp6Policy (
601 IN HTTP_BOOT_PRIVATE_DATA *Private
602 )
603 {
604 EFI_IP6_CONFIG_POLICY Policy;
605 EFI_IP6_CONFIG_PROTOCOL *Ip6Config;
606 EFI_STATUS Status;
607 UINTN DataSize;
608
609 Ip6Config = Private->Ip6Config;
610 DataSize = sizeof (EFI_IP6_CONFIG_POLICY);
611
612 //
613 // Get and store the current policy of IP6 driver.
614 //
615 Status = Ip6Config->GetData (
616 Ip6Config,
617 Ip6ConfigDataTypePolicy,
618 &DataSize,
619 &Policy
620 );
621 if (EFI_ERROR (Status)) {
622 return Status;
623 }
624
625 if (Policy == Ip6ConfigPolicyManual) {
626 Policy = Ip6ConfigPolicyAutomatic;
627 Status = Ip6Config->SetData (
628 Ip6Config,
629 Ip6ConfigDataTypePolicy,
630 sizeof(EFI_IP6_CONFIG_POLICY),
631 &Policy
632 );
633 if (EFI_ERROR (Status)) {
634 return Status;
635 }
636 }
637 return EFI_SUCCESS;
638 }
639
640 /**
641 This function will register the default DNS addresses to the network device.
642
643 @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
644 @param[in] DataLength Size of the buffer pointed to by DnsServerData in bytes.
645 @param[in] DnsServerData Point a list of DNS server address in an array
646 of EFI_IPv6_ADDRESS instances.
647
648 @retval EFI_SUCCESS The DNS configuration has been configured successfully.
649 @retval Others Failed to configure the address.
650
651 **/
652 EFI_STATUS
653 HttpBootSetIp6Dns (
654 IN HTTP_BOOT_PRIVATE_DATA *Private,
655 IN UINTN DataLength,
656 IN VOID *DnsServerData
657 )
658 {
659 EFI_IP6_CONFIG_PROTOCOL *Ip6Config;
660
661 ASSERT (Private->UsingIpv6);
662
663 Ip6Config = Private->Ip6Config;
664
665 return Ip6Config->SetData (
666 Ip6Config,
667 Ip6ConfigDataTypeDnsServer,
668 DataLength,
669 DnsServerData
670 );
671 }
672
673 /**
674 This function will register the IPv6 gateway address to the network device.
675
676 @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
677
678 @retval EFI_SUCCESS The new IP configuration has been configured successfully.
679 @retval Others Failed to configure the address.
680
681 **/
682 EFI_STATUS
683 HttpBootSetIp6Gateway (
684 IN HTTP_BOOT_PRIVATE_DATA *Private
685 )
686 {
687 EFI_IP6_CONFIG_PROTOCOL *Ip6Config;
688 EFI_STATUS Status;
689
690 ASSERT (Private->UsingIpv6);
691 Ip6Config = Private->Ip6Config;
692
693 //
694 // Set the default gateway address.
695 //
696 if (!Private->NoGateway && !NetIp6IsUnspecifiedAddr (&Private->GatewayIp.v6)) {
697 Status = Ip6Config->SetData (
698 Ip6Config,
699 Ip6ConfigDataTypeGateway,
700 sizeof (EFI_IPv6_ADDRESS),
701 &Private->GatewayIp.v6
702 );
703 if (EFI_ERROR(Status)) {
704 return Status;
705 }
706 }
707
708 return EFI_SUCCESS;
709 }
710
711 /**
712 This function will register the station IP address.
713
714 @param[in] Private The pointer to HTTP_BOOT_PRIVATE_DATA.
715
716 @retval EFI_SUCCESS The new IP address has been configured successfully.
717 @retval Others Failed to configure the address.
718
719 **/
720 EFI_STATUS
721 HttpBootSetIp6Address (
722 IN HTTP_BOOT_PRIVATE_DATA *Private
723 )
724 {
725 EFI_STATUS Status;
726 EFI_IP6_PROTOCOL *Ip6;
727 EFI_IP6_CONFIG_PROTOCOL *Ip6Cfg;
728 EFI_IP6_CONFIG_POLICY Policy;
729 EFI_IP6_CONFIG_MANUAL_ADDRESS CfgAddr;
730 EFI_IPv6_ADDRESS *Ip6Addr;
731 EFI_IPv6_ADDRESS GatewayAddr;
732 EFI_IP6_CONFIG_DATA Ip6CfgData;
733 EFI_EVENT MappedEvt;
734 UINTN DataSize;
735 BOOLEAN IsAddressOk;
736 UINTN Index;
737
738 ASSERT (Private->UsingIpv6);
739
740 MappedEvt = NULL;
741 IsAddressOk = FALSE;
742 Ip6Addr = NULL;
743 Ip6Cfg = Private->Ip6Config;
744 Ip6 = Private->Ip6;
745
746 ZeroMem (&CfgAddr, sizeof (EFI_IP6_CONFIG_MANUAL_ADDRESS));
747 CopyMem (&CfgAddr, &Private->StationIp.v6, sizeof (EFI_IPv6_ADDRESS));
748 ZeroMem (&Ip6CfgData, sizeof (EFI_IP6_CONFIG_DATA));
749
750 Ip6CfgData.AcceptIcmpErrors = TRUE;
751 Ip6CfgData.DefaultProtocol = IP6_ICMP;
752 Ip6CfgData.HopLimit = HTTP_BOOT_DEFAULT_HOPLIMIT;
753 Ip6CfgData.ReceiveTimeout = HTTP_BOOT_DEFAULT_LIFETIME;
754 Ip6CfgData.TransmitTimeout = HTTP_BOOT_DEFAULT_LIFETIME;
755
756 Status = Ip6->Configure (Ip6, &Ip6CfgData);
757 if (EFI_ERROR (Status)) {
758 goto ON_EXIT;
759 }
760
761 //
762 // Retrieve the gateway address from IP6 route table.
763 //
764 Status = HttpBootCheckRouteTable (Private, HTTP_BOOT_IP6_ROUTE_TABLE_TIMEOUT, &GatewayAddr);
765 if (EFI_ERROR (Status)) {
766 Private->NoGateway = TRUE;
767 } else {
768 IP6_COPY_ADDRESS (&Private->GatewayIp.v6, &GatewayAddr);
769 }
770
771 //
772 // Set the new address by Ip6ConfigProtocol manually.
773 //
774 Policy = Ip6ConfigPolicyManual;
775 Status = Ip6Cfg->SetData (
776 Ip6Cfg,
777 Ip6ConfigDataTypePolicy,
778 sizeof(EFI_IP6_CONFIG_POLICY),
779 &Policy
780 );
781 if (EFI_ERROR (Status)) {
782 goto ON_EXIT;
783 }
784
785 //
786 // Create a notify event to set address flag when DAD if IP6 driver succeeded.
787 //
788 Status = gBS->CreateEvent (
789 EVT_NOTIFY_SIGNAL,
790 TPL_NOTIFY,
791 HttpBootCommonNotify,
792 &IsAddressOk,
793 &MappedEvt
794 );
795 if (EFI_ERROR (Status)) {
796 goto ON_EXIT;
797 }
798
799 //
800 // Set static host ip6 address. This is a asynchronous process.
801 //
802 Status = Ip6Cfg->RegisterDataNotify (
803 Ip6Cfg,
804 Ip6ConfigDataTypeManualAddress,
805 MappedEvt
806 );
807 if (EFI_ERROR(Status)) {
808 goto ON_EXIT;
809 }
810
811 Status = Ip6Cfg->SetData (
812 Ip6Cfg,
813 Ip6ConfigDataTypeManualAddress,
814 sizeof (EFI_IP6_CONFIG_MANUAL_ADDRESS),
815 &CfgAddr
816 );
817 if (EFI_ERROR (Status) && Status != EFI_NOT_READY) {
818 goto ON_EXIT;
819 } else if (Status == EFI_NOT_READY) {
820 //
821 // Poll the network until the asynchronous process is finished.
822 //
823 while (!IsAddressOk) {
824 Ip6->Poll (Ip6);
825 }
826 //
827 // Check whether the Ip6 Address setting is successed.
828 //
829 DataSize = 0;
830 Status = Ip6Cfg->GetData (
831 Ip6Cfg,
832 Ip6ConfigDataTypeManualAddress,
833 &DataSize,
834 NULL
835 );
836 if (Status != EFI_BUFFER_TOO_SMALL || DataSize == 0) {
837 Status = EFI_DEVICE_ERROR;
838 goto ON_EXIT;
839 }
840
841 Ip6Addr = AllocatePool (DataSize);
842 if (Ip6Addr == NULL) {
843 return EFI_OUT_OF_RESOURCES;
844 }
845 Status = Ip6Cfg->GetData (
846 Ip6Cfg,
847 Ip6ConfigDataTypeManualAddress,
848 &DataSize,
849 (VOID *) Ip6Addr
850 );
851 if (EFI_ERROR (Status)) {
852 Status = EFI_DEVICE_ERROR;
853 goto ON_EXIT;
854 }
855
856 for (Index = 0; Index < DataSize / sizeof (EFI_IPv6_ADDRESS); Index ++) {
857 if (CompareMem (Ip6Addr + Index, &CfgAddr, sizeof (EFI_IPv6_ADDRESS)) == 0) {
858 break;
859 }
860 }
861 if (Index == DataSize / sizeof (EFI_IPv6_ADDRESS)) {
862 Status = EFI_ABORTED;
863 goto ON_EXIT;
864 }
865 }
866
867 ON_EXIT:
868 if (MappedEvt != NULL) {
869 Ip6Cfg->UnregisterDataNotify (
870 Ip6Cfg,
871 Ip6ConfigDataTypeManualAddress,
872 MappedEvt
873 );
874 gBS->CloseEvent (MappedEvt);
875 }
876
877 if (Ip6Addr != NULL) {
878 FreePool (Ip6Addr);
879 }
880
881 return Status;
882 }
883
884 /**
885 Start the S.A.R.R DHCPv6 process to acquire the IPv6 address and other Http boot information.
886
887 @param[in] Private Pointer to HTTP_BOOT private data.
888
889 @retval EFI_SUCCESS The S.A.R.R process successfully finished.
890 @retval Others Failed to finish the S.A.R.R process.
891
892 **/
893 EFI_STATUS
894 HttpBootDhcp6Sarr (
895 IN HTTP_BOOT_PRIVATE_DATA *Private
896 )
897 {
898 EFI_DHCP6_PROTOCOL *Dhcp6;
899 EFI_DHCP6_CONFIG_DATA Config;
900 EFI_DHCP6_MODE_DATA Mode;
901 EFI_DHCP6_RETRANSMISSION *Retransmit;
902 EFI_DHCP6_PACKET_OPTION *OptList[HTTP_BOOT_DHCP6_OPTION_MAX_NUM];
903 UINT32 OptCount;
904 UINT8 Buffer[HTTP_BOOT_DHCP6_OPTION_MAX_SIZE];
905 EFI_STATUS Status;
906
907 Dhcp6 = Private->Dhcp6;
908 ASSERT (Dhcp6 != NULL);
909
910 //
911 // Build options list for the request packet.
912 //
913 OptCount = HttpBootBuildDhcp6Options (Private, OptList, Buffer);
914 ASSERT (OptCount >0);
915
916 Retransmit = AllocateZeroPool (sizeof (EFI_DHCP6_RETRANSMISSION));
917 if (Retransmit == NULL) {
918 return EFI_OUT_OF_RESOURCES;
919 }
920
921 ZeroMem (&Mode, sizeof (EFI_DHCP6_MODE_DATA));
922 ZeroMem (&Config, sizeof (EFI_DHCP6_CONFIG_DATA));
923
924 Config.OptionCount = OptCount;
925 Config.OptionList = OptList;
926 Config.Dhcp6Callback = HttpBootDhcp6CallBack;
927 Config.CallbackContext = Private;
928 Config.IaInfoEvent = NULL;
929 Config.RapidCommit = FALSE;
930 Config.ReconfigureAccept = FALSE;
931 Config.IaDescriptor.IaId = NET_RANDOM (NetRandomInitSeed ());
932 Config.IaDescriptor.Type = EFI_DHCP6_IA_TYPE_NA;
933 Config.SolicitRetransmission = Retransmit;
934 Retransmit->Irt = 4;
935 Retransmit->Mrc = 4;
936 Retransmit->Mrt = 32;
937 Retransmit->Mrd = 60;
938
939 //
940 // Configure the DHCPv6 instance for HTTP boot.
941 //
942 Status = Dhcp6->Configure (Dhcp6, &Config);
943 FreePool (Retransmit);
944 if (EFI_ERROR (Status)) {
945 goto ON_EXIT;
946 }
947 //
948 // Initialize the record fields for DHCPv6 offer in private data.
949 //
950 Private->OfferNum = 0;
951 Private->SelectIndex = 0;
952 ZeroMem (Private->OfferCount, sizeof (Private->OfferCount));
953 ZeroMem (Private->OfferIndex, sizeof (Private->OfferIndex));
954
955 //
956 // Start DHCPv6 S.A.R.R. process to acquire IPv6 address.
957 //
958 Status = Dhcp6->Start (Dhcp6);
959 if (EFI_ERROR (Status)) {
960 goto ON_EXIT;
961 }
962
963 //
964 // Get the acquired IPv6 address and store them.
965 //
966 Status = Dhcp6->GetModeData (Dhcp6, &Mode, NULL);
967 if (EFI_ERROR (Status)) {
968 goto ON_EXIT;
969 }
970
971 ASSERT (Mode.Ia->State == Dhcp6Bound);
972 CopyMem (&Private->StationIp.v6, &Mode.Ia->IaAddress[0].IpAddress, sizeof (EFI_IPv6_ADDRESS));
973
974 AsciiPrint ("\n Station IPv6 address is ");
975 HttpBootShowIp6Addr (&Private->StationIp.v6);
976 AsciiPrint ("\n");
977
978 ON_EXIT:
979 if (EFI_ERROR (Status)) {
980 Dhcp6->Stop (Dhcp6);
981 Dhcp6->Configure (Dhcp6, NULL);
982 } else {
983 ZeroMem (&Config, sizeof (EFI_DHCP6_CONFIG_DATA));
984 Dhcp6->Configure (Dhcp6, &Config);
985 if (Mode.ClientId != NULL) {
986 FreePool (Mode.ClientId);
987 }
988 if (Mode.Ia != NULL) {
989 FreePool (Mode.Ia);
990 }
991 }
992
993 return Status;
994
995 }
996
EFI Development Kit II mirror for PVE