From 4cefb5e9032f089f4d572684cd7e230f5f5ab414 Mon Sep 17 00:00:00 2001 From: Antoine Coeur Date: Fri, 7 Feb 2020 02:08:00 +0100 Subject: NetworkPkg/TcpDxe/Sock: Fix few typos Fix few typos in comments and documentation. Cc: Jiaxin Wu Cc: Siyuan Fu Cc: Maciej Rabeda Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Reviewed-by: Maciej Rabeda Signed-off-by: Philippe Mathieu-Daude Message-Id: <20200207010831.9046-48-philmd@redhat.com> --- NetworkPkg/TcpDxe/SockImpl.c | 4 ++-- NetworkPkg/TcpDxe/SockImpl.h | 2 +- NetworkPkg/TcpDxe/SockInterface.c | 10 +++++----- NetworkPkg/TcpDxe/Socket.h | 36 ++++++++++++++++++------------------ 4 files changed, 26 insertions(+), 26 deletions(-) (limited to 'NetworkPkg') diff --git a/NetworkPkg/TcpDxe/SockImpl.c b/NetworkPkg/TcpDxe/SockImpl.c index fb28e2e..564e621 100644 --- a/NetworkPkg/TcpDxe/SockImpl.c +++ b/NetworkPkg/TcpDxe/SockImpl.c @@ -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; diff --git a/NetworkPkg/TcpDxe/SockImpl.h b/NetworkPkg/TcpDxe/SockImpl.h index f255b2f..5ec0435 100644 --- a/NetworkPkg/TcpDxe/SockImpl.h +++ b/NetworkPkg/TcpDxe/SockImpl.h @@ -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 * diff --git a/NetworkPkg/TcpDxe/SockInterface.c b/NetworkPkg/TcpDxe/SockInterface.c index ed0a031..6217eb5 100644 --- a/NetworkPkg/TcpDxe/SockInterface.c +++ b/NetworkPkg/TcpDxe/SockInterface.c @@ -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 diff --git a/NetworkPkg/TcpDxe/Socket.h b/NetworkPkg/TcpDxe/Socket.h index 874708e..9448710 100644 --- a/NetworkPkg/TcpDxe/Socket.h +++ b/NetworkPkg/TcpDxe/Socket.h @@ -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. -- cgit v1.1