/** @file\r
- \r
This file defines the EFI IPv4 (Internet Protocol version 4)\r
Protocol interface. It is split into the following three main\r
sections:\r
- EFI IPv4 Service Binding Protocol\r
- - EFI IPv4 Variable\r
- - EFI IPv4 Protocol The EFI IPv4 Protocol provides basic\r
- network IPv4 packet I/O services, which includes support for\r
- a subset of the Internet Control Message Protocol (ICMP) and\r
- may include support for the Internet Group Management\r
- Protocol (IGMP).\r
+ - EFI IPv4 Variable (deprecated in UEFI 2.4B)\r
+ - EFI IPv4 Protocol.\r
+ The EFI IPv4 Protocol provides basic network IPv4 packet I/O services,\r
+ which includes support foR a subset of the Internet Control Message \r
+ Protocol (ICMP) and may include support for the Internet Group Management\r
+ Protocol (IGMP).\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation \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 \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
+Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+The full text of the license may be found at\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
+ @par Revision Reference: \r
+ This Protocol is introduced in UEFI Specification 2.0. \r
\r
**/\r
\r
}\r
\r
typedef struct _EFI_IP4_PROTOCOL EFI_IP4_PROTOCOL;\r
- \r
+\r
+///\r
+/// EFI_IP4_ADDRESS_PAIR is deprecated in the UEFI 2.4B and should not be used any more.\r
+/// The definition in here is only present to provide backwards compatability.\r
+///\r
typedef struct {\r
EFI_HANDLE InstanceHandle;\r
EFI_IPv4_ADDRESS Ip4Address;\r
EFI_IPv4_ADDRESS SubnetMask;\r
} EFI_IP4_ADDRESS_PAIR; \r
\r
+///\r
+/// EFI_IP4_VARIABLE_DATA is deprecated in the UEFI 2.4B and should not be used any more.\r
+/// The definition in here is only present to provide backwards compatability.\r
+///\r
typedef struct {\r
EFI_HANDLE DriverHandle;\r
UINT32 AddressCount;\r
} EFI_IP4_VARIABLE_DATA;\r
\r
typedef struct {\r
+ ///\r
+ /// The default IPv4 protocol packets to send and receive. Ignored\r
+ /// when AcceptPromiscuous is TRUE.\r
+ ///\r
UINT8 DefaultProtocol;\r
+ ///\r
+ /// Set to TRUE to receive all IPv4 packets that get through the receive filters.\r
+ /// Set to FALSE to receive only the DefaultProtocol IPv4\r
+ /// packets that get through the receive filters.\r
+ ///\r
BOOLEAN AcceptAnyProtocol;\r
+ ///\r
+ /// Set to TRUE to receive ICMP error report packets. Ignored when\r
+ /// AcceptPromiscuous or AcceptAnyProtocol is TRUE.\r
+ ///\r
BOOLEAN AcceptIcmpErrors;\r
+ ///\r
+ /// Set to TRUE to receive broadcast IPv4 packets. Ignored when\r
+ /// AcceptPromiscuous is TRUE.\r
+ /// Set to FALSE to stop receiving broadcast IPv4 packets.\r
+ ///\r
BOOLEAN AcceptBroadcast;\r
+ ///\r
+ /// Set to TRUE to receive all IPv4 packets that are sent to any\r
+ /// hardware address or any protocol address.\r
+ /// Set to FALSE to stop receiving all promiscuous IPv4 packets\r
+ ///\r
BOOLEAN AcceptPromiscuous;\r
+ ///\r
+ /// Set to TRUE to use the default IPv4 address and default routing table.\r
+ ///\r
BOOLEAN UseDefaultAddress;\r
+ ///\r
+ /// The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.\r
+ ///\r
EFI_IPv4_ADDRESS StationAddress;\r
+ ///\r
+ /// The subnet address mask that is associated with the station address.\r
+ ///\r
EFI_IPv4_ADDRESS SubnetMask;\r
+ ///\r
+ /// TypeOfService field in transmitted IPv4 packets.\r
+ ///\r
UINT8 TypeOfService;\r
+ ///\r
+ /// TimeToLive field in transmitted IPv4 packets.\r
+ ///\r
UINT8 TimeToLive;\r
+ ///\r
+ /// State of the DoNotFragment bit in transmitted IPv4 packets.\r
+ ///\r
BOOLEAN DoNotFragment;\r
+ ///\r
+ /// Set to TRUE to send and receive unformatted packets. The other\r
+ /// IPv4 receive filters are still applied. Fragmentation is disabled for RawData mode.\r
+ ///\r
BOOLEAN RawData;\r
+ ///\r
+ /// The timer timeout value (number of microseconds) for the\r
+ /// receive timeout event to be associated with each assembled\r
+ /// packet. Zero means do not drop assembled packets.\r
+ ///\r
UINT32 ReceiveTimeout;\r
+ ///\r
+ /// The timer timeout value (number of microseconds) for the\r
+ /// transmit timeout event to be associated with each outgoing\r
+ /// packet. Zero means do not drop outgoing packets.\r
+ ///\r
UINT32 TransmitTimeout;\r
} EFI_IP4_CONFIG_DATA;\r
\r
} EFI_IP4_ICMP_TYPE;\r
\r
typedef struct {\r
+ ///\r
+ /// Set to TRUE after this EFI IPv4 Protocol instance has been successfully configured.\r
+ ///\r
BOOLEAN IsStarted;\r
+ ///\r
+ /// The maximum packet size, in bytes, of the packet which the upper layer driver could feed.\r
+ ///\r
+ UINT32 MaxPacketSize;\r
+ ///\r
+ /// Current configuration settings.\r
+ ///\r
EFI_IP4_CONFIG_DATA ConfigData;\r
+ ///\r
+ /// Set to TRUE when the EFI IPv4 Protocol instance has a station address and subnet mask.\r
+ ///\r
BOOLEAN IsConfigured;\r
+ ///\r
+ /// Number of joined multicast groups.\r
+ ///\r
UINT32 GroupCount;\r
+ ///\r
+ /// List of joined multicast group addresses.\r
+ ///\r
EFI_IPv4_ADDRESS *GroupTable;\r
+ ///\r
+ /// Number of entries in the routing table.\r
+ ///\r
UINT32 RouteCount;\r
+ ///\r
+ /// Routing table entries.\r
+ ///\r
EFI_IP4_ROUTE_TABLE *RouteTable;\r
+ ///\r
+ /// Number of entries in the supported ICMP types list.\r
+ ///\r
UINT32 IcmpTypeCount;\r
+ ///\r
+ /// Array of ICMP types and codes that are supported by this EFI IPv4 Protocol driver\r
+ ///\r
EFI_IP4_ICMP_TYPE *IcmpTypeList;\r
} EFI_IP4_MODE_DATA;\r
\r
} EFI_IP4_TRANSMIT_DATA;\r
\r
typedef struct {\r
+ ///\r
+ /// This Event will be signaled after the Status field is updated\r
+ /// by the EFI IPv4 Protocol driver. The type of Event must be\r
+ /// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of\r
+ /// Event must be lower than or equal to TPL_CALLBACK.\r
+ ///\r
EFI_EVENT Event;\r
+ ///\r
+ /// The status that is returned to the caller at the end of the operation\r
+ /// to indicate whether this operation completed successfully.\r
+ ///\r
EFI_STATUS Status;\r
union {\r
+ ///\r
+ /// When this token is used for receiving, RxData is a pointer to the EFI_IP4_RECEIVE_DATA.\r
+ ///\r
EFI_IP4_RECEIVE_DATA *RxData;\r
+ ///\r
+ /// When this token is used for transmitting, TxData is a pointer to the EFI_IP4_TRANSMIT_DATA.\r
+ ///\r
EFI_IP4_TRANSMIT_DATA *TxData;\r
} Packet;\r
} EFI_IP4_COMPLETION_TOKEN;\r
\r
/**\r
Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.\r
+ \r
+ The GetModeData() function returns the current operational mode data for this\r
+ driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This\r
+ function is used optionally to retrieve the operational mode data of underlying\r
+ networks or drivers.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Ip4ModeData Pointer to the EFI IPv4 Protocol mode data structure.\r
- @param MnpConfigData Pointer to the managed network configuration data structure.\r
- @param SnpModeData Pointer to the simple network mode data structure.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Ip4ModeData The pointer to the EFI IPv4 Protocol mode data structure.\r
+ @param MnpConfigData The pointer to the managed network configuration data structure.\r
+ @param SnpModeData The pointer to the simple network mode data structure.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
\r
/**\r
Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r
+ \r
+ The Configure() function is used to set, change, or reset the operational\r
+ parameters and filter settings for this EFI IPv4 Protocol instance. Until these\r
+ parameters have been set, no network traffic can be sent or received by this\r
+ instance. Once the parameters have been reset (by calling this function with\r
+ IpConfigData set to NULL), no more traffic can be sent or received until these\r
+ parameters have been set again. Each EFI IPv4 Protocol instance can be started\r
+ and stopped independently of each other by enabling or disabling their receive\r
+ filter settings with the Configure() function.\r
+ \r
+ When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will\r
+ be appended as an alias address into the addresses list in the EFI IPv4 Protocol\r
+ driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL\r
+ to retrieve the default IPv4 address if it is not available yet. Clients could\r
+ frequently call GetModeData() to check the status to ensure that the default IPv4\r
+ address is ready.\r
+ \r
+ If operational parameters are reset or changed, any pending transmit and receive\r
+ requests will be cancelled. Their completion token status will be set to EFI_ABORTED\r
+ and their events will be signaled.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param IpConfigData Pointer to the EFI IPv4 Protocol configuration data structure.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param IpConfigData The pointer to the EFI IPv4 Protocol configuration data structure.\r
\r
@retval EFI_SUCCESS The driver instance was successfully opened.\r
@retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
RARP, etc.) is not finished yet.\r
@retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
+ This is NULL.\r
+ IpConfigData.StationAddress is not a unicast IPv4 address.\r
+ IpConfigData.SubnetMask is not a valid IPv4 subnet \r
@retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:\r
A configuration protocol (DHCP, BOOTP, RARP, etc.) could\r
not be located when clients choose to use the default IPv4\r
\r
/**\r
Joins and leaves multicast groups.\r
+ \r
+ The Groups() function is used to join and leave multicast group sessions. Joining\r
+ a group will enable reception of matching multicast packets. Leaving a group will\r
+ disable the multicast packet reception.\r
+ \r
+ If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
@param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.\r
- @param GroupAddress Pointer to the IPv4 multicast address.\r
+ @param GroupAddress The pointer to the IPv4 multicast address.\r
\r
@retval EFI_SUCCESS The operation completed successfully.\r
@retval EFI_INVALID_PARAMETER One or more of the following is TRUE:\r
- This is NULL.\r
- JoinFlag is TRUE and GroupAddress is NULL.\r
- GroupAddress is not NULL and *GroupAddress is\r
- not a multicast IPv4 address.\r
+ not a multicast IPv4 address.\r
@retval EFI_NOT_STARTED This instance has not been started.\r
@retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,\r
RARP, etc.) is not finished yet.\r
/**\r
Adds and deletes routing table entries.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ The Routes() function adds a route to or deletes a route from the routing table.\r
+ \r
+ Routes are determined by comparing the SubnetAddress with the destination IPv4\r
+ address arithmetically AND-ed with the SubnetMask. The gateway address must be\r
+ on the same subnet as the configured station address.\r
+ \r
+ The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.\r
+ The default route matches all destination IPv4 addresses that do not match any\r
+ other routes.\r
+ \r
+ A GatewayAddress that is zero is a nonroute. Packets are sent to the destination\r
+ IP address if it can be found in the ARP cache or on the local subnet. One automatic\r
+ nonroute entry will be inserted into the routing table for outgoing packets that\r
+ are addressed to a local subnet (gateway address of 0.0.0.0).\r
+ \r
+ Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI\r
+ IPv4 Protocol instances that use the default IPv4 address will also have copies\r
+ of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these\r
+ copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its\r
+ instances. As a result, client modification to the routing table will be lost.\r
+\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
@param DeleteRoute Set to TRUE to delete this route from the routing table. Set to\r
FALSE to add this route to the routing table. SubnetAddress\r
and SubnetMask are used as the key to each route entry.\r
@retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.\r
@retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).\r
@retval EFI_ACCESS_DENIED The route is already defined in the routing table (when\r
- DeleteRoute is FALSE).\r
+ DeleteRoute is FALSE).\r
\r
**/\r
typedef \r
/**\r
Places outgoing data packets into the transmit queue.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to the transmit token.\r
+ The Transmit() function places a sending request in the transmit queue of this\r
+ EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some\r
+ errors occur, the event in the token will be signaled and the status is updated.\r
+\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token The pointer to the transmit token.\r
\r
@retval EFI_SUCCESS The data has been queued for transmission.\r
@retval EFI_NOT_STARTED This instance has not been started.\r
\r
/**\r
Places a receiving request into the receiving queue.\r
+ \r
+ The Receive() function places a completion token into the receive packet queue.\r
+ This function is always asynchronous.\r
+ \r
+ The Token.Event field in the completion token must be filled in by the caller\r
+ and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol\r
+ driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event\r
+ is signaled.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that is associated with the receive data descriptor.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token The pointer to a token that is associated with the receive data descriptor.\r
\r
@retval EFI_SUCCESS The receive completion token was cached.\r
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
resources (usually memory).\r
@retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
The EFI IPv4 Protocol instance has been reset to startup defaults.\r
- EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r
+ @retval EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already\r
in the receive queue.\r
@retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.\r
@retval EFI_ICMP_ERROR An ICMP error packet was received.\r
\r
/**\r
Abort an asynchronous transmit or receive request.\r
-\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\r
+ \r
+ The Cancel() function is used to abort a pending transmit or receive request.\r
+ If the token is in the transmit or receive request queues, after calling this\r
+ function, Token->Status will be set to EFI_ABORTED and then Token->Event will\r
+ be signaled. If the token is not in one of the queues, which usually means the\r
+ asynchronous operation has completed, this function will not signal the token\r
+ and EFI_NOT_FOUND is returned.\r
+\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param Token The pointer to a token that has been issued by\r
EFI_IP4_PROTOCOL.Transmit() or\r
EFI_IP4_PROTOCOL.Receive(). If NULL, all pending\r
tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is\r
defined in EFI_IP4_PROTOCOL.Transmit().\r
\r
@retval EFI_SUCCESS The asynchronous I/O request was aborted and\r
- Token.->Event was signaled. When Token is NULL, all\r
+ Token->Event was signaled. When Token is NULL, all\r
pending requests were aborted and their events were signaled.\r
@retval EFI_INVALID_PARAMETER This is NULL.\r
@retval EFI_NOT_STARTED This instance has not been started.\r
\r
/**\r
Polls for incoming data packets and processes outgoing data packets.\r
+ \r
+ The Poll() function polls for incoming data packets and processes outgoing data\r
+ packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()\r
+ function to increase the rate that data packets are moved between the communications\r
+ device and the transmit and receive queues.\r
+ \r
+ In some systems the periodic timer event may not poll the underlying communications\r
+ device fast enough to transmit and/or receive all data packets without missing\r
+ incoming packets or dropping outgoing packets. Drivers and applications that are\r
+ experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function\r
+ more often.\r
\r
- @param This Pointer to the EFI_IP4_PROTOCOL instance.\r
+ @param This The pointer to the EFI_IP4_PROTOCOL instance.\r
\r
@retval EFI_SUCCESS Incoming or outgoing data was processed.\r
@retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.\r
projects / mirror_edk2.git / blobdiff