]> git.proxmox.com Git - mirror_edk2.git/commitdiff
NetworkPkg/IScsiDxe: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:07:54 +0000 (02:07 +0100)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 10 Feb 2020 22:30:07 +0000 (22:30 +0000)
Fix various 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@linux.intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-42-philmd@redhat.com>

NetworkPkg/IScsiDxe/ComponentName.c
NetworkPkg/IScsiDxe/IScsiCHAP.c
NetworkPkg/IScsiDxe/IScsiConfig.c
NetworkPkg/IScsiDxe/IScsiDhcp.c
NetworkPkg/IScsiDxe/IScsiDriver.c
NetworkPkg/IScsiDxe/IScsiMisc.c
NetworkPkg/IScsiDxe/IScsiMisc.h
NetworkPkg/IScsiDxe/IScsiProto.c
NetworkPkg/IScsiDxe/IScsiProto.h

index 77e6f3858a29272647219851bce7f2a933febedc..8572ac281d1d300f3dcdc6d75bf4e5b49e20105c 100644 (file)
@@ -249,7 +249,7 @@ IScsiComponentNameGetControllerName (
   }\r
 \r
   //\r
-  // Get the handle of the controller we are controling.\r
+  // Get the handle of the controller we are controlling.\r
   //\r
   IScsiController = NetLibGetNicHandle (ControllerHandle, &gEfiTcp4ProtocolGuid);\r
   if (IScsiController != NULL) {\r
index 627882af00580353cd0cd798950cb6e04bef4afa..355c6f129f68fd06a9e9a070243a48544b0a7d37 100644 (file)
@@ -9,7 +9,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 #include "IScsiImpl.h"\r
 \r
 /**\r
-  Initator calculates its own expected hash value.\r
+  Initiator calculates its own expected hash value.\r
 \r
   @param[in]   ChapIdentifier     iSCSI CHAP identifier sent by authenticator.\r
   @param[in]   ChapSecret         iSCSI CHAP secret of the authenticator.\r
@@ -88,7 +88,7 @@ Exit:
 }\r
 \r
 /**\r
-  The initator checks the CHAP response replied by target against its own\r
+  The initiator checks the CHAP response replied by target against its own\r
   calculation of the expected hash value.\r
 \r
   @param[in]   AuthData             iSCSI CHAP authentication data.\r
index d773849fd3b0f1af206c8eef9df025a376e805c5..326b1da39ea300b2e6e6d2f24bbaf227d6ee3d14 100644 (file)
@@ -293,7 +293,7 @@ IScsiConvertIsIdToString (
   @param[in]  String             The string is "&OFFSET=".\r
   @param[out] Value              The Offset value.\r
 \r
-  @retval EFI_OUT_OF_RESOURCES   Insufficient resources to store neccessary\r
+  @retval EFI_OUT_OF_RESOURCES   Insufficient resources to store necessary\r
                                  structures.\r
   @retval EFI_SUCCESS            Value of <Number> is outputted in Number\r
                                  successfully.\r
@@ -2229,7 +2229,7 @@ IScsiConfigAddAttemptsByKeywords (
 \r
   @retval EFI_NOT_FOUND          Cannot find the corresponding variable.\r
   @retval EFI_SUCCESS            The operation is completed successfully.\r
-  @retval EFI_ABOTRED            This operation is aborted cause of error\r
+  @retval EFI_ABORTED            This operation is aborted cause of error\r
                                  configuration.\r
   @retval EFI_OUT_OF_RESOURCES   Fail to finish the operation due to lack of\r
                                  resources.\r
@@ -3024,7 +3024,7 @@ IScsiFormExtractConfig (
   }\r
 \r
   //\r
-  // Extract all AttemptConfigData to Keyword stroage of IfrNvData.\r
+  // Extract all AttemptConfigData to Keyword storage of IfrNvData.\r
   //\r
   IScsiConvertAttemptConfigDataToIfrNvDataByKeyword (IfrNvData);\r
 \r
index d8c9fff6c65d8406149a88c7fd4af8e1163c430c..7ce9bf575012b0f1594bd702cf2f4cfe73537dd9 100644 (file)
@@ -193,7 +193,7 @@ ON_EXIT:
 }\r
 \r
 /**\r
-  The callback function registerd to the DHCP4 instance that is used to select\r
+  The callback function registered to the DHCP4 instance that is used to select\r
   the qualified DHCP OFFER.\r
 \r
   @param[in]  This         The DHCP4 protocol.\r
@@ -460,7 +460,7 @@ IScsiDoDhcp (
   // the active state, If the DHCP4 D.O.R.A started by IP4 auto\r
   // configuration and has not been completed, the Dhcp4 state machine\r
   // will not be in the right state for the iSCSI to start a new round D.O.R.A.\r
-  // So, we need to switch it's policy to static.\r
+  // So, we need to switch its policy to static.\r
   //\r
   Status = gBS->HandleProtocol (Controller, &gEfiIp4Config2ProtocolGuid, (VOID **) &Ip4Config2);\r
   if (!EFI_ERROR (Status)) {\r
index 94c9b228c241cb596ed9a8aa36b12b0014a26ca5..98b73308c118d675a3764e8193ae83420b145ee3 100644 (file)
@@ -334,7 +334,7 @@ IScsiSupported (
   @param[in]  ControllerHandle     Handle of the controller.\r
   @param[in]  IpVersion            IP_VERSION_4 or IP_VERSION_6.\r
 \r
-  @retval EFI_SUCCES            This driver was started.\r
+  @retval EFI_SUCCESS           This driver was started.\r
   @retval EFI_ALREADY_STARTED   This driver is already running on this device.\r
   @retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
   @retval EFI_NOT_FOUND         There is no sufficient information to establish\r
@@ -720,7 +720,7 @@ IScsiStart (
     }\r
 \r
     //\r
-    // Restore the origial user setting which specifies the proxy/virtual iSCSI target to NV region.\r
+    // Restore the original user setting which specifies the proxy/virtual iSCSI target to NV region.\r
     //\r
     NvData = &AttemptConfigData->SessionConfigData;\r
     if (NvData->RedirectFlag) {\r
@@ -1091,7 +1091,7 @@ IScsiStop (
   }\r
 \r
   //\r
-  // Get the handle of the controller we are controling.\r
+  // Get the handle of the controller we are controlling.\r
   //\r
   if (IpVersion == IP_VERSION_4) {\r
     ProtocolGuid            = &gIScsiV4PrivateGuid;\r
@@ -1154,7 +1154,7 @@ IScsiStop (
   IScsiRemoveNic (IScsiController);\r
 \r
   //\r
-  // Update the iSCSI Boot Firware Table.\r
+  // Update the iSCSI Boot Firmware Table.\r
   //\r
   IScsiPublishIbft ();\r
 \r
@@ -1504,7 +1504,7 @@ IScsiUnload (
   EFI_COMPONENT_NAME2_PROTOCOL      *ComponentName2;\r
 \r
   //\r
-  // Try to disonnect the driver from the devices it's controlling.\r
+  // Try to disconnect the driver from the devices it's controlling.\r
   //\r
   Status = gBS->LocateHandleBuffer (\r
                   AllHandles,\r
index 38ad67917c300d0369c4df0466b421210a07917c..b8fef3ff6f5a4d571a872825b58feb81b9c19dc1 100644 (file)
@@ -272,7 +272,7 @@ IScsiAsciiStrToIp (
 }\r
 \r
 /**\r
-  Convert the mac address into a hexadecimal encoded "-" seperated string.\r
+  Convert the mac address into a hexadecimal encoded "-" separated string.\r
 \r
   @param[in]  Mac     The mac address.\r
   @param[in]  Len     Length in bytes of the mac address.\r
@@ -2412,7 +2412,7 @@ IScsiGetTcpConnDevicePath (
         //  Add a judgement here to support previous versions of IPv4_DEVICE_PATH.\r
         //  In previous versions of IPv4_DEVICE_PATH, GatewayIpAddress and SubnetMask\r
         //  do not exist.\r
-        //  In new version of IPv4_DEVICE_PATH, structcure length is 27.\r
+        //  In new version of IPv4_DEVICE_PATH, structure length is 27.\r
         //\r
 \r
         PathLen = DevicePathNodeLength (&DPathNode->Ipv4);\r
@@ -2502,7 +2502,7 @@ IScsiOnExitBootService (
 \r
   This function tests whether the driver specified by DriverBindingHandle is\r
   currently managing the controller specified by ControllerHandle.  This test\r
-  is performed by evaluating if the the protocol specified by ProtocolGuid is\r
+  is performed by evaluating if the protocol specified by ProtocolGuid is\r
   present on ControllerHandle and is was opened by DriverBindingHandle and Nic\r
   Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.\r
   If ProtocolGuid is NULL, then ASSERT().\r
index 92f42e140ace0e4f449fa19f8c7d11d612ae7a52..46c725aab3a4ffff88f62bd5aa7da68c8f052925 100644 (file)
@@ -46,7 +46,7 @@ typedef struct _ISCSI_SESSION_CONFIG_NVDATA {
   UINT8             PrefixLength;\r
   UINT8             BootLun[8];\r
 \r
-  UINT16            ConnectTimeout; ///< timout value in milliseconds.\r
+  UINT16            ConnectTimeout; ///< timeout value in milliseconds.\r
   UINT8             ConnectRetryCount;\r
   UINT8             IsId[6];\r
 \r
@@ -104,7 +104,7 @@ IScsiLunToUnicodeStr (
   );\r
 \r
 /**\r
-  Convert the mac address into a hexadecimal encoded "-" seperated string.\r
+  Convert the mac address into a hexadecimal encoded "-" separated string.\r
 \r
   @param[in]  Mac     The mac address.\r
   @param[in]  Len     Length in bytes of the mac address.\r
@@ -352,7 +352,7 @@ IScsiCreateDriverData (
 \r
   @param[in]              Private The iSCSI driver data.\r
 \r
-  @retval EFI_SUCCES      The clean operation is successful.\r
+  @retval EFI_SUCCESS     The clean operation is successful.\r
   @retval Others          Other errors as indicated.\r
 \r
 **/\r
@@ -439,7 +439,7 @@ IScsiOnExitBootService (
 \r
   This function tests whether the driver specified by DriverBindingHandle is\r
   currently managing the controller specified by ControllerHandle.  This test\r
-  is performed by evaluating if the the protocol specified by ProtocolGuid is\r
+  is performed by evaluating if the protocol specified by ProtocolGuid is\r
   present on ControllerHandle and is was opened by DriverBindingHandle and Nic\r
   Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.\r
   If ProtocolGuid is NULL, then ASSERT().\r
index 6fbf973e35f307ce5b6c98de2900cd72c090c331..6983f0fa5973feb4aa84f4f516cecd616e4a34fc 100644 (file)
@@ -468,7 +468,7 @@ IScsiSessionLogin (
     IScsiAttatchConnection (Session, Conn);\r
 \r
     //\r
-    // Login througth the newly created connection.\r
+    // Login through the newly created connection.\r
     //\r
     Status = IScsiConnLogin (Conn, Session->ConfigData->SessionConfigData.ConnectTimeout);\r
     if (EFI_ERROR (Status)) {\r
@@ -765,7 +765,7 @@ IScsiPrepareLoginReq (
   LoginReq->CmdSN             = HTONL (Session->CmdSN);\r
 \r
   //\r
-  // For the first Login Request on a coonection this is ExpStatSN for the\r
+  // For the first Login Request on a connection this is ExpStatSN for the\r
   // old connection, and this field is only valid if the Login Request restarts\r
   // a connection.\r
   // For subsequent Login Requests it is used to acknowledge the Login Responses\r
@@ -941,7 +941,7 @@ IScsiProcessLoginRsp (
     // A Login Response with the C bit set to 1 MUST have the T bit set to 0.\r
     // The CSG in the Login Response MUST be the same with the I-end of this connection.\r
     // The T bit can't be 1 if the last Login Response sent by the initiator doesn't\r
-    // initiate the transistion.\r
+    // initiate the transition.\r
     // The NSG MUST be the same with the I-end of this connection if Transit is required.\r
     // The ISID in the Login Response MUST be the same with this session.\r
     //\r
@@ -1152,13 +1152,13 @@ IScsiUpdateTargetAddress (
     }\r
 \r
     //\r
-    // Save the origial user setting which specifies the proxy/virtual iSCSI target.\r
+    // Save the original user setting which specifies the proxy/virtual iSCSI target.\r
     //\r
     NvData->OriginalTargetPort = NvData->TargetPort;\r
 \r
     if (*TargetAddress == ',') {\r
       //\r
-      // Comma and the portal group tag MUST be ommitted if the TargetAddress is sent\r
+      // Comma and the portal group tag MUST be omitted if the TargetAddress is sent\r
       // as the result of a redirection.\r
       //\r
       continue;\r
@@ -1181,7 +1181,7 @@ IScsiUpdateTargetAddress (
     }\r
 \r
     //\r
-    // Save the origial user setting which specifies the proxy/virtual iSCSI target.\r
+    // Save the original user setting which specifies the proxy/virtual iSCSI target.\r
     //\r
     CopyMem (&NvData->OriginalTargetIp, &NvData->TargetIp, sizeof (EFI_IP_ADDRESS));\r
 \r
@@ -1471,7 +1471,7 @@ ON_EXIT:
 \r
   @param[in, out]  Conn          The connection in iSCSI login.\r
 \r
-  @retval EFI_SUCCESS          The parmeter check is passed and negotiation is finished.\r
+  @retval EFI_SUCCESS          The parameter check is passed and negotiation is finished.\r
   @retval EFI_PROTOCOL_ERROR   Some kind of iSCSI protocol error occurred.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
 \r
@@ -1546,7 +1546,7 @@ IScsiCheckOpParams (
     goto ON_ERROR;\r
   }\r
   //\r
-  // ErrorRecoveryLevel: result fuction is Minimum.\r
+  // ErrorRecoveryLevel: result function is Minimum.\r
   //\r
   Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_ERROR_RECOVERY_LEVEL);\r
   if (Value == NULL) {\r
@@ -1590,7 +1590,7 @@ IScsiCheckOpParams (
     Conn->MaxRecvDataSegmentLength = (UINT32) IScsiNetNtoi (Value);\r
   }\r
   //\r
-  // MaxBurstLength: result funtion is Mininum.\r
+  // MaxBurstLength: result function is Minimum.\r
   //\r
   Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_BURST_LENGTH);\r
   if (Value == NULL) {\r
@@ -2249,7 +2249,7 @@ IScsiNewScsiCmdPdu (
 \r
   if (Session->ImmediateData && (Packet->OutTransferLength != 0)) {\r
     //\r
-    // Send immediate data in this SCSI Command PDU. The length of the immeidate\r
+    // Send immediate data in this SCSI Command PDU. The length of the immediate\r
     // data is the minimum of FirstBurstLength, the data length to be xfered, and\r
     // the MaxRecvdataSegmentLength on this connection.\r
     //\r
@@ -2494,7 +2494,7 @@ ON_EXIT:
   @param[in]  Lun             The LUN the data will be sent to.\r
   @param[in]  Tcb             The task control block.\r
 \r
-  @retval EFI_SUCCES           The data is sent out to the LUN.\r
+  @retval EFI_SUCCESS          The data is sent out to the LUN.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
   @retval Others               Other errors as indicated.\r
 \r
@@ -2547,9 +2547,9 @@ IScsiSendDataOutPduSequence (
   @param[in]        Tcb      The task control block.\r
   @param[in, out]   Packet   The EXT SCSI PASS THRU request packet.\r
 \r
-  @retval EFI_SUCCES           The check on the Data IN PDU is passed and some update\r
+  @retval EFI_SUCCESS          The check on the Data IN PDU is passed and some update\r
                                actions are taken.\r
-  @retval EFI_PROTOCOL_ERROR   Some kind of iSCSI protocol errror occurred.\r
+  @retval EFI_PROTOCOL_ERROR   Some kind of iSCSI protocol error occurred.\r
   @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.\r
   @retval Others               Other errors as indicated.\r
 \r
@@ -2639,8 +2639,8 @@ IScsiOnDataInRcvd (
   @param[in]       Lun       The Lun.\r
   @param[in, out]  Packet    The EXT SCSI PASS THRU request packet.\r
 \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 occurred.\r
+  @retval EFI_SUCCESS        The R2T PDU is valid and the solicited data is sent out.\r
+  @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.\r
   @retval Others             Other errors as indicated.\r
 \r
 **/\r
@@ -2707,8 +2707,8 @@ IScsiOnR2TRcvd (
   @param[in]       Tcb      The task control block.\r
   @param[in, out]  Packet   The EXT SCSI PASS THRU request packet.\r
 \r
-  @retval EFI_SUCCES         The Response PDU is processed.\r
-  @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.\r
+  @retval EFI_SUCCESS        The Response PDU is processed.\r
+  @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.\r
   @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.\r
   @retval Others             Other errors as indicated.\r
 \r
@@ -2815,9 +2815,9 @@ IScsiOnScsiRspRcvd (
   @param[in]  Pdu            The NOP In PDU received.\r
   @param[in]  Tcb            The task control block.\r
 \r
-  @retval EFI_SUCCES         The NOP In PDU is processed and the related sequence\r
+  @retval EFI_SUCCESS        The NOP In PDU is processed and the related sequence\r
                              numbers are updated.\r
-  @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.\r
+  @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -2864,7 +2864,7 @@ IScsiOnNopInRcvd (
   @param[in, out]  Packet    The request packet containing IO request, SCSI command\r
                              buffer and buffers to read/write.\r
 \r
-  @retval EFI_SUCCES           The SCSI command is executed and the result is updated to\r
+  @retval EFI_SUCCESS          The SCSI command is executed and the result is updated to\r
                                the Packet.\r
   @retval EFI_DEVICE_ERROR     Session state was not as required.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
index 34b682b68df1898666b17635cf50353a6a2a2bbb..3b8e6622152439629ee966638abc3bc30705758e 100644 (file)
@@ -308,7 +308,7 @@ typedef struct _ISCSI_SENSE_DATA {
 } ISCSI_SENSE_DATA;\r
 \r
 ///\r
-/// iSCSI Task Managment Function Request.\r
+/// iSCSI Task Management Function Request.\r
 ///\r
 typedef struct _ISCSI_TMF_REQUEST {\r
   UINT8   OpCode;\r
@@ -870,7 +870,7 @@ IScsiReceivePdu (
 \r
   @param[in, out]  Conn          The connection in iSCSI login.\r
 \r
-  @retval EFI_SUCCESS          The parmeter check is passed and negotiation is finished.\r
+  @retval EFI_SUCCESS          The parameter check is passed and negotiation is finished.\r
   @retval EFI_PROTOCOL_ERROR   Some kind of iSCSI protocol error occurred.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
 \r
@@ -897,7 +897,7 @@ IScsiFillOpParams (
   Pad the iSCSI AHS or data segment to an integer number of 4 byte words.\r
 \r
   @param[in, out]  Pdu         The iSCSI pdu which contains segments to pad.\r
-  @param[in]       Len         The length of the last semgnet in the PDU.\r
+  @param[in]       Len         The length of the last segment in the PDU.\r
 \r
   @retval EFI_SUCCESS          The segment is padded or no need to pad it.\r
   @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the\r
@@ -978,7 +978,7 @@ IScsiNormalizeName (
   @param[in, out]  Packet    The request packet containing IO request, SCSI command\r
                              buffer and buffers to read/write.\r
 \r
-  @retval EFI_SUCCES           The SCSI command is executed and the result is updated to\r
+  @retval EFI_SUCCESS          The SCSI command is executed and the result is updated to\r
                                the Packet.\r
   @retval EFI_DEVICE_ERROR     Session state was not as required.\r
   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
@@ -999,7 +999,7 @@ IScsiExecuteScsiCommand (
 \r
   @param[in]  Session           The iSCSI session\r
 \r
-  @retval EFI_SUCCES            The session is reinstated from some error.\r
+  @retval EFI_SUCCESS           The session is reinstated from some error.\r
   @retval Other                 Reinstatement failed.\r
 \r
 **/\r