Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that 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.
#define EFI_IP4_HEADER_LEN | ( | HdrPtr | ) | ((HdrPtr)->HeaderLength << 2) |
Get the IP header length from the struct EFI_IP4_HEADER. HeaderLength is Internet header length in 32-bit words, so HeaderLength<<2 is the real length of IP header.
[out] | HdrPtr | A pointer to EFI_IP4_HEADER. |
#define ICMP6_ERR_PACKAGE_TOOBIG 4 |
#define ICMP6_ERR_PARAMPROB_HEADER 7 |
#define ICMP6_ERR_PARAMPROB_IPV6OPTION 9 |
#define ICMP6_ERR_PARAMPROB_NEXHEADER 8 |
#define ICMP6_ERR_TIMXCEED_HOPLIMIT 5 |
#define ICMP6_ERR_TIMXCEED_REASS 6 |
#define ICMP6_ERR_UNREACH_HOST 1 |
#define ICMP6_ERR_UNREACH_NET 0 |
#define ICMP6_ERR_UNREACH_PORT 3 |
#define ICMP6_ERR_UNREACH_PROTOCOL 2 |
#define ICMP_CODE_UNREACH_HOST 1 |
#define ICMP_CODE_UNREACH_HOST_PROHIB 10 |
#define ICMP_CODE_UNREACH_HOST_UNKNOWN 7 |
#define ICMP_CODE_UNREACH_ISOLATED 8 |
#define ICMP_CODE_UNREACH_NEEDFRAG 4 |
#define ICMP_CODE_UNREACH_NET 0 |
#define ICMP_CODE_UNREACH_NET_PROHIB 9 |
#define ICMP_CODE_UNREACH_NET_UNKNOWN 6 |
#define ICMP_CODE_UNREACH_PORT 3 |
#define ICMP_CODE_UNREACH_PROTOCOL 2 |
#define ICMP_CODE_UNREACH_SRCFAIL 5 |
#define ICMP_CODE_UNREACH_TOSHOST 12 |
#define ICMP_CODE_UNREACH_TOSNET 11 |
#define ICMP_ERR_MSGSIZE 4 |
#define ICMP_ERR_PARAMPROB 9 |
#define ICMP_ERR_QUENCH 8 |
#define ICMP_ERR_TIMXCEED_INTRANS 6 |
#define ICMP_ERR_TIMXCEED_REASS 7 |
#define ICMP_ERR_UNREACH_HOST 1 |
#define ICMP_ERR_UNREACH_NET 0 |
This error will be delivered to the listening transportation layer protocol that consumes IpIO.
#define ICMP_ERR_UNREACH_PORT 3 |
#define ICMP_ERR_UNREACH_PROTOCOL 2 |
#define ICMP_ERR_UNREACH_SRCFAIL 5 |
#define ICMP_ERRLEN | ( | IpHdr | ) | (sizeof(IP4_ICMP_HEAD) + EFI_IP4_HEADER_LEN(IpHdr) + 8) |
To types of ICMP error which consist of ICMP header, IP header and original datagram's data, get length from sum of ICMP header length, IP header length and first 64 bits of datagram's data length.
[in] | IpHdr | A pointer to EFI_IP4_HEADER. |
#define ICMP_TYPE_PARAMPROB 12 |
#define ICMP_TYPE_SOURCEQUENCH 4 |
#define ICMP_TYPE_TIMXCEED 11 |
#define ICMP_TYPE_UNREACH 3 |
#define NET_PROTO_HDR | ( | Buf, | |||
Type | ) | ((Type *) ((Buf)->BlockOp[0].Head)) |
typedef IN VOID* Context |
typedef struct _EFI_NET_SESSION_DATA EFI_NET_SESSION_DATA |
The IP session for an IP receive packet.
typedef IN UINT8 IcmpErr |
This data structure wraps Ip4/Ip6 instances. The IpIo Library uses it for all Ip4/Ip6 operations.
typedef struct _IP_IO_IP_INFO IP_IO_IP_INFO |
The IP_IO_IP_INFO is used in IpIoSend() to override the default IP instance in IP_IO.
typedef struct _IP_IO_OPEN_DATA IP_IO_OPEN_DATA |
The struct is for the user to pass IP configuration and callbacks to IP_IO. It is used by IpIoOpen().
typedef struct _IP_IO_SEND_ENTRY IP_IO_SEND_ENTRY |
Internal struct book-keeping send request of IP_IO.
An IP_IO_SEND_ENTRY will be created each time a send request is issued to IP_IO via IpIoSend().
typedef IN UINT8 IN EFI_NET_SESSION_DATA* NetSession |
typedef IN VOID IN IP_IO_IP_PROTOCOL IN VOID* NotifyData |
typedef IN UINT8 IN EFI_NET_SESSION_DATA IN NET_BUF* Pkt |
typedef IN VOID IN IP_IO_IP_PROTOCOL Sender |
IP_IO_IP_INFO* EFIAPI IpIoAddIp | ( | IN OUT IP_IO * | IpIo | ) |
Add a new IP instance for sending data.
The function is used to add the IP_IO to the IP_IO sending list. The caller can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send data.
[in,out] | IpIo | The pointer to an IP_IO instance to add a new IP instance for sending purposes. |
VOID EFIAPI IpIoCancelTxToken | ( | IN IP_IO * | IpIo, | |
IN VOID * | Packet | |||
) |
Cancel the IP transmit token that wraps this Packet.
[in] | IpIo | The pointer to the IP_IO instance. |
[in] | Packet | The pointer to the packet of NET_BUF to cancel. |
EFI_STATUS EFIAPI IpIoConfigIp | ( | IN OUT IP_IO_IP_INFO * | IpInfo, | |
IN OUT VOID * | IpConfigData | |||
) |
Configure the IP instance of this IpInfo and start the receiving if IpConfigData is not NULL.
[in,out] | IpInfo | The pointer to the IP_IO_IP_INFO instance. |
[in,out] | IpConfigData | The IP4 or IP6 configure data used to configure the IP instance. If NULL, the IP instance is reset. If UseDefaultAddress is set to TRUE, and the configure operation succeeds, the default address information is written back in this IpConfigData. |
EFI_SUCCESS | The IP instance of this IpInfo was configured successfully, or there is no need to reconfigure it. | |
Others | The configuration failed. |
IP_IO* EFIAPI IpIoCreate | ( | IN EFI_HANDLE | Image, | |
IN EFI_HANDLE | Controller, | |||
IN UINT8 | IpVersion | |||
) |
Create a new IP_IO instance.
This function uses IP4/IP6 service binding protocol in Controller to create an IP4/IP6 child (aka IP4/IP6 instance).
[in] | Image | The image handle of the driver or application that consumes IP_IO. |
[in] | Controller | The controller handle that has IP4 or IP6 service binding protocol installed. |
[in] | IpVersion | The version of the IP protocol to use, either IPv4 or IPv6. |
EFI_STATUS EFIAPI IpIoDestroy | ( | IN OUT IP_IO * | IpIo | ) |
Destroy an IP_IO instance.
This function is paired with IpIoCreate(). The IP_IO will be closed first. Resource will be freed afterwards. See IpIoClose().
[in,out] | IpIo | The pointer to the IP_IO instance that needs to be destroyed. |
EFI_SUCCESS | The IP_IO instance was destroyed successfully. | |
Others | An error condition occurred. |
IP_IO_IP_INFO* EFIAPI IpIoFindSender | ( | IN OUT IP_IO ** | IpIo, | |
IN UINT8 | IpVersion, | |||
IN EFI_IP_ADDRESS * | Src | |||
) |
Find the first IP protocol maintained in IpIo whose local address is the same as Src.
This function is called when the caller needs the IpIo to send data to the specified Src. The IpIo was added previously by IpIoAddIp().
[in,out] | IpIo | The pointer to the pointer of the IP_IO instance. |
[in] | IpVersion | The version of the IP protocol to use, either IPv4 or IPv6. |
[in] | Src | The local IP address. |
EFI_STATUS EFIAPI IpIoGetIcmpErrStatus | ( | IN UINT8 | IcmpError, | |
IN UINT8 | IpVersion, | |||
OUT BOOLEAN * | IsHard, | |||
OUT BOOLEAN * | Notify | |||
) |
Get the ICMP error map information.
The ErrorStatus will be returned. The IsHard and Notify are optional. If they are not NULL, this routine will fill them.
[in] | IcmpError | IcmpError Type. |
[in] | IpVersion | The version of the IP protocol to use, either IPv4 or IPv6. |
[out] | IsHard | If TRUE, indicates that it is a hard error. |
[out] | Notify | If TRUE, SockError needs to be notified. |
EFI_STATUS EFIAPI IpIoOpen | ( | IN OUT IP_IO * | IpIo, | |
IN IP_IO_OPEN_DATA * | OpenData | |||
) |
Open an IP_IO instance for use.
This function is called after IpIoCreate(). It is used for configuring the IP instance and register the callbacks and their context data for sending and receiving IP packets.
[in,out] | IpIo | The pointer to an IP_IO instance that needs to open. |
[in] | OpenData | The configuration data and callbacks for the IP_IO instance. |
EFI_SUCCESS | The IP_IO instance opened with OpenData successfully. | |
EFI_ACCESS_DENIED | The IP_IO instance is configured; avoid reopening it. | |
Others | An error condition occurred. |
EFI_STATUS IpIoRefreshNeighbor | ( | IN IP_IO * | IpIo, | |
IN EFI_IP_ADDRESS * | Neighbor, | |||
IN UINT32 | Timeout | |||
) |
Refresh the remote peer's Neighbor Cache entries.
This function is called when the caller needs the IpIo to refresh the existing IPv6 neighbor cache entries since the neighbor is considered reachable by the node has recently received a confirmation that packets sent recently to the neighbor were received by its IP layer.
[in] | IpIo | The pointer to an IP_IO instance |
[in] | Neighbor | The IP address of the neighbor |
[in] | Timeout | The time in 100-ns units that this entry will remain in the neighbor cache. A value of zero means that the entry is permanent. A value of non-zero means that the entry is dynamic and will be deleted after Timeout. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_NOT_STARTED | The IpIo is not configured. | |
EFI_INVALID_PARAMETER | The Neighbor Address is invalid. | |
EFI_NOT_FOUND | The neighbor cache entry is not in the neighbor table. | |
EFI_OUT_OF_RESOURCES | Failed due to resource limitations. |
VOID EFIAPI IpIoRemoveIp | ( | IN IP_IO * | IpIo, | |
IN IP_IO_IP_INFO * | IpInfo | |||
) |
Destroy an IP instance maintained in IpIo->IpList for sending purpose.
This function pairs with IpIoAddIp(). The IpInfo is previously created by IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance will be dstroyed if the RefCnt is zero.
[in] | IpIo | The pointer to the IP_IO instance. |
[in] | IpInfo | The pointer to the IpInfo to be removed. |
EFI_STATUS EFIAPI IpIoSend | ( | IN OUT IP_IO * | IpIo, | |
IN OUT NET_BUF * | Pkt, | |||
IN IP_IO_IP_INFO * | Sender, | |||
IN VOID * | Context, | |||
IN VOID * | NotifyData, | |||
IN EFI_IP_ADDRESS * | Dest, | |||
IN IP_IO_OVERRIDE * | OverrideData | |||
) |
Send out an IP packet.
This function is called after IpIoOpen(). The data to be sent are wrapped in Pkt. The IP instance wrapped in IpIo is used for sending by default, but can be overriden by Sender. Other sending configurations, such as source address and gateway address, are specified in OverrideData.
[in,out] | IpIo | The pointer to an IP_IO instance used for sending IP packet. |
[in,out] | Pkt | The pointer to the IP packet to be sent. |
[in] | Sender | Optional. The IP protocol instance used for sending. |
[in] | Context | The optional context data. |
[in] | NotifyData | The optional notify data. |
[in] | Dest | The destination IP address to send this packet to. |
[in] | OverrideData | The data to override some configuration of the IP instance used for sending. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_NOT_STARTED | The IpIo is not configured. | |
EFI_OUT_OF_RESOURCES | Failed due to resource limitations. |
EFI_STATUS EFIAPI IpIoStop | ( | IN OUT IP_IO * | IpIo | ) |
Stop an IP_IO instance.
This function is paired with IpIoOpen(). The IP_IO will be unconfigured, and all pending send/receive tokens will be canceled.
[in,out] | IpIo | The pointer to the IP_IO instance that needs to stop. |
EFI_SUCCESS | The IP_IO instance stopped successfully. | |
Others | Anrror condition occurred. |
typedef VOID | ( | EFIAPI * | PKT_RCVD_NOTIFY | ) |
The prototype is called back when an IP packet is received.
[in] | Status | The result of the receive request. |
[in] | IcmpErr | Valid when Status is EFI_ICMP_ERROR. |
[in] | NetSession | The IP session for the received packet. |
[in] | Pkt | The packet received. |
[in] | Context | The data provided by the user for the received packet when the callback is registered in IP_IO_OPEN_DATA::RcvdContext. |
[in] | Status | Result of the IP packet being sent. |
[in] | Context | The data provided by user for the received packet when the callback is registered in IP_IO_OPEN_DATA::SndContext. |
[in] | Sender | A Union type to specify a pointer of EFI_IP4_PROTOCOL or EFI_IP6_PROTOCOL. |
[in] | NotifyData | The Context data specified when calling IpIoSend() |
Register Exit handler function. When more than one handler function is registered, the latter one will override the previous one. When NULL handler is specified, the previous Exit handler will be unregistered.
[in] | Handler | Pointer to handler function. |
EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData |
EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData |