1)update function header coding style issue

change Some unexpected error happened.    to Other errors as indicated.
2) delete unused parameter in IScsiConfigFormInit()
3) correct IN OUT mistake in IScsiSessionInit ()
4)roll back one update for Piece of code in IScsiDhcp.c around line 99 on FieldIndex

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7013 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.c
index ad68cd9d4c7436772f4837401df5917ebacfa605..4df7123b545e4c2e3a2230d6e9a9969de49c28cc 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.c
@@ -30,7 +30,7 @@ EFI_GUID  mIScsiCHAPAuthInfoGuid = ISCSI_CHAP_AUTH_INFO_GUID;
   @retval EFI_SUCCESS             The expected hash value was caculatedly successfully.\r
   @retval EFI_PROTOCOL_ERROR      The length of the secret should be at least the \r
                                   length of the hash value for the hashing algorithm chosen.\r
-  @retval Others                  Some unexpected error happened.                                \r
+  @retval Others                  Other errors as indicated.                                \r
 **/\r
 EFI_STATUS\r
 IScsiCHAPCalculateResponse (\r
@@ -82,7 +82,7 @@ IScsiCHAPCalculateResponse (
 \r
   @retval EFI_SUCCESS               The response from target passed authentication.\r
   @retval EFI_SECURITY_VIOLATION    The response from target was not expected value.\r
-  @retval Others                    Some unexpected error happened.\r
+  @retval Others                    Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiCHAPAuthTarget (\r
@@ -123,7 +123,7 @@ IScsiCHAPAuthTarget (
   @retval EFI_SUCCESS          The Login Response passed the CHAP validation.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
   @retval EFI_PROTOCOL_ERROR   Some kind of protocol error happend.\r
-  @retval Others               Some unexpected error happend.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiCHAPOnRspReceived (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h
index 7bb01c5a6bf223f50a709fb4b1b187117e31e3f7..ca8338d504c5edc7742a684e3b841b608a254a1a 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h
@@ -88,7 +88,7 @@ typedef struct _ISCSI_CHAP_AUTH_DATA {
   @retval EFI_SUCCESS          The Login Response passed the CHAP validation.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
   @retval EFI_PROTOCOL_ERROR   Some kind of protocol error happend.\r
-  @retval Others               Some unexpected error happend.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiCHAPOnRspReceived (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.c
index b0976731668cfd4bd8a3fb67fd2e9e14f4da7708..5b6c3bcee36930cbc73a8169e818ece14058a29a 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.c
@@ -58,7 +58,7 @@ PopUpInvalidNotify (
   Update the list of iSCSI devices the iSCSI driver is controlling.\r
   \r
   @retval EFI_SUCCESS            The callback successfully handled the action.\r
-  @retval Others                 Some unexpected errors happened.   \r
+  @retval Others                 Other errors as indicated.   \r
 **/\r
 EFI_STATUS\r
 IScsiUpdateDeviceList (\r
@@ -460,7 +460,7 @@ IScsiFormRouteConfig (
   @retval EFI_UNSUPPORTED        The specified Action is not supported by the\r
                                  callback.Currently not implemented.\r
   @retval EFI_INVALID_PARAMETERS Passing in wrong parameter. \r
-  @retval Others                 Some unexpected error happened. \r
+  @retval Others                 Other errors as indicated. \r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -737,7 +737,7 @@ IScsiFormCallback (
 \r
   @retval EFI_SUCCESS             The iSCSI configuration form is updated.\r
   @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
-  @retval Others                  Some unexpected errors happened.\r
+  @retval Others                  Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiConfigUpdateForm (\r
@@ -891,11 +891,11 @@ IScsiConfigUpdateForm (
 \r
   @retval EFI_SUCCESS              The iSCSI configuration form is initialized.\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
 IScsiConfigFormInit (\r
-  IN EFI_HANDLE  DriverBindingHandle\r
+  VOID\r
   )\r
 {\r
   EFI_STATUS                  Status;\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
index e4f2645d310f4b8a38811fbe88b4dfc04a5fccaf..eb6e0e38535992398a741e331a606e80dcaf2714 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
@@ -32,6 +32,31 @@ extern UINT8  IScsiDxeStrings[];
 \r
 #define ISCSI_FORM_CALLBACK_INFO_SIGNATURE  EFI_SIGNATURE_32 ('I', 'f', 'c', 'i')\r
 \r
+\r
+\r
+/**\r
+  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, \r
+  then this macro return a pointer to a data structure ISCSI_FORM_CALLBACK_INFO.\r
+\r
+  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,  \r
+  The Signature field of the data structure ISCSI_FORM_CALLBACK_INFO \r
+  is compared to TestSignature.  If the signatures match, then a pointer \r
+  to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO is returned.  \r
+  If the signatures do not match, then DebugAssert() is called with a description \r
+  of "CR has a bad signature" and Callback is returned.  \r
+\r
+  If the data type ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain the field\r
+  specified by Callback, then the module will not compile.\r
+\r
+  If ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain a field called Signature, \r
+  then the module will not compile.\r
+\r
+  @param  Callback       Pointer to the specified field within the data \r
+                         structure ISCSI_FORM_CALLBACK_INFO.\r
+  @return                a pointer to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO.\r
+  @return  Others        Some unexpected error happened.\r
+**/\r
+\r
 #define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \\r
   CR ( \\r
   Callback, \\r
@@ -87,7 +112,7 @@ typedef struct _ISCSI_FORM_CALLBACK_INFO {
 \r
   @retval EFI_SUCCESS             The iSCSI configuration form is updated.\r
   @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
-  @retval Others                  Some unexpected errors happened.\r
+  @retval Others                  Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiConfigUpdateForm (\r
@@ -103,11 +128,11 @@ IScsiConfigUpdateForm (
 \r
   @retval EFI_SUCCESS              The iSCSI configuration form is initialized.\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
 IScsiConfigFormInit (\r
-  IN EFI_HANDLE  DriverBindingHandle\r
+  VOID\r
   );\r
 \r
 /**\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.c
index f02423475e6f2d22f52c4890aa468209a9d6ac1d..85b5dbf7450bc2490808545aa2adecaebda0ad03 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.c
@@ -96,24 +96,18 @@ IScsiDhcpExtractRootPath (
     goto ON_EXIT;\r
   }\r
   \r
-  for (FieldIndex = RP_FIELD_IDX_SERVERNAME; FieldIndex != RP_FIELD_IDX_TARGETNAME; FieldIndex = RP_FIELD_IDX_TARGETNAME) {\r
-    if (Fields[FieldIndex].Str == NULL) {\r
-      Status = EFI_INVALID_PARAMETER;\r
-      goto ON_EXIT;\r
-    }\r
-  }\r
-  \r
-  FieldIndex = RP_FIELD_IDX_PROTOCOL;\r
-  if (Fields[RP_FIELD_IDX_PROTOCOL].Len > 1) {\r
+    if ((Fields[RP_FIELD_IDX_SERVERNAME].Str == NULL) ||\r
+      (Fields[RP_FIELD_IDX_TARGETNAME].Str == NULL) ||\r
+      (Fields[RP_FIELD_IDX_PROTOCOL].Len > 1)\r
+      ) {\r
+\r
     Status = EFI_INVALID_PARAMETER;\r
     goto ON_EXIT;\r
   }\r
-\r
   //\r
   // Get the IP address of the target.\r
   //\r
-  FieldIndex = RP_FIELD_IDX_SERVERNAME;\r
-  Field   = &Fields[FieldIndex];\r
+  Field   = &Fields[RP_FIELD_IDX_SERVERNAME];\r
   Status  = IScsiAsciiStrToIp (Field->Str, &ConfigNvData->TargetIp);\r
   if (EFI_ERROR (Status)) {\r
     goto ON_EXIT;\r
@@ -121,8 +115,7 @@ IScsiDhcpExtractRootPath (
   //\r
   // Check the protocol type.\r
   //\r
-  FieldIndex = RP_FIELD_IDX_PROTOCOL;\r
-  Field = &Fields[FieldIndex];\r
+  Field = &Fields[RP_FIELD_IDX_PROTOCOL];\r
   if ((Field->Str != NULL) && ((*(Field->Str) - '0') != EFI_IP_PROTO_TCP)) {\r
     Status = EFI_INVALID_PARAMETER;\r
     goto ON_EXIT;\r
@@ -130,8 +123,7 @@ IScsiDhcpExtractRootPath (
   //\r
   // Get the port of the iSCSI target.\r
   //\r
-  FieldIndex = RP_FIELD_IDX_PORT;\r
-  Field = &Fields[FieldIndex];\r
+  Field = &Fields[RP_FIELD_IDX_PORT];\r
   if (Field->Str != NULL) {\r
     ConfigNvData->TargetPort = (UINT16) AsciiStrDecimalToUintn (Field->Str);\r
   } else {\r
@@ -140,8 +132,7 @@ IScsiDhcpExtractRootPath (
   //\r
   // Get the LUN.\r
   //\r
-  FieldIndex = RP_FIELD_IDX_LUN;\r
-  Field = &Fields[FieldIndex];\r
+  Field = &Fields[RP_FIELD_IDX_LUN];\r
   if (Field->Str != NULL) {\r
     Status = IScsiAsciiStrToLun (Field->Str, ConfigNvData->BootLun);\r
     if (EFI_ERROR (Status)) {\r
@@ -153,8 +144,8 @@ IScsiDhcpExtractRootPath (
   //\r
   // Get the target iSCSI Name.\r
   //\r
-  FieldIndex = RP_FIELD_IDX_TARGETNAME;  \r
-  Field = &Fields[FieldIndex];\r
+  Field = &Fields[RP_FIELD_IDX_TARGETNAME];\r
+\r
   if (AsciiStrLen (Field->Str) > ISCSI_NAME_MAX_SIZE - 1) {\r
     Status = EFI_INVALID_PARAMETER;\r
     goto ON_EXIT;\r
@@ -190,7 +181,7 @@ ON_EXIT:
   @retval EFI_SUCCESS      Either the DHCP OFFER is qualified or we're not intereseted\r
                            in the Dhcp4Event.\r
   @retval EFI_NOT_READY    The DHCP OFFER packet doesn't match our requirements.\r
-  @retval Others           Some unexpected error happened.\r
+  @retval Others           Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiDhcpSelectOffer (\r
@@ -261,7 +252,7 @@ IScsiDhcpSelectOffer (
   @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.\r
   @retval EFI_NO_MAPPING        DHCP failed to acquire address and other information.\r
   @retval EFI_INVALID_PARAMETER The DHCP ACK's DNS option is mal-formatted.\r
-  @retval EFI_DEVICE_ERROR      Some unexpected error happened.\r
+  @retval EFI_DEVICE_ERROR      Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiParseDhcpAck (\r
@@ -352,7 +343,7 @@ IScsiParseDhcpAck (
 \r
   @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.\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
 IScsiDoDhcp (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
index 1c7ad5676728b50a6e24a19ec794d521405dfa23..af55c13daec2569790c426bc632e43619e998c14 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
@@ -49,7 +49,7 @@ typedef struct _ISCSI_ROOT_PATH_FIELD {
 \r
   @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.\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
 IScsiDoDhcp (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c
index b23289ff567007e5c83ef2c0a25c71672fd68f85..2f776aa22461aa3f692f39dc43cf5ecbdf95d485 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c
@@ -337,7 +337,7 @@ IScsiDriverBindingStop (
   @param[in]  ImageHandle       Handle that identifies the image to be unloaded.\r
 \r
   @retval EFI_SUCCESS           The image has been unloaded.\r
-  @retval Others                Some unexpected errors happened.\r
+  @retval Others                Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -408,7 +408,7 @@ EfiIScsiUnload (
 \r
   @retval EFI_SUCCESS           The operation completed successfully.\r
   @retval EFI_ACCESS_DENIED     EFI_ISCSI_INITIATOR_NAME_PROTOCOL was installed unexpectedly.\r
-  @retval Others                Some unexpected error happened.\r
+  @retval Others                Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -472,7 +472,7 @@ IScsiDriverEntryPoint (
     //\r
     // Initialize the configuration form of iSCSI.\r
     //\r
-    Status = IScsiConfigFormInit (gIScsiDriverBinding.DriverBindingHandle);\r
+    Status = IScsiConfigFormInit ();\r
     if (EFI_ERROR (Status)) {\r
       gBS->UninstallMultipleProtocolInterfaces (\r
             ImageHandle,\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h
index f8f726c34069bf1ee2f2f4ee8d52d99a2047e9cc..369f1591207923721bada51c8fddc931dda3863d 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h
@@ -258,7 +258,7 @@ IScsiComponentNameGetControllerName (
   @retval EFI_BUFFER_TOO_SMALL  BufferSize is too small for the result.\r
   @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.\r
   @retval EFI_DEVICE_ERROR      The iSCSI initiator name could not be retrieved due to a hardware error.\r
-  @retval Others                Some unexpected error happened.\r
+  @retval Others                Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -283,7 +283,7 @@ IScsiGetInitiatorName (
   @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the data.\r
   @retval EFI_PROTOCOL_ERROR    Input iSCSI initiator name does not adhere to RFC 3720\r
                                 (and other related protocols)\r
-  @retval Others                Some unexpected error happened.\r
+  @retval Others                Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c
index 127fe9f733989ebb0362766a170733f4badb811a..ff8c96eafe085ff23e108788a240a0921cf4328d 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.c
@@ -189,7 +189,7 @@ IScsiMapV4ToV6Addr (
   @param[in]  Controller  The handle of the controller.\r
 \r
   @return UINT16          The composited representation of the NIC PCI location.\r
-  @retval 0               Some unexpected error happened.\r
+  @retval 0               Other errors as indicated.\r
 **/\r
 UINT16\r
 IScsiGetNICPciLocation (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.h
index a21990e3a21ba74a714a2d2c450668786522d281..e2fec0b2555673220a5149e1287201a95878222a 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiIbft.h
@@ -31,7 +31,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 **/\r
 VOID\r
 IScsiPublishIbft (\r
-  VOID\r
+  VOID  \r
   );\r
 \r
 #endif\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
index c6b1bf3586348f02d67f508bbfad8547206309d2..2084fe1779e5cec4a2c031609a937fd469d0f8a8 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
@@ -32,7 +32,7 @@ EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName = {
   @retval EFI_BUFFER_TOO_SMALL  BufferSize is too small for the result.\r
   @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.\r
   @retval EFI_DEVICE_ERROR      The iSCSI initiator name could not be retrieved due to a hardware error.\r
-  @retval Others                Some unexpected error happened.\r
+  @retval Others                Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -74,7 +74,7 @@ IScsiGetInitiatorName (
   @retval EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the data.\r
   @retval EFI_PROTOCOL_ERROR    Input iSCSI initiator name does not adhere to RFC 3720\r
                                 (and other related protocols)\r
-  @retval Others                Some unexpected error happened.\r
+  @retval Others                Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
index 2215fdaa2bc401198a291689d6bbaaabea31d684..7a77b2a04de80b7ba9b5804868ada21916719e2f 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
@@ -20,7 +20,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8  IScsiHexString[] = "0123456789ABCDEFa
   Removes (trims) specified leading and trailing characters from a string.\r
 \r
   @param[in, out]  Str  Pointer to the null-terminated string to be trimmed. On return, \r
-                        str will hold the trimmed string. \r
+                        Str will hold the trimmed string. \r
 \r
   @param[in]      CharC Character will be trimmed from str.\r
 **/\r
@@ -74,7 +74,7 @@ StrTrim (
   @param[in]  SubnetMask The IPv4 subnet mask.\r
 \r
   @return The prefix length of the subnet mask.\r
-  @return 0 Some unexpected error happened.\r
+  @retval 0 Other errors as indicated.\r
 **/\r
 UINT8\r
 IScsiGetSubnetMaskPrefixLength (\r
@@ -424,7 +424,7 @@ IScsiBinToHex (
 \r
   @retval EFI_SUCCESS          The hexadecimal string is converted into a binary\r
                                encoded buffer.\r
-  @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.s\r
+  @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.\r
 **/\r
 EFI_STATUS\r
 IScsiHexToBin (\r
@@ -512,7 +512,7 @@ IScsiGenRandom (
   @param[in] Controller The handle of the controller.\r
 \r
   @return The iSCSI driver data created.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 ISCSI_DRIVER_DATA *\r
 IScsiCreateDriverData (\r
@@ -619,7 +619,7 @@ IScsiCleanDriverData (
 \r
   @retval EFI_SUCCESS   The configuration of this instance is got.\r
   @retval EFI_ABORTED   The operation was aborted.\r
-  @retval Others        Some unexpected error happened.\r
+  @retval Others        Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiGetConfigData (\r
@@ -709,7 +709,7 @@ IScsiGetConfigData (
   @param[in]  Private The iSCSI driver data.\r
 \r
   @return The updated device path.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 EFI_DEVICE_PATH_PROTOCOL *\r
 IScsiGetTcpConnDevicePath (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h
index cde79aa52587b358807351587776d67baa30cc21..33b7b58acfba85f06763555924f10117799f44a0 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h
@@ -50,7 +50,7 @@ struct _ISCSI_SESSION_CONFIG_DATA {
   @param[in]  SubnetMask The IPv4 subnet mask.\r
 \r
   @return The prefix length of the subnet mask.\r
-  @return 0 Some unexpected error happened.\r
+  @retval 0 Other errors as indicated.\r
 **/\r
 UINT8\r
 IScsiGetSubnetMaskPrefixLength (\r
@@ -171,7 +171,7 @@ IScsiBinToHex (
 \r
   @retval EFI_SUCCESS          The hexadecimal string is converted into a binary\r
                                encoded buffer.\r
-  @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.s\r
+  @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.\r
 **/\r
 EFI_STATUS\r
 IScsiHexToBin (\r
@@ -199,7 +199,7 @@ IScsiGenRandom (
   @param[in] Controller The handle of the controller.\r
 \r
   @return The iSCSI driver data created.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 ISCSI_DRIVER_DATA *\r
 IScsiCreateDriverData (\r
@@ -224,7 +224,7 @@ IScsiCleanDriverData (
 \r
   @retval EFI_SUCCESS   The configuration of this instance is got.\r
   @retval EFI_ABORTED   The operation was aborted.\r
-  @retval Others        Some unexpected error happened.\r
+  @retval Others        Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiGetConfigData (\r
@@ -237,7 +237,7 @@ IScsiGetConfigData (
   @param[in]  Private The iSCSI driver data.\r
 \r
   @return The updated device path.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 EFI_DEVICE_PATH_PROTOCOL *\r
 IScsiGetTcpConnDevicePath (\r

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

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

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.c
index f1520267b8acae5df4d60c6ef727baa270b8297a..96d990f7fe3b54cbdd8e7f21ef5c09ad715d7d41 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.c
@@ -272,7 +272,7 @@ Tcp4IoDestroySocket (
   \r
   @retval EFI_SUCCESS          Connect to the other endpoint of the TCP socket successfully.\r
   @retval EFI_TIMEOUT          Failed to connect to the other endpoint of the TCP socket in the                               specified time period.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoConnect (\r
@@ -338,7 +338,7 @@ Tcp4IoReset (
   \r
   @retval EFI_SUCCESS          The packet is trasmitted.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoTransmit (\r
@@ -404,7 +404,7 @@ ON_EXIT:
   @retval EFI_OUT_OF_RESOURCES Failed to allocate momery.\r
   @retval EFI_TIMEOUT          Failed to receive the required amount of data in the\r
                                specified time period.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoReceive (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h
index 86c2f86e0432e5a4e1ff45a1cf3131a825f4b8ba..1cc051c58ae6b404b46a493e56c473c211feacaa 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiTcp4Io.h
@@ -82,7 +82,7 @@ Tcp4IoDestroySocket (
   \r
   @retval EFI_SUCCESS          Connect to the other endpoint of the TCP socket successfully.\r
   @retval EFI_TIMEOUT          Failed to connect to the other endpoint of the TCP socket in the                               specified time period.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoConnect (\r
@@ -108,7 +108,7 @@ Tcp4IoReset (
   \r
   @retval EFI_SUCCESS          The packet is trasmitted.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoTransmit (\r
@@ -129,7 +129,7 @@ Tcp4IoTransmit (
   @retval EFI_OUT_OF_RESOURCES Failed to allocate momery.\r
   @retval EFI_TIMEOUT          Failed to receive the required amount of data in the\r
                                specified time period.\r
-  @retval Others               Some expected error happened.\r
+  @retval Others               Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 Tcp4IoReceive (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.c b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.c
index 202de40d1f1df17f3b1bfcf09f9f532818b4054c..fae10d268fbfa3076d343e5e2ee27dd83a8093a6 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.c
@@ -285,7 +285,7 @@ MD5Init (
   @param[in]  DataLen The length of data.\r
 \r
   @retval EFI_SUCCESS The transform is ok.\r
-  @retval Others      Some unexpected errors happened.\r
+  @retval Others      Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 MD5Update (\r
@@ -312,7 +312,7 @@ MD5Update (
   @param[out]  HashVal The final 128-bits output.\r
 \r
   @retval EFI_SUCCESS  The transform is ok.\r
-  @retval Others       Some unexpected errors happened.\r
+  @retval Others       Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 MD5Final (\r

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
index 2804d4e189ade9c01f1749d858d2718b7b792b55..18accea7d5c3f8e8d91b3933ab3ecd7a9c12edeb 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
@@ -50,7 +50,7 @@ MD5Init (
   @param[in]  DataLen The length of data.\r
 \r
   @retval EFI_SUCCESS The transform is ok.\r
-  @retval Others      Some unexpected errors happened.\r
+  @retval Others      Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 MD5Update (\r
@@ -68,7 +68,7 @@ MD5Update (
   @param[out]  HashVal The final 128-bits output.\r
 \r
   @retval EFI_SUCCESS  The transform is ok.\r
-  @retval Others       Some unexpected errors happened.\r
+  @retval Others       Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 MD5Final (\r