Re: [edk2] [PATCH v1] MdeModulePkg/UfsBlockIoPei: Correct use of 'DeviceIndex' in BlkIO PPI

2019-02-25 Thread Ni, Ray
Reviewed-by: Ray Ni 

> -Original Message-
> From: edk2-devel  On Behalf Of Hao Wu
> Sent: Friday, February 15, 2019 10:55 AM
> To: edk2-devel@lists.01.org
> Cc: Wu, Hao A 
> Subject: [edk2] [PATCH v1] MdeModulePkg/UfsBlockIoPei: Correct use of
> 'DeviceIndex' in BlkIO PPI
> 
> REF:https://bugzilla.tianocore.org/show_bug.cgi?id=1474
> 
> Within UfsBlockIoPei, the current implementation of the Block IO(2)
> services:
> 
> UfsBlockIoPeimGetMediaInfo
> UfsBlockIoPeimReadBlocks
> UfsBlockIoPeimGetMediaInfo2
> UfsBlockIoPeimReadBlocks2
> 
> does not handle the input parameter 'DeviceIndex' properly.
> 
> According to both of the PI spec and the function description comments:
> 
> > DeviceIndexSpecifies the block device to which the function wants
> >to talk. ... This index is a number from one to
> >NumberBlockDevices.
> 
> But current codes incorrectly treat the valid range of 'DeviceIndex' as 0 to
> (NumberBlockDevices - 1).
> 
> This commit is to address this issue.
> 
> Cc: Jian J Wang 
> Cc: Ray Ni 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Hao Wu 
> ---
>  MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c | 56 +++-
> 
>  1 file changed, 31 insertions(+), 25 deletions(-)
> 
> diff --git a/MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c
> b/MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c
> index 204e456413..c969ab45f5 100644
> --- a/MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c
> +++ b/MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c
> @@ -1,6 +1,6 @@
>  /** @file
> 
> -  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.
> +  Copyright (c) 2014 - 2019, Intel Corporation. All rights
> + reserved.
>This program and the accompanying materials
>are licensed and made available under the terms and conditions of the BSD
> License
>which accompanies this distribution.  The full text of the license may be
> found at @@ -587,15 +587,17 @@ UfsBlockIoPeimGetMediaInfo (
>EFI_SCSI_DISK_CAPACITY_DATA16  Capacity16;
>UINTN  DataLength;
>BOOLEANNeedRetry;
> +  UINTN  Lun;
> 
>Private   = GET_UFS_PEIM_HC_PRIVATE_DATA_FROM_THIS (This);
>NeedRetry = TRUE;
> 
> -  if (DeviceIndex >= UFS_PEIM_MAX_LUNS) {
> +  if ((DeviceIndex == 0) || (DeviceIndex > UFS_PEIM_MAX_LUNS)) {
>  return EFI_INVALID_PARAMETER;
>}
> 
> -  if ((Private->Luns.BitMask & (BIT0 << DeviceIndex)) == 0) {
> +  Lun = DeviceIndex - 1;
> +  if ((Private->Luns.BitMask & (BIT0 << Lun)) == 0) {
>  return EFI_ACCESS_DENIED;
>}
> 
> @@ -609,7 +611,7 @@ UfsBlockIoPeimGetMediaInfo (
>do {
>  Status = UfsPeimTestUnitReady (
> Private,
> -   DeviceIndex,
> +   Lun,
> ,
> 
> );
> @@ -621,7 +623,7 @@ UfsBlockIoPeimGetMediaInfo (
>continue;
>  }
> 
> -Status = UfsPeimParsingSenseKeys (&(Private->Media[DeviceIndex]),
> , );
> +Status = UfsPeimParsingSenseKeys (&(Private->Media[Lun]),
> + , );
>  if (EFI_ERROR (Status)) {
>return EFI_DEVICE_ERROR;
>  }
> @@ -630,7 +632,7 @@ UfsBlockIoPeimGetMediaInfo (
> 
>DataLength  = sizeof (EFI_SCSI_DISK_CAPACITY_DATA);
>SenseDataLength = 0;
> -  Status = UfsPeimReadCapacity (Private, DeviceIndex, , (UINT32
> *), NULL, );
> +  Status = UfsPeimReadCapacity (Private, Lun, , (UINT32
> + *), NULL, );
>if (EFI_ERROR (Status)) {
>  return EFI_DEVICE_ERROR;
>}
> @@ -639,22 +641,22 @@ UfsBlockIoPeimGetMediaInfo (
>(Capacity.LastLba1 == 0xff) && (Capacity.LastLba0 == 0xff)) {
>  DataLength  = sizeof (EFI_SCSI_DISK_CAPACITY_DATA16);
>  SenseDataLength = 0;
> -Status = UfsPeimReadCapacity16 (Private, DeviceIndex, ,
> (UINT32 *), NULL, );
> +Status = UfsPeimReadCapacity16 (Private, Lun, , (UINT32
> + *), NULL, );
>  if (EFI_ERROR (Status)) {
>return EFI_DEVICE_ERROR;
>  }
> -Private->Media[DeviceIndex].LastBlock  = ((UINT32)Capacity16.LastLba3
> << 24) | (Capacity16.LastLba2 << 16) | (Capacity16.LastLba1 << 8) |
> Capacity16.LastLba0;
> -Private->Media[DeviceIndex].LastBlock |= LShiftU64
> ((UINT64)Capacity16.LastLba7, 56) | LShiftU64((UINT64)Capacity16.LastLba6,
> 48) | LShiftU64 ((UINT64)Capacity16.LastLba5, 40) | LShiftU64
> ((UINT64)Capacity16.LastLba4, 32);
> -Private->Media[DeviceIndex].BlockSize  = (Capacity16.BlockS

[edk2] [PATCH v1] MdeModulePkg/UfsBlockIoPei: Correct use of 'DeviceIndex' in BlkIO PPI

2019-02-14 Thread Hao Wu
REF:https://bugzilla.tianocore.org/show_bug.cgi?id=1474

Within UfsBlockIoPei, the current implementation of the Block IO(2)
services:

UfsBlockIoPeimGetMediaInfo
UfsBlockIoPeimReadBlocks
UfsBlockIoPeimGetMediaInfo2
UfsBlockIoPeimReadBlocks2

does not handle the input parameter 'DeviceIndex' properly.

According to both of the PI spec and the function description comments:

> DeviceIndexSpecifies the block device to which the function wants
>to talk. ... This index is a number from one to
>NumberBlockDevices.

But current codes incorrectly treat the valid range of 'DeviceIndex' as 0
to (NumberBlockDevices - 1).

This commit is to address this issue.

Cc: Jian J Wang 
Cc: Ray Ni 
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Hao Wu 
---
 MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c | 56 +++-
 1 file changed, 31 insertions(+), 25 deletions(-)

diff --git a/MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c 
b/MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c
index 204e456413..c969ab45f5 100644
--- a/MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c
+++ b/MdeModulePkg/Bus/Ufs/UfsBlockIoPei/UfsBlockIoPei.c
@@ -1,6 +1,6 @@
 /** @file
 
-  Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.
+  Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.
   This program and the accompanying materials
   are licensed and made available under the terms and conditions of the BSD 
License
   which accompanies this distribution.  The full text of the license may be 
found at
@@ -587,15 +587,17 @@ UfsBlockIoPeimGetMediaInfo (
   EFI_SCSI_DISK_CAPACITY_DATA16  Capacity16;
   UINTN  DataLength;
   BOOLEANNeedRetry;
+  UINTN  Lun;
 
   Private   = GET_UFS_PEIM_HC_PRIVATE_DATA_FROM_THIS (This);
   NeedRetry = TRUE;
 
-  if (DeviceIndex >= UFS_PEIM_MAX_LUNS) {
+  if ((DeviceIndex == 0) || (DeviceIndex > UFS_PEIM_MAX_LUNS)) {
 return EFI_INVALID_PARAMETER;
   }
 
-  if ((Private->Luns.BitMask & (BIT0 << DeviceIndex)) == 0) {
+  Lun = DeviceIndex - 1;
+  if ((Private->Luns.BitMask & (BIT0 << Lun)) == 0) {
 return EFI_ACCESS_DENIED;
   }
 
@@ -609,7 +611,7 @@ UfsBlockIoPeimGetMediaInfo (
   do {
 Status = UfsPeimTestUnitReady (
Private,
-   DeviceIndex,
+   Lun,
,

);
@@ -621,7 +623,7 @@ UfsBlockIoPeimGetMediaInfo (
   continue;
 }
 
-Status = UfsPeimParsingSenseKeys (&(Private->Media[DeviceIndex]), 
, );
+Status = UfsPeimParsingSenseKeys (&(Private->Media[Lun]), , 
);
 if (EFI_ERROR (Status)) {
   return EFI_DEVICE_ERROR;
 }
@@ -630,7 +632,7 @@ UfsBlockIoPeimGetMediaInfo (
 
   DataLength  = sizeof (EFI_SCSI_DISK_CAPACITY_DATA);
   SenseDataLength = 0;
-  Status = UfsPeimReadCapacity (Private, DeviceIndex, , (UINT32 
*), NULL, );
+  Status = UfsPeimReadCapacity (Private, Lun, , (UINT32 
*), NULL, );
   if (EFI_ERROR (Status)) {
 return EFI_DEVICE_ERROR;
   }
@@ -639,22 +641,22 @@ UfsBlockIoPeimGetMediaInfo (
   (Capacity.LastLba1 == 0xff) && (Capacity.LastLba0 == 0xff)) {
 DataLength  = sizeof (EFI_SCSI_DISK_CAPACITY_DATA16);
 SenseDataLength = 0;
-Status = UfsPeimReadCapacity16 (Private, DeviceIndex, , (UINT32 
*), NULL, );
+Status = UfsPeimReadCapacity16 (Private, Lun, , (UINT32 
*), NULL, );
 if (EFI_ERROR (Status)) {
   return EFI_DEVICE_ERROR;
 }
-Private->Media[DeviceIndex].LastBlock  = ((UINT32)Capacity16.LastLba3 << 
24) | (Capacity16.LastLba2 << 16) | (Capacity16.LastLba1 << 8) | 
Capacity16.LastLba0;
-Private->Media[DeviceIndex].LastBlock |= LShiftU64 
((UINT64)Capacity16.LastLba7, 56) | LShiftU64((UINT64)Capacity16.LastLba6, 48) 
| LShiftU64 ((UINT64)Capacity16.LastLba5, 40) | LShiftU64 
((UINT64)Capacity16.LastLba4, 32);
-Private->Media[DeviceIndex].BlockSize  = (Capacity16.BlockSize3 << 24) | 
(Capacity16.BlockSize2 << 16) | (Capacity16.BlockSize1 << 8) | 
Capacity16.BlockSize0;
+Private->Media[Lun].LastBlock  = ((UINT32)Capacity16.LastLba3 << 24) | 
(Capacity16.LastLba2 << 16) | (Capacity16.LastLba1 << 8) | Capacity16.LastLba0;
+Private->Media[Lun].LastBlock |= LShiftU64 ((UINT64)Capacity16.LastLba7, 
56) | LShiftU64((UINT64)Capacity16.LastLba6, 48) | LShiftU64 
((UINT64)Capacity16.LastLba5, 40) | LShiftU64 ((UINT64)Capacity16.LastLba4, 32);
+Private->Media[Lun].BlockSize  = (Capacity16.BlockSize3 << 24) | 
(Capacity16.BlockSize2 << 16) | (Capacity16.BlockSize1 << 8) | 
Capacity16.BlockSize0;
   } else {
-Private->Media[DeviceIndex].LastBlock  = ((UINT32)Capacity.LastLba3 << 24) 
| (Capacity.LastLba2 << 16) | (Capacity.LastLba1 << 8) | Capacity.LastLba0;
-Private->Media[DeviceIndex].BlockSize  = (Capacity.BlockSize3 << 24) | 
(Capacity.BlockSize2 << 16) | (Capacity.BlockSize1 << 8) | Capacity.BlockSize0;
+