MdeModulePkg: Update Ip4Dxe driver to support Ip4Config2 protocol,
and also add new UI configuration support in Ip4Dxe driver. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: jiaxinwu <jiaxin.wu@intel.com> Reviewed-by: Ye Ting <ting.ye@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17853 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jiaxinwu
jiaxinwu
252
MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Impl.h
Normal file
252
MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Config2Impl.h
Normal file
@@ -0,0 +1,252 @@
|
||||
/** @file
|
||||
Definitions for EFI IPv4 Configuration II Protocol implementation.
|
||||
|
||||
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
|
||||
|
||||
This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
which accompanies this distribution. The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
**/
|
||||
|
||||
#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 DHCP_TAG_PARA_LIST 55
|
||||
#define DHCP_TAG_NETMASK 1
|
||||
#define DHCP_TAG_ROUTER 3
|
||||
|
||||
|
||||
#define DATA_ATTRIB_SET(Attrib, Bits) (BOOLEAN)((Attrib) & (Bits))
|
||||
#define SET_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 \
|
||||
)
|
||||
|
||||
/**
|
||||
The prototype of work function for EfiIp4Config2SetData().
|
||||
|
||||
@param[in] Instance The pointer to the IP4 config2 instance data.
|
||||
@param[in] DataSize In bytes, the size of the buffer pointed to by Data.
|
||||
@param[in] Data The data buffer to set.
|
||||
|
||||
@retval EFI_BAD_BUFFER_SIZE The DataSize does not match the size of the type,
|
||||
8 bytes.
|
||||
@retval EFI_SUCCESS The specified configuration data for the EFI IPv4
|
||||
network stack was set successfully.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(*IP4_CONFIG2_SET_DATA) (
|
||||
IN IP4_CONFIG2_INSTANCE *Instance,
|
||||
IN UINTN DataSize,
|
||||
IN VOID *Data
|
||||
);
|
||||
|
||||
/**
|
||||
The prototype of work function for EfiIp4Config2GetData().
|
||||
|
||||
@param[in] Instance The pointer to the IP4 config2 instance data.
|
||||
@param[in, out] DataSize On input, in bytes, the size of Data. On output, in
|
||||
bytes, the size of buffer required to store the specified
|
||||
configuration data.
|
||||
@param[in] Data The data buffer in which the configuration data is returned.
|
||||
Ignored if DataSize is ZERO.
|
||||
|
||||
@retval EFI_BUFFER_TOO_SMALL The size of Data is too small for the specified
|
||||
configuration data, and the required size is
|
||||
returned in DataSize.
|
||||
@retval EFI_SUCCESS The specified configuration data was obtained successfully.
|
||||
|
||||
**/
|
||||
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; ///< manual or automatic
|
||||
EFI_IP4_CONFIG2_MANUAL_ADDRESS *ManualAddress; ///< IP addresses
|
||||
UINT32 ManualAddressCount; ///< IP addresses count
|
||||
EFI_IPv4_ADDRESS *GatewayAddress; ///< Gateway address
|
||||
UINT32 GatewayAddressCount; ///< Gateway address count
|
||||
EFI_IPv4_ADDRESS *DnsAddress; ///< DNS server address
|
||||
UINT32 DnsAddressCount; ///< DNS server address count
|
||||
} 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 DHCP_TAG_NETMASK is included in Head.
|
||||
//
|
||||
#pragma pack(1)
|
||||
typedef struct {
|
||||
EFI_DHCP4_PACKET_OPTION Head;
|
||||
UINT8 Route;
|
||||
} IP4_CONFIG2_DHCP4_OPTION;
|
||||
#pragma pack()
|
||||
|
||||
/**
|
||||
Initialize an IP4_CONFIG2_INSTANCE.
|
||||
|
||||
@param[out] Instance The buffer of IP4_CONFIG2_INSTANCE to be initialized.
|
||||
|
||||
@retval EFI_OUT_OF_RESOURCES Failed to allocate resources to complete the operation.
|
||||
@retval EFI_SUCCESS The IP4_CONFIG2_INSTANCE initialized successfully.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
Ip4Config2InitInstance (
|
||||
OUT IP4_CONFIG2_INSTANCE *Instance
|
||||
);
|
||||
|
||||
/**
|
||||
Release an IP4_CONFIG2_INSTANCE.
|
||||
|
||||
@param[in, out] Instance The buffer of IP4_CONFIG2_INSTANCE to be freed.
|
||||
|
||||
**/
|
||||
VOID
|
||||
Ip4Config2CleanInstance (
|
||||
IN OUT IP4_CONFIG2_INSTANCE *Instance
|
||||
);
|
||||
|
||||
/**
|
||||
Destroy the Dhcp4 child in IP4_CONFIG2_INSTANCE and release the resources.
|
||||
|
||||
@param[in, out] Instance The buffer of IP4 config2 instance to be freed.
|
||||
|
||||
@retval EFI_SUCCESS The child was successfully destroyed.
|
||||
@retval Others Failed to destroy the child.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
Ip4Config2DestroyDhcp4 (
|
||||
IN OUT IP4_CONFIG2_INSTANCE *Instance
|
||||
);
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user