2 The implementation of EFI IPv4 Configuration II Protocol.
4 Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 LIST_ENTRY mIp4Config2InstanceList
= {&mIp4Config2InstanceList
, &mIp4Config2InstanceList
};
22 The event process routine when the DHCPv4 service binding protocol is installed
25 @param[in] Event Not used.
26 @param[in] Context Pointer to the IP4 config2 instance data.
31 Ip4Config2OnDhcp4SbInstalled (
37 Destroy the Dhcp4 child in IP4_CONFIG2_INSTANCE and release the resources.
39 @param[in, out] Instance The buffer of IP4 config2 instance to be freed.
41 @retval EFI_SUCCESS The child was successfully destroyed.
42 @retval Others Failed to destroy the child.
46 Ip4Config2DestroyDhcp4 (
47 IN OUT IP4_CONFIG2_INSTANCE
*Instance
52 EFI_DHCP4_PROTOCOL
*Dhcp4
;
54 Dhcp4
= Instance
->Dhcp4
;
55 ASSERT (Dhcp4
!= NULL
);
58 Dhcp4
->Configure (Dhcp4
, NULL
);
59 Instance
->Dhcp4
= NULL
;
61 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
64 // Close DHCPv4 protocol and destroy the child.
66 Status
= gBS
->CloseProtocol (
67 Instance
->Dhcp4Handle
,
68 &gEfiDhcp4ProtocolGuid
,
72 if (EFI_ERROR (Status
)) {
76 Status
= NetLibDestroyServiceChild (
79 &gEfiDhcp4ServiceBindingProtocolGuid
,
83 Instance
->Dhcp4Handle
= NULL
;
89 Update the current policy to NewPolicy. During the transition
90 period, the default router list
91 and address list in all interfaces will be released.
93 @param[in] IpSb The IP4 service binding instance.
94 @param[in] NewPolicy The new policy to be updated to.
98 Ip4Config2OnPolicyChanged (
100 IN EFI_IP4_CONFIG2_POLICY NewPolicy
104 IP4_ROUTE_TABLE
*RouteTable
;
107 // Currently there are only two policies: static and dhcp. Regardless of
108 // what transition is going on, i.e., static -> dhcp and dhcp ->
109 // static, we have to free default router table and all addresses.
112 if (IpSb
->DefaultInterface
!= NULL
) {
113 if (IpSb
->DefaultRouteTable
!= NULL
) {
114 Ip4FreeRouteTable (IpSb
->DefaultRouteTable
);
115 IpSb
->DefaultRouteTable
= NULL
;
118 Ip4CancelReceive (IpSb
->DefaultInterface
);
120 Ip4FreeInterface (IpSb
->DefaultInterface
, NULL
);
121 IpSb
->DefaultInterface
= NULL
;
124 Ip4CleanAssembleTable (&IpSb
->Assemble
);
127 // Create new default interface and route table.
129 IpIf
= Ip4CreateInterface (IpSb
->Mnp
, IpSb
->Controller
, IpSb
->Image
);
134 RouteTable
= Ip4CreateRouteTable ();
135 if (RouteTable
== NULL
) {
136 Ip4FreeInterface (IpIf
, NULL
);
140 IpSb
->DefaultInterface
= IpIf
;
141 InsertHeadList (&IpSb
->Interfaces
, &IpIf
->Link
);
142 IpSb
->DefaultRouteTable
= RouteTable
;
143 Ip4ReceiveFrame (IpIf
, NULL
, Ip4AccpetFrame
, IpSb
);
145 if (IpSb
->State
== IP4_SERVICE_CONFIGED
|| IpSb
->State
== IP4_SERVICE_STARTED
) {
146 IpSb
->State
= IP4_SERVICE_UNSTARTED
;
150 // Start the dhcp configuration.
152 if (NewPolicy
== Ip4Config2PolicyDhcp
) {
153 Ip4StartAutoConfig (&IpSb
->Ip4Config2Instance
);
159 Signal the registered event. It is the callback routine for NetMapIterate.
161 @param[in] Map Points to the list of registered event.
162 @param[in] Item The registered event.
163 @param[in] Arg Not used.
165 @retval EFI_SUCCESS The event was signaled successfully.
169 Ip4Config2SignalEvent (
171 IN NET_MAP_ITEM
*Item
,
175 gBS
->SignalEvent ((EFI_EVENT
) Item
->Key
);
181 Read the configuration data from variable storage according to the VarName and
182 gEfiIp4Config2ProtocolGuid. It checks the integrity of variable data. If the
183 data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the
184 configuration data to IP4_CONFIG2_INSTANCE.
186 @param[in] VarName The pointer to the variable name
187 @param[in, out] Instance The pointer to the IP4 config2 instance data.
189 @retval EFI_NOT_FOUND The variable can not be found or already corrupted.
190 @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation.
191 @retval EFI_SUCCESS The configuration data was retrieved successfully.
195 Ip4Config2ReadConfigData (
197 IN OUT IP4_CONFIG2_INSTANCE
*Instance
202 IP4_CONFIG2_VARIABLE
*Variable
;
203 IP4_CONFIG2_DATA_ITEM
*DataItem
;
205 IP4_CONFIG2_DATA_RECORD DataRecord
;
209 // Try to read the configuration variable.
212 Status
= gRT
->GetVariable (
214 &gEfiIp4Config2ProtocolGuid
,
220 if (Status
== EFI_BUFFER_TOO_SMALL
) {
222 // Allocate buffer and read the config variable.
224 Variable
= AllocatePool (VarSize
);
225 if (Variable
== NULL
) {
226 return EFI_OUT_OF_RESOURCES
;
229 Status
= gRT
->GetVariable (
231 &gEfiIp4Config2ProtocolGuid
,
236 if (EFI_ERROR (Status
) || (UINT16
) (~NetblockChecksum ((UINT8
*) Variable
, (UINT32
) VarSize
)) != 0) {
238 // GetVariable still error or the variable is corrupted.
239 // Fall back to the default value.
244 // Remove the problematic variable and return EFI_NOT_FOUND, a new
245 // variable will be set again.
249 &gEfiIp4Config2ProtocolGuid
,
250 IP4_CONFIG2_VARIABLE_ATTRIBUTE
,
255 return EFI_NOT_FOUND
;
259 for (Index
= 0; Index
< Variable
->DataRecordCount
; Index
++) {
261 CopyMem (&DataRecord
, &Variable
->DataRecord
[Index
], sizeof (DataRecord
));
263 DataItem
= &Instance
->DataItem
[DataRecord
.DataType
];
264 if (DATA_ATTRIB_SET (DataItem
->Attribute
, DATA_ATTRIB_SIZE_FIXED
) &&
265 (DataItem
->DataSize
!= DataRecord
.DataSize
)
268 // Perhaps a corrupted data record...
273 if (!DATA_ATTRIB_SET (DataItem
->Attribute
, DATA_ATTRIB_SIZE_FIXED
)) {
275 // This data item has variable length data.
277 DataItem
->Data
.Ptr
= AllocatePool (DataRecord
.DataSize
);
278 if (DataItem
->Data
.Ptr
== NULL
) {
280 // no memory resource
286 Data
= (CHAR8
*) Variable
+ DataRecord
.Offset
;
287 CopyMem (DataItem
->Data
.Ptr
, Data
, DataRecord
.DataSize
);
289 DataItem
->DataSize
= DataRecord
.DataSize
;
290 DataItem
->Status
= EFI_SUCCESS
;
301 Write the configuration data from IP4_CONFIG2_INSTANCE to variable storage.
303 @param[in] VarName The pointer to the variable name.
304 @param[in] Instance The pointer to the IP4 config2 instance data.
306 @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation.
307 @retval EFI_SUCCESS The configuration data is written successfully.
311 Ip4Config2WriteConfigData (
313 IN IP4_CONFIG2_INSTANCE
*Instance
318 IP4_CONFIG2_DATA_ITEM
*DataItem
;
319 IP4_CONFIG2_VARIABLE
*Variable
;
320 IP4_CONFIG2_DATA_RECORD
*DataRecord
;
324 VarSize
= sizeof (IP4_CONFIG2_VARIABLE
) - sizeof (IP4_CONFIG2_DATA_RECORD
);
326 for (Index
= 0; Index
< Ip4Config2DataTypeMaximum
; Index
++) {
328 DataItem
= &Instance
->DataItem
[Index
];
329 if (!DATA_ATTRIB_SET (DataItem
->Attribute
, DATA_ATTRIB_VOLATILE
) && !EFI_ERROR (DataItem
->Status
)) {
331 VarSize
+= sizeof (IP4_CONFIG2_DATA_RECORD
) + DataItem
->DataSize
;
335 Variable
= AllocatePool (VarSize
);
336 if (Variable
== NULL
) {
337 return EFI_OUT_OF_RESOURCES
;
340 Heap
= (CHAR8
*) Variable
+ VarSize
;
341 Variable
->DataRecordCount
= 0;
343 for (Index
= 0; Index
< Ip4Config2DataTypeMaximum
; Index
++) {
345 DataItem
= &Instance
->DataItem
[Index
];
346 if (!DATA_ATTRIB_SET (DataItem
->Attribute
, DATA_ATTRIB_VOLATILE
) && !EFI_ERROR (DataItem
->Status
)) {
348 Heap
-= DataItem
->DataSize
;
349 CopyMem (Heap
, DataItem
->Data
.Ptr
, DataItem
->DataSize
);
351 DataRecord
= &Variable
->DataRecord
[Variable
->DataRecordCount
];
352 DataRecord
->DataType
= (EFI_IP4_CONFIG2_DATA_TYPE
) Index
;
353 DataRecord
->DataSize
= (UINT32
) DataItem
->DataSize
;
354 DataRecord
->Offset
= (UINT16
) (Heap
- (CHAR8
*) Variable
);
356 Variable
->DataRecordCount
++;
360 Variable
->Checksum
= 0;
361 Variable
->Checksum
= (UINT16
) ~NetblockChecksum ((UINT8
*) Variable
, (UINT32
) VarSize
);
363 Status
= gRT
->SetVariable (
365 &gEfiIp4Config2ProtocolGuid
,
366 IP4_CONFIG2_VARIABLE_ATTRIBUTE
,
378 Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of GetModeData.
379 The EFI_IP4_ROUTE_TABLE is clumsy to use in the internal operation of the
382 @param[in] IpSb The IP4 service binding instance.
383 @param[out] Table The built IP4 route table.
385 @retval EFI_SUCCESS The route table is successfully build
386 @retval EFI_NOT_FOUND Failed to allocate the memory for the rotue table.
390 Ip4Config2BuildDefaultRouteTable (
391 IN IP4_SERVICE
*IpSb
,
392 OUT EFI_IP4_ROUTE_TABLE
*Table
396 IP4_ROUTE_ENTRY
*RtEntry
;
400 if (IpSb
->DefaultRouteTable
== NULL
) {
401 return EFI_NOT_FOUND
;
404 Count
= IpSb
->DefaultRouteTable
->TotalNum
;
407 return EFI_NOT_FOUND
;
411 // Copy the route entry to EFI route table. Keep the order of
412 // route entry copied from most specific to default route. That
413 // is, interlevel the route entry from the instance's route area
414 // and those from the default route table's route area.
418 for (Index
= IP4_MASK_MAX
; Index
>= 0; Index
--) {
420 NET_LIST_FOR_EACH (Entry
, &(IpSb
->DefaultRouteTable
->RouteArea
[Index
])) {
421 RtEntry
= NET_LIST_USER_STRUCT (Entry
, IP4_ROUTE_ENTRY
, Link
);
423 EFI_IP4 (Table
[Count
].SubnetAddress
) = HTONL (RtEntry
->Dest
& RtEntry
->Netmask
);
424 EFI_IP4 (Table
[Count
].SubnetMask
) = HTONL (RtEntry
->Netmask
);
425 EFI_IP4 (Table
[Count
].GatewayAddress
) = HTONL (RtEntry
->NextHop
);
436 The event process routine when the DHCPv4 service binding protocol is installed
439 @param[in] Event Not used.
440 @param[in] Context The pointer to the IP4 config2 instance data.
445 Ip4Config2OnDhcp4SbInstalled (
450 IP4_CONFIG2_INSTANCE
*Instance
;
452 Instance
= (IP4_CONFIG2_INSTANCE
*) Context
;
454 if ((Instance
->Dhcp4Handle
!= NULL
) || (Instance
->Policy
!= Ip4Config2PolicyDhcp
)) {
456 // The DHCP4 child is already created or the policy is no longer DHCP.
461 Ip4StartAutoConfig (Instance
);
465 Set the station address and subnetmask for the default interface.
467 @param[in] IpSb The pointer to the IP4 service binding instance.
468 @param[in] StationAddress Ip address to be set.
469 @param[in] SubnetMask Subnet to be set.
471 @retval EFI_SUCCESS Set default address successful.
472 @retval Others Some errors occur in setting.
476 Ip4Config2SetDefaultAddr (
477 IN IP4_SERVICE
*IpSb
,
478 IN IP4_ADDR StationAddress
,
479 IN IP4_ADDR SubnetMask
484 IP4_PROTOCOL
*Ip4Instance
;
485 EFI_ARP_PROTOCOL
*Arp
;
488 IP4_ROUTE_TABLE
*RouteTable
;
490 IpIf
= IpSb
->DefaultInterface
;
491 ASSERT (IpIf
!= NULL
);
493 if ((IpIf
->Ip
== StationAddress
) && (IpIf
->SubnetMask
== SubnetMask
)) {
494 IpSb
->State
= IP4_SERVICE_CONFIGED
;
498 if (IpSb
->Reconfig
) {
500 // The default address is changed, free the previous interface first.
502 if (IpSb
->DefaultRouteTable
!= NULL
) {
503 Ip4FreeRouteTable (IpSb
->DefaultRouteTable
);
504 IpSb
->DefaultRouteTable
= NULL
;
507 Ip4CancelReceive (IpSb
->DefaultInterface
);
508 Ip4FreeInterface (IpSb
->DefaultInterface
, NULL
);
509 IpSb
->DefaultInterface
= NULL
;
511 // Create new default interface and route table.
513 IpIf
= Ip4CreateInterface (IpSb
->Mnp
, IpSb
->Controller
, IpSb
->Image
);
515 return EFI_OUT_OF_RESOURCES
;
518 RouteTable
= Ip4CreateRouteTable ();
519 if (RouteTable
== NULL
) {
520 Ip4FreeInterface (IpIf
, NULL
);
521 return EFI_OUT_OF_RESOURCES
;
524 IpSb
->DefaultInterface
= IpIf
;
525 InsertHeadList (&IpSb
->Interfaces
, &IpIf
->Link
);
526 IpSb
->DefaultRouteTable
= RouteTable
;
527 Ip4ReceiveFrame (IpIf
, NULL
, Ip4AccpetFrame
, IpSb
);
530 if (IpSb
->State
== IP4_SERVICE_CONFIGED
) {
531 IpSb
->State
= IP4_SERVICE_UNSTARTED
;
534 Status
= Ip4SetAddress (IpIf
, StationAddress
, SubnetMask
);
535 if (EFI_ERROR (Status
)) {
539 if (IpIf
->Arp
!= NULL
) {
541 // A non-NULL IpIf->Arp here means a new ARP child is created when setting default address,
542 // but some IP children may have referenced the default interface before it is configured,
543 // these IP instances also consume this ARP protocol so they need to open it BY_CHILD_CONTROLLER.
546 NET_LIST_FOR_EACH (Entry
, &IpIf
->IpInstances
) {
547 Ip4Instance
= NET_LIST_USER_STRUCT_S (Entry
, IP4_PROTOCOL
, AddrLink
, IP4_PROTOCOL_SIGNATURE
);
548 Status
= gBS
->OpenProtocol (
550 &gEfiArpProtocolGuid
,
552 gIp4DriverBinding
.DriverBindingHandle
,
554 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
556 if (EFI_ERROR (Status
)) {
563 IpSb
->DefaultRouteTable
,
570 // Add a route for the connected network.
572 Subnet
= StationAddress
& SubnetMask
;
575 IpSb
->DefaultRouteTable
,
581 IpSb
->State
= IP4_SERVICE_CONFIGED
;
582 IpSb
->Reconfig
= FALSE
;
588 Set the station address, subnetmask and gateway address for the default interface.
590 @param[in] Instance The pointer to the IP4 config2 instance data.
591 @param[in] StationAddress Ip address to be set.
592 @param[in] SubnetMask Subnet to be set.
593 @param[in] GatewayAddress Gateway to be set.
595 @retval EFI_SUCCESS Set default If successful.
596 @retval Others Errors occur as indicated.
600 Ip4Config2SetDefaultIf (
601 IN IP4_CONFIG2_INSTANCE
*Instance
,
602 IN IP4_ADDR StationAddress
,
603 IN IP4_ADDR SubnetMask
,
604 IN IP4_ADDR GatewayAddress
610 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
612 Status
= Ip4Config2SetDefaultAddr (IpSb
, StationAddress
, SubnetMask
);
613 if (EFI_ERROR (Status
)) {
618 // Create a route if there is a default router.
620 if (GatewayAddress
!= IP4_ALLZERO_ADDRESS
) {
622 IpSb
->DefaultRouteTable
,
634 Release all the DHCP related resources.
636 @param Instance The IP4 config2 instance.
642 Ip4Config2CleanDhcp4 (
643 IN IP4_CONFIG2_INSTANCE
*Instance
648 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
650 if (Instance
->Dhcp4
!= NULL
) {
651 Instance
->Dhcp4
->Stop (Instance
->Dhcp4
);
654 Instance
->Dhcp4Handle
,
655 &gEfiDhcp4ProtocolGuid
,
660 Instance
->Dhcp4
= NULL
;
663 if (Instance
->Dhcp4Handle
!= NULL
) {
664 NetLibDestroyServiceChild (
667 &gEfiDhcp4ServiceBindingProtocolGuid
,
668 Instance
->Dhcp4Handle
671 Instance
->Dhcp4Handle
= NULL
;
674 if (Instance
->Dhcp4Event
!= NULL
) {
675 gBS
->CloseEvent (Instance
->Dhcp4Event
);
676 Instance
->Dhcp4Event
= NULL
;
681 This worker function sets the DNS server list for the EFI IPv4 network
682 stack running on the communication device that this EFI_IP4_CONFIG2_PROTOCOL
683 manages. The DNS server addresses must be unicast IPv4 addresses.
685 @param[in] Instance The pointer to the IP4 config2 instance data.
686 @param[in] DataSize The size of the buffer pointed to by Data in bytes.
687 @param[in] Data The data buffer to set, points to an array of
688 EFI_IPv4_ADDRESS instances.
690 @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type.
691 @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid.
692 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation.
693 @retval EFI_ABORTED The DNS server addresses to be set equal the current
695 @retval EFI_SUCCESS The specified configuration data for the EFI IPv4
696 network stack was set.
700 Ip4Config2SetDnsServerWorker (
701 IN IP4_CONFIG2_INSTANCE
*Instance
,
709 EFI_IPv4_ADDRESS
*OldDns
;
710 EFI_IPv4_ADDRESS
*NewDns
;
713 IP4_CONFIG2_DATA_ITEM
*Item
;
718 if ((DataSize
% sizeof (EFI_IPv4_ADDRESS
) != 0) || (DataSize
== 0)) {
719 return EFI_BAD_BUFFER_SIZE
;
722 Item
= &Instance
->DataItem
[Ip4Config2DataTypeDnsServer
];
723 NewDns
= (EFI_IPv4_ADDRESS
*) Data
;
724 OldDns
= Item
->Data
.DnsServers
;
725 NewDnsCount
= DataSize
/ sizeof (EFI_IPv4_ADDRESS
);
726 OldDnsCount
= Item
->DataSize
/ sizeof (EFI_IPv4_ADDRESS
);
729 if (NewDnsCount
!= OldDnsCount
) {
730 Tmp
= AllocatePool (DataSize
);
732 return EFI_OUT_OF_RESOURCES
;
738 for (NewIndex
= 0; NewIndex
< NewDnsCount
; NewIndex
++) {
739 CopyMem (&DnsAddress
, NewDns
+ NewIndex
, sizeof (IP4_ADDR
));
740 if (IP4_IS_UNSPECIFIED (NTOHL (DnsAddress
)) || IP4_IS_LOCAL_BROADCAST (NTOHL (DnsAddress
))) {
742 // The dns server address must be unicast.
745 return EFI_INVALID_PARAMETER
;
748 for (Index1
= NewIndex
+ 1; Index1
< NewDnsCount
; Index1
++) {
749 if (EFI_IP4_EQUAL (NewDns
+ NewIndex
, NewDns
+ Index1
)) {
751 return EFI_INVALID_PARAMETER
;
757 // If any address in the new setting is not in the old settings, skip the
758 // comparision below.
763 for (OldIndex
= 0; OldIndex
< OldDnsCount
; OldIndex
++) {
764 if (EFI_IP4_EQUAL (NewDns
+ NewIndex
, OldDns
+ OldIndex
)) {
766 // If found break out.
772 if (OldIndex
== OldDnsCount
) {
777 if (!OneAdded
&& (DataSize
== Item
->DataSize
)) {
779 // No new item is added and the size is the same.
781 Item
->Status
= EFI_SUCCESS
;
785 if (Item
->Data
.Ptr
!= NULL
) {
786 FreePool (Item
->Data
.Ptr
);
788 Item
->Data
.Ptr
= Tmp
;
791 CopyMem (Item
->Data
.Ptr
, Data
, DataSize
);
792 Item
->DataSize
= DataSize
;
793 Item
->Status
= EFI_SUCCESS
;
801 Callback function when DHCP process finished. It will save the
802 retrieved IP configure parameter from DHCP to the NVRam.
804 @param Event The callback event
805 @param Context Opaque context to the callback
812 Ip4Config2OnDhcp4Complete (
817 IP4_CONFIG2_INSTANCE
*Instance
;
818 EFI_DHCP4_MODE_DATA Dhcp4Mode
;
820 IP4_ADDR StationAddress
;
822 IP4_ADDR GatewayAddress
;
825 EFI_DHCP4_PACKET_OPTION
**OptionList
;
827 Instance
= (IP4_CONFIG2_INSTANCE
*) Context
;
828 ASSERT (Instance
->Dhcp4
!= NULL
);
831 // Get the DHCP retrieved parameters
833 Status
= Instance
->Dhcp4
->GetModeData (Instance
->Dhcp4
, &Dhcp4Mode
);
835 if (EFI_ERROR (Status
)) {
839 if (Dhcp4Mode
.State
== Dhcp4Bound
) {
840 StationAddress
= EFI_NTOHL (Dhcp4Mode
.ClientAddress
);
841 SubnetMask
= EFI_NTOHL (Dhcp4Mode
.SubnetMask
);
842 GatewayAddress
= EFI_NTOHL (Dhcp4Mode
.RouterAddress
);
844 Status
= Ip4Config2SetDefaultIf (Instance
, StationAddress
, SubnetMask
, GatewayAddress
);
845 if (EFI_ERROR (Status
)) {
850 // Parse the ACK to get required DNS server information.
855 Status
= Instance
->Dhcp4
->Parse (Instance
->Dhcp4
, Dhcp4Mode
.ReplyPacket
, &OptionCount
, OptionList
);
856 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
860 OptionList
= AllocateZeroPool (OptionCount
* sizeof (EFI_DHCP4_PACKET_OPTION
*));
861 if (OptionList
== NULL
) {
865 Status
= Instance
->Dhcp4
->Parse (Instance
->Dhcp4
, Dhcp4Mode
.ReplyPacket
, &OptionCount
, OptionList
);
866 if (EFI_ERROR (Status
)) {
867 FreePool (OptionList
);
871 for (Index
= 0; Index
< OptionCount
; Index
++) {
873 // Look for DNS Server opcode (6).
875 if (OptionList
[Index
]->OpCode
== DHCP4_TAG_DNS_SERVER
) {
876 if (((OptionList
[Index
]->Length
& 0x3) != 0) || (OptionList
[Index
]->Length
== 0)) {
880 Ip4Config2SetDnsServerWorker (Instance
, OptionList
[Index
]->Length
, &OptionList
[Index
]->Data
[0]);
885 FreePool (OptionList
);
887 Instance
->DhcpSuccess
= TRUE
;
891 Ip4Config2CleanDhcp4 (Instance
);
897 Start the DHCP configuration for this IP service instance.
898 It will locates the EFI_IP4_CONFIG2_PROTOCOL, then start the
901 @param[in] Instance The IP4 config2 instance to configure
903 @retval EFI_SUCCESS The auto configuration is successfully started
904 @retval Others Failed to start auto configuration.
909 IN IP4_CONFIG2_INSTANCE
*Instance
913 EFI_DHCP4_PROTOCOL
*Dhcp4
;
914 EFI_DHCP4_MODE_DATA Dhcp4Mode
;
915 EFI_DHCP4_PACKET_OPTION
*OptionList
[1];
916 IP4_CONFIG2_DHCP4_OPTION ParaList
;
920 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
922 if (IpSb
->State
> IP4_SERVICE_UNSTARTED
) {
927 // A host must not invoke DHCP configuration if it is already
928 // participating in the DHCP configuraiton process.
930 if (Instance
->Dhcp4Handle
!= NULL
) {
934 Status
= NetLibCreateServiceChild (
937 &gEfiDhcp4ServiceBindingProtocolGuid
,
938 &Instance
->Dhcp4Handle
941 if (Status
== EFI_UNSUPPORTED
) {
943 // No DHCPv4 Service Binding protocol, register a notify.
945 if (Instance
->Dhcp4SbNotifyEvent
== NULL
) {
946 Instance
->Dhcp4SbNotifyEvent
= EfiCreateProtocolNotifyEvent (
947 &gEfiDhcp4ServiceBindingProtocolGuid
,
949 Ip4Config2OnDhcp4SbInstalled
,
951 &Instance
->Registration
956 if (EFI_ERROR (Status
)) {
960 if (Instance
->Dhcp4SbNotifyEvent
!= NULL
) {
961 gBS
->CloseEvent (Instance
->Dhcp4SbNotifyEvent
);
964 Status
= gBS
->OpenProtocol (
965 Instance
->Dhcp4Handle
,
966 &gEfiDhcp4ProtocolGuid
,
967 (VOID
**) &Instance
->Dhcp4
,
970 EFI_OPEN_PROTOCOL_BY_DRIVER
972 ASSERT_EFI_ERROR (Status
);
976 // Check the current DHCP status, if the DHCP process has
977 // already finished, return now.
979 Dhcp4
= Instance
->Dhcp4
;
980 Status
= Dhcp4
->GetModeData (Dhcp4
, &Dhcp4Mode
);
982 if (Dhcp4Mode
.State
== Dhcp4Bound
) {
983 Ip4Config2OnDhcp4Complete (NULL
, Instance
);
989 // Try to start the DHCP process. Use most of the current
990 // DHCP configuration to avoid problems if some DHCP client
991 // yields the control of this DHCP service to us.
993 ParaList
.Head
.OpCode
= DHCP4_TAG_PARA_LIST
;
994 ParaList
.Head
.Length
= 3;
995 ParaList
.Head
.Data
[0] = DHCP4_TAG_NETMASK
;
996 ParaList
.Route
= DHCP4_TAG_ROUTER
;
997 ParaList
.Dns
= DHCP4_TAG_DNS_SERVER
;
998 OptionList
[0] = &ParaList
.Head
;
999 Dhcp4Mode
.ConfigData
.OptionCount
= 1;
1000 Dhcp4Mode
.ConfigData
.OptionList
= OptionList
;
1002 Status
= Dhcp4
->Configure (Dhcp4
, &Dhcp4Mode
.ConfigData
);
1004 if (EFI_ERROR (Status
)) {
1009 // Start the DHCP process
1011 Status
= gBS
->CreateEvent (
1014 Ip4Config2OnDhcp4Complete
,
1016 &Instance
->Dhcp4Event
1019 if (EFI_ERROR (Status
)) {
1023 Status
= Dhcp4
->Start (Dhcp4
, Instance
->Dhcp4Event
);
1025 if (EFI_ERROR (Status
)) {
1029 IpSb
->State
= IP4_SERVICE_STARTED
;
1038 The work function is to get the interface information of the communication
1039 device this IP4_CONFIG2_INSTANCE manages.
1041 @param[in] Instance Pointer to the IP4 config2 instance data.
1042 @param[in, out] DataSize On input, in bytes, the size of Data. On output, in
1043 bytes, the size of buffer required to store the specified
1045 @param[in] Data The data buffer in which the configuration data is returned.
1046 Ignored if DataSize is ZERO.
1048 @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified
1049 configuration data, and the required size is
1050 returned in DataSize.
1051 @retval EFI_SUCCESS The specified configuration data was obtained.
1055 Ip4Config2GetIfInfo (
1056 IN IP4_CONFIG2_INSTANCE
*Instance
,
1057 IN OUT UINTN
*DataSize
,
1058 IN VOID
*Data OPTIONAL
1063 IP4_CONFIG2_DATA_ITEM
*Item
;
1064 EFI_IP4_CONFIG2_INTERFACE_INFO
*IfInfo
;
1067 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
1068 Length
= sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO
);
1070 if (IpSb
->DefaultRouteTable
!= NULL
) {
1071 Length
+= IpSb
->DefaultRouteTable
->TotalNum
* sizeof (EFI_IP4_ROUTE_TABLE
);
1074 if (*DataSize
< Length
) {
1076 return EFI_BUFFER_TOO_SMALL
;
1080 // Copy the fixed size part of the interface info.
1082 Item
= &Instance
->DataItem
[Ip4Config2DataTypeInterfaceInfo
];
1083 IfInfo
= (EFI_IP4_CONFIG2_INTERFACE_INFO
*) Data
;
1084 CopyMem (IfInfo
, Item
->Data
.Ptr
, sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO
));
1087 // Update the address info.
1089 if (IpSb
->DefaultInterface
!= NULL
) {
1090 Address
= HTONL (IpSb
->DefaultInterface
->Ip
);
1091 CopyMem (&IfInfo
->StationAddress
, &Address
, sizeof (EFI_IPv4_ADDRESS
));
1092 Address
= HTONL (IpSb
->DefaultInterface
->SubnetMask
);
1093 CopyMem (&IfInfo
->SubnetMask
, &Address
, sizeof (EFI_IPv4_ADDRESS
));
1096 if (IpSb
->DefaultRouteTable
!= NULL
) {
1097 IfInfo
->RouteTableSize
= IpSb
->DefaultRouteTable
->TotalNum
;
1098 IfInfo
->RouteTable
= (EFI_IP4_ROUTE_TABLE
*) ((UINT8
*) Data
+ sizeof (EFI_IP4_CONFIG2_INTERFACE_INFO
));
1100 Ip4Config2BuildDefaultRouteTable (IpSb
, IfInfo
->RouteTable
);
1107 The work function is to set the general configuration policy for the EFI IPv4 network
1108 stack that is running on the communication device managed by this IP4_CONFIG2_INSTANCE.
1109 The policy will affect other configuration settings.
1111 @param[in] Instance Pointer to the IP4 config2 instance data.
1112 @param[in] DataSize Size of the buffer pointed to by Data in bytes.
1113 @param[in] Data The data buffer to set.
1115 @retval EFI_INVALID_PARAMETER The to be set policy is invalid.
1116 @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type.
1117 @retval EFI_ABORTED The new policy equals the current policy.
1118 @retval EFI_SUCCESS The specified configuration data for the EFI IPv6
1119 network stack was set.
1123 Ip4Config2SetPolicy (
1124 IN IP4_CONFIG2_INSTANCE
*Instance
,
1129 EFI_IP4_CONFIG2_POLICY NewPolicy
;
1130 IP4_CONFIG2_DATA_ITEM
*DataItem
;
1133 if (DataSize
!= sizeof (EFI_IP4_CONFIG2_POLICY
)) {
1134 return EFI_BAD_BUFFER_SIZE
;
1137 NewPolicy
= *((EFI_IP4_CONFIG2_POLICY
*) Data
);
1139 if (NewPolicy
>= Ip4Config2PolicyMax
) {
1140 return EFI_INVALID_PARAMETER
;
1143 if (NewPolicy
== Instance
->Policy
) {
1144 if (NewPolicy
!= Ip4Config2PolicyDhcp
|| Instance
->DhcpSuccess
) {
1149 // The policy is changed. Clean the ManualAddress, Gateway and DnsServers,
1150 // shrink the variable data size, and fire up all the related events.
1152 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeManualAddress
];
1153 if (DataItem
->Data
.Ptr
!= NULL
) {
1154 FreePool (DataItem
->Data
.Ptr
);
1156 DataItem
->Data
.Ptr
= NULL
;
1157 DataItem
->DataSize
= 0;
1158 DataItem
->Status
= EFI_NOT_FOUND
;
1159 NetMapIterate (&DataItem
->EventMap
, Ip4Config2SignalEvent
, NULL
);
1161 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeGateway
];
1162 if (DataItem
->Data
.Ptr
!= NULL
) {
1163 FreePool (DataItem
->Data
.Ptr
);
1165 DataItem
->Data
.Ptr
= NULL
;
1166 DataItem
->DataSize
= 0;
1167 DataItem
->Status
= EFI_NOT_FOUND
;
1168 NetMapIterate (&DataItem
->EventMap
, Ip4Config2SignalEvent
, NULL
);
1170 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeDnsServer
];
1171 if (DataItem
->Data
.Ptr
!= NULL
) {
1172 FreePool (DataItem
->Data
.Ptr
);
1174 DataItem
->Data
.Ptr
= NULL
;
1175 DataItem
->DataSize
= 0;
1176 DataItem
->Status
= EFI_NOT_FOUND
;
1177 NetMapIterate (&DataItem
->EventMap
, Ip4Config2SignalEvent
, NULL
);
1179 if (NewPolicy
== Ip4Config2PolicyDhcp
) {
1180 SET_DATA_ATTRIB (DataItem
->Attribute
, DATA_ATTRIB_VOLATILE
);
1183 // The policy is changed from dhcp to static. Stop the DHCPv4 process
1184 // and destroy the DHCPv4 child.
1186 if (Instance
->Dhcp4Handle
!= NULL
) {
1187 Ip4Config2DestroyDhcp4 (Instance
);
1193 if (Instance
->Dhcp4Event
!= NULL
) {
1194 gBS
->CloseEvent (Instance
->Dhcp4Event
);
1195 Instance
->Dhcp4Event
= NULL
;
1200 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
1201 Ip4Config2OnPolicyChanged (IpSb
, NewPolicy
);
1203 Instance
->Policy
= NewPolicy
;
1209 The work function is to set the station addresses manually for the EFI IPv4
1210 network stack. It is only configurable when the policy is Ip4Config2PolicyStatic.
1212 @param[in] Instance Pointer to the IP4 config2 instance data.
1213 @param[in] DataSize Size of the buffer pointed to by Data in bytes.
1214 @param[in] Data The data buffer to set.
1216 @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type.
1217 @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set
1218 under the current policy.
1219 @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid.
1220 @retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation.
1221 @retval EFI_NOT_READY An asynchrous process is invoked to set the specified
1222 configuration data, and the process is not finished.
1223 @retval EFI_ABORTED The manual addresses to be set equal current
1225 @retval EFI_SUCCESS The specified configuration data for the EFI IPv6
1226 network stack was set.
1230 Ip4Config2SetMaunualAddress (
1231 IN IP4_CONFIG2_INSTANCE
*Instance
,
1236 EFI_IP4_CONFIG2_MANUAL_ADDRESS NewAddress
;
1237 IP4_CONFIG2_DATA_ITEM
*DataItem
;
1239 IP4_ADDR StationAddress
;
1240 IP4_ADDR SubnetMask
;
1244 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
1246 ASSERT (Instance
->DataItem
[Ip4Config2DataTypeManualAddress
].Status
!= EFI_NOT_READY
);
1248 if (((DataSize
% sizeof (EFI_IP4_CONFIG2_MANUAL_ADDRESS
)) != 0) || (DataSize
== 0)) {
1249 return EFI_BAD_BUFFER_SIZE
;
1252 if (Instance
->Policy
!= Ip4Config2PolicyStatic
) {
1253 return EFI_WRITE_PROTECTED
;
1256 NewAddress
= *((EFI_IP4_CONFIG2_MANUAL_ADDRESS
*) Data
);
1259 // Store the new data, and init the DataItem status to EFI_NOT_READY because
1260 // we may have an asynchronous configuration process.
1262 Ptr
= AllocateCopyPool (DataSize
, Data
);
1264 return EFI_OUT_OF_RESOURCES
;
1267 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeManualAddress
];
1268 if (DataItem
->Data
.Ptr
!= NULL
) {
1269 FreePool (DataItem
->Data
.Ptr
);
1272 DataItem
->Data
.Ptr
= Ptr
;
1273 DataItem
->DataSize
= DataSize
;
1274 DataItem
->Status
= EFI_NOT_READY
;
1276 StationAddress
= EFI_NTOHL (NewAddress
.Address
);
1277 SubnetMask
= EFI_NTOHL (NewAddress
.SubnetMask
);
1279 IpSb
->Reconfig
= TRUE
;
1280 Status
= Ip4Config2SetDefaultAddr (IpSb
, StationAddress
, SubnetMask
);
1281 if (EFI_ERROR (Status
)) {
1285 DataItem
->Status
= EFI_SUCCESS
;
1288 if (EFI_ERROR (DataItem
->Status
)) {
1292 DataItem
->Data
.Ptr
= NULL
;
1299 The work function is to set the gateway addresses manually for the EFI IPv4
1300 network stack that is running on the communication device that this EFI IPv4
1301 Configuration Protocol manages. It is not configurable when the policy is
1302 Ip4Config2PolicyDhcp. The gateway addresses must be unicast IPv4 addresses.
1304 @param[in] Instance The pointer to the IP4 config2 instance data.
1305 @param[in] DataSize The size of the buffer pointed to by Data in bytes.
1306 @param[in] Data The data buffer to set. This points to an array of
1307 EFI_IPv6_ADDRESS instances.
1309 @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type.
1310 @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set
1311 under the current policy.
1312 @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid.
1313 @retval EFI_OUT_OF_RESOURCES Failed to allocate resource to complete the operation.
1314 @retval EFI_ABORTED The manual gateway addresses to be set equal the
1315 current configuration.
1316 @retval EFI_SUCCESS The specified configuration data for the EFI IPv6
1317 network stack was set.
1321 Ip4Config2SetGateway (
1322 IN IP4_CONFIG2_INSTANCE
*Instance
,
1328 IP4_CONFIG2_DATA_ITEM
*DataItem
;
1333 EFI_IPv4_ADDRESS
*OldGateway
;
1334 EFI_IPv4_ADDRESS
*NewGateway
;
1335 UINTN OldGatewayCount
;
1336 UINTN NewGatewayCount
;
1341 if ((DataSize
% sizeof (EFI_IPv4_ADDRESS
) != 0) || (DataSize
== 0)) {
1342 return EFI_BAD_BUFFER_SIZE
;
1345 if (Instance
->Policy
!= Ip4Config2PolicyStatic
) {
1346 return EFI_WRITE_PROTECTED
;
1349 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
1351 NewGateway
= (EFI_IPv4_ADDRESS
*) Data
;
1352 NewGatewayCount
= DataSize
/ sizeof (EFI_IPv4_ADDRESS
);
1353 for (Index1
= 0; Index1
< NewGatewayCount
; Index1
++) {
1354 CopyMem (&Gateway
, NewGateway
+ Index1
, sizeof (IP4_ADDR
));
1356 if ((IpSb
->DefaultInterface
->SubnetMask
!= 0) &&
1357 !NetIp4IsUnicast (NTOHL (Gateway
), IpSb
->DefaultInterface
->SubnetMask
)) {
1358 return EFI_INVALID_PARAMETER
;
1361 for (Index2
= Index1
+ 1; Index2
< NewGatewayCount
; Index2
++) {
1362 if (EFI_IP4_EQUAL (NewGateway
+ Index1
, NewGateway
+ Index2
)) {
1363 return EFI_INVALID_PARAMETER
;
1368 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeGateway
];
1369 OldGateway
= DataItem
->Data
.Gateway
;
1370 OldGatewayCount
= DataItem
->DataSize
/ sizeof (EFI_IPv4_ADDRESS
);
1374 if (NewGatewayCount
!= OldGatewayCount
) {
1375 Tmp
= AllocatePool (DataSize
);
1377 return EFI_OUT_OF_RESOURCES
;
1383 for (Index1
= 0; Index1
< OldGatewayCount
; Index1
++) {
1385 // Remove this route entry.
1387 CopyMem (&Gateway
, OldGateway
+ Index1
, sizeof (IP4_ADDR
));
1389 IpSb
->DefaultRouteTable
,
1390 IP4_ALLZERO_ADDRESS
,
1391 IP4_ALLZERO_ADDRESS
,
1398 for (Index1
= 0; Index1
< NewGatewayCount
; Index1
++) {
1399 CopyMem (&Gateway
, NewGateway
+ Index1
, sizeof (IP4_ADDR
));
1401 IpSb
->DefaultRouteTable
,
1402 IP4_ALLZERO_ADDRESS
,
1403 IP4_ALLZERO_ADDRESS
,
1411 if (!OneRemoved
&& !OneAdded
) {
1412 DataItem
->Status
= EFI_SUCCESS
;
1417 if (DataItem
->Data
.Ptr
!= NULL
) {
1418 FreePool (DataItem
->Data
.Ptr
);
1420 DataItem
->Data
.Ptr
= Tmp
;
1423 CopyMem (DataItem
->Data
.Ptr
, Data
, DataSize
);
1424 DataItem
->DataSize
= DataSize
;
1425 DataItem
->Status
= EFI_SUCCESS
;
1432 The work function is to set the DNS server list for the EFI IPv4 network
1433 stack running on the communication device that this EFI_IP4_CONFIG2_PROTOCOL
1434 manages. It is not configurable when the policy is Ip4Config2PolicyDhcp.
1435 The DNS server addresses must be unicast IPv4 addresses.
1437 @param[in] Instance The pointer to the IP4 config2 instance data.
1438 @param[in] DataSize The size of the buffer pointed to by Data in bytes.
1439 @param[in] Data The data buffer to set, points to an array of
1440 EFI_IPv4_ADDRESS instances.
1442 @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type.
1443 @retval EFI_WRITE_PROTECTED The specified configuration data cannot be set
1444 under the current policy.
1445 @retval EFI_INVALID_PARAMETER One or more fields in Data is invalid.
1446 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation.
1447 @retval EFI_ABORTED The DNS server addresses to be set equal the current
1449 @retval EFI_SUCCESS The specified configuration data for the EFI IPv4
1450 network stack was set.
1454 Ip4Config2SetDnsServer (
1455 IN IP4_CONFIG2_INSTANCE
*Instance
,
1460 IP4_CONFIG2_DATA_ITEM
*Item
;
1464 if (Instance
->Policy
!= Ip4Config2PolicyStatic
) {
1465 return EFI_WRITE_PROTECTED
;
1468 Item
= &Instance
->DataItem
[Ip4Config2DataTypeDnsServer
];
1470 if (DATA_ATTRIB_SET (Item
->Attribute
, DATA_ATTRIB_VOLATILE
)) {
1471 REMOVE_DATA_ATTRIB (Item
->Attribute
, DATA_ATTRIB_VOLATILE
);
1474 return Ip4Config2SetDnsServerWorker (Instance
, DataSize
, Data
);
1478 Generate the operational state of the interface this IP4 config2 instance manages
1479 and output in EFI_IP4_CONFIG2_INTERFACE_INFO.
1481 @param[in] IpSb The pointer to the IP4 service binding instance.
1482 @param[out] IfInfo The pointer to the IP4 config2 interface information structure.
1486 Ip4Config2InitIfInfo (
1487 IN IP4_SERVICE
*IpSb
,
1488 OUT EFI_IP4_CONFIG2_INTERFACE_INFO
*IfInfo
1491 IfInfo
->Name
[0] = L
'e';
1492 IfInfo
->Name
[1] = L
't';
1493 IfInfo
->Name
[2] = L
'h';
1494 IfInfo
->Name
[3] = (CHAR16
) (L
'0' + IpSb
->Ip4Config2Instance
.IfIndex
);
1495 IfInfo
->Name
[4] = 0;
1497 IfInfo
->IfType
= IpSb
->SnpMode
.IfType
;
1498 IfInfo
->HwAddressSize
= IpSb
->SnpMode
.HwAddressSize
;
1499 CopyMem (&IfInfo
->HwAddress
, &IpSb
->SnpMode
.CurrentAddress
, IfInfo
->HwAddressSize
);
1503 The event handle routine when DHCPv4 process is finished or is updated.
1505 @param[in] Event Not used.
1506 @param[in] Context The pointer to the IP4 configuration instance data.
1511 Ip4Config2OnDhcp4Event (
1521 Set the configuration for the EFI IPv4 network stack running on the communication
1522 device this EFI_IP4_CONFIG2_PROTOCOL instance manages.
1524 This function is used to set the configuration data of type DataType for the EFI
1525 IPv4 network stack that is running on the communication device that this EFI IPv4
1526 Configuration Protocol instance manages.
1528 DataSize is used to calculate the count of structure instances in the Data for
1529 a DataType in which multiple structure instances are allowed.
1531 This function is always non-blocking. When setting some type of configuration data,
1532 an asynchronous process is invoked to check the correctness of the data, such as
1533 performing Duplicate Address Detection on the manually set local IPv4 addresses.
1534 EFI_NOT_READY is returned immediately to indicate that such an asynchronous process
1535 is invoked, and the process is not finished yet. The caller wanting to get the result
1536 of the asynchronous process is required to call RegisterDataNotify() to register an
1537 event on the specified configuration data. Once the event is signaled, the caller
1538 can call GetData() to obtain the configuration data and know the result.
1539 For other types of configuration data that do not require an asynchronous configuration
1540 process, the result of the operation is immediately returned.
1542 @param[in] This The pointer to the EFI_IP4_CONFIG2_PROTOCOL instance.
1543 @param[in] DataType The type of data to set.
1544 @param[in] DataSize Size of the buffer pointed to by Data in bytes.
1545 @param[in] Data The data buffer to set. The type of the data buffer is
1546 associated with the DataType.
1548 @retval EFI_SUCCESS The specified configuration data for the EFI IPv6
1549 network stack was set successfully.
1550 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
1553 - One or more fields in Data do not match the requirement of the
1554 data type indicated by DataType.
1555 @retval EFI_WRITE_PROTECTED The specified configuration data is read-only or the specified
1556 configuration data cannot be set under the current policy.
1557 @retval EFI_ACCESS_DENIED Another set operation on the specified configuration
1558 data is already in process.
1559 @retval EFI_NOT_READY An asynchronous process was invoked to set the specified
1560 configuration data, and the process is not finished yet.
1561 @retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type
1562 indicated by DataType.
1563 @retval EFI_UNSUPPORTED This DataType is not supported.
1564 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1565 @retval EFI_DEVICE_ERROR An unexpected system error or network error occurred.
1570 EfiIp4Config2SetData (
1571 IN EFI_IP4_CONFIG2_PROTOCOL
*This
,
1572 IN EFI_IP4_CONFIG2_DATA_TYPE DataType
,
1579 IP4_CONFIG2_INSTANCE
*Instance
;
1582 if ((This
== NULL
) || (Data
== NULL
)) {
1583 return EFI_INVALID_PARAMETER
;
1586 if (DataType
>= Ip4Config2DataTypeMaximum
) {
1587 return EFI_UNSUPPORTED
;
1590 Instance
= IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This
);
1591 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
1592 NET_CHECK_SIGNATURE (IpSb
, IP4_SERVICE_SIGNATURE
);
1595 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1597 Status
= Instance
->DataItem
[DataType
].Status
;
1598 if (Status
!= EFI_NOT_READY
) {
1600 if (Instance
->DataItem
[DataType
].SetData
== NULL
) {
1602 // This type of data is readonly.
1604 Status
= EFI_WRITE_PROTECTED
;
1607 Status
= Instance
->DataItem
[DataType
].SetData (Instance
, DataSize
, Data
);
1608 if (!EFI_ERROR (Status
)) {
1610 // Fire up the events registered with this type of data.
1612 NetMapIterate (&Instance
->DataItem
[DataType
].EventMap
, Ip4Config2SignalEvent
, NULL
);
1613 Ip4Config2WriteConfigData (IpSb
->MacString
, Instance
);
1614 } else if (Status
== EFI_ABORTED
) {
1616 // The SetData is aborted because the data to set is the same with
1617 // the one maintained.
1619 Status
= EFI_SUCCESS
;
1620 NetMapIterate (&Instance
->DataItem
[DataType
].EventMap
, Ip4Config2SignalEvent
, NULL
);
1625 // Another asynchornous process is on the way.
1627 Status
= EFI_ACCESS_DENIED
;
1630 gBS
->RestoreTPL (OldTpl
);
1636 Get the configuration data for the EFI IPv4 network stack running on the communication
1637 device that this EFI_IP4_CONFIG2_PROTOCOL instance manages.
1639 This function returns the configuration data of type DataType for the EFI IPv4 network
1640 stack running on the communication device that this EFI IPv4 Configuration Protocol instance
1643 The caller is responsible for allocating the buffer used to return the specified
1644 configuration data. The required size will be returned to the caller if the size of
1645 the buffer is too small.
1647 EFI_NOT_READY is returned if the specified configuration data is not ready due to an
1648 asynchronous configuration process already in progress. The caller can call RegisterDataNotify()
1649 to register an event on the specified configuration data. Once the asynchronous configuration
1650 process is finished, the event will be signaled, and a subsequent GetData() call will return
1651 the specified configuration data.
1653 @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance.
1654 @param[in] DataType The type of data to get.
1655 @param[in, out] DataSize On input, in bytes, the size of Data. On output, in bytes, the
1656 size of buffer required to store the specified configuration data.
1657 @param[in] Data The data buffer in which the configuration data is returned. The
1658 type of the data buffer is associated with the DataType.
1659 This is an optional parameter that may be NULL.
1661 @retval EFI_SUCCESS The specified configuration data was obtained successfully.
1662 @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE:
1665 - Data is NULL if *DataSize is not zero.
1666 @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified configuration data,
1667 and the required size is returned in DataSize.
1668 @retval EFI_NOT_READY The specified configuration data is not ready due to an
1669 asynchronous configuration process already in progress.
1670 @retval EFI_NOT_FOUND The specified configuration data is not found.
1675 EfiIp4Config2GetData (
1676 IN EFI_IP4_CONFIG2_PROTOCOL
*This
,
1677 IN EFI_IP4_CONFIG2_DATA_TYPE DataType
,
1678 IN OUT UINTN
*DataSize
,
1679 IN VOID
*Data OPTIONAL
1684 IP4_CONFIG2_INSTANCE
*Instance
;
1685 IP4_CONFIG2_DATA_ITEM
*DataItem
;
1687 if ((This
== NULL
) || (DataSize
== NULL
) || ((*DataSize
!= 0) && (Data
== NULL
))) {
1688 return EFI_INVALID_PARAMETER
;
1691 if (DataType
>= Ip4Config2DataTypeMaximum
) {
1692 return EFI_NOT_FOUND
;
1695 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1697 Instance
= IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This
);
1698 DataItem
= &Instance
->DataItem
[DataType
];
1700 Status
= Instance
->DataItem
[DataType
].Status
;
1701 if (!EFI_ERROR (Status
)) {
1703 if (DataItem
->GetData
!= NULL
) {
1705 Status
= DataItem
->GetData (Instance
, DataSize
, Data
);
1706 } else if (*DataSize
< Instance
->DataItem
[DataType
].DataSize
) {
1708 // Update the buffer length.
1710 *DataSize
= Instance
->DataItem
[DataType
].DataSize
;
1711 Status
= EFI_BUFFER_TOO_SMALL
;
1714 *DataSize
= Instance
->DataItem
[DataType
].DataSize
;
1715 CopyMem (Data
, Instance
->DataItem
[DataType
].Data
.Ptr
, *DataSize
);
1719 gBS
->RestoreTPL (OldTpl
);
1725 Register an event that is signaled whenever a configuration process on the specified
1726 configuration data is done.
1728 This function registers an event that is to be signaled whenever a configuration
1729 process on the specified configuration data is performed. An event can be registered
1730 for a different DataType simultaneously. The caller is responsible for determining
1731 which type of configuration data causes the signaling of the event in such an event.
1733 @param[in] This Pointer to the EFI_IP4_CONFIG2_PROTOCOL instance.
1734 @param[in] DataType The type of data to unregister the event for.
1735 @param[in] Event The event to register.
1737 @retval EFI_SUCCESS The notification event for the specified configuration data is
1739 @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL.
1740 @retval EFI_UNSUPPORTED The configuration data type specified by DataType is not
1742 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
1743 @retval EFI_ACCESS_DENIED The Event is already registered for the DataType.
1748 EfiIp4Config2RegisterDataNotify (
1749 IN EFI_IP4_CONFIG2_PROTOCOL
*This
,
1750 IN EFI_IP4_CONFIG2_DATA_TYPE DataType
,
1756 IP4_CONFIG2_INSTANCE
*Instance
;
1760 if ((This
== NULL
) || (Event
== NULL
)) {
1761 return EFI_INVALID_PARAMETER
;
1764 if (DataType
>= Ip4Config2DataTypeMaximum
) {
1765 return EFI_UNSUPPORTED
;
1768 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1770 Instance
= IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This
);
1771 EventMap
= &Instance
->DataItem
[DataType
].EventMap
;
1774 // Check whether this event is already registered for this DataType.
1776 Item
= NetMapFindKey (EventMap
, Event
);
1779 Status
= NetMapInsertTail (EventMap
, Event
, NULL
);
1781 if (EFI_ERROR (Status
)) {
1783 Status
= EFI_OUT_OF_RESOURCES
;
1788 Status
= EFI_ACCESS_DENIED
;
1791 gBS
->RestoreTPL (OldTpl
);
1797 Remove a previously registered event for the specified configuration data.
1799 @param This The pointer to the EFI_IP4_CONFIG2_PROTOCOL instance.
1800 @param DataType The type of data to remove from the previously
1802 @param Event The event to be unregistered.
1804 @retval EFI_SUCCESS The event registered for the specified
1805 configuration data was removed.
1806 @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL.
1807 @retval EFI_NOT_FOUND The Event has not been registered for the
1813 EfiIp4Config2UnregisterDataNotify (
1814 IN EFI_IP4_CONFIG2_PROTOCOL
*This
,
1815 IN EFI_IP4_CONFIG2_DATA_TYPE DataType
,
1821 IP4_CONFIG2_INSTANCE
*Instance
;
1824 if ((This
== NULL
) || (Event
== NULL
)) {
1825 return EFI_INVALID_PARAMETER
;
1828 if (DataType
>= Ip4Config2DataTypeMaximum
) {
1829 return EFI_NOT_FOUND
;
1832 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1834 Instance
= IP4_CONFIG2_INSTANCE_FROM_PROTOCOL (This
);
1836 Item
= NetMapFindKey (&Instance
->DataItem
[DataType
].EventMap
, Event
);
1839 NetMapRemoveItem (&Instance
->DataItem
[DataType
].EventMap
, Item
, NULL
);
1840 Status
= EFI_SUCCESS
;
1843 Status
= EFI_NOT_FOUND
;
1846 gBS
->RestoreTPL (OldTpl
);
1852 Initialize an IP4_CONFIG2_INSTANCE.
1854 @param[out] Instance The buffer of IP4_CONFIG2_INSTANCE to be initialized.
1856 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation.
1857 @retval EFI_SUCCESS The IP4_CONFIG2_INSTANCE initialized successfully.
1861 Ip4Config2InitInstance (
1862 OUT IP4_CONFIG2_INSTANCE
*Instance
1866 IP4_CONFIG2_INSTANCE
*TmpInstance
;
1871 IP4_CONFIG2_DATA_ITEM
*DataItem
;
1874 IpSb
= IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE (Instance
);
1876 Instance
->Signature
= IP4_CONFIG2_INSTANCE_SIGNATURE
;
1880 // Determine the index of this interface.
1883 NET_LIST_FOR_EACH (Entry
, &mIp4Config2InstanceList
) {
1884 TmpInstance
= NET_LIST_USER_STRUCT_S (Entry
, IP4_CONFIG2_INSTANCE
, Link
, IP4_CONFIG2_INSTANCE_SIGNATURE
);
1886 if (TmpInstance
->IfIndex
> IfIndex
) {
1888 // There is a sequence hole because some interface is down.
1896 Instance
->IfIndex
= IfIndex
;
1897 NetListInsertBefore (Entry
, &Instance
->Link
);
1899 for (Index
= 0; Index
< Ip4Config2DataTypeMaximum
; Index
++) {
1901 // Initialize the event map for each data item.
1903 NetMapInit (&Instance
->DataItem
[Index
].EventMap
);
1908 // Initialize each data type: associate storage and set data size for the
1909 // fixed size data types, hook the SetData function, set the data attribute.
1911 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeInterfaceInfo
];
1912 DataItem
->GetData
= Ip4Config2GetIfInfo
;
1913 DataItem
->Data
.Ptr
= &Instance
->InterfaceInfo
;
1914 DataItem
->DataSize
= sizeof (Instance
->InterfaceInfo
);
1915 SET_DATA_ATTRIB (DataItem
->Attribute
, DATA_ATTRIB_SIZE_FIXED
| DATA_ATTRIB_VOLATILE
);
1916 Ip4Config2InitIfInfo (IpSb
, &Instance
->InterfaceInfo
);
1918 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypePolicy
];
1919 DataItem
->SetData
= Ip4Config2SetPolicy
;
1920 DataItem
->Data
.Ptr
= &Instance
->Policy
;
1921 DataItem
->DataSize
= sizeof (Instance
->Policy
);
1922 Instance
->Policy
= Ip4Config2PolicyStatic
;
1923 SET_DATA_ATTRIB (DataItem
->Attribute
, DATA_ATTRIB_SIZE_FIXED
);
1925 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeManualAddress
];
1926 DataItem
->SetData
= Ip4Config2SetMaunualAddress
;
1927 DataItem
->Status
= EFI_NOT_FOUND
;
1929 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeGateway
];
1930 DataItem
->SetData
= Ip4Config2SetGateway
;
1931 DataItem
->Status
= EFI_NOT_FOUND
;
1933 DataItem
= &Instance
->DataItem
[Ip4Config2DataTypeDnsServer
];
1934 DataItem
->SetData
= Ip4Config2SetDnsServer
;
1935 DataItem
->Status
= EFI_NOT_FOUND
;
1938 // Create the event used for DHCP.
1940 Status
= gBS
->CreateEvent (
1943 Ip4Config2OnDhcp4Event
,
1945 &Instance
->Dhcp4Event
1947 ASSERT_EFI_ERROR (Status
);
1949 Instance
->Configured
= TRUE
;
1952 // Try to read the config data from NV variable.
1953 // If not found, write initialized config data into NV variable
1954 // as a default config data.
1956 Status
= Ip4Config2ReadConfigData (IpSb
->MacString
, Instance
);
1957 if (Status
== EFI_NOT_FOUND
) {
1958 Status
= Ip4Config2WriteConfigData (IpSb
->MacString
, Instance
);
1961 if (EFI_ERROR (Status
)) {
1965 Instance
->Ip4Config2
.SetData
= EfiIp4Config2SetData
;
1966 Instance
->Ip4Config2
.GetData
= EfiIp4Config2GetData
;
1967 Instance
->Ip4Config2
.RegisterDataNotify
= EfiIp4Config2RegisterDataNotify
;
1968 Instance
->Ip4Config2
.UnregisterDataNotify
= EfiIp4Config2UnregisterDataNotify
;
1971 // Publish the IP4 configuration form
1973 return Ip4Config2FormInit (Instance
);
1978 Release an IP4_CONFIG2_INSTANCE.
1980 @param[in, out] Instance The buffer of IP4_CONFIG2_INSTANCE to be freed.
1984 Ip4Config2CleanInstance (
1985 IN OUT IP4_CONFIG2_INSTANCE
*Instance
1989 IP4_CONFIG2_DATA_ITEM
*DataItem
;
1991 if (Instance
->DeclineAddress
!= NULL
) {
1992 FreePool (Instance
->DeclineAddress
);
1995 if (!Instance
->Configured
) {
1999 if (Instance
->Dhcp4Handle
!= NULL
) {
2001 Ip4Config2DestroyDhcp4 (Instance
);
2007 if (Instance
->Dhcp4Event
!= NULL
) {
2008 gBS
->CloseEvent (Instance
->Dhcp4Event
);
2009 Instance
->Dhcp4Event
= NULL
;
2012 for (Index
= 0; Index
< Ip4Config2DataTypeMaximum
; Index
++) {
2014 DataItem
= &Instance
->DataItem
[Index
];
2016 if (!DATA_ATTRIB_SET (DataItem
->Attribute
, DATA_ATTRIB_SIZE_FIXED
)) {
2017 if (DataItem
->Data
.Ptr
!= NULL
) {
2018 FreePool (DataItem
->Data
.Ptr
);
2020 DataItem
->Data
.Ptr
= NULL
;
2021 DataItem
->DataSize
= 0;
2024 NetMapClean (&Instance
->DataItem
[Index
].EventMap
);
2027 Ip4Config2FormUnload (Instance
);
2029 RemoveEntryList (&Instance
->Link
);
2033 The event handle for IP4 auto reconfiguration. The original default
2034 interface and route table will be removed as the default.
2036 @param[in] Context The IP4 service binding instance.
2041 Ip4AutoReconfigCallBackDpc (
2047 IpSb
= (IP4_SERVICE
*) Context
;
2048 NET_CHECK_SIGNATURE (IpSb
, IP4_SERVICE_SIGNATURE
);
2050 if (IpSb
->State
> IP4_SERVICE_UNSTARTED
) {
2051 IpSb
->State
= IP4_SERVICE_UNSTARTED
;
2054 IpSb
->Reconfig
= TRUE
;
2056 Ip4StartAutoConfig (&IpSb
->Ip4Config2Instance
);
2063 Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK.
2065 @param Event The event that is signalled.
2066 @param Context The IP4 service binding instance.
2071 Ip4AutoReconfigCallBack (
2077 // Request Ip4AutoReconfigCallBackDpc as a DPC at TPL_CALLBACK
2079 QueueDpc (TPL_CALLBACK
, Ip4AutoReconfigCallBackDpc
, Context
);