/** @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 - 2009, 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
///\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
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
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
\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
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 Pointer to the EFI_IP4_PROTOCOL instance.\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
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 Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to the transmit token.\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
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
Abort an asynchronous transmit or receive request.\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, then after calling this\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 Pointer to the EFI_IP4_PROTOCOL instance.\r
- @param Token Pointer to a token that has been issued by\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
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