tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-24 06:04:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

MdeModulePkg/Bus/Scsi: Fix various typos

Browse Source 
Fix various typos in comments and documentation.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Acked-by: Liming Gao <liming.gao@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-15-philmd@redhat.com>
This commit is contained in:
Antoine Coeur 2020-02-07 02:07:27 +01:00 committed by mergify[bot]
parent 1d031e750b
commit cc530cd10c
4 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBus.c
View File

@ -487,7 +487,7 @@ SCSIBusDriverBindingStart (
} else { } else {
// //
// If RemainingDevicePath is the End of Device Path Node, // If RemainingDevicePath is the End of Device Path Node,
// skip enumerate any device and return EFI_SUCESSS // skip enumerate any device and return EFI_SUCCESS
// //
ScanOtherPuns = FALSE; ScanOtherPuns = FALSE;
} }
@ -644,7 +644,7 @@ SCSIBusDriverBindingStop (
); );
// //
// When Start() succeeds to open ExtPassThru, it always tries to open PassThru BY_DRIVER. // When Start() succeeds to open ExtPassThru, it always tries to open PassThru BY_DRIVER.
// Its intent is to prevent another SCSI Bus Driver from woking on the same host handle. // Its intent is to prevent another SCSI Bus Driver from working on the same host handle.
// So Stop() needs to try to close PassThru if present here. // So Stop() needs to try to close PassThru if present here.
// //
gBS->CloseProtocol ( gBS->CloseProtocol (
@ -1099,7 +1099,7 @@ ScsiExecuteSCSICommand (
@param This Protocol instance pointer @param This Protocol instance pointer
@param Controller Controller handle @param Controller Controller handle
@param TargetId Tartget to be scanned @param TargetId Target to be scanned
@param Lun The Lun of the SCSI device on the SCSI channel. @param Lun The Lun of the SCSI device on the SCSI channel.
@param ScsiBusDev The pointer of SCSI_BUS_DEVICE @param ScsiBusDev The pointer of SCSI_BUS_DEVICE

4
MdeModulePkg/Bus/Scsi/ScsiBusDxe/ScsiBus.h
View File

@ -50,7 +50,7 @@ typedef struct {
} SCSI_EVENT_DATA; } SCSI_EVENT_DATA;
// //
// SCSI Bus Controller device strcuture // SCSI Bus Controller device structure
// //
#define SCSI_BUS_DEVICE_SIGNATURE SIGNATURE_32 ('s', 'c', 's', 'i') #define SCSI_BUS_DEVICE_SIGNATURE SIGNATURE_32 ('s', 'c', 's', 'i')
@ -450,7 +450,7 @@ ScsiExecuteSCSICommand (
@param This Protocol instance pointer @param This Protocol instance pointer
@param Controller Controller handle @param Controller Controller handle
@param TargetId Tartget to be scanned @param TargetId Target to be scanned
@param Lun The Lun of the SCSI device on the SCSI channel. @param Lun The Lun of the SCSI device on the SCSI channel.
@param ScsiBusDev The pointer of SCSI_BUS_DEVICE @param ScsiBusDev The pointer of SCSI_BUS_DEVICE

32
MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.c
View File

@ -704,7 +704,7 @@ Done:
@retval EFI_WRITE_PROTECTED The device can not be written to. @retval EFI_WRITE_PROTECTED The device can not be written to.
@retval EFI_DEVICE_ERROR Fail to detect media. @retval EFI_DEVICE_ERROR Fail to detect media.
@retval EFI_NO_MEDIA Media is not present. @retval EFI_NO_MEDIA Media is not present.
@retval EFI_MEDIA_CHNAGED Media has changed. @retval EFI_MEDIA_CHANGED Media has changed.
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
@retval EFI_INVALID_PARAMETER Invalid parameter passed in. @retval EFI_INVALID_PARAMETER Invalid parameter passed in.
@ -3166,7 +3166,7 @@ CheckTargetStatus (
When encountering error during the process, if retrieve sense keys before When encountering error during the process, if retrieve sense keys before
error encountered, it returns the sense keys with return status set to EFI_SUCCESS, error encountered, it returns the sense keys with return status set to EFI_SUCCESS,
and NeedRetry set to FALSE; otherwize, return the proper return status. and NeedRetry set to FALSE; otherwise, return the proper return status.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param NeedRetry The pointer of flag indicates if need a retry @param NeedRetry The pointer of flag indicates if need a retry
@ -3438,7 +3438,7 @@ ScsiDiskReadSectors (
// As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, we have to use // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, we have to use
// the lowest transfer rate to calculate the possible maximum timeout value for each operation. // the lowest transfer rate to calculate the possible maximum timeout value for each operation.
// From the above table, we could know 2.1Mbytes per second is lowest one. // From the above table, we could know 2.1Mbytes per second is lowest one.
// The timout value is rounded up to nearest integar and here an additional 30s is added // The timeout value is rounded up to nearest integer and here an additional 30s is added
// to follow ATA spec in which it mentioned that the device may take up to 30s to respond // to follow ATA spec in which it mentioned that the device may take up to 30s to respond
// commands in the Standby/Idle mode. // commands in the Standby/Idle mode.
// //
@ -3482,7 +3482,7 @@ ScsiDiskReadSectors (
// it is invalid to request more sectors in the CDB than the entire // it is invalid to request more sectors in the CDB than the entire
// transfer (ie. ByteCount) can carry. // transfer (ie. ByteCount) can carry.
// //
// In addition, ByteCount is only expected to go down, or stay unchaged. // In addition, ByteCount is only expected to go down, or stay unchanged.
// Therefore we don't need to update Timeout: the original timeout should // Therefore we don't need to update Timeout: the original timeout should
// accommodate shorter transfers too. // accommodate shorter transfers too.
// //
@ -3603,7 +3603,7 @@ ScsiDiskWriteSectors (
// As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, we have to use // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, we have to use
// the lowest transfer rate to calculate the possible maximum timeout value for each operation. // the lowest transfer rate to calculate the possible maximum timeout value for each operation.
// From the above table, we could know 2.1Mbytes per second is lowest one. // From the above table, we could know 2.1Mbytes per second is lowest one.
// The timout value is rounded up to nearest integar and here an additional 30s is added // The timeout value is rounded up to nearest integer and here an additional 30s is added
// to follow ATA spec in which it mentioned that the device may take up to 30s to respond // to follow ATA spec in which it mentioned that the device may take up to 30s to respond
// commands in the Standby/Idle mode. // commands in the Standby/Idle mode.
// //
@ -3646,7 +3646,7 @@ ScsiDiskWriteSectors (
// it is invalid to request more sectors in the CDB than the entire // it is invalid to request more sectors in the CDB than the entire
// transfer (ie. ByteCount) can carry. // transfer (ie. ByteCount) can carry.
// //
// In addition, ByteCount is only expected to go down, or stay unchaged. // In addition, ByteCount is only expected to go down, or stay unchanged.
// Therefore we don't need to update Timeout: the original timeout should // Therefore we don't need to update Timeout: the original timeout should
// accommodate shorter transfers too. // accommodate shorter transfers too.
// //
@ -3787,7 +3787,7 @@ ScsiDiskAsyncReadSectors (
// we have to use the lowest transfer rate to calculate the possible // we have to use the lowest transfer rate to calculate the possible
// maximum timeout value for each operation. // maximum timeout value for each operation.
// From the above table, we could know 2.1Mbytes per second is lowest one. // From the above table, we could know 2.1Mbytes per second is lowest one.
// The timout value is rounded up to nearest integar and here an additional // The timeout value is rounded up to nearest integer and here an additional
// 30s is added to follow ATA spec in which it mentioned that the device // 30s is added to follow ATA spec in which it mentioned that the device
// may take up to 30s to respond commands in the Standby/Idle mode. // may take up to 30s to respond commands in the Standby/Idle mode.
// //
@ -4004,7 +4004,7 @@ ScsiDiskAsyncWriteSectors (
// we have to use the lowest transfer rate to calculate the possible // we have to use the lowest transfer rate to calculate the possible
// maximum timeout value for each operation. // maximum timeout value for each operation.
// From the above table, we could know 2.1Mbytes per second is lowest one. // From the above table, we could know 2.1Mbytes per second is lowest one.
// The timout value is rounded up to nearest integar and here an additional // The timeout value is rounded up to nearest integer and here an additional
// 30s is added to follow ATA spec in which it mentioned that the device // 30s is added to follow ATA spec in which it mentioned that the device
// may take up to 30s to respond commands in the Standby/Idle mode. // may take up to 30s to respond commands in the Standby/Idle mode.
// //
@ -4143,10 +4143,10 @@ ScsiDiskRead10 (
UINTN Action; UINTN Action;
// //
// Implement a backoff algorithem to resolve some compatibility issues that // Implement a backoff algorithm to resolve some compatibility issues that
// some SCSI targets or ATAPI devices couldn't correctly response reading/writing // some SCSI targets or ATAPI devices couldn't correctly response reading/writing
// big data in a single operation. // big data in a single operation.
// This algorithem will at first try to execute original request. If the request fails // This algorithm will at first try to execute original request. If the request fails
// with media error sense data or else, it will reduce the transfer length to half and // with media error sense data or else, it will reduce the transfer length to half and
// try again till the operation succeeds or fails with one sector transfer length. // try again till the operation succeeds or fails with one sector transfer length.
// //
@ -4268,10 +4268,10 @@ ScsiDiskWrite10 (
UINTN Action; UINTN Action;
// //
// Implement a backoff algorithem to resolve some compatibility issues that // Implement a backoff algorithm to resolve some compatibility issues that
// some SCSI targets or ATAPI devices couldn't correctly response reading/writing // some SCSI targets or ATAPI devices couldn't correctly response reading/writing
// big data in a single operation. // big data in a single operation.
// This algorithem will at first try to execute original request. If the request fails // This algorithm will at first try to execute original request. If the request fails
// with media error sense data or else, it will reduce the transfer length to half and // with media error sense data or else, it will reduce the transfer length to half and
// try again till the operation succeeds or fails with one sector transfer length. // try again till the operation succeeds or fails with one sector transfer length.
// //
@ -4391,10 +4391,10 @@ ScsiDiskRead16 (
UINTN Action; UINTN Action;
// //
// Implement a backoff algorithem to resolve some compatibility issues that // Implement a backoff algorithm to resolve some compatibility issues that
// some SCSI targets or ATAPI devices couldn't correctly response reading/writing // some SCSI targets or ATAPI devices couldn't correctly response reading/writing
// big data in a single operation. // big data in a single operation.
// This algorithem will at first try to execute original request. If the request fails // This algorithm will at first try to execute original request. If the request fails
// with media error sense data or else, it will reduce the transfer length to half and // with media error sense data or else, it will reduce the transfer length to half and
// try again till the operation succeeds or fails with one sector transfer length. // try again till the operation succeeds or fails with one sector transfer length.
// //
@ -4515,10 +4515,10 @@ ScsiDiskWrite16 (
UINTN Action; UINTN Action;
// //
// Implement a backoff algorithem to resolve some compatibility issues that // Implement a backoff algorithm to resolve some compatibility issues that
// some SCSI targets or ATAPI devices couldn't correctly response reading/writing // some SCSI targets or ATAPI devices couldn't correctly response reading/writing
// big data in a single operation. // big data in a single operation.
// This algorithem will at first try to execute original request. If the request fails // This algorithm will at first try to execute original request. If the request fails
// with media error sense data or else, it will reduce the transfer length to half and // with media error sense data or else, it will reduce the transfer length to half and
// try again till the operation succeeds or fails with one sector transfer length. // try again till the operation succeeds or fails with one sector transfer length.
// //

10
MdeModulePkg/Bus/Scsi/ScsiDiskDxe/ScsiDisk.h
View File

@ -185,7 +185,7 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gScsiDiskComponentName2;
// //
// SCSI Disk Timeout Experience Value // SCSI Disk Timeout Experience Value
// //
// As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, the timout // As ScsiDisk and ScsiBus driver are used to manage SCSI or ATAPI devices, the timeout
// value is updated to 30s to follow ATA/ATAPI spec in which the device may take up to 30s // value is updated to 30s to follow ATA/ATAPI spec in which the device may take up to 30s
// to respond command. // to respond command.
// //
@ -412,7 +412,7 @@ ScsiDiskComponentNameGetControllerName (
@retval EFI_SUCCESS The device was reset. @retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The device is not functioning properly and could @retval EFI_DEVICE_ERROR The device is not functioning properly and could
not be reset. not be reset.
@return EFI_STATUS is retured from EFI_SCSI_IO_PROTOCOL.ResetDevice(). @return EFI_STATUS is returned from EFI_SCSI_IO_PROTOCOL.ResetDevice().
**/ **/
EFI_STATUS EFI_STATUS
@ -464,7 +464,7 @@ ScsiDiskReadBlocks (
@retval EFI_WRITE_PROTECTED The device can not be written to. @retval EFI_WRITE_PROTECTED The device can not be written to.
@retval EFI_DEVICE_ERROR Fail to detect media. @retval EFI_DEVICE_ERROR Fail to detect media.
@retval EFI_NO_MEDIA Media is not present. @retval EFI_NO_MEDIA Media is not present.
@retval EFI_MEDIA_CHNAGED Media has changed. @retval EFI_MEDIA_CHANGED Media has changed.
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device. @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
@retval EFI_INVALID_PARAMETER Invalid parameter passed in. @retval EFI_INVALID_PARAMETER Invalid parameter passed in.
@ -1010,7 +1010,7 @@ CheckTargetStatus (
When encountering error during the process, if retrieve sense keys before When encountering error during the process, if retrieve sense keys before
error encountered, it returns the sense keys with return status set to EFI_SUCCESS, error encountered, it returns the sense keys with return status set to EFI_SUCCESS,
and NeedRetry set to FALSE; otherwize, return the proper return status. and NeedRetry set to FALSE; otherwise, return the proper return status.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV @param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param NeedRetry The pointer of flag indicates if need a retry @param NeedRetry The pointer of flag indicates if need a retry
@ -1444,7 +1444,7 @@ ScsiDiskIsHardwareError (
@param SenseCounts The number of sense key @param SenseCounts The number of sense key
@retval TRUE Media is changed. @retval TRUE Media is changed.
@retval FALSE Medit is NOT changed. @retval FALSE Media is NOT changed.
**/ **/
BOOLEAN BOOLEAN
ScsiDiskIsMediaChange ( ScsiDiskIsMediaChange (