/** @file\r
Header file for IP4Config driver.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation.<BR>\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
#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/NetLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
+#include <Library/HiiLib.h>\r
+#include <Library/PrintLib.h>\r
+#include <Library/DpcLib.h>\r
\r
#include "NicIp4Variable.h"\r
\r
typedef struct _IP4_CONFIG_INSTANCE IP4_CONFIG_INSTANCE;\r
\r
//\r
-// Global variables \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
-extern EFI_NIC_IP4_CONFIG_PROTOCOL mNicIp4ConfigProtocolTemplate;\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
+#define IP4_CONFIG_STATE_IDLE 0\r
+#define IP4_CONFIG_STATE_STARTED 1\r
+#define IP4_CONFIG_STATE_CONFIGURED 2\r
+\r
+#define DHCP_TAG_PARA_LIST 55\r
+#define DHCP_TAG_NETMASK 1\r
+#define DHCP_TAG_ROUTER 3\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
} 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;\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
- EFI_NIC_IP4_CONFIG_PROTOCOL NicIp4Protocol;\r
+\r
+ IP4_FORM_CALLBACK_INFO Ip4FormCallbackInfo;\r
\r
//\r
// NicConfig's state, such as IP4_CONFIG_STATE_IDLE\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_NIC_IP4CONFIG(this) \\r
- CR (this, IP4_CONFIG_INSTANCE, NicIp4Protocol, IP4_CONFIG_INSTANCE_SIGNATURE)\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
Ip4ConfigCleanConfig (\r
IN IP4_CONFIG_INSTANCE *Instance\r
);\r
- \r
+\r
//\r
// EFI Component Name Functions\r
//\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 4646 or ISO 639-2 language code format. \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
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 4646 or ISO 639-2 language code format.\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
+\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
IN CHAR8 *Language,\r
OUT CHAR16 **ControllerName\r
);\r
- \r
+\r
/**\r
Test to see if this driver supports ControllerHandle.\r
\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
);\r
- \r
+\r
/**\r
Start this driver on ControllerHandle.\r
\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
);\r
- \r
+\r
/**\r
Stop this driver on ControllerHandle.\r
\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
);\r
- \r
+\r
#endif\r