Add the detailed descriptions for the structure data member in these protocol.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6935 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -52,19 +52,74 @@ typedef struct {
|
||||
} EFI_IP4_VARIABLE_DATA;
|
||||
|
||||
typedef struct {
|
||||
///
|
||||
/// The default IPv4 protocol packets to send and receive. Ignored
|
||||
/// when AcceptPromiscuous is TRUE.
|
||||
///
|
||||
UINT8 DefaultProtocol;
|
||||
///
|
||||
/// Set to TRUE to receive all IPv4 packets that get through the receive filters.
|
||||
/// Set to FALSE to receive only the DefaultProtocol IPv4
|
||||
/// packets that get through the receive filters.
|
||||
///
|
||||
BOOLEAN AcceptAnyProtocol;
|
||||
///
|
||||
/// Set to TRUE to receive ICMP error report packets. Ignored when
|
||||
/// AcceptPromiscuous or AcceptAnyProtocol is TRUE.
|
||||
///
|
||||
BOOLEAN AcceptIcmpErrors;
|
||||
///
|
||||
/// Set to TRUE to receive broadcast IPv4 packets. Ignored when
|
||||
/// AcceptPromiscuous is TRUE.
|
||||
/// Set to FALSE to stop receiving broadcast IPv4 packets.
|
||||
///
|
||||
BOOLEAN AcceptBroadcast;
|
||||
///
|
||||
/// Set to TRUE to receive all IPv4 packets that are sent to any
|
||||
/// hardware address or any protocol address.
|
||||
/// Set to FALSE to stop receiving all promiscuous IPv4 packets
|
||||
///
|
||||
BOOLEAN AcceptPromiscuous;
|
||||
///
|
||||
/// Set to TRUE to use the default IPv4 address and default routing table.
|
||||
///
|
||||
BOOLEAN UseDefaultAddress;
|
||||
///
|
||||
/// The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.
|
||||
///
|
||||
EFI_IPv4_ADDRESS StationAddress;
|
||||
///
|
||||
/// The subnet address mask that is associated with the station address.
|
||||
///
|
||||
EFI_IPv4_ADDRESS SubnetMask;
|
||||
///
|
||||
/// TypeOfService field in transmitted IPv4 packets.
|
||||
///
|
||||
UINT8 TypeOfService;
|
||||
///
|
||||
/// TimeToLive field in transmitted IPv4 packets.
|
||||
///
|
||||
UINT8 TimeToLive;
|
||||
///
|
||||
/// State of the DoNotFragment bit in transmitted IPv4 packets.
|
||||
///
|
||||
BOOLEAN DoNotFragment;
|
||||
///
|
||||
/// Set to TRUE to send and receive unformatted packets. The other
|
||||
/// IPv4 receive filters are still applied. Fragmentation is disabled for RawData mode.
|
||||
///
|
||||
BOOLEAN RawData;
|
||||
///
|
||||
/// The timer timeout value (number of microseconds) for the
|
||||
/// receive timeout event to be associated with each assembled
|
||||
/// packet. Zero means do not drop assembled packets.
|
||||
///
|
||||
UINT32 ReceiveTimeout;
|
||||
///
|
||||
/// The timer timeout value (number of microseconds) for the
|
||||
/// transmit timeout event to be associated with each outgoing
|
||||
/// packet. Zero means do not drop outgoing packets.
|
||||
///
|
||||
UINT32 TransmitTimeout;
|
||||
} EFI_IP4_CONFIG_DATA;
|
||||
|
||||
@@ -81,14 +136,41 @@ typedef struct {
|
||||
} EFI_IP4_ICMP_TYPE;
|
||||
|
||||
typedef struct {
|
||||
///
|
||||
/// Set to TRUE after this EFI IPv4 Protocol instance has been successfully configured.
|
||||
///
|
||||
BOOLEAN IsStarted;
|
||||
///
|
||||
/// Current configuration settings.
|
||||
///
|
||||
EFI_IP4_CONFIG_DATA ConfigData;
|
||||
///
|
||||
/// Set to TRUE when the EFI IPv4 Protocol instance has a station address and subnet mask.
|
||||
///
|
||||
BOOLEAN IsConfigured;
|
||||
///
|
||||
/// Number of joined multicast groups.
|
||||
///
|
||||
UINT32 GroupCount;
|
||||
///
|
||||
/// List of joined multicast group addresses.
|
||||
///
|
||||
EFI_IPv4_ADDRESS *GroupTable;
|
||||
///
|
||||
/// Number of entries in the routing table.
|
||||
///
|
||||
UINT32 RouteCount;
|
||||
///
|
||||
/// Routing table entries.
|
||||
///
|
||||
EFI_IP4_ROUTE_TABLE *RouteTable;
|
||||
///
|
||||
/// Number of entries in the supported ICMP types list.
|
||||
///
|
||||
UINT32 IcmpTypeCount;
|
||||
///
|
||||
/// Array of ICMP types and codes that are supported by this EFI IPv4 Protocol driver
|
||||
///
|
||||
EFI_IP4_ICMP_TYPE *IcmpTypeList;
|
||||
} EFI_IP4_MODE_DATA;
|
||||
|
||||
@@ -149,10 +231,26 @@ typedef struct {
|
||||
} EFI_IP4_TRANSMIT_DATA;
|
||||
|
||||
typedef struct {
|
||||
///
|
||||
/// This Event will be signaled after the Status field is updated
|
||||
/// by the EFI IPv4 Protocol driver. The type of Event must be
|
||||
/// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of
|
||||
/// Event must be lower than or equal to TPL_CALLBACK.
|
||||
///
|
||||
EFI_EVENT Event;
|
||||
///
|
||||
/// The status that is returned to the caller at the end of the operation
|
||||
/// to indicate whether this operation completed successfully.
|
||||
///
|
||||
EFI_STATUS Status;
|
||||
union {
|
||||
///
|
||||
/// When this token is used for receiving, RxData is a pointer to the EFI_IP4_RECEIVE_DATA.
|
||||
///
|
||||
EFI_IP4_RECEIVE_DATA *RxData;
|
||||
///
|
||||
/// When this token is used for transmitting, TxData is a pointer to the EFI_IP4_TRANSMIT_DATA.
|
||||
///
|
||||
EFI_IP4_TRANSMIT_DATA *TxData;
|
||||
} Packet;
|
||||
} EFI_IP4_COMPLETION_TOKEN;
|
||||
|
Reference in New Issue
Block a user