Ip6ConfigImpl.h

Go to the documentation of this file.

 
#ifndef __IP6_CONFIG_IMPL_H__
#define __IP6_CONFIG_IMPL_H__
 
#define IP6_CONFIG_INSTANCE_SIGNATURE     SIGNATURE_32 ('I', 'P', '6', 'C')
#define IP6_FORM_CALLBACK_INFO_SIGNATURE  SIGNATURE_32 ('I', 'F', 'C', 'I')
#define IP6_CONFIG_VARIABLE_ATTRIBUTE     (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)
 
#define IP6_CONFIG_DEFAULT_DAD_XMITS  1
 
#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))
 
typedef struct _IP6_CONFIG_INSTANCE IP6_CONFIG_INSTANCE;
 
#define IP6_CONFIG_INSTANCE_FROM_PROTOCOL(Proto) \
  CR ((Proto), \
      IP6_CONFIG_INSTANCE, \
      Ip6Config, \
      IP6_CONFIG_INSTANCE_SIGNATURE \
      )
 
#define IP6_CONFIG_INSTANCE_FROM_FORM_CALLBACK(Callback) \
  CR ((Callback), \
      IP6_CONFIG_INSTANCE, \
      CallbackInfo, \
      IP6_CONFIG_INSTANCE_SIGNATURE \
      )
 
#define IP6_SERVICE_FROM_IP6_CONFIG_INSTANCE(Instance) \
  CR ((Instance), \
      IP6_SERVICE, \
      Ip6ConfigInstance, \
      IP6_SERVICE_SIGNATURE \
      )
 
#define IP6_FORM_CALLBACK_INFO_FROM_CONFIG_ACCESS(ConfigAccess) \
  CR ((ConfigAccess), \
      IP6_FORM_CALLBACK_INFO, \
      HiiConfigAccess, \
      IP6_FORM_CALLBACK_INFO_SIGNATURE \
      )
 
typedef
EFI_STATUS
(*IP6_CONFIG_SET_DATA) (
  IN IP6_CONFIG_INSTANCE  *Instance,
  IN UINTN                DataSize,
  IN VOID                 *Data
  );
 
typedef
EFI_STATUS
(*IP6_CONFIG_GET_DATA) (
  IN IP6_CONFIG_INSTANCE  *Instance,
  IN OUT UINTN            *DataSize,
  IN VOID                 *Data      OPTIONAL
  );
 
typedef union {
  VOID                                        *Ptr;
  EFI_IP6_CONFIG_INTERFACE_INFO               *IfInfo;
  EFI_IP6_CONFIG_INTERFACE_ID                 *AltIfId;
  EFI_IP6_CONFIG_POLICY                       *Policy;
  EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS    *DadXmits;
  EFI_IP6_CONFIG_MANUAL_ADDRESS               *ManualAddress;
  EFI_IPv6_ADDRESS                            *Gateway;
  EFI_IPv6_ADDRESS                            *DnsServers;
} IP6_CONFIG_DATA;
 
typedef struct {
  IP6_CONFIG_SET_DATA    SetData;
  IP6_CONFIG_GET_DATA    GetData;
  EFI_STATUS             Status;
  UINT8                  Attribute;
  NET_MAP                EventMap;
  IP6_CONFIG_DATA        Data;
  UINTN                  DataSize;
} IP6_CONFIG_DATA_ITEM;
 
typedef struct {
  UINT16                      Offset;
  UINT32                      DataSize;
  EFI_IP6_CONFIG_DATA_TYPE    DataType;
} IP6_CONFIG_DATA_RECORD;
 
#pragma pack(1)
 
//
// heap data that contains the data for each data record.
//
//  BOOLEAN                                   IsAltIfIdSet;
//  EFI_IP6_CONFIG_POLICY                     Policy;
//  EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS  DadXmits;
//  UINT32                                    ManualaddressCount;
//  UINT32                                    GatewayCount;
//  UINT32                                    DnsServersCount;
//  EFI_IP6_CONFIG_INTERFACE_ID               AltIfId;
//  EFI_IP6_CONFIG_MANUAL_ADDRESS             ManualAddress[];
//  EFI_IPv6_ADDRESS                          Gateway[];
//  EFI_IPv6_ADDRESS                          DnsServers[];
//
typedef struct {
  UINT32                    IaId;
  UINT16                    Checksum;
  UINT16                    DataRecordCount;
  IP6_CONFIG_DATA_RECORD    DataRecord[1];
} IP6_CONFIG_VARIABLE;
 
#pragma pack()
 
typedef struct {
  LIST_ENTRY              Link;
  EFI_IP6_ADDRESS_INFO    AddrInfo;
} IP6_ADDRESS_INFO_ENTRY;
 
typedef struct {
  EFI_IP6_CONFIG_POLICY                       Policy;              
  EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS    DadTransmitCount;    
  EFI_IP6_CONFIG_INTERFACE_ID                 InterfaceId;         
  LIST_ENTRY                                  ManualAddress;       
  UINT32                                      ManualAddressCount;  
  LIST_ENTRY                                  GatewayAddress;      
  UINT32                                      GatewayAddressCount; 
  LIST_ENTRY                                  DnsAddress;          
  UINT32                                      DnsAddressCount;     
} IP6_CONFIG_NVDATA;
 
typedef struct _IP6_FORM_CALLBACK_INFO {
  UINT32                            Signature;
  EFI_HANDLE                        ChildHandle;
  EFI_HII_CONFIG_ACCESS_PROTOCOL    HiiConfigAccess;
  EFI_DEVICE_PATH_PROTOCOL          *HiiVendorDevicePath;
  EFI_HII_HANDLE                    RegisteredHandle;
} IP6_FORM_CALLBACK_INFO;
 
struct _IP6_CONFIG_INSTANCE {
  UINT32                                      Signature;
  BOOLEAN                                     Configured;
  LIST_ENTRY                                  Link;
  UINT16                                      IfIndex;
 
  EFI_IP6_CONFIG_INTERFACE_INFO               InterfaceInfo;
  EFI_IP6_CONFIG_INTERFACE_ID                 AltIfId;
  EFI_IP6_CONFIG_POLICY                       Policy;
  EFI_IP6_CONFIG_DUP_ADDR_DETECT_TRANSMITS    DadXmits;
 
  IP6_CONFIG_DATA_ITEM                        DataItem[Ip6ConfigDataTypeMaximum];
  NET_MAP                                     DadFailedMap;
  NET_MAP                                     DadPassedMap;
 
  EFI_IP6_CONFIG_PROTOCOL                     Ip6Config;
 
  EFI_EVENT                                   Dhcp6SbNotifyEvent;
  VOID                                        *Registration;
  EFI_HANDLE                                  Dhcp6Handle;
  EFI_DHCP6_PROTOCOL                          *Dhcp6;
  BOOLEAN                                     OtherInfoOnly;
  UINT32                                      IaId;
  EFI_EVENT                                   Dhcp6Event;
  UINT32                                      FailedIaAddressCount;
  EFI_IPv6_ADDRESS                            *DeclineAddress;
  UINT32                                      DeclineAddressCount;
 
  IP6_FORM_CALLBACK_INFO                      CallbackInfo;
  IP6_CONFIG_NVDATA                           Ip6NvData;
};
 
EFI_STATUS
Ip6ConfigReadConfigData (
  IN     CHAR16               *VarName,
  IN OUT IP6_CONFIG_INSTANCE  *Instance
  );
 
EFI_STATUS
EFIAPI
Ip6ConfigOnDhcp6Reply (
  IN EFI_DHCP6_PROTOCOL  *This,
  IN VOID                *Context,
  IN EFI_DHCP6_PACKET    *Packet
  );
 
EFI_STATUS
Ip6ConfigStartStatefulAutoConfig (
  IN IP6_CONFIG_INSTANCE  *Instance,
  IN BOOLEAN              OtherInfoOnly
  );
 
EFI_STATUS
Ip6ConfigInitInstance (
  OUT IP6_CONFIG_INSTANCE  *Instance
  );
 
VOID
Ip6ConfigCleanInstance (
  IN OUT IP6_CONFIG_INSTANCE  *Instance
  );
 
EFI_STATUS
Ip6ConfigDestroyDhcp6 (
  IN OUT IP6_CONFIG_INSTANCE  *Instance
  );
 
#endif