[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4ConfigDxe / Ip4Config.h

/** @file\r
  Header file for IP4Config driver.\r
\r
Copyright (c) 2006 - 2009, Intel Corporation.<BR>\r
All rights reserved. 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<BR>\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 _EFI_IP4CONFIG_H_\r
#define _EFI_IP4CONFIG_H_\r
\r
#include <Uefi.h>\r
\r
#include <Protocol/Dhcp4.h>\r
#include <Protocol/Ip4Config.h>\r
#include <Protocol/ManagedNetwork.h>\r
#include <Protocol/HiiConfigAccess.h>\r
#include <Protocol/HiiDatabase.h>\r
#include <Protocol/HiiConfigRouting.h>\r
\r
#include <Guid/MdeModuleHii.h>\r
\r
#include <Library/DevicePathLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/NetLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/PrintLib.h>\r
\r
#include "NicIp4Variable.h"\r
\r
typedef struct _IP4_CONFIG_INSTANCE IP4_CONFIG_INSTANCE;\r
\r
//\r
// Global variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL   gIp4ConfigDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL   gIp4ConfigComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gIp4ConfigComponentName2;\r
\r
extern IP4_CONFIG_INSTANCE           *mIp4ConfigNicList[MAX_IP4_CONFIG_IN_VARIABLE];\r
extern EFI_IP4_CONFIG_PROTOCOL       mIp4ConfigProtocolTemplate;\r
\r
#define IP4_PROTO_ICMP                 0x01\r
#define IP4_CONFIG_INSTANCE_SIGNATURE  SIGNATURE_32 ('I', 'P', '4', 'C')\r
\r
typedef enum {\r
  IP4_CONFIG_STATE_IDLE         = 0,\r
  IP4_CONFIG_STATE_STARTED,\r
  IP4_CONFIG_STATE_CONFIGURED\r
} IP4_CONFIG_STATE;\r
\r
typedef enum {\r
  DHCP_TAG_PARA_LIST            = 55,\r
  DHCP_TAG_NETMASK              = 1,\r
  DHCP_TAG_ROUTER               = 3\r
} DHCP_TAGS;\r
\r
//\r
// Configure the DHCP to request the routers and netmask\r
// from server. The DHCP_TAG_NETMASK is included in Head.\r
//\r
#pragma pack(1)\r
typedef struct {\r
  EFI_DHCP4_PACKET_OPTION Head;\r
  UINT8                   Route;\r
} IP4_CONFIG_DHCP4_OPTION;\r
#pragma pack()\r
\r
\r
typedef struct {\r
  UINTN             DeviceNum;\r
  BOOLEAN           Enabled;\r
  EFI_IPv4_ADDRESS  LocalIp;\r
  EFI_IPv4_ADDRESS  SubnetMask;\r
  EFI_IPv4_ADDRESS  Gateway;\r
} IP4_CONFIG_SESSION_DATA;\r
\r
typedef struct _IP4_CONFIG_FORM_ENTRY {\r
  LIST_ENTRY                    Link;\r
  IP4_CONFIG_INSTANCE           *Ip4ConfigInstance;\r
  EFI_HANDLE                    Controller;\r
  CHAR16                        MacString[95];\r
  EFI_STRING_ID                 PortTitleToken;\r
  EFI_STRING_ID                 PortTitleHelpToken;\r
  IP4_CONFIG_SESSION_DATA       SessionConfigData;\r
} IP4CONFIG_FORM_ENTRY;\r
\r
#define IP4CONFIG_FORM_CALLBACK_INFO_SIGNATURE  SIGNATURE_32 ('I', 'P', '4', 'C')\r
\r
typedef struct _IP4_FORM_CALLBACK_INFO_INSTANCE {\r
  UINTN                            Signature;\r
  EFI_HANDLE                       DriverHandle;\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;\r
  EFI_HII_DATABASE_PROTOCOL        *HiiDatabase;\r
  EFI_HII_CONFIG_ROUTING_PROTOCOL  *ConfigRouting;\r
  EFI_HII_HANDLE                   RegisteredHandle;\r
  IP4CONFIG_FORM_ENTRY             *Current;\r
} IP4_FORM_CALLBACK_INFO;\r
\r
#define IP4CONFIG_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \\r
  CR ( \\r
  Callback, \\r
  IP4_FORM_CALLBACK_INFO, \\r
  ConfigAccess, \\r
  IP4CONFIG_FORM_CALLBACK_INFO_SIGNATURE \\r
  )\r
\r
struct _IP4_CONFIG_INSTANCE {\r
  UINT32                        Signature;\r
  EFI_HANDLE                    Controller;\r
  EFI_HANDLE                    Image;\r
\r
  EFI_IP4_CONFIG_PROTOCOL       Ip4ConfigProtocol;\r
\r
  IP4_FORM_CALLBACK_INFO        Ip4FormCallbackInfo;\r
\r
  //\r
  // NicConfig's state, such as IP4_CONFIG_STATE_IDLE\r
  //\r
  INTN                          State;\r
\r
  //\r
  // Mnp child to keep the connection with MNP.\r
  //\r
  EFI_MANAGED_NETWORK_PROTOCOL  *Mnp;\r
  EFI_HANDLE                    MnpHandle;\r
\r
  //\r
  // User's requests data\r
  //\r
  EFI_EVENT                     DoneEvent;\r
  EFI_EVENT                     ReconfigEvent;\r
  EFI_STATUS                    Result;\r
\r
  //\r
  // Identity of this interface and some configuration info.\r
  //\r
  NIC_ADDR                      NicAddr;\r
  UINT16                        NicName[IP4_NIC_NAME_LENGTH];\r
  UINT32                        NicIndex;\r
  NIC_IP4_CONFIG_INFO           *NicConfig;\r
\r
  //\r
  // DHCP handles to access DHCP\r
  //\r
  EFI_DHCP4_PROTOCOL            *Dhcp4;\r
  EFI_HANDLE                    Dhcp4Handle;\r
  EFI_EVENT                     Dhcp4Event;\r
};\r
\r
#define IP4_CONFIG_INSTANCE_FROM_IP4CONFIG(this) \\r
  CR (this, IP4_CONFIG_INSTANCE, Ip4ConfigProtocol, IP4_CONFIG_INSTANCE_SIGNATURE)\r
\r
#define IP4_CONFIG_INSTANCE_FROM_IP4FORM_CALLBACK_INFO(this) \\r
  CR (this, IP4_CONFIG_INSTANCE, Ip4FormCallbackInfo, IP4_CONFIG_INSTANCE_SIGNATURE)\r
\r
\r
/**\r
  Set the IP configure parameters for this NIC. \r
\r
  If Reconfig is TRUE, the IP driver will be informed to discard current \r
  auto configure parameter and restart the auto configuration process. \r
  If current there is a pending auto configuration, EFI_ALREADY_STARTED is\r
  returned. You can only change the configure setting when either\r
  the configure has finished or not started yet. If NicConfig, the\r
  NIC's configure parameter is removed from the variable.\r
\r
  @param  Instance               The IP4 CONFIG instance.\r
  @param  NicConfig              The new NIC IP4 configure parameter\r
  @param  Reconfig               Inform the IP4 driver to restart the auto\r
                                 configuration\r
                                 \r
  @retval EFI_SUCCESS            The configure parameter for this NIC was \r
                                 set successfully .\r
  @retval EFI_INVALID_PARAMETER  This is NULL or the configure parameter is\r
                                 invalid.\r
  @retval EFI_ALREADY_STARTED    There is a pending auto configuration.\r
  @retval EFI_NOT_FOUND          No auto configure parameter is found\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiNicIp4ConfigSetInfo (\r
  IN IP4_CONFIG_INSTANCE          *Instance,\r
  IN NIC_IP4_CONFIG_INFO          *NicConfig     OPTIONAL,\r
  IN BOOLEAN                      Reconfig\r
  );\r
\r
/**\r
  Get the configure parameter for this NIC.\r
\r
  @param  Instance               The IP4 CONFIG Instance.\r
  @param  ConfigLen              The length of the NicConfig buffer.\r
  @param  NicConfig              The buffer to receive the NIC's configure\r
                                 parameter.\r
\r
  @retval EFI_SUCCESS            The configure parameter for this NIC was \r
                                 obtained successfully .\r
  @retval EFI_INVALID_PARAMETER  This or ConfigLen is NULL.\r
  @retval EFI_NOT_FOUND          There is no configure parameter for the NIC in\r
                                 NVRam.\r
  @retval EFI_BUFFER_TOO_SMALL   The ConfigLen is too small or the NicConfig is \r
                                 NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiNicIp4ConfigGetInfo (\r
  IN  IP4_CONFIG_INSTANCE         *Instance,\r
  IN OUT  UINTN                   *ConfigLen,\r
  OUT NIC_IP4_CONFIG_INFO         *NicConfig\r
  );\r
\r
/**\r
  Release all the DHCP related resources.\r
\r
  @param  This                   The IP4 configure instance\r
\r
  @return None\r
\r
**/\r
VOID\r
Ip4ConfigCleanDhcp4 (\r
  IN IP4_CONFIG_INSTANCE    *This\r
  );\r
\r
/**\r
  Clean up all the configuration parameters.\r
\r
  @param  Instance               The IP4 configure instance\r
\r
  @return None\r
\r
**/\r
VOID\r
Ip4ConfigCleanConfig (\r
  IN IP4_CONFIG_INSTANCE        *Instance\r
  );\r
\r
//\r
// EFI Component Name Functions\r
//\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the driver.\r
\r
  This function retrieves the user readable name of a driver in the form of a\r
  Unicode string. If the driver specified by This has a user readable name in\r
  the language specified by Language, then a pointer to the driver name is\r
  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
  by This does not support the language specified by Language,\r
  then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language. This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified\r
                                in RFC 3066 or ISO 639-2 language code format.\r
  @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                driver specified by This in the language\r
                                specified by Language.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
                                This and the language specified by Language was\r
                                returned in DriverName.\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ip4ConfigComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  );\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the controller\r
  that is being managed by a driver.\r
\r
  This function retrieves the user readable name of the controller specified by\r
  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
  driver specified by This has a user readable name in the language specified by\r
  Language, then a pointer to the controller name is returned in ControllerName,\r
  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
  managing the controller specified by ControllerHandle and ChildHandle,\r
  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
  @param  ControllerHandle[in]  The handle of a controller that the driver\r
                                specified by This is managing.  This handle\r
                                specifies the controller whose name is to be\r
                                returned.\r
  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
                                the name of.  This is an optional parameter that\r
                                may be NULL.  It will be NULL for device\r
                                drivers.  It will also be NULL for a bus drivers\r
                                that wish to retrieve the name of the bus\r
                                controller.  It will not be NULL for a bus\r
                                driver that wishes to retrieve the name of a\r
                                child controller.\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language.  This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified in\r
                                RFC 3066 or ISO 639-2 language code format.\r
  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                controller specified by ControllerHandle and\r
                                ChildHandle in the language specified by\r
                                Language from the point of view of the driver\r
                                specified by This.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
                                the language specified by Language for the\r
                                driver specified by This was returned in\r
                                DriverName.\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                EFI_HANDLE.\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by\r
                                ControllerHandle and ChildHandle.\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ip4ConfigComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  );\r
\r
/**\r
  Test to see if this driver supports ControllerHandle.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  ControllerHandle     Handle of device to test\r
  @param  RemainingDevicePath  Optional parameter use to pick a specific child\r
                               device to start.\r
\r
  @retval EFI_SUCCES           This driver supports this device\r
  @retval EFI_ALREADY_STARTED  This driver is already running on this device\r
  @retval other                This driver does not support this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ip4ConfigDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath  OPTIONAL\r
  );\r
\r
/**\r
  Start this driver on ControllerHandle.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  ControllerHandle     Handle of device to bind driver to\r
  @param  RemainingDevicePath  Optional parameter use to pick a specific child\r
                               device to start.\r
\r
  @retval EFI_SUCCES           This driver is added to ControllerHandle\r
  @retval EFI_ALREADY_STARTED  This driver is already running on ControllerHandle\r
  @retval other                This driver does not support this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ip4ConfigDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL\r
  );\r
\r
/**\r
  Stop this driver on ControllerHandle.\r
\r
  @param  This                 Protocol instance pointer.\r
  @param  ControllerHandle     Handle of device to stop driver on\r
  @param  NumberOfChildren     Number of Handles in ChildHandleBuffer. If number of\r
                                children is zero stop the entire bus driver.\r
  @param  ChildHandleBuffer    List of Child Handles to Stop.\r
\r
  @retval EFI_SUCCES           This driver is removed ControllerHandle\r
  @retval other                This driver was not removed from this device\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ip4ConfigDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  );\r
\r
#endif\r
Commit	Line	Data
83cbd279	1	/** @file\r
402fa70f	2	Header file for IP4Config driver.\r
83cbd279	3	\r
63886849	4	Copyright (c) 2006 - 2009, Intel Corporation.<BR>\r
83cbd279	5	All rights reserved. This program and the accompanying materials\r
83cbd279	6	are licensed and made available under the terms and conditions of the BSD License\r
402fa70f	7	which accompanies this distribution. The full text of the license may be found at<BR>\r
83cbd279	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
83cbd279	13	**/\r
83cbd279	14	\r
402fa70f	15	#ifndef _EFI_IP4CONFIG_H_\r
402fa70f	16	#define _EFI_IP4CONFIG_H_\r
83cbd279	17	\r
c8d8f1e3	18	#include <Uefi.h>\r
b2570da8	19	\r
b2570da8	20	#include <Protocol/Dhcp4.h>\r
24e58768	21	#include <Protocol/Ip4Config.h>\r
b2570da8	22	#include <Protocol/ManagedNetwork.h>\r
63886849	23	#include <Protocol/HiiConfigAccess.h>\r
	24	#include <Protocol/HiiDatabase.h>\r
	25	#include <Protocol/HiiConfigRouting.h>\r
b2570da8	26	\r
63886849	27	#include <Guid/MdeModuleHii.h>\r
	28	\r
	29	#include <Library/DevicePathLib.h>\r
b2570da8	30	#include <Library/DebugLib.h>\r
	31	#include <Library/UefiRuntimeServicesTableLib.h>\r
	32	#include <Library/UefiDriverEntryPoint.h>\r
	33	#include <Library/UefiBootServicesTableLib.h>\r
	34	#include <Library/UefiLib.h>\r
	35	#include <Library/NetLib.h>\r
	36	#include <Library/BaseMemoryLib.h>\r
83cbd279	37	#include <Library/MemoryAllocationLib.h>\r
63886849	38	#include <Library/HiiLib.h>\r
63886849	39	#include <Library/PrintLib.h>\r
83cbd279	40	\r
	41	#include "NicIp4Variable.h"\r
	42	\r
	43	typedef struct _IP4_CONFIG_INSTANCE IP4_CONFIG_INSTANCE;\r
	44	\r
c8d8f1e3	45	//\r
63886849	46	// Global variables\r
c8d8f1e3	47	//\r
	48	extern EFI_DRIVER_BINDING_PROTOCOL gIp4ConfigDriverBinding;\r
	49	extern EFI_COMPONENT_NAME_PROTOCOL gIp4ConfigComponentName;\r
	50	extern EFI_COMPONENT_NAME2_PROTOCOL gIp4ConfigComponentName2;\r
	51	\r
	52	extern IP4_CONFIG_INSTANCE *mIp4ConfigNicList[MAX_IP4_CONFIG_IN_VARIABLE];\r
	53	extern EFI_IP4_CONFIG_PROTOCOL mIp4ConfigProtocolTemplate;\r
c8d8f1e3	54	\r
	55	#define IP4_PROTO_ICMP 0x01\r
	56	#define IP4_CONFIG_INSTANCE_SIGNATURE SIGNATURE_32 ('I', 'P', '4', 'C')\r
	57	\r
7bce0c5a	58	typedef enum {\r
83cbd279	59	IP4_CONFIG_STATE_IDLE = 0,\r
83cbd279	60	IP4_CONFIG_STATE_STARTED,\r
7bce0c5a	61	IP4_CONFIG_STATE_CONFIGURED\r
7bce0c5a	62	} IP4_CONFIG_STATE;\r
83cbd279	63	\r
7bce0c5a	64	typedef enum {\r
83cbd279	65	DHCP_TAG_PARA_LIST = 55,\r
	66	DHCP_TAG_NETMASK = 1,\r
	67	DHCP_TAG_ROUTER = 3\r
7bce0c5a	68	} DHCP_TAGS;\r
83cbd279	69	\r
	70	//\r
	71	// Configure the DHCP to request the routers and netmask\r
	72	// from server. The DHCP_TAG_NETMASK is included in Head.\r
	73	//\r
	74	#pragma pack(1)\r
	75	typedef struct {\r
	76	EFI_DHCP4_PACKET_OPTION Head;\r
	77	UINT8 Route;\r
	78	} IP4_CONFIG_DHCP4_OPTION;\r
	79	#pragma pack()\r
	80	\r
63886849	81	\r
	82	typedef struct {\r
	83	UINTN DeviceNum;\r
	84	BOOLEAN Enabled;\r
	85	EFI_IPv4_ADDRESS LocalIp;\r
	86	EFI_IPv4_ADDRESS SubnetMask;\r
	87	EFI_IPv4_ADDRESS Gateway;\r
	88	} IP4_CONFIG_SESSION_DATA;\r
	89	\r
	90	typedef struct _IP4_CONFIG_FORM_ENTRY {\r
	91	LIST_ENTRY Link;\r
	92	IP4_CONFIG_INSTANCE *Ip4ConfigInstance;\r
	93	EFI_HANDLE Controller;\r
	94	CHAR16 MacString[95];\r
	95	EFI_STRING_ID PortTitleToken;\r
	96	EFI_STRING_ID PortTitleHelpToken;\r
	97	IP4_CONFIG_SESSION_DATA SessionConfigData;\r
	98	} IP4CONFIG_FORM_ENTRY;\r
	99	\r
	100	#define IP4CONFIG_FORM_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('I', 'P', '4', 'C')\r
	101	\r
	102	typedef struct _IP4_FORM_CALLBACK_INFO_INSTANCE {\r
	103	UINTN Signature;\r
	104	EFI_HANDLE DriverHandle;\r
	105	EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;\r
	106	EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
	107	EFI_HII_CONFIG_ROUTING_PROTOCOL *ConfigRouting;\r
	108	EFI_HII_HANDLE RegisteredHandle;\r
	109	IP4CONFIG_FORM_ENTRY *Current;\r
	110	} IP4_FORM_CALLBACK_INFO;\r
	111	\r
	112	#define IP4CONFIG_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \\r
	113	CR ( \\r
	114	Callback, \\r
	115	IP4_FORM_CALLBACK_INFO, \\r
	116	ConfigAccess, \\r
	117	IP4CONFIG_FORM_CALLBACK_INFO_SIGNATURE \\r
	118	)\r
	119	\r
83cbd279	120	struct _IP4_CONFIG_INSTANCE {\r
	121	UINT32 Signature;\r
	122	EFI_HANDLE Controller;\r
	123	EFI_HANDLE Image;\r
	124	\r
	125	EFI_IP4_CONFIG_PROTOCOL Ip4ConfigProtocol;\r
63886849	126	\r
63886849	127	IP4_FORM_CALLBACK_INFO Ip4FormCallbackInfo;\r
83cbd279	128	\r
	129	//\r
	130	// NicConfig's state, such as IP4_CONFIG_STATE_IDLE\r
	131	//\r
	132	INTN State;\r
	133	\r
	134	//\r
	135	// Mnp child to keep the connection with MNP.\r
	136	//\r
	137	EFI_MANAGED_NETWORK_PROTOCOL *Mnp;\r
	138	EFI_HANDLE MnpHandle;\r
	139	\r
	140	//\r
	141	// User's requests data\r
	142	//\r
	143	EFI_EVENT DoneEvent;\r
	144	EFI_EVENT ReconfigEvent;\r
	145	EFI_STATUS Result;\r
	146	\r
	147	//\r
	148	// Identity of this interface and some configuration info.\r
	149	//\r
	150	NIC_ADDR NicAddr;\r
	151	UINT16 NicName[IP4_NIC_NAME_LENGTH];\r
	152	UINT32 NicIndex;\r
	153	NIC_IP4_CONFIG_INFO *NicConfig;\r
	154	\r
	155	//\r
	156	// DHCP handles to access DHCP\r
	157	//\r
	158	EFI_DHCP4_PROTOCOL *Dhcp4;\r
	159	EFI_HANDLE Dhcp4Handle;\r
	160	EFI_EVENT Dhcp4Event;\r
	161	};\r
	162	\r
	163	#define IP4_CONFIG_INSTANCE_FROM_IP4CONFIG(this) \\r
	164	CR (this, IP4_CONFIG_INSTANCE, Ip4ConfigProtocol, IP4_CONFIG_INSTANCE_SIGNATURE)\r
	165	\r
63886849	166	#define IP4_CONFIG_INSTANCE_FROM_IP4FORM_CALLBACK_INFO(this) \\r
	167	CR (this, IP4_CONFIG_INSTANCE, Ip4FormCallbackInfo, IP4_CONFIG_INSTANCE_SIGNATURE)\r
	168	\r
	169	\r
	170	/**\r
	171	Set the IP configure parameters for this NIC. \r
	172	\r
	173	If Reconfig is TRUE, the IP driver will be informed to discard current \r
	174	auto configure parameter and restart the auto configuration process. \r
	175	If current there is a pending auto configuration, EFI_ALREADY_STARTED is\r
	176	returned. You can only change the configure setting when either\r
	177	the configure has finished or not started yet. If NicConfig, the\r
	178	NIC's configure parameter is removed from the variable.\r
	179	\r
	180	@param Instance The IP4 CONFIG instance.\r
	181	@param NicConfig The new NIC IP4 configure parameter\r
	182	@param Reconfig Inform the IP4 driver to restart the auto\r
	183	configuration\r
	184	\r
	185	@retval EFI_SUCCESS The configure parameter for this NIC was \r
	186	set successfully .\r
	187	@retval EFI_INVALID_PARAMETER This is NULL or the configure parameter is\r
	188	invalid.\r
	189	@retval EFI_ALREADY_STARTED There is a pending auto configuration.\r
	190	@retval EFI_NOT_FOUND No auto configure parameter is found\r
	191	\r
	192	**/\r
	193	EFI_STATUS\r
	194	EFIAPI\r
	195	EfiNicIp4ConfigSetInfo (\r
	196	IN IP4_CONFIG_INSTANCE *Instance,\r
	197	IN NIC_IP4_CONFIG_INFO *NicConfig OPTIONAL,\r
	198	IN BOOLEAN Reconfig\r
	199	);\r
	200	\r
	201	/**\r
	202	Get the configure parameter for this NIC.\r
	203	\r
	204	@param Instance The IP4 CONFIG Instance.\r
	205	@param ConfigLen The length of the NicConfig buffer.\r
	206	@param NicConfig The buffer to receive the NIC's configure\r
	207	parameter.\r
	208	\r
	209	@retval EFI_SUCCESS The configure parameter for this NIC was \r
	210	obtained successfully .\r
	211	@retval EFI_INVALID_PARAMETER This or ConfigLen is NULL.\r
	212	@retval EFI_NOT_FOUND There is no configure parameter for the NIC in\r
	213	NVRam.\r
	214	@retval EFI_BUFFER_TOO_SMALL The ConfigLen is too small or the NicConfig is \r
	215	NULL.\r
	216	\r
	217	**/\r
	218	EFI_STATUS\r
	219	EFIAPI\r
	220	EfiNicIp4ConfigGetInfo (\r
	221	IN IP4_CONFIG_INSTANCE *Instance,\r
	222	IN OUT UINTN *ConfigLen,\r
	223	OUT NIC_IP4_CONFIG_INFO *NicConfig\r
	224	);\r
83cbd279	225	\r
7bce0c5a	226	/**\r
	227	Release all the DHCP related resources.\r
	228	\r
	229	@param This The IP4 configure instance\r
	230	\r
	231	@return None\r
	232	\r
	233	**/\r
83cbd279	234	VOID\r
83cbd279	235	Ip4ConfigCleanDhcp4 (\r
c8d8f1e3	236	IN IP4_CONFIG_INSTANCE *This\r
83cbd279	237	);\r
83cbd279	238	\r
7bce0c5a	239	/**\r
	240	Clean up all the configuration parameters.\r
	241	\r
	242	@param Instance The IP4 configure instance\r
	243	\r
	244	@return None\r
	245	\r
	246	**/\r
83cbd279	247	VOID\r
	248	Ip4ConfigCleanConfig (\r
	249	IN IP4_CONFIG_INSTANCE *Instance\r
	250	);\r
63886849	251	\r
c8d8f1e3	252	//\r
	253	// EFI Component Name Functions\r
	254	//\r
	255	\r
	256	/**\r
	257	Retrieves a Unicode string that is the user readable name of the driver.\r
	258	\r
	259	This function retrieves the user readable name of a driver in the form of a\r
	260	Unicode string. If the driver specified by This has a user readable name in\r
	261	the language specified by Language, then a pointer to the driver name is\r
	262	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	263	by This does not support the language specified by Language,\r
	264	then EFI_UNSUPPORTED is returned.\r
	265	\r
	266	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	267	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	268	@param Language[in] A pointer to a Null-terminated ASCII string\r
	269	array indicating the language. This is the\r
	270	language of the driver name that the caller is\r
	271	requesting, and it must match one of the\r
	272	languages specified in SupportedLanguages. The\r
	273	number of languages supported by a driver is up\r
	274	to the driver writer. Language is specified\r
63886849	275	in RFC 3066 or ISO 639-2 language code format.\r
c8d8f1e3	276	@param DriverName[out] A pointer to the Unicode string to return.\r
	277	This Unicode string is the name of the\r
	278	driver specified by This in the language\r
	279	specified by Language.\r
	280	\r
	281	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	282	This and the language specified by Language was\r
	283	returned in DriverName.\r
	284	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	285	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	286	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	287	the language specified by Language.\r
	288	\r
	289	**/\r
	290	EFI_STATUS\r
	291	EFIAPI\r
	292	Ip4ConfigComponentNameGetDriverName (\r
	293	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	294	IN CHAR8 *Language,\r
	295	OUT CHAR16 **DriverName\r
	296	);\r
	297	\r
	298	/**\r
	299	Retrieves a Unicode string that is the user readable name of the controller\r
	300	that is being managed by a driver.\r
	301	\r
	302	This function retrieves the user readable name of the controller specified by\r
	303	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	304	driver specified by This has a user readable name in the language specified by\r
	305	Language, then a pointer to the controller name is returned in ControllerName,\r
	306	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
	307	managing the controller specified by ControllerHandle and ChildHandle,\r
	308	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
	309	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
	310	\r
	311	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	312	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	313	@param ControllerHandle[in] The handle of a controller that the driver\r
	314	specified by This is managing. This handle\r
	315	specifies the controller whose name is to be\r
	316	returned.\r
	317	@param ChildHandle[in] The handle of the child controller to retrieve\r
	318	the name of. This is an optional parameter that\r
	319	may be NULL. It will be NULL for device\r
	320	drivers. It will also be NULL for a bus drivers\r
	321	that wish to retrieve the name of the bus\r
	322	controller. It will not be NULL for a bus\r
	323	driver that wishes to retrieve the name of a\r
	324	child controller.\r
	325	@param Language[in] A pointer to a Null-terminated ASCII string\r
	326	array indicating the language. This is the\r
	327	language of the driver name that the caller is\r
	328	requesting, and it must match one of the\r
	329	languages specified in SupportedLanguages. The\r
	330	number of languages supported by a driver is up\r
	331	to the driver writer. Language is specified in\r
63886849	332	RFC 3066 or ISO 639-2 language code format.\r
c8d8f1e3	333	@param ControllerName[out] A pointer to the Unicode string to return.\r
	334	This Unicode string is the name of the\r
	335	controller specified by ControllerHandle and\r
	336	ChildHandle in the language specified by\r
	337	Language from the point of view of the driver\r
	338	specified by This.\r
63886849	339	\r
c8d8f1e3	340	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
	341	the language specified by Language for the\r
	342	driver specified by This was returned in\r
	343	DriverName.\r
	344	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	345	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
	346	EFI_HANDLE.\r
	347	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	348	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
	349	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
	350	managing the controller specified by\r
	351	ControllerHandle and ChildHandle.\r
	352	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	353	the language specified by Language.\r
	354	\r
	355	**/\r
	356	EFI_STATUS\r
	357	EFIAPI\r
	358	Ip4ConfigComponentNameGetControllerName (\r
	359	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	360	IN EFI_HANDLE ControllerHandle,\r
	361	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	362	IN CHAR8 *Language,\r
	363	OUT CHAR16 **ControllerName\r
	364	);\r
63886849	365	\r
c8d8f1e3	366	/**\r
	367	Test to see if this driver supports ControllerHandle.\r
	368	\r
	369	@param This Protocol instance pointer.\r
	370	@param ControllerHandle Handle of device to test\r
	371	@param RemainingDevicePath Optional parameter use to pick a specific child\r
	372	device to start.\r
	373	\r
	374	@retval EFI_SUCCES This driver supports this device\r
	375	@retval EFI_ALREADY_STARTED This driver is already running on this device\r
	376	@retval other This driver does not support this device\r
	377	\r
	378	**/\r
	379	EFI_STATUS\r
	380	EFIAPI\r
	381	Ip4ConfigDriverBindingSupported (\r
	382	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	383	IN EFI_HANDLE ControllerHandle,\r
	384	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
	385	);\r
63886849	386	\r
c8d8f1e3	387	/**\r
	388	Start this driver on ControllerHandle.\r
	389	\r
	390	@param This Protocol instance pointer.\r
	391	@param ControllerHandle Handle of device to bind driver to\r
	392	@param RemainingDevicePath Optional parameter use to pick a specific child\r
	393	device to start.\r
	394	\r
	395	@retval EFI_SUCCES This driver is added to ControllerHandle\r
	396	@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r
	397	@retval other This driver does not support this device\r
	398	\r
	399	**/\r
	400	EFI_STATUS\r
	401	EFIAPI\r
	402	Ip4ConfigDriverBindingStart (\r
	403	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	404	IN EFI_HANDLE ControllerHandle,\r
	405	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
	406	);\r
63886849	407	\r
c8d8f1e3	408	/**\r
	409	Stop this driver on ControllerHandle.\r
	410	\r
	411	@param This Protocol instance pointer.\r
	412	@param ControllerHandle Handle of device to stop driver on\r
	413	@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r
	414	children is zero stop the entire bus driver.\r
	415	@param ChildHandleBuffer List of Child Handles to Stop.\r
	416	\r
	417	@retval EFI_SUCCES This driver is removed ControllerHandle\r
	418	@retval other This driver was not removed from this device\r
	419	\r
	420	**/\r
	421	EFI_STATUS\r
	422	EFIAPI\r
	423	Ip4ConfigDriverBindingStop (\r
	424	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	425	IN EFI_HANDLE ControllerHandle,\r
	426	IN UINTN NumberOfChildren,\r
	427	IN EFI_HANDLE *ChildHandleBuffer\r
	428	);\r
63886849	429	\r
83cbd279	430	#endif\r