Scrubbed some code for Ip4ConfigDxe.

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

/** @file\r
  Header file for IP4Config driver.\r
\r
Copyright (c) 2006 - 2008, 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 <PiDxe.h>\r
\r
#include <Protocol/Dhcp4.h>\r
#include <Protocol/Ip4Config.h>\r
#include <Protocol/ManagedNetwork.h>\r
\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
\r
#include "NicIp4Variable.h"\r
\r
typedef struct _IP4_CONFIG_INSTANCE IP4_CONFIG_INSTANCE;\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
#define IP4_PROTO_ICMP                 0x01\r
#define IP4_CONFIG_INSTANCE_SIGNATURE  SIGNATURE_32 ('I', 'P', '4', 'C')\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
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
  //\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_NIC_IP4CONFIG(this) \\r
  CR (this, IP4_CONFIG_INSTANCE, NicIp4Protocol, IP4_CONFIG_INSTANCE_SIGNATURE)\r
\r
extern EFI_DRIVER_BINDING_PROTOCOL   gIp4ConfigDriverBinding;\r
extern EFI_COMPONENT_NAME_PROTOCOL   gIp4ConfigComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gIp4ConfigComponentName2;\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
\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
#endif\r