tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NetworkPkg/TcpDxe/Sock: Fix few typos 

Fix few typos in comments and documentation.

Cc: Jiaxin Wu <jiaxin.wu@intel.com>
Cc: Siyuan Fu <siyuan.fu@intel.com>
Cc: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-48-philmd@redhat.com>
This commit is contained in:
Antoine Coeur 2020-02-07 02:08:00 +01:00 committed by mergify[bot]
parent bb3594e842
commit 4cefb5e903
4 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
NetworkPkg/TcpDxe/SockImpl.c
View File

@ -89,7 +89,7 @@ SockFreeFoo (
@param[in] BufLen The maximum length of the data buffer to
store the received data in the socket layer.
@return The length of the data can be retreived.
@return The length of the data can be retrieved.
**/
UINT32
@ -270,7 +270,7 @@ SockProcessSndToken (
);
//
// Proceess it in the light of SockType
// Process it in the light of SockType
//
SndToken = (SOCK_IO_TOKEN *) SockToken->Token;
TxData = SndToken->Packet.TxData;

2
NetworkPkg/TcpDxe/SockImpl.h
View File

@ -93,7 +93,7 @@ SockCancelToken (
@param[in] SockInitData Pointer to the initial data of the socket.
@return Pointer to the newly created socket, return NULL when exception occured.
@return Pointer to the newly created socket, return NULL when exception occurred.
**/
SOCKET *

10
NetworkPkg/TcpDxe/SockInterface.c
View File

@ -255,12 +255,12 @@ SockDestroyChild (
/**
Create a socket and its associated protocol control block
with the intial data SockInitData and protocol specific
with the initial data SockInitData and protocol specific
data ProtoData.
@param[in] SockInitData Inital data to setting the socket.
@param[in] SockInitData Initial data to setting the socket.
@return Pointer to the newly created socket. If NULL, an error condition occured.
@return Pointer to the newly created socket. If NULL, an error condition occurred.
**/
SOCKET *
@ -397,7 +397,7 @@ OnExit:
/**
Initiate a connection establishment process.
@param[in] Sock Pointer to the socket to initiate the initate the
@param[in] Sock Pointer to the socket to initiate the
connection.
@param[in] Token Pointer to the token used for the connection
operation.
@ -474,7 +474,7 @@ OnExit:
@param[in] Sock Pointer to the socket to accept connections.
@param[in] Token The token to accept a connection.
@retval EFI_SUCCESS Either a connection is accpeted or the Token is
@retval EFI_SUCCESS Either a connection is accepted or the Token is
buffered for further acception.
@retval EFI_ACCESS_DENIED Failed to get the lock to access the socket, or the
socket is closed, or the socket is not configured to

36
NetworkPkg/TcpDxe/Socket.h
View File

@ -107,8 +107,8 @@
@param[in] Sock Pointer to the socket.
@retval TRUE The socket is unconfigued.
@retval FALSE The socket is not unconfigued.
@retval TRUE The socket is unconfigured.
@retval FALSE The socket is not unconfigured.
**/
#define SOCK_IS_UNCONFIGURED(Sock) ((Sock)->ConfigureState == SO_UNCONFIGURED)
@ -118,8 +118,8 @@
@param[in] Sock Pointer to the socket
@retval TRUE The socket is configued
@retval FALSE The socket is not configued
@retval TRUE The socket is configured
@retval FALSE The socket is not configured
**/
#define SOCK_IS_CONFIGURED(Sock) \
@ -131,8 +131,8 @@
@param[in] Sock Pointer to the socket.
@retval TRUE The socket is configued to active mode.
@retval FALSE The socket is not configued to active mode.
@retval TRUE The socket is configured to active mode.
@retval FALSE The socket is not configured to active mode.
**/
#define SOCK_IS_CONFIGURED_ACTIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE)
@ -142,8 +142,8 @@
@param[in] Sock Pointer to the socket.
@retval TRUE The socket is configued to passive mode.
@retval FALSE The socket is not configued to passive mode.
@retval TRUE The socket is configured to passive mode.
@retval FALSE The socket is not configured to passive mode.
**/
#define SOCK_IS_CONNECTED_PASSIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE)
@ -380,13 +380,13 @@ EFI_STATUS
);
/**
The Callback funtion called after the TCP socket is created.
The Callback function called after the TCP socket is created.
@param[in] This Pointer to the socket just created.
@param[in] Context Context of the socket.
@retval EFI_SUCCESS This protocol installed successfully.
@retval other Some error occured.
@retval other Some error occurred.
**/
typedef
@ -429,7 +429,7 @@ typedef struct _SOCK_INIT_DATA {
// Callbacks after socket is created and before socket is to be destroyed.
//
SOCK_CREATE_CALLBACK CreateCallback; ///< Callback after created
SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroied
SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroyed
VOID *Context; ///< The context of the callback
//
@ -501,7 +501,7 @@ struct _TCP_SOCKET {
// Callbacks after socket is created and before socket is to be destroyed.
//
SOCK_CREATE_CALLBACK CreateCallback; ///< Callback after created
SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroied
SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroyed
VOID *Context; ///< The context of the callback
};
@ -512,7 +512,7 @@ typedef struct _SOCK_TOKEN {
LIST_ENTRY TokenList; ///< The entry to add in the token list
SOCK_COMPLETION_TOKEN *Token; ///< The application's token
UINT32 RemainDataLen; ///< Unprocessed data length
SOCKET *Sock; ///< The poninter to the socket this token
SOCKET *Sock; ///< The pointer to the socket this token
///< belongs to
} SOCK_TOKEN;
@ -524,7 +524,7 @@ typedef struct _TCP_RSV_DATA {
} TCP_RSV_DATA;
//
// Socket provided oprerations for low layer protocol implemented in SockImpl.c
// Socket provided operations for low layer protocol implemented in SockImpl.c
//
/**
@ -676,12 +676,12 @@ SockNoMoreData (
/**
Create a socket and its associated protocol control block
with the intial data SockInitData and protocol specific
with the initial data SockInitData and protocol specific
data ProtoData.
@param[in] SockInitData Inital data to setting the socket.
@param[in] SockInitData Initial data to setting the socket.
@return Pointer to the newly created socket. If NULL, an error condition occured.
@return Pointer to the newly created socket. If NULL, an error condition occurred.
**/
SOCKET *
@ -723,7 +723,7 @@ SockConfigure (
/**
Initiate a connection establishment process.
@param[in] Sock Pointer to the socket to initiate the initate the
@param[in] Sock Pointer to the socket to initiate the
connection.
@param[in] Token Pointer to the token used for the connection
operation.