From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [205.139.110.120]) by mx.groups.io with SMTP id smtpd.web11.2021.1578044450420531769 for ; Fri, 03 Jan 2020 01:40:50 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=dQcWaSHA; spf=pass (domain: redhat.com, ip: 205.139.110.120, mailfrom: philmd@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1578044449; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=mutoJCtlHR7tUBPA9W/psbJI2QzVJ0Be+/g36yTVzOc=; b=dQcWaSHAkq7yVGZ0u2SQET3dAJ/EALZYjtIEMJcjLullWmn4JP6Rt/KKTT+ak3Ahx2BU2g ZuUTSVJ6OxctGeQyscix2N2fYgT2Gs3WCJriUcly0wxIYce3PkZAwVFNIK20DYrCcglyUU /R1jlXASC4tNexejgTfiu7TTJFxRJWU= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-376-EYecDptPPBmnfO1hYgUrOg-1; Fri, 03 Jan 2020 04:40:47 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id AD211800D41; Fri, 3 Jan 2020 09:40:46 +0000 (UTC) Received: from x1w.redhat.com (ovpn-116-190.ams2.redhat.com [10.36.116.190]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 06E7A60BF7; Fri, 3 Jan 2020 09:40:44 +0000 (UTC) From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= To: devel@edk2.groups.io Cc: Antoine Coeur , Jiaxin Wu , Siyuan Fu , Maciej Rabeda , Philippe Mathieu-Daude Subject: [PATCH v2 41/78] NetworkPkg/IScsiDxe: Fix various typos Date: Fri, 3 Jan 2020 10:07:35 +0100 Message-Id: <20200103090812.10592-42-philmd@redhat.com> In-Reply-To: <20200103090812.10592-1-philmd@redhat.com> References: <20200103090812.10592-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-MC-Unique: EYecDptPPBmnfO1hYgUrOg-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Antoine Coeur Fix various typos in comments and documentation. Cc: Jiaxin Wu Cc: Siyuan Fu Cc: Maciej Rabeda Signed-off-by: Antoine Coeur Reviewed-by: Philippe Mathieu-Daude Signed-off-by: Philippe Mathieu-Daude --- NetworkPkg/IScsiDxe/IScsiMisc.h | 8 +++--- NetworkPkg/IScsiDxe/IScsiProto.h | 10 ++++---- NetworkPkg/IScsiDxe/ComponentName.c | 2 +- NetworkPkg/IScsiDxe/IScsiCHAP.c | 4 +-- NetworkPkg/IScsiDxe/IScsiConfig.c | 6 ++--- NetworkPkg/IScsiDxe/IScsiDhcp.c | 4 +-- NetworkPkg/IScsiDxe/IScsiDriver.c | 10 ++++---- NetworkPkg/IScsiDxe/IScsiMisc.c | 6 ++--- NetworkPkg/IScsiDxe/IScsiProto.c | 40 ++++++++++++++--------------- 9 files changed, 45 insertions(+), 45 deletions(-) diff --git a/NetworkPkg/IScsiDxe/IScsiMisc.h b/NetworkPkg/IScsiDxe/IScsiMis= c.h index 92f42e140ace..46c725aab3a4 100644 --- a/NetworkPkg/IScsiDxe/IScsiMisc.h +++ b/NetworkPkg/IScsiDxe/IScsiMisc.h @@ -46,7 +46,7 @@ typedef struct _ISCSI_SESSION_CONFIG_NVDATA { UINT8 PrefixLength; UINT8 BootLun[8]; =20 - UINT16 ConnectTimeout; ///< timout value in milliseconds. + UINT16 ConnectTimeout; ///< timeout value in milliseconds. UINT8 ConnectRetryCount; UINT8 IsId[6]; =20 @@ -104,7 +104,7 @@ IScsiLunToUnicodeStr ( ); =20 /** - Convert the mac address into a hexadecimal encoded "-" seperated string. + Convert the mac address into a hexadecimal encoded "-" separated string. =20 @param[in] Mac The mac address. @param[in] Len Length in bytes of the mac address. @@ -352,7 +352,7 @@ IScsiCreateDriverData ( =20 @param[in] Private The iSCSI driver data. =20 - @retval EFI_SUCCES The clean operation is successful. + @retval EFI_SUCCESS The clean operation is successful. @retval Others Other errors as indicated. =20 **/ @@ -439,7 +439,7 @@ IScsiOnExitBootService ( =20 This function tests whether the driver specified by DriverBindingHandle = is currently managing the controller specified by ControllerHandle. This t= est - is performed by evaluating if the the protocol specified by ProtocolGuid= is + is performed by evaluating if the protocol specified by ProtocolGuid is present on ControllerHandle and is was opened by DriverBindingHandle and= Nic Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER. If ProtocolGuid is NULL, then ASSERT(). diff --git a/NetworkPkg/IScsiDxe/IScsiProto.h b/NetworkPkg/IScsiDxe/IScsiPr= oto.h index 34b682b68df1..3b8e66221524 100644 --- a/NetworkPkg/IScsiDxe/IScsiProto.h +++ b/NetworkPkg/IScsiDxe/IScsiProto.h @@ -308,7 +308,7 @@ typedef struct _ISCSI_SENSE_DATA { } ISCSI_SENSE_DATA; =20 /// -/// iSCSI Task Managment Function Request. +/// iSCSI Task Management Function Request. /// typedef struct _ISCSI_TMF_REQUEST { UINT8 OpCode; @@ -870,7 +870,7 @@ IScsiReceivePdu ( =20 @param[in, out] Conn The connection in iSCSI login. =20 - @retval EFI_SUCCESS The parmeter check is passed and negotiatio= n is finished. + @retval EFI_SUCCESS The parameter check is passed and negotiati= on is finished. @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. =20 @@ -897,7 +897,7 @@ IScsiFillOpParams ( Pad the iSCSI AHS or data segment to an integer number of 4 byte words. =20 @param[in, out] Pdu The iSCSI pdu which contains segments to pa= d. - @param[in] Len The length of the last semgnet in the PDU. + @param[in] Len The length of the last segment in the PDU. =20 @retval EFI_SUCCESS The segment is padded or no need to pad it. @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to= add the @@ -978,7 +978,7 @@ IScsiNormalizeName ( @param[in, out] Packet The request packet containing IO request, SCS= I command buffer and buffers to read/write. =20 - @retval EFI_SUCCES The SCSI command is executed and the result= is updated to + @retval EFI_SUCCESS The SCSI command is executed and the result= is updated to the Packet. @retval EFI_DEVICE_ERROR Session state was not as required. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. @@ -999,7 +999,7 @@ IScsiExecuteScsiCommand ( =20 @param[in] Session The iSCSI session =20 - @retval EFI_SUCCES The session is reinstated from some error. + @retval EFI_SUCCESS The session is reinstated from some error. @retval Other Reinstatement failed. =20 **/ diff --git a/NetworkPkg/IScsiDxe/ComponentName.c b/NetworkPkg/IScsiDxe/Comp= onentName.c index 77e6f3858a29..8572ac281d1d 100644 --- a/NetworkPkg/IScsiDxe/ComponentName.c +++ b/NetworkPkg/IScsiDxe/ComponentName.c @@ -249,7 +249,7 @@ IScsiComponentNameGetControllerName ( } =20 // - // Get the handle of the controller we are controling. + // Get the handle of the controller we are controlling. // IScsiController =3D NetLibGetNicHandle (ControllerHandle, &gEfiTcp4Proto= colGuid); if (IScsiController !=3D NULL) { diff --git a/NetworkPkg/IScsiDxe/IScsiCHAP.c b/NetworkPkg/IScsiDxe/IScsiCHA= P.c index 627882af0058..355c6f129f68 100644 --- a/NetworkPkg/IScsiDxe/IScsiCHAP.c +++ b/NetworkPkg/IScsiDxe/IScsiCHAP.c @@ -9,7 +9,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent #include "IScsiImpl.h" =20 /** - Initator calculates its own expected hash value. + Initiator calculates its own expected hash value. =20 @param[in] ChapIdentifier iSCSI CHAP identifier sent by authentica= tor. @param[in] ChapSecret iSCSI CHAP secret of the authenticator. @@ -88,7 +88,7 @@ Exit: } =20 /** - The initator checks the CHAP response replied by target against its own + The initiator checks the CHAP response replied by target against its own calculation of the expected hash value. =20 @param[in] AuthData iSCSI CHAP authentication data. diff --git a/NetworkPkg/IScsiDxe/IScsiConfig.c b/NetworkPkg/IScsiDxe/IScsiC= onfig.c index d773849fd3b0..326b1da39ea3 100644 --- a/NetworkPkg/IScsiDxe/IScsiConfig.c +++ b/NetworkPkg/IScsiDxe/IScsiConfig.c @@ -293,7 +293,7 @@ IScsiConvertIsIdToString ( @param[in] String The string is "&OFFSET=3D". @param[out] Value The Offset value. =20 - @retval EFI_OUT_OF_RESOURCES Insufficient resources to store neccessar= y + @retval EFI_OUT_OF_RESOURCES Insufficient resources to store necessary structures. @retval EFI_SUCCESS Value of is outputted in Number successfully. @@ -2229,7 +2229,7 @@ IScsiConfigAddAttemptsByKeywords ( =20 @retval EFI_NOT_FOUND Cannot find the corresponding variable. @retval EFI_SUCCESS The operation is completed successfully. - @retval EFI_ABOTRED This operation is aborted cause of error + @retval EFI_ABORTED This operation is aborted cause of error configuration. @retval EFI_OUT_OF_RESOURCES Fail to finish the operation due to lack = of resources. @@ -3024,7 +3024,7 @@ IScsiFormExtractConfig ( } =20 // - // Extract all AttemptConfigData to Keyword stroage of IfrNvData. + // Extract all AttemptConfigData to Keyword storage of IfrNvData. // IScsiConvertAttemptConfigDataToIfrNvDataByKeyword (IfrNvData); =20 diff --git a/NetworkPkg/IScsiDxe/IScsiDhcp.c b/NetworkPkg/IScsiDxe/IScsiDhc= p.c index d8c9fff6c65d..7ce9bf575012 100644 --- a/NetworkPkg/IScsiDxe/IScsiDhcp.c +++ b/NetworkPkg/IScsiDxe/IScsiDhcp.c @@ -193,7 +193,7 @@ ON_EXIT: } =20 /** - The callback function registerd to the DHCP4 instance that is used to se= lect + The callback function registered to the DHCP4 instance that is used to s= elect the qualified DHCP OFFER. =20 @param[in] This The DHCP4 protocol. @@ -460,7 +460,7 @@ IScsiDoDhcp ( // the active state, If the DHCP4 D.O.R.A started by IP4 auto // configuration and has not been completed, the Dhcp4 state machine // will not be in the right state for the iSCSI to start a new round D.O= .R.A. - // So, we need to switch it's policy to static. + // So, we need to switch its policy to static. // Status =3D gBS->HandleProtocol (Controller, &gEfiIp4Config2ProtocolGuid,= (VOID **) &Ip4Config2); if (!EFI_ERROR (Status)) { diff --git a/NetworkPkg/IScsiDxe/IScsiDriver.c b/NetworkPkg/IScsiDxe/IScsiD= river.c index 94c9b228c241..98b73308c118 100644 --- a/NetworkPkg/IScsiDxe/IScsiDriver.c +++ b/NetworkPkg/IScsiDxe/IScsiDriver.c @@ -334,7 +334,7 @@ IScsiSupported ( @param[in] ControllerHandle Handle of the controller. @param[in] IpVersion IP_VERSION_4 or IP_VERSION_6. =20 - @retval EFI_SUCCES This driver was started. + @retval EFI_SUCCESS This driver was started. @retval EFI_ALREADY_STARTED This driver is already running on this dev= ice. @retval EFI_INVALID_PARAMETER Any input parameter is invalid. @retval EFI_NOT_FOUND There is no sufficient information to esta= blish @@ -720,7 +720,7 @@ IScsiStart ( } =20 // - // Restore the origial user setting which specifies the proxy/virtual = iSCSI target to NV region. + // Restore the original user setting which specifies the proxy/virtual= iSCSI target to NV region. // NvData =3D &AttemptConfigData->SessionConfigData; if (NvData->RedirectFlag) { @@ -1091,7 +1091,7 @@ IScsiStop ( } =20 // - // Get the handle of the controller we are controling. + // Get the handle of the controller we are controlling. // if (IpVersion =3D=3D IP_VERSION_4) { ProtocolGuid =3D &gIScsiV4PrivateGuid; @@ -1154,7 +1154,7 @@ IScsiStop ( IScsiRemoveNic (IScsiController); =20 // - // Update the iSCSI Boot Firware Table. + // Update the iSCSI Boot Firmware Table. // IScsiPublishIbft (); =20 @@ -1504,7 +1504,7 @@ IScsiUnload ( EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2; =20 // - // Try to disonnect the driver from the devices it's controlling. + // Try to disconnect the driver from the devices it's controlling. // Status =3D gBS->LocateHandleBuffer ( AllHandles, diff --git a/NetworkPkg/IScsiDxe/IScsiMisc.c b/NetworkPkg/IScsiDxe/IScsiMis= c.c index 38ad67917c30..b8fef3ff6f5a 100644 --- a/NetworkPkg/IScsiDxe/IScsiMisc.c +++ b/NetworkPkg/IScsiDxe/IScsiMisc.c @@ -272,7 +272,7 @@ IScsiAsciiStrToIp ( } =20 /** - Convert the mac address into a hexadecimal encoded "-" seperated string. + Convert the mac address into a hexadecimal encoded "-" separated string. =20 @param[in] Mac The mac address. @param[in] Len Length in bytes of the mac address. @@ -2412,7 +2412,7 @@ IScsiGetTcpConnDevicePath ( // Add a judgement here to support previous versions of IPv4_DEVI= CE_PATH. // In previous versions of IPv4_DEVICE_PATH, GatewayIpAddress and= SubnetMask // do not exist. - // In new version of IPv4_DEVICE_PATH, structcure length is 27. + // In new version of IPv4_DEVICE_PATH, structure length is 27. // =20 PathLen =3D DevicePathNodeLength (&DPathNode->Ipv4); @@ -2502,7 +2502,7 @@ IScsiOnExitBootService ( =20 This function tests whether the driver specified by DriverBindingHandle = is currently managing the controller specified by ControllerHandle. This t= est - is performed by evaluating if the the protocol specified by ProtocolGuid= is + is performed by evaluating if the protocol specified by ProtocolGuid is present on ControllerHandle and is was opened by DriverBindingHandle and= Nic Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER. If ProtocolGuid is NULL, then ASSERT(). diff --git a/NetworkPkg/IScsiDxe/IScsiProto.c b/NetworkPkg/IScsiDxe/IScsiPr= oto.c index 6fbf973e35f3..6983f0fa5973 100644 --- a/NetworkPkg/IScsiDxe/IScsiProto.c +++ b/NetworkPkg/IScsiDxe/IScsiProto.c @@ -468,7 +468,7 @@ IScsiSessionLogin ( IScsiAttatchConnection (Session, Conn); =20 // - // Login througth the newly created connection. + // Login through the newly created connection. // Status =3D IScsiConnLogin (Conn, Session->ConfigData->SessionConfigDat= a.ConnectTimeout); if (EFI_ERROR (Status)) { @@ -765,7 +765,7 @@ IScsiPrepareLoginReq ( LoginReq->CmdSN =3D HTONL (Session->CmdSN); =20 // - // For the first Login Request on a coonection this is ExpStatSN for the + // For the first Login Request on a connection this is ExpStatSN for the // old connection, and this field is only valid if the Login Request res= tarts // a connection. // For subsequent Login Requests it is used to acknowledge the Login Res= ponses @@ -941,7 +941,7 @@ IScsiProcessLoginRsp ( // A Login Response with the C bit set to 1 MUST have the T bit set to= 0. // The CSG in the Login Response MUST be the same with the I-end of th= is connection. // The T bit can't be 1 if the last Login Response sent by the initiat= or doesn't - // initiate the transistion. + // initiate the transition. // The NSG MUST be the same with the I-end of this connection if Trans= it is required. // The ISID in the Login Response MUST be the same with this session. // @@ -1152,13 +1152,13 @@ IScsiUpdateTargetAddress ( } =20 // - // Save the origial user setting which specifies the proxy/virtual iSC= SI target. + // Save the original user setting which specifies the proxy/virtual iS= CSI target. // NvData->OriginalTargetPort =3D NvData->TargetPort; =20 if (*TargetAddress =3D=3D ',') { // - // Comma and the portal group tag MUST be ommitted if the TargetAddr= ess is sent + // Comma and the portal group tag MUST be omitted if the TargetAddre= ss is sent // as the result of a redirection. // continue; @@ -1181,7 +1181,7 @@ IScsiUpdateTargetAddress ( } =20 // - // Save the origial user setting which specifies the proxy/virtual iSC= SI target. + // Save the original user setting which specifies the proxy/virtual iS= CSI target. // CopyMem (&NvData->OriginalTargetIp, &NvData->TargetIp, sizeof (EFI_IP_= ADDRESS)); =20 @@ -1471,7 +1471,7 @@ ON_EXIT: =20 @param[in, out] Conn The connection in iSCSI login. =20 - @retval EFI_SUCCESS The parmeter check is passed and negotiatio= n is finished. + @retval EFI_SUCCESS The parameter check is passed and negotiati= on is finished. @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. =20 @@ -1546,7 +1546,7 @@ IScsiCheckOpParams ( goto ON_ERROR; } // - // ErrorRecoveryLevel: result fuction is Minimum. + // ErrorRecoveryLevel: result function is Minimum. // Value =3D IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_ERROR_RECO= VERY_LEVEL); if (Value =3D=3D NULL) { @@ -1590,7 +1590,7 @@ IScsiCheckOpParams ( Conn->MaxRecvDataSegmentLength =3D (UINT32) IScsiNetNtoi (Value); } // - // MaxBurstLength: result funtion is Mininum. + // MaxBurstLength: result function is Minimum. // Value =3D IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_BURST_= LENGTH); if (Value =3D=3D NULL) { @@ -2249,7 +2249,7 @@ IScsiNewScsiCmdPdu ( =20 if (Session->ImmediateData && (Packet->OutTransferLength !=3D 0)) { // - // Send immediate data in this SCSI Command PDU. The length of the imm= eidate + // Send immediate data in this SCSI Command PDU. The length of the imm= ediate // data is the minimum of FirstBurstLength, the data length to be xfer= ed, and // the MaxRecvdataSegmentLength on this connection. // @@ -2494,7 +2494,7 @@ ON_EXIT: @param[in] Lun The LUN the data will be sent to. @param[in] Tcb The task control block. =20 - @retval EFI_SUCCES The data is sent out to the LUN. + @retval EFI_SUCCESS The data is sent out to the LUN. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. @retval Others Other errors as indicated. =20 @@ -2547,9 +2547,9 @@ IScsiSendDataOutPduSequence ( @param[in] Tcb The task control block. @param[in, out] Packet The EXT SCSI PASS THRU request packet. =20 - @retval EFI_SUCCES The check on the Data IN PDU is passed and = some update + @retval EFI_SUCCESS The check on the Data IN PDU is passed and = some update actions are taken. - @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred= . + @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred. @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the = request. @retval Others Other errors as indicated. =20 @@ -2639,8 +2639,8 @@ IScsiOnDataInRcvd ( @param[in] Lun The Lun. @param[in, out] Packet The EXT SCSI PASS THRU request packet. =20 - @retval EFI_SUCCES The R2T PDU is valid and the solicited data i= s sent out. - @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred. + @retval EFI_SUCCESS The R2T PDU is valid and the solicited data i= s sent out. + @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred. @retval Others Other errors as indicated. =20 **/ @@ -2707,8 +2707,8 @@ IScsiOnR2TRcvd ( @param[in] Tcb The task control block. @param[in, out] Packet The EXT SCSI PASS THRU request packet. =20 - @retval EFI_SUCCES The Response PDU is processed. - @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred. + @retval EFI_SUCCESS The Response PDU is processed. + @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred. @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the = request. @retval Others Other errors as indicated. =20 @@ -2815,9 +2815,9 @@ IScsiOnScsiRspRcvd ( @param[in] Pdu The NOP In PDU received. @param[in] Tcb The task control block. =20 - @retval EFI_SUCCES The NOP In PDU is processed and the related s= equence + @retval EFI_SUCCESS The NOP In PDU is processed and the related s= equence numbers are updated. - @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred. + @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred. =20 **/ EFI_STATUS @@ -2864,7 +2864,7 @@ IScsiOnNopInRcvd ( @param[in, out] Packet The request packet containing IO request, SCS= I command buffer and buffers to read/write. =20 - @retval EFI_SUCCES The SCSI command is executed and the result= is updated to + @retval EFI_SUCCESS The SCSI command is executed and the result= is updated to the Packet. @retval EFI_DEVICE_ERROR Session state was not as required. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory. --=20 2.21.0