1)update function header coding style issue

[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiProto.h

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.h
index 484cb6f1698eb2d78f753ff57a2bc90e3ed3a27e..870e6ded449cd1e32031ecab5088f715b552f8c9 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.h
@@ -657,7 +657,7 @@ IScsiDetatchConnection (
 \r
   @retval EFI_SUCCESS        The iSCSI connection is logged into the iSCSI target.\r
   @retval EFI_TIMEOUT        Timeout happened during the login procedure.\r
-  @retval Others             Some unexpected error happened.  \r
+  @retval Others             Other errors as indicated.  \r
 **/\r
 EFI_STATUS\r
 IScsiConnLogin (\r
@@ -695,7 +695,7 @@ IScsiDestroyConnection (
 \r
   @retval EFI_SUCCESS          The iSCSI session login procedure finished.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
-  @retval Others               Some unexpected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiSessionLogin (\r
@@ -724,7 +724,7 @@ IScsiSendLoginReq (
   @param[in]  Conn             The connection in the iSCSI login phase.\r
   \r
   @retval EFI_SUCCESS          The iSCSI login response PDU is received and processed.\r
-  @retval Others               Some unexpected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiReceiveLoginRsp (\r
@@ -759,7 +759,7 @@ IScsiAddKeyValuePair (
   @param[in]  Conn The connection in the iSCSI login phase.\r
 \r
   @return The pointer to the net buffer containing the iSCSI login request built.\r
-  @retval Others    Some unexpected error happened.\r
+  @retval Others    Other errors as indicated.\r
 **/\r
 NET_BUF *\r
 IScsiPrepareLoginReq (\r
@@ -775,7 +775,7 @@ IScsiPrepareLoginReq (
   @retval EFI_SUCCESS        The iSCSI login response PDU is processed and all check are passed.\r
   @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
   @retval EFI_MEDIA_CHANGED  Target is redirected.\r
-  @retval Others             Some unexpected error happened.\r
+  @retval Others             Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiProcessLoginRsp (\r
@@ -795,7 +795,7 @@ IScsiProcessLoginRsp (
   @retval EFI_SUCCESS          The target address is updated.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
   @retval EFI_NOT_FOUND        The TargetAddress key is not found.\r
-  @retval Others               Some unexpected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiUpdateTargetAddress (\r
@@ -831,7 +831,7 @@ IScsiFreeNbufList (
   @retval EFI_SUCCESS          An iSCSI pdu is received.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
   @retval EFI_PROTOCOL_ERROR   Some kind of iSCSI protocol error happened.\r
-  @retval Others               Some unexpected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiReceivePdu (\r
@@ -896,7 +896,7 @@ IScsiPadSegment (
   @param[in]  Len  Length of the data segment.\r
 \r
   @return The key-value list.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 LIST_ENTRY *\r
 IScsiBuildKeyValueList (\r
@@ -955,9 +955,9 @@ IScsiNormalizeName (
                              \r
   @retval EFI_SUCCES           The SCSI command is executed and the result is updated to \r
                                the Packet.\r
-  @retval EFI_DEVICE_ERROR     Some unexpected error happened.\r
+  @retval EFI_DEVICE_ERROR     Other errors as indicated.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
-  @retval Others               Some unexpected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiExecuteScsiCommand (\r
@@ -983,15 +983,15 @@ IScsiSessionReinstatement (
 /**\r
   Initialize some session parameters before login.\r
 \r
-  @param[in]  Session  The iSCSI session.\r
-  @param[in]  Recovery Whether the request is from a fresh new start or recovery.\r
+  @param[in, out]  Session  The iSCSI session.\r
+  @param[in]       Recovery Whether the request is from a fresh new start or recovery.\r
 **/\r
 VOID\r
 IScsiSessionInit (\r
-  IN ISCSI_SESSION  *Session,\r
-  IN BOOLEAN        Recovery\r
+  IN OUT ISCSI_SESSION  *Session,\r
+  IN BOOLEAN            Recovery\r
   );\r
-\r
+  \r
 /**\r
   Abort the iSCSI session, that is, reset all the connection and free the\r
   resources.\r