Ip4Config2Impl.h

Go to the documentation of this file.

 
#ifndef __IP4_CONFIG2_IMPL_H__
#define __IP4_CONFIG2_IMPL_H__
 
#define IP4_CONFIG2_INSTANCE_SIGNATURE    SIGNATURE_32 ('I', 'P', 'C', '2')
#define IP4_FORM_CALLBACK_INFO_SIGNATURE  SIGNATURE_32 ('I', 'F', 'C', 'I')
 
#define IP4_CONFIG2_VARIABLE_ATTRIBUTE  (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)
 
#define DATA_ATTRIB_SIZE_FIXED  0x1
#define DATA_ATTRIB_VOLATILE    0x2
 
#define DATA_ATTRIB_SET(Attrib, Bits)     (BOOLEAN)((Attrib) & (Bits))
#define SET_DATA_ATTRIB(Attrib, Bits)     ((Attrib) |= (Bits))
#define REMOVE_DATA_ATTRIB(Attrib, Bits)  ((Attrib) &= (~Bits))
 
typedef struct _IP4_CONFIG2_INSTANCE IP4_CONFIG2_INSTANCE;
 
#define IP4_CONFIG2_INSTANCE_FROM_PROTOCOL(Proto) \
  CR ((Proto), \
      IP4_CONFIG2_INSTANCE, \
      Ip4Config2, \
      IP4_CONFIG2_INSTANCE_SIGNATURE \
      )
 
#define IP4_SERVICE_FROM_IP4_CONFIG2_INSTANCE(Instance) \
  CR ((Instance), \
      IP4_SERVICE, \
      Ip4Config2Instance, \
      IP4_SERVICE_SIGNATURE \
      )
 
#define IP4_CONFIG2_INSTANCE_FROM_FORM_CALLBACK(Callback) \
  CR ((Callback), \
      IP4_CONFIG2_INSTANCE, \
      CallbackInfo, \
      IP4_CONFIG2_INSTANCE_SIGNATURE \
      )
 
#define IP4_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(ConfigAccess) \
  CR ((ConfigAccess), \
      IP4_FORM_CALLBACK_INFO, \
      HiiConfigAccessProtocol, \
      IP4_FORM_CALLBACK_INFO_SIGNATURE \
      )
 
typedef
EFI_STATUS
(*IP4_CONFIG2_SET_DATA) (
  IN IP4_CONFIG2_INSTANCE  *Instance,
  IN UINTN                 DataSize,
  IN VOID                  *Data
  );
 
typedef
EFI_STATUS
(*IP4_CONFIG2_GET_DATA) (
  IN IP4_CONFIG2_INSTANCE  *Instance,
  IN OUT UINTN             *DataSize,
  IN VOID                  *Data      OPTIONAL
  );
 
typedef union {
  VOID                              *Ptr;
  EFI_IP4_CONFIG2_INTERFACE_INFO    *IfInfo;
  EFI_IP4_CONFIG2_POLICY            *Policy;
  EFI_IP4_CONFIG2_MANUAL_ADDRESS    *ManualAddress;
  EFI_IPv4_ADDRESS                  *Gateway;
  EFI_IPv4_ADDRESS                  *DnsServers;
} IP4_CONFIG2_DATA;
 
typedef struct {
  IP4_CONFIG2_SET_DATA    SetData;
  IP4_CONFIG2_GET_DATA    GetData;
  EFI_STATUS              Status;
  UINT8                   Attribute;
  NET_MAP                 EventMap;
  IP4_CONFIG2_DATA        Data;
  UINTN                   DataSize;
} IP4_CONFIG2_DATA_ITEM;
 
typedef struct {
  UINT16                       Offset;
  UINT32                       DataSize;
  EFI_IP4_CONFIG2_DATA_TYPE    DataType;
} IP4_CONFIG2_DATA_RECORD;
 
#pragma pack(1)
 
//
// heap data that contains the data for each data record.
//
//  EFI_IP4_CONFIG2_POLICY                    Policy;
//  UINT32                                    ManualaddressCount;
//  UINT32                                    GatewayCount;
//  UINT32                                    DnsServersCount;
//  EFI_IP4_CONFIG2_MANUAL_ADDRESS            ManualAddress[];
//  EFI_IPv4_ADDRESS                          Gateway[];
//  EFI_IPv4_ADDRESS                          DnsServers[];
//
typedef struct {
  UINT16                     Checksum;
  UINT16                     DataRecordCount;
  IP4_CONFIG2_DATA_RECORD    DataRecord[1];
} IP4_CONFIG2_VARIABLE;
 
#pragma pack()
 
typedef struct {
  EFI_IP4_CONFIG2_POLICY            Policy;                      
  EFI_IP4_CONFIG2_MANUAL_ADDRESS    *ManualAddress;              
  UINT32                            ManualAddressCount;          
  EFI_IPv4_ADDRESS                  *GatewayAddress;             
  UINT32                            GatewayAddressCount;         
  EFI_IPv4_ADDRESS                  *DnsAddress;                 
  UINT32                            DnsAddressCount;             
} IP4_CONFIG2_NVDATA;
 
typedef struct _IP4_FORM_CALLBACK_INFO {
  UINT32                            Signature;
  EFI_HANDLE                        ChildHandle;
  EFI_HII_CONFIG_ACCESS_PROTOCOL    HiiConfigAccessProtocol;
  EFI_DEVICE_PATH_PROTOCOL          *HiiVendorDevicePath;
  EFI_HII_HANDLE                    RegisteredHandle;
} IP4_FORM_CALLBACK_INFO;
 
struct _IP4_CONFIG2_INSTANCE {
  UINT32                            Signature;
  BOOLEAN                           Configured;
  LIST_ENTRY                        Link;
  UINT16                            IfIndex;
 
  EFI_IP4_CONFIG2_PROTOCOL          Ip4Config2;
 
  EFI_IP4_CONFIG2_INTERFACE_INFO    InterfaceInfo;
  EFI_IP4_CONFIG2_POLICY            Policy;
  IP4_CONFIG2_DATA_ITEM             DataItem[Ip4Config2DataTypeMaximum];
 
  EFI_EVENT                         Dhcp4SbNotifyEvent;
  VOID                              *Registration;
  EFI_HANDLE                        Dhcp4Handle;
  EFI_DHCP4_PROTOCOL                *Dhcp4;
  BOOLEAN                           DhcpSuccess;
  BOOLEAN                           OtherInfoOnly;
  EFI_EVENT                         Dhcp4Event;
  UINT32                            FailedIaAddressCount;
  EFI_IPv4_ADDRESS                  *DeclineAddress;
  UINT32                            DeclineAddressCount;
 
  IP4_FORM_CALLBACK_INFO            CallbackInfo;
 
  IP4_CONFIG2_NVDATA                Ip4NvData;
};
 
//
// Configure the DHCP to request the routers and netmask
// from server. The DHCP4_TAG_NETMASK is included in Head.
//
#pragma pack(1)
typedef struct {
  EFI_DHCP4_PACKET_OPTION    Head;
  UINT8                      Route;
  UINT8                      Dns;
} IP4_CONFIG2_DHCP4_OPTION;
#pragma pack()
 
EFI_STATUS
Ip4Config2ReadConfigData (
  IN     CHAR16                *VarName,
  IN OUT IP4_CONFIG2_INSTANCE  *Instance
  );
 
EFI_STATUS
Ip4StartAutoConfig (
  IN IP4_CONFIG2_INSTANCE  *Instance
  );
 
EFI_STATUS
Ip4Config2InitInstance (
  OUT IP4_CONFIG2_INSTANCE  *Instance
  );
 
VOID
Ip4Config2CleanInstance (
  IN OUT IP4_CONFIG2_INSTANCE  *Instance
  );
 
VOID
EFIAPI
Ip4AutoReconfigCallBack (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
EFI_STATUS
Ip4Config2DestroyDhcp4 (
  IN OUT IP4_CONFIG2_INSTANCE  *Instance
  );
 
#endif