[mirror_edk2.git] / NetworkPkg / Ip6Dxe / Ip6ConfigImpl.h

/** @file\r
  Definitions for EFI IPv6 Configuartion Protocol implementation.\r
\r
  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __IP6_CONFIG_IMPL_H__\r
#define __IP6_CONFIG_IMPL_H__\r
\r
#define IP6_CONFIG_INSTANCE_SIGNATURE    SIGNATURE_32 ('I', 'P', '6', 'C')\r
#define IP6_FORM_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('I', 'F', 'C', 'I')\r
#define IP6_CONFIG_VARIABLE_ATTRIBUTE    (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)\r
\r
#define IP6_CONFIG_DEFAULT_DAD_XMITS        1\r
#define IP6_CONFIG_DHCP6_OPTION_ORO         6\r
#define IP6_CONFIG_DHCP6_OPTION_DNS_SERVERS 23\r
\r
#define DATA_ATTRIB_SIZE_FIXED              0x1\r
#define DATA_ATTRIB_VOLATILE                0x2\r
\r
#define DATA_ATTRIB_SET(Attrib, Bits)       (BOOLEAN)((Attrib) & (Bits))\r
#define SET_DATA_ATTRIB(Attrib, Bits)       ((Attrib) |= (Bits))\r
\r
typedef struct _IP6_CONFIG_INSTANCE IP6_CONFIG_INSTANCE;\r
\r
#define IP6_CONFIG_INSTANCE_FROM_PROTOCOL(Proto) \\r
  CR ((Proto), \\r
      IP6_CONFIG_INSTANCE, \\r
      Ip6Config, \\r
      IP6_CONFIG_INSTANCE_SIGNATURE \\r
      )\r
\r
\r
#define IP6_CONFIG_INSTANCE_FROM_FORM_CALLBACK(Callback) \\r
  CR ((Callback), \\r
      IP6_CONFIG_INSTANCE, \\r
      CallbackInfo, \\r
      IP6_CONFIG_INSTANCE_SIGNATURE \\r
      )\r
\r
#define IP6_SERVICE_FROM_IP6_CONFIG_INSTANCE(Instance) \\r
  CR ((Instance), \\r
      IP6_SERVICE, \\r
      Ip6ConfigInstance, \\r
      IP6_SERVICE_SIGNATURE \\r
      )\r
\r
#define IP6_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(ConfigAccess) \\r
  CR ((ConfigAccess), \\r
      IP6_FORM_CALLBACK_INFO, \\r
      HiiConfigAccess, \\r
      IP6_FORM_CALLBACK_INFO_SIGNATURE \\r
      )\r
\r
/**\r
  The prototype of work function for EfiIp6ConfigSetData().\r
\r
  @param[in]     Instance The pointer to the IP6 config instance data.\r
  @param[in]     DataSize In bytes, the size of the buffer pointed to by Data.\r
  @param[in]     Data     The data buffer to set.\r
\r
  @retval EFI_BAD_BUFFER_SIZE  The DataSize does not match the size of the type,\r
                               8 bytes.\r
  @retval EFI_SUCCESS          The specified configuration data for the EFI IPv6\r
                               network stack was set successfully.\r
  \r
**/\r
typedef\r
EFI_STATUS\r
(*IP6_CONFIG_SET_DATA) (\r
  IN IP6_CONFIG_INSTANCE  *Instance,\r
  IN UINTN                DataSize,\r
  IN VOID                 *Data\r
  );\r
\r
/**\r
  The prototype of work function for EfiIp6ConfigGetData().\r
\r
  @param[in]      Instance The pointer to the IP6 config instance data.\r
  @param[in, out] DataSize On input, in bytes, the size of Data. On output, in\r
                           bytes, the size of buffer required to store the specified\r
                           configuration data.\r
  @param[in]      Data     The data buffer in which the configuration data is returned.  \r
                           Ignored if DataSize is ZERO.\r
\r
  @retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified\r
                               configuration data, and the required size is \r
                               returned in DataSize.\r
  @retval EFI_SUCCESS          The specified configuration data was obtained successfully.                               \r
  \r
**/\r
typedef\r
EFI_STATUS\r
(*IP6_CONFIG_GET_DATA) (\r
  IN IP6_CONFIG_INSTANCE  *Instance,\r
  IN OUT UINTN            *DataSize,\r
  IN VOID                 *Data      OPTIONAL\r
  );\r
\r
typedef union {\r
  VOID                                      *Ptr;\r
  EFI_IP6_CONFIG_INTERFACE_INFO             *IfInfo;\r
  EFI_IP6_CONFIG_INTERFACE_ID               *AltIfId;\r
  EFI_IP6_CONFIG_POLICY                     *Policy;\r
  EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS  *DadXmits;\r
  EFI_IP6_CONFIG_MANUAL_ADDRESS             *ManualAddress;\r
  EFI_IPv6_ADDRESS                          *Gateway;\r
  EFI_IPv6_ADDRESS                          *DnsServers;\r
} IP6_CONFIG_DATA;\r
\r
typedef struct {\r
  IP6_CONFIG_SET_DATA  SetData;\r
  IP6_CONFIG_GET_DATA  GetData;\r
  EFI_STATUS           Status;\r
  UINT8                Attribute;\r
  NET_MAP              EventMap;\r
  IP6_CONFIG_DATA      Data;\r
  UINTN                DataSize;\r
} IP6_CONFIG_DATA_ITEM;\r
\r
typedef struct {\r
  UINT16                    Offset;\r
  UINT32                    DataSize;\r
  EFI_IP6_CONFIG_DATA_TYPE  DataType;\r
} IP6_CONFIG_DATA_RECORD;\r
\r
#pragma pack(1)\r
\r
//\r
// heap data that contains the data for each data record.\r
//\r
//  BOOLEAN                                   IsAltIfIdSet;\r
//  EFI_IP6_CONFIG_POLICY                     Policy;\r
//  EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS  DadXmits;\r
//  UINT32                                    ManualaddressCount;\r
//  UINT32                                    GatewayCount;\r
//  UINT32                                    DnsServersCount;\r
//  EFI_IP6_CONFIG_INTERFACE_ID               AltIfId;\r
//  EFI_IP6_CONFIG_MANUAL_ADDRESS             ManualAddress[];\r
//  EFI_IPv6_ADDRESS                          Gateway[];\r
//  EFI_IPv6_ADDRESS                          DnsServers[];\r
//\r
typedef struct {\r
  UINT32                  IaId;\r
  UINT16                  Checksum;\r
  UINT16                  DataRecordCount;\r
  IP6_CONFIG_DATA_RECORD  DataRecord[1];\r
} IP6_CONFIG_VARIABLE;\r
\r
#pragma pack()\r
\r
typedef struct {\r
  LIST_ENTRY                  Link;\r
  EFI_IP6_ADDRESS_INFO        AddrInfo;\r
} IP6_ADDRESS_INFO_ENTRY;\r
\r
typedef struct {\r
  EFI_IP6_CONFIG_POLICY                    Policy;              ///< manual or automatic  \r
  EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS DadTransmitCount;    ///< dad transmits count\r
  EFI_IP6_CONFIG_INTERFACE_ID              InterfaceId;         ///< alternative interface id \r
  LIST_ENTRY                               ManualAddress;       ///< IP addresses\r
  UINT32                                   ManualAddressCount;  ///< IP addresses count\r
  LIST_ENTRY                               GatewayAddress;      ///< Gateway address\r
  UINT32                                   GatewayAddressCount; ///< Gateway address count\r
  LIST_ENTRY                               DnsAddress;          ///< DNS server address\r
  UINT32                                   DnsAddressCount;     ///< DNS server address count\r
} IP6_CONFIG_NVDATA;\r
\r
typedef struct _IP6_FORM_CALLBACK_INFO {\r
  UINT32                           Signature;\r
  EFI_HANDLE                       ChildHandle;\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL   HiiConfigAccess;\r
  EFI_DEVICE_PATH_PROTOCOL         *HiiVendorDevicePath;\r
  EFI_HII_HANDLE                   RegisteredHandle;\r
} IP6_FORM_CALLBACK_INFO;\r
\r
struct _IP6_CONFIG_INSTANCE {\r
  UINT32                                    Signature;\r
  BOOLEAN                                   Configured;\r
  LIST_ENTRY                                Link;\r
  UINT16                                    IfIndex;\r
\r
  EFI_IP6_CONFIG_INTERFACE_INFO             InterfaceInfo;\r
  EFI_IP6_CONFIG_INTERFACE_ID               AltIfId;\r
  EFI_IP6_CONFIG_POLICY                     Policy;\r
  EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS  DadXmits;\r
\r
  IP6_CONFIG_DATA_ITEM                      DataItem[Ip6ConfigDataTypeMaximum];\r
  NET_MAP                                   DadFailedMap;\r
  NET_MAP                                   DadPassedMap;\r
\r
  EFI_IP6_CONFIG_PROTOCOL                   Ip6Config;\r
\r
  EFI_EVENT                                 Dhcp6SbNotifyEvent;\r
  VOID                                      *Registration;\r
  EFI_HANDLE                                Dhcp6Handle;\r
  EFI_DHCP6_PROTOCOL                        *Dhcp6;\r
  BOOLEAN                                   OtherInfoOnly;\r
  UINT32                                    IaId;\r
  EFI_EVENT                                 Dhcp6Event;\r
  UINT32                                    FailedIaAddressCount;\r
  EFI_IPv6_ADDRESS                          *DeclineAddress;\r
  UINT32                                    DeclineAddressCount;\r
\r
  IP6_FORM_CALLBACK_INFO                    CallbackInfo;\r
  IP6_CONFIG_NVDATA                         Ip6NvData;\r
};\r
\r
/**\r
  Read the configuration data from variable storage according to the VarName and\r
  gEfiIp6ConfigProtocolGuid. It checks the integrity of variable data. If the\r
  data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the\r
  configuration data to IP6_CONFIG_INSTANCE.\r
\r
  @param[in]      VarName  The pointer to the variable name\r
  @param[in, out] Instance The pointer to the IP6 config instance data.\r
\r
  @retval EFI_NOT_FOUND         The variable can not be found or already corrupted.\r
  @retval EFI_OUT_OF_RESOURCES  Fail to allocate resource to complete the operation.\r
  @retval EFI_SUCCESS           The configuration data was retrieved successfully.\r
\r
**/\r
EFI_STATUS\r
Ip6ConfigReadConfigData (\r
  IN     CHAR16               *VarName,\r
  IN OUT IP6_CONFIG_INSTANCE  *Instance\r
  );\r
\r
/**\r
  The event process routine when the DHCPv6 server is answered with a reply packet\r
  for an information request.\r
  \r
  @param[in]     This          Points to the EFI_DHCP6_PROTOCOL.\r
  @param[in]     Context       The pointer to the IP6 configuration instance data.\r
  @param[in]     Packet        The DHCPv6 reply packet.\r
\r
  @retval EFI_SUCCESS      The DNS server address was retrieved from the reply packet.\r
  @retval EFI_NOT_READY    The reply packet does not contain the DNS server option, or \r
                           the DNS server address is not valid.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ip6ConfigOnDhcp6Reply (\r
  IN EFI_DHCP6_PROTOCOL  *This,\r
  IN VOID                *Context,\r
  IN EFI_DHCP6_PACKET    *Packet\r
  );\r
\r
/**\r
  The work function to trigger the DHCPv6 process to perform a stateful autoconfiguration.\r
  \r
  @param[in]     Instance      Pointer to the IP6 config instance data.\r
  @param[in]     OtherInfoOnly If FALSE, get stateful address and other information\r
                               via DHCPv6. Otherwise, only get the other information.\r
\r
  @retval    EFI_SUCCESS       The operation finished successfully.\r
  @retval    EFI_UNSUPPORTED   The DHCP6 driver is not available.\r
\r
**/\r
EFI_STATUS\r
Ip6ConfigStartStatefulAutoConfig (\r
  IN IP6_CONFIG_INSTANCE  *Instance,\r
  IN BOOLEAN              OtherInfoOnly\r
  );\r
\r
/**\r
  Initialize an IP6_CONFIG_INSTANCE.\r
\r
  @param[out]    Instance       The buffer of IP6_CONFIG_INSTANCE to be initialized.\r
  \r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resources to complete the operation.\r
  @retval EFI_SUCCESS           The IP6_CONFIG_INSTANCE initialized successfully.\r
  \r
**/\r
EFI_STATUS\r
Ip6ConfigInitInstance (\r
  OUT IP6_CONFIG_INSTANCE  *Instance\r
  );\r
\r
/**\r
  Release an IP6_CONFIG_INSTANCE.\r
\r
  @param[in, out] Instance    The buffer of IP6_CONFIG_INSTANCE to be freed.\r
  \r
**/\r
VOID\r
Ip6ConfigCleanInstance (\r
  IN OUT IP6_CONFIG_INSTANCE  *Instance\r
  );\r
\r
/**\r
  Destroy the Dhcp6 child in IP6_CONFIG_INSTANCE and release the resources.\r
\r
  @param[in, out] Instance    The buffer of IP6_CONFIG_INSTANCE to be freed.\r
\r
  @retval EFI_SUCCESS         The child was successfully destroyed.\r
  @retval Others              Failed to destroy the child.\r
  \r
**/\r
EFI_STATUS\r
Ip6ConfigDestroyDhcp6 (\r
  IN OUT IP6_CONFIG_INSTANCE  *Instance\r
  );\r
\r
#endif\r
Commit	Line	Data
a3bcde70 HT	1	/** @file\r
	2	Definitions for EFI IPv6 Configuartion Protocol implementation.\r
	3	\r
4720106b	4	Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
a3bcde70 HT	5	\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php.\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef __IP6_CONFIG_IMPL_H__\r
	17	#define __IP6_CONFIG_IMPL_H__\r
	18	\r
	19	#define IP6_CONFIG_INSTANCE_SIGNATURE SIGNATURE_32 ('I', 'P', '6', 'C')\r
	20	#define IP6_FORM_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('I', 'F', 'C', 'I')\r
	21	#define IP6_CONFIG_VARIABLE_ATTRIBUTE (EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS)\r
	22	\r
	23	#define IP6_CONFIG_DEFAULT_DAD_XMITS 1\r
	24	#define IP6_CONFIG_DHCP6_OPTION_ORO 6\r
	25	#define IP6_CONFIG_DHCP6_OPTION_DNS_SERVERS 23\r
	26	\r
	27	#define DATA_ATTRIB_SIZE_FIXED 0x1\r
	28	#define DATA_ATTRIB_VOLATILE 0x2\r
	29	\r
	30	#define DATA_ATTRIB_SET(Attrib, Bits) (BOOLEAN)((Attrib) & (Bits))\r
	31	#define SET_DATA_ATTRIB(Attrib, Bits) ((Attrib) \|= (Bits))\r
	32	\r
	33	typedef struct _IP6_CONFIG_INSTANCE IP6_CONFIG_INSTANCE;\r
	34	\r
	35	#define IP6_CONFIG_INSTANCE_FROM_PROTOCOL(Proto) \\r
	36	CR ((Proto), \\r
	37	IP6_CONFIG_INSTANCE, \\r
	38	Ip6Config, \\r
	39	IP6_CONFIG_INSTANCE_SIGNATURE \\r
	40	)\r
	41	\r
	42	\r
	43	#define IP6_CONFIG_INSTANCE_FROM_FORM_CALLBACK(Callback) \\r
	44	CR ((Callback), \\r
	45	IP6_CONFIG_INSTANCE, \\r
	46	CallbackInfo, \\r
	47	IP6_CONFIG_INSTANCE_SIGNATURE \\r
	48	)\r
	49	\r
	50	#define IP6_SERVICE_FROM_IP6_CONFIG_INSTANCE(Instance) \\r
	51	CR ((Instance), \\r
	52	IP6_SERVICE, \\r
	53	Ip6ConfigInstance, \\r
	54	IP6_SERVICE_SIGNATURE \\r
	55	)\r
	56	\r
	57	#define IP6_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(ConfigAccess) \\r
	58	CR ((ConfigAccess), \\r
	59	IP6_FORM_CALLBACK_INFO, \\r
	60	HiiConfigAccess, \\r
	61	IP6_FORM_CALLBACK_INFO_SIGNATURE \\r
	62	)\r
	63	\r
	64	/**\r
	65	The prototype of work function for EfiIp6ConfigSetData().\r
	66	\r
	67	@param[in] Instance The pointer to the IP6 config instance data.\r
	68	@param[in] DataSize In bytes, the size of the buffer pointed to by Data.\r
69	@param[in] Data The data buffer to set.\r
70	\r
71	@retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type,\r
72	8 bytes.\r
73	@retval EFI_SUCCESS The specified configuration data for the EFI IPv6\r
74	network stack was set successfully.\r
75	\r
76	**/\r
77	typedef\r
78	EFI_STATUS\r
79	(*IP6_CONFIG_SET_DATA) (\r
80	IN IP6_CONFIG_INSTANCE *Instance,\r
81	IN UINTN DataSize,\r
82	IN VOID *Data\r
83	);\r
84	\r
85	/**\r
86	The prototype of work function for EfiIp6ConfigGetData().\r
87	\r
88	@param[in] Instance The pointer to the IP6 config instance data.\r
89	@param[in, out] DataSize On input, in bytes, the size of Data. On output, in\r
90	bytes, the size of buffer required to store the specified\r
91	configuration data.\r
92	@param[in] Data The data buffer in which the configuration data is returned. \r
93	Ignored if DataSize is ZERO.\r
94	\r
95	@retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified\r
96	configuration data, and the required size is \r
97	returned in DataSize.\r
98	@retval EFI_SUCCESS The specified configuration data was obtained successfully. \r
99	\r
100	**/\r
101	typedef\r
102	EFI_STATUS\r
103	(*IP6_CONFIG_GET_DATA) (\r
104	IN IP6_CONFIG_INSTANCE *Instance,\r
105	IN OUT UINTN *DataSize,\r
106	IN VOID *Data OPTIONAL\r
107	);\r
108	\r
109	typedef union {\r
110	VOID *Ptr;\r
111	EFI_IP6_CONFIG_INTERFACE_INFO *IfInfo;\r
112	EFI_IP6_CONFIG_INTERFACE_ID *AltIfId;\r
113	EFI_IP6_CONFIG_POLICY *Policy;\r
114	EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS *DadXmits;\r
115	EFI_IP6_CONFIG_MANUAL_ADDRESS *ManualAddress;\r
116	EFI_IPv6_ADDRESS *Gateway;\r
117	EFI_IPv6_ADDRESS *DnsServers;\r
118	} IP6_CONFIG_DATA;\r
119	\r
120	typedef struct {\r
121	IP6_CONFIG_SET_DATA SetData;\r
122	IP6_CONFIG_GET_DATA GetData;\r
123	EFI_STATUS Status;\r
124	UINT8 Attribute;\r
125	NET_MAP EventMap;\r
126	IP6_CONFIG_DATA Data;\r
127	UINTN DataSize;\r
128	} IP6_CONFIG_DATA_ITEM;\r
129	\r
130	typedef struct {\r
131	UINT16 Offset;\r
fdc4b0b1	132	UINT32 DataSize;\r
a3bcde70 HT	133	EFI_IP6_CONFIG_DATA_TYPE DataType;\r
	134	} IP6_CONFIG_DATA_RECORD;\r
	135	\r
	136	#pragma pack(1)\r
	137	\r
	138	//\r
	139	// heap data that contains the data for each data record.\r
	140	//\r
	141	// BOOLEAN IsAltIfIdSet;\r
	142	// EFI_IP6_CONFIG_POLICY Policy;\r
	143	// EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS DadXmits;\r
	144	// UINT32 ManualaddressCount;\r
	145	// UINT32 GatewayCount;\r
	146	// UINT32 DnsServersCount;\r
	147	// EFI_IP6_CONFIG_INTERFACE_ID AltIfId;\r
	148	// EFI_IP6_CONFIG_MANUAL_ADDRESS ManualAddress[];\r
	149	// EFI_IPv6_ADDRESS Gateway[];\r
	150	// EFI_IPv6_ADDRESS DnsServers[];\r
	151	//\r
	152	typedef struct {\r
	153	UINT32 IaId;\r
	154	UINT16 Checksum;\r
	155	UINT16 DataRecordCount;\r
	156	IP6_CONFIG_DATA_RECORD DataRecord[1];\r
	157	} IP6_CONFIG_VARIABLE;\r
	158	\r
	159	#pragma pack()\r
	160	\r
	161	typedef struct {\r
	162	LIST_ENTRY Link;\r
	163	EFI_IP6_ADDRESS_INFO AddrInfo;\r
	164	} IP6_ADDRESS_INFO_ENTRY;\r
	165	\r
	166	typedef struct {\r
	167	EFI_IP6_CONFIG_POLICY Policy; ///< manual or automatic \r
	168	EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS DadTransmitCount; ///< dad transmits count\r
	169	EFI_IP6_CONFIG_INTERFACE_ID InterfaceId; ///< alternative interface id \r
	170	LIST_ENTRY ManualAddress; ///< IP addresses\r
	171	UINT32 ManualAddressCount; ///< IP addresses count\r
	172	LIST_ENTRY GatewayAddress; ///< Gateway address\r
	173	UINT32 GatewayAddressCount; ///< Gateway address count\r
	174	LIST_ENTRY DnsAddress; ///< DNS server address\r
	175	UINT32 DnsAddressCount; ///< DNS server address count\r
	176	} IP6_CONFIG_NVDATA;\r
	177	\r
	178	typedef struct _IP6_FORM_CALLBACK_INFO {\r
	179	UINT32 Signature;\r
	180	EFI_HANDLE ChildHandle;\r
	181	EFI_HII_CONFIG_ACCESS_PROTOCOL HiiConfigAccess;\r
	182	EFI_DEVICE_PATH_PROTOCOL *HiiVendorDevicePath;\r
	183	EFI_HII_HANDLE RegisteredHandle;\r
	184	} IP6_FORM_CALLBACK_INFO;\r
	185	\r
	186	struct _IP6_CONFIG_INSTANCE {\r
	187	UINT32 Signature;\r
	188	BOOLEAN Configured;\r
	189	LIST_ENTRY Link;\r
	190	UINT16 IfIndex;\r
	191	\r
	192	EFI_IP6_CONFIG_INTERFACE_INFO InterfaceInfo;\r
	193	EFI_IP6_CONFIG_INTERFACE_ID AltIfId;\r
	194	EFI_IP6_CONFIG_POLICY Policy;\r
	195	EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS DadXmits;\r
	196	\r
197	IP6_CONFIG_DATA_ITEM DataItem[Ip6ConfigDataTypeMaximum];\r
198	NET_MAP DadFailedMap;\r
199	NET_MAP DadPassedMap;\r
200	\r
201	EFI_IP6_CONFIG_PROTOCOL Ip6Config;\r
202	\r
203	EFI_EVENT Dhcp6SbNotifyEvent;\r
204	VOID *Registration;\r
205	EFI_HANDLE Dhcp6Handle;\r
206	EFI_DHCP6_PROTOCOL *Dhcp6;\r
207	BOOLEAN OtherInfoOnly;\r
208	UINT32 IaId;\r
209	EFI_EVENT Dhcp6Event;\r
210	UINT32 FailedIaAddressCount;\r
211	EFI_IPv6_ADDRESS *DeclineAddress;\r
212	UINT32 DeclineAddressCount;\r
213	\r
214	IP6_FORM_CALLBACK_INFO CallbackInfo;\r
215	IP6_CONFIG_NVDATA Ip6NvData;\r
216	};\r
217	\r
4720106b JW	218	/**\r
	219	Read the configuration data from variable storage according to the VarName and\r
	220	gEfiIp6ConfigProtocolGuid. It checks the integrity of variable data. If the\r
	221	data is corrupted, it clears the variable data to ZERO. Othewise, it outputs the\r
	222	configuration data to IP6_CONFIG_INSTANCE.\r
	223	\r
	224	@param[in] VarName The pointer to the variable name\r
	225	@param[in, out] Instance The pointer to the IP6 config instance data.\r
	226	\r
	227	@retval EFI_NOT_FOUND The variable can not be found or already corrupted.\r
	228	@retval EFI_OUT_OF_RESOURCES Fail to allocate resource to complete the operation.\r
	229	@retval EFI_SUCCESS The configuration data was retrieved successfully.\r
	230	\r
	231	**/\r
	232	EFI_STATUS\r
	233	Ip6ConfigReadConfigData (\r
	234	IN CHAR16 *VarName,\r
	235	IN OUT IP6_CONFIG_INSTANCE *Instance\r
	236	);\r
	237	\r
a3bcde70 HT	238	/**\r
	239	The event process routine when the DHCPv6 server is answered with a reply packet\r
	240	for an information request.\r
	241	\r
	242	@param[in] This Points to the EFI_DHCP6_PROTOCOL.\r
	243	@param[in] Context The pointer to the IP6 configuration instance data.\r
	244	@param[in] Packet The DHCPv6 reply packet.\r
	245	\r
	246	@retval EFI_SUCCESS The DNS server address was retrieved from the reply packet.\r
	247	@retval EFI_NOT_READY The reply packet does not contain the DNS server option, or \r
	248	the DNS server address is not valid.\r
	249	\r
	250	**/\r
	251	EFI_STATUS\r
	252	EFIAPI\r
	253	Ip6ConfigOnDhcp6Reply (\r
	254	IN EFI_DHCP6_PROTOCOL *This,\r
	255	IN VOID *Context,\r
	256	IN EFI_DHCP6_PACKET *Packet\r
	257	);\r
	258	\r
	259	/**\r
	260	The work function to trigger the DHCPv6 process to perform a stateful autoconfiguration.\r
	261	\r
	262	@param[in] Instance Pointer to the IP6 config instance data.\r
	263	@param[in] OtherInfoOnly If FALSE, get stateful address and other information\r
	264	via DHCPv6. Otherwise, only get the other information.\r
	265	\r
	266	@retval EFI_SUCCESS The operation finished successfully.\r
	267	@retval EFI_UNSUPPORTED The DHCP6 driver is not available.\r
	268	\r
	269	**/\r
	270	EFI_STATUS\r
	271	Ip6ConfigStartStatefulAutoConfig (\r
	272	IN IP6_CONFIG_INSTANCE *Instance,\r
	273	IN BOOLEAN OtherInfoOnly\r
	274	);\r
	275	\r
	276	/**\r
	277	Initialize an IP6_CONFIG_INSTANCE.\r
	278	\r
	279	@param[out] Instance The buffer of IP6_CONFIG_INSTANCE to be initialized.\r
	280	\r
	281	@retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation.\r
	282	@retval EFI_SUCCESS The IP6_CONFIG_INSTANCE initialized successfully.\r
	283	\r
	284	**/\r
	285	EFI_STATUS\r
	286	Ip6ConfigInitInstance (\r
	287	OUT IP6_CONFIG_INSTANCE *Instance\r
	288	);\r
	289	\r
	290	/**\r
	291	Release an IP6_CONFIG_INSTANCE.\r
	292	\r
	293	@param[in, out] Instance The buffer of IP6_CONFIG_INSTANCE to be freed.\r
	294	\r
	295	**/\r
	296	VOID\r
	297	Ip6ConfigCleanInstance (\r
	298	IN OUT IP6_CONFIG_INSTANCE *Instance\r
	299	);\r
	300	\r
	301	/**\r
75dce340	302	Destroy the Dhcp6 child in IP6_CONFIG_INSTANCE and release the resources.\r
a3bcde70 HT	303	\r
	304	@param[in, out] Instance The buffer of IP6_CONFIG_INSTANCE to be freed.\r
	305	\r
	306	@retval EFI_SUCCESS The child was successfully destroyed.\r
75dce340	307	@retval Others Failed to destroy the child.\r
a3bcde70 HT	308	\r
	309	**/\r
	310	EFI_STATUS\r
	311	Ip6ConfigDestroyDhcp6 (\r
	312	IN OUT IP6_CONFIG_INSTANCE *Instance\r
	313	);\r
	314	\r
	315	#endif\r