diff options
author | Liming Gao <liming.gao@intel.com> | 2018-06-27 21:08:52 +0800 |
---|---|---|
committer | Liming Gao <liming.gao@intel.com> | 2018-06-28 11:19:45 +0800 |
commit | d1102dba7210b95e41d06c2338a22ba6af248645 (patch) | |
tree | 8b4af076b5d6f2aa7f35563d4defcca4d4bfdd87 /MdeModulePkg/Include/Library/IpIoLib.h | |
parent | ca79bab7af4770c5eb578f6d495af01705aedb79 (diff) | |
download | edk2-d1102dba7210b95e41d06c2338a22ba6af248645.zip edk2-d1102dba7210b95e41d06c2338a22ba6af248645.tar.gz edk2-d1102dba7210b95e41d06c2338a22ba6af248645.tar.bz2 |
MdeModulePkg: Clean up source files
1. Do not use tab characters
2. No trailing white space in one line
3. All files must end with CRLF
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>
Diffstat (limited to 'MdeModulePkg/Include/Library/IpIoLib.h')
-rw-r--r-- | MdeModulePkg/Include/Library/IpIoLib.h | 94 |
1 files changed, 47 insertions, 47 deletions
diff --git a/MdeModulePkg/Include/Library/IpIoLib.h b/MdeModulePkg/Include/Library/IpIoLib.h index 61653b0..fe136c1 100644 --- a/MdeModulePkg/Include/Library/IpIoLib.h +++ b/MdeModulePkg/Include/Library/IpIoLib.h @@ -2,13 +2,13 @@ This library is only intended to be used by UEFI network stack modules.
It provides the combined IpIo layer on the EFI IP4 Protocol and EFI IP6 protocol.
-Copyright (c) 2005 - 2017, 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 that accompanies this distribution.
+Copyright (c) 2005 - 2018, 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 that accompanies this distribution.
The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
+http://opensource.org/licenses/bsd-license.php.
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include <Library/NetLib.h>
//
-// type and code define for ICMP protocol error
+// type and code define for ICMP protocol error
// from IP
//
#define ICMP_TYPE_UNREACH 3
@@ -48,20 +48,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 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.
-
+
@param[out] HdrPtr A pointer to EFI_IP4_HEADER.
-
+
@return The IP header length.
**/
#define EFI_IP4_HEADER_LEN(HdrPtr) ((HdrPtr)->HeaderLength << 2)
/**
- 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
+ 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.
-
+
@param[in] IpHdr A pointer to EFI_IP4_HEADER.
-
+
@return The ICMP error length.
**/
#define ICMP_ERRLEN(IpHdr) \
@@ -69,15 +69,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /**
Get the packet header from NET_BUF.
-
+
@param[out] Buf A pointer to NET_BUF.
@param[in] Type Header type.
-
+
@return The pointer to packet header.
**/
#define NET_PROTO_HDR(Buf, Type) ((Type *) ((Buf)->BlockOp[0].Head))
-
+
extern EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData;
extern EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData;
@@ -165,8 +165,8 @@ typedef struct _EFI_NET_SESSION_DATA { EFI_IP_ADDRESS Source; ///< Source IP of the received packet.
EFI_IP_ADDRESS Dest; ///< Destination IP of the received packet.
IP_IO_IP_HEADER IpHdr; ///< IP header of the received packet.
- UINT32 IpHdrLen; ///< IP header length of the received packet.
- ///< For IPv6, it includes the IP6 header
+ UINT32 IpHdrLen; ///< IP header length of the received packet.
+ ///< For IPv6, it includes the IP6 header
///< length and extension header length. For
///< IPv4, it includes the IP4 header length
///< and options length.
@@ -175,19 +175,19 @@ typedef struct _EFI_NET_SESSION_DATA { /**
The prototype is called back when an IP packet is received.
-
+
@param[in] Status The result of the receive request.
@param[in] IcmpErr Valid when Status is EFI_ICMP_ERROR.
@param[in] NetSession The IP session for the received packet.
@param[in] Pkt The packet received.
@param[in] Context The data provided by the user for the received packet when
the callback is registered in IP_IO_OPEN_DATA::RcvdContext.
-
+
**/
typedef
VOID
(EFIAPI *PKT_RCVD_NOTIFY) (
- IN EFI_STATUS Status,
+ IN EFI_STATUS Status,
IN UINT8 IcmpErr,
IN EFI_NET_SESSION_DATA *NetSession,
IN NET_BUF *Pkt,
@@ -196,14 +196,14 @@ VOID /**
The prototype is called back when an IP packet is sent.
-
+
@param[in] Status Result of the IP packet being sent.
@param[in] Context The data provided by user for the received packet when
the callback is registered in IP_IO_OPEN_DATA::SndContext.
- @param[in] Sender A Union type to specify a pointer of EFI_IP4_PROTOCOL
+ @param[in] Sender A Union type to specify a pointer of EFI_IP4_PROTOCOL
or EFI_IP6_PROTOCOL.
@param[in] NotifyData The Context data specified when calling IpIoSend()
-
+
**/
typedef
VOID
@@ -228,7 +228,7 @@ typedef struct _IP_IO { /// The list used to maintain the IP instance for different sending purpose.
///
LIST_ENTRY IpList;
-
+
EFI_HANDLE Controller;
EFI_HANDLE Image;
EFI_HANDLE ChildHandle;
@@ -246,7 +246,7 @@ typedef struct _IP_IO { ///
/// Token and event used to get data from IP.
///
- IP_IO_IP_COMPLETION_TOKEN RcvToken;
+ IP_IO_IP_COMPLETION_TOKEN RcvToken;
///
/// List entry used to link the token passed to IP_IO.
@@ -312,7 +312,7 @@ typedef struct _IP_IO_IP_INFO { Create a new IP_IO instance.
If IpVersion is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
-
+
This function uses IP4/IP6 service binding protocol in Controller to create
an IP4/IP6 child (aka IP4/IP6 instance).
@@ -321,7 +321,7 @@ typedef struct _IP_IO_IP_INFO { @param[in] Controller The controller handle that has IP4 or IP6 service
binding protocol installed.
@param[in] IpVersion The version of the IP protocol to use, either
- IPv4 or IPv6.
+ IPv4 or IPv6.
@return The pointer to a newly created IP_IO instance, or NULL if failed.
@@ -336,7 +336,7 @@ IpIoCreate ( /**
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().
@@ -357,7 +357,7 @@ IpIoDestroy ( Stop an IP_IO instance.
If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
-
+
This function is paired with IpIoOpen(). The IP_IO will be unconfigured, and all
pending send/receive tokens will be canceled.
@@ -390,7 +390,7 @@ IpIoStop ( @retval EFI_SUCCESS The IP_IO instance opened with OpenData
successfully.
- @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
+ @retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
reopen it.
@retval EFI_UNSUPPORTED IPv4 RawData mode is no supported.
@retval EFI_INVALID_PARAMETER Invalid input parameter.
@@ -406,7 +406,7 @@ IpIoOpen ( /**
Send out an IP packet.
-
+
This function is called after IpIoOpen(). The data to be sent is wrapped in
Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
overriden by Sender. Other sending configs, like source address and gateway
@@ -464,7 +464,7 @@ IpIoCancelTxToken ( If IpIo is NULL, then ASSERT().
If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
-
+
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.
@@ -488,7 +488,7 @@ IpIoAddIp ( If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
@param[in, out] IpInfo The pointer to the IP_IO_IP_INFO instance.
- @param[in, out] IpConfigData The IP4 or IP6 configure data used to configure
+ @param[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
@@ -510,8 +510,8 @@ IpIoConfigIp ( Destroy an IP instance maintained in IpIo->IpList for
sending purpose.
- If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
-
+ If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
+
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.
@@ -530,7 +530,7 @@ IpIoRemoveIp ( /**
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().
@@ -553,13 +553,13 @@ IpIoFindSender ( /**
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.
@param[in] IcmpError IcmpError Type.
@param[in] IpVersion The version of the IP protocol to use,
- either IPv4 or IPv6.
+ either IPv4 or IPv6.
@param[out] IsHard If TRUE, indicates that it is a hard error.
@param[out] Notify If TRUE, SockError needs to be notified.
@@ -580,23 +580,23 @@ IpIoGetIcmpErrStatus ( 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.
+ 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.
@param[in] IpIo The pointer to an IP_IO instance
@param[in] Neighbor The IP address of the neighbor
@param[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
+ 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.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The IpIo is not configured.
@retval EFI_INVALID_PARAMETER The Neighbor Address is invalid.
- @retval EFI_NOT_FOUND The neighbor cache entry is not in the
- neighbor table.
+ @retval EFI_NOT_FOUND The neighbor cache entry is not in the
+ neighbor table.
@retval EFI_UNSUPPORTED IP version is IPv4, which doesn't support neighbor cache refresh.
@retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.
@@ -606,7 +606,7 @@ EFIAPI IpIoRefreshNeighbor (
IN IP_IO *IpIo,
IN EFI_IP_ADDRESS *Neighbor,
- IN UINT32 Timeout
+ IN UINT32 Timeout
);
#endif
|