1)update function header coding style issue

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

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.c
index c3ef7818c4021aee14d62cc70e3762047e8de97a..f3ed2b780eac96f640574247b3ad8689d3c33a05 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.c
@@ -116,7 +116,7 @@ IScsiUpdateCmdSN (
 \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
@@ -276,7 +276,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
@@ -366,7 +366,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
@@ -472,7 +472,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
@@ -567,7 +567,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
@@ -776,7 +776,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
@@ -906,7 +906,7 @@ IScsiNbufExtFree (
   @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
@@ -1447,7 +1447,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
@@ -1762,7 +1762,7 @@ IScsiNewDataSegment (
   @param[in]  Tcb    The tcb assocated with this SCSI command.\r
 \r
   @return The  created iSCSI SCSI command PDU.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 NET_BUF *\r
 IScsiNewScsiCmdPdu (\r
@@ -1936,7 +1936,7 @@ ON_EXIT:
   @param[in]  Lun    The LUN.\r
 \r
   @return The net buffer wrapping the Data Out PDU.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 NET_BUF *\r
 IScsiNewDataOutPdu (\r
@@ -2023,7 +2023,7 @@ IScsiNewDataOutPdu (
   @param[in]  Lun  The LUN the data will be sent to.\r
 \r
   @return A list of net buffers with each of them wraps an iSCSI SCSI Data Out PDU.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 LIST_ENTRY *\r
 IScsiGenerateDataOutPduSequence (\r
@@ -2097,7 +2097,7 @@ ON_EXIT:
 \r
   @retval EFI_SUCCES           The data is sent out to the LUN.\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
 IScsiSendDataOutPduSequence (\r
@@ -2149,7 +2149,7 @@ IScsiSendDataOutPduSequence (
                                actions are taken.\r
   @retval EFI_PROTOCOL_ERROR   Some kind of iSCSI protocol errror happened.\r
   @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.\r
-  @retval Others               Some unexpected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiOnDataInRcvd (\r
@@ -2234,7 +2234,7 @@ IScsiOnDataInRcvd (
 \r
   @retval EFI_SUCCES         The R2T PDU is valid and the solicited data is sent out.\r
   @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
-  @retval Others             Some unexpected error happened.\r
+  @retval Others             Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiOnR2TRcvd (\r
@@ -2298,7 +2298,7 @@ IScsiOnR2TRcvd (
   @retval EFI_SUCCES         The Response PDU is processed.\r
   @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
   @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.\r
-  @retval Others             Some unexpected error happened.\r
+  @retval Others             Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiOnScsiRspRcvd (\r
@@ -2441,9 +2441,9 @@ IScsiOnNopInRcvd (
                              \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     Session state was not as required.\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
@@ -2654,13 +2654,13 @@ 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
   UINT32  Random;\r