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>
@param[in] BufLen The maximum length of the data buffer to\r
store the received data in the socket layer.\r
\r
@param[in] BufLen The maximum length of the data buffer to\r
store the received data in the socket layer.\r
\r
- @return The length of the data can be retreived.\r
+ @return The length of the data can be retrieved.\r
- // Proceess it in the light of SockType\r
+ // Process it in the light of SockType\r
//\r
SndToken = (SOCK_IO_TOKEN *) SockToken->Token;\r
TxData = SndToken->Packet.TxData;\r
//\r
SndToken = (SOCK_IO_TOKEN *) SockToken->Token;\r
TxData = SndToken->Packet.TxData;\r
\r
@param[in] SockInitData Pointer to the initial data of the socket.\r
\r
\r
@param[in] SockInitData Pointer to the initial data of the socket.\r
\r
- @return Pointer to the newly created socket, return NULL when exception occured.\r
+ @return Pointer to the newly created socket, return NULL when exception occurred.\r
\r
/**\r
Create a socket and its associated protocol control block\r
\r
/**\r
Create a socket and its associated protocol control block\r
- with the intial data SockInitData and protocol specific\r
+ with the initial data SockInitData and protocol specific\r
- @param[in] SockInitData Inital data to setting the socket.\r
+ @param[in] SockInitData Initial data to setting the socket.\r
- @return Pointer to the newly created socket. If NULL, an error condition occured.\r
+ @return Pointer to the newly created socket. If NULL, an error condition occurred.\r
/**\r
Initiate a connection establishment process.\r
\r
/**\r
Initiate a connection establishment process.\r
\r
- @param[in] Sock Pointer to the socket to initiate the initate the\r
+ @param[in] Sock Pointer to the socket to initiate the\r
connection.\r
@param[in] Token Pointer to the token used for the connection\r
operation.\r
connection.\r
@param[in] Token Pointer to the token used for the connection\r
operation.\r
@param[in] Sock Pointer to the socket to accept connections.\r
@param[in] Token The token to accept a connection.\r
\r
@param[in] Sock Pointer to the socket to accept connections.\r
@param[in] Token The token to accept a connection.\r
\r
- @retval EFI_SUCCESS Either a connection is accpeted or the Token is\r
+ @retval EFI_SUCCESS Either a connection is accepted or the Token is\r
buffered for further acception.\r
@retval EFI_ACCESS_DENIED Failed to get the lock to access the socket, or the\r
socket is closed, or the socket is not configured to\r
buffered for further acception.\r
@retval EFI_ACCESS_DENIED Failed to get the lock to access the socket, or the\r
socket is closed, or the socket is not configured to\r
\r
@param[in] Sock Pointer to the socket.\r
\r
\r
@param[in] Sock Pointer to the socket.\r
\r
- @retval TRUE The socket is unconfigued.\r
- @retval FALSE The socket is not unconfigued.\r
+ @retval TRUE The socket is unconfigured.\r
+ @retval FALSE The socket is not unconfigured.\r
\r
**/\r
#define SOCK_IS_UNCONFIGURED(Sock) ((Sock)->ConfigureState == SO_UNCONFIGURED)\r
\r
**/\r
#define SOCK_IS_UNCONFIGURED(Sock) ((Sock)->ConfigureState == SO_UNCONFIGURED)\r
\r
@param[in] Sock Pointer to the socket\r
\r
\r
@param[in] Sock Pointer to the socket\r
\r
- @retval TRUE The socket is configued\r
- @retval FALSE The socket is not configued\r
+ @retval TRUE The socket is configured\r
+ @retval FALSE The socket is not configured\r
\r
**/\r
#define SOCK_IS_CONFIGURED(Sock) \\r
\r
**/\r
#define SOCK_IS_CONFIGURED(Sock) \\r
\r
@param[in] Sock Pointer to the socket.\r
\r
\r
@param[in] Sock Pointer to the socket.\r
\r
- @retval TRUE The socket is configued to active mode.\r
- @retval FALSE The socket is not configued to active mode.\r
+ @retval TRUE The socket is configured to active mode.\r
+ @retval FALSE The socket is not configured to active mode.\r
\r
**/\r
#define SOCK_IS_CONFIGURED_ACTIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE)\r
\r
**/\r
#define SOCK_IS_CONFIGURED_ACTIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_ACTIVE)\r
\r
@param[in] Sock Pointer to the socket.\r
\r
\r
@param[in] Sock Pointer to the socket.\r
\r
- @retval TRUE The socket is configued to passive mode.\r
- @retval FALSE The socket is not configued to passive mode.\r
+ @retval TRUE The socket is configured to passive mode.\r
+ @retval FALSE The socket is not configured to passive mode.\r
\r
**/\r
#define SOCK_IS_CONNECTED_PASSIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE)\r
\r
**/\r
#define SOCK_IS_CONNECTED_PASSIVE(Sock) ((Sock)->ConfigureState == SO_CONFIGURED_PASSIVE)\r
- The Callback funtion called after the TCP socket is created.\r
+ The Callback function called after the TCP socket is created.\r
\r
@param[in] This Pointer to the socket just created.\r
@param[in] Context Context of the socket.\r
\r
@retval EFI_SUCCESS This protocol installed successfully.\r
\r
@param[in] This Pointer to the socket just created.\r
@param[in] Context Context of the socket.\r
\r
@retval EFI_SUCCESS This protocol installed successfully.\r
- @retval other Some error occured.\r
+ @retval other Some error occurred.\r
// Callbacks after socket is created and before socket is to be destroyed.\r
//\r
SOCK_CREATE_CALLBACK CreateCallback; ///< Callback after created\r
// Callbacks after socket is created and before socket is to be destroyed.\r
//\r
SOCK_CREATE_CALLBACK CreateCallback; ///< Callback after created\r
- SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroied\r
+ SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroyed\r
VOID *Context; ///< The context of the callback\r
\r
//\r
VOID *Context; ///< The context of the callback\r
\r
//\r
// Callbacks after socket is created and before socket is to be destroyed.\r
//\r
SOCK_CREATE_CALLBACK CreateCallback; ///< Callback after created\r
// Callbacks after socket is created and before socket is to be destroyed.\r
//\r
SOCK_CREATE_CALLBACK CreateCallback; ///< Callback after created\r
- SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroied\r
+ SOCK_DESTROY_CALLBACK DestroyCallback; ///< Callback before destroyed\r
VOID *Context; ///< The context of the callback\r
};\r
\r
VOID *Context; ///< The context of the callback\r
};\r
\r
LIST_ENTRY TokenList; ///< The entry to add in the token list\r
SOCK_COMPLETION_TOKEN *Token; ///< The application's token\r
UINT32 RemainDataLen; ///< Unprocessed data length\r
LIST_ENTRY TokenList; ///< The entry to add in the token list\r
SOCK_COMPLETION_TOKEN *Token; ///< The application's token\r
UINT32 RemainDataLen; ///< Unprocessed data length\r
- SOCKET *Sock; ///< The poninter to the socket this token\r
+ SOCKET *Sock; ///< The pointer to the socket this token\r
///< belongs to\r
} SOCK_TOKEN;\r
\r
///< belongs to\r
} SOCK_TOKEN;\r
\r
} TCP_RSV_DATA;\r
\r
//\r
} TCP_RSV_DATA;\r
\r
//\r
-// Socket provided oprerations for low layer protocol implemented in SockImpl.c\r
+// Socket provided operations for low layer protocol implemented in SockImpl.c\r
\r
/**\r
Create a socket and its associated protocol control block\r
\r
/**\r
Create a socket and its associated protocol control block\r
- with the intial data SockInitData and protocol specific\r
+ with the initial data SockInitData and protocol specific\r
- @param[in] SockInitData Inital data to setting the socket.\r
+ @param[in] SockInitData Initial data to setting the socket.\r
- @return Pointer to the newly created socket. If NULL, an error condition occured.\r
+ @return Pointer to the newly created socket. If NULL, an error condition occurred.\r
/**\r
Initiate a connection establishment process.\r
\r
/**\r
Initiate a connection establishment process.\r
\r
- @param[in] Sock Pointer to the socket to initiate the initate the\r
+ @param[in] Sock Pointer to the socket to initiate the\r
connection.\r
@param[in] Token Pointer to the token used for the connection\r
operation.\r
connection.\r
@param[in] Token Pointer to the token used for the connection\r
operation.\r