Re: [PATCH v4] MdeModulePkg/UfsPassThruDxe: Improve Device initialization polling Loop

["Wu, Hao A" <hao.a.wu@intel.com>]

> -----Original Message-----
> From: Bandaru, Purna Chandra Rao <purna.chandra.rao.bandaru@intel.com>
> Sent: Tuesday, March 2, 2021 1:18 PM
> To: devel@edk2.groups.io
> Cc: Bandaru, Purna Chandra Rao <purna.chandra.rao.bandaru@intel.com>;
> Albecki, Mateusz <mateusz.albecki@intel.com>; Ni, Ray <ray.ni@intel.com>;
> Wu, Hao A <hao.a.wu@intel.com>
> Subject: [PATCH v4] MdeModulePkg/UfsPassThruDxe: Improve Device
> initialization polling Loop
> 
> https://bugzilla.tianocore.org/show_bug.cgi?id=3217
> 
> Current Ufs Pass thru driver polls for 5us and return success even when the
> timeout occurs.
> There are cards that can take upto 600ms for Init and hence increased the
> time out for fDeviceInit polling loop.
> 
> Change-Id: I7b38e6f6aa46d93f07621caf29ad7c43f57df021


Reviewed-by: Hao A Wu <hao.a.wu@intel.com>

I will remove the above 'Change-Id' information when pushing the patch.
I will hold this patch until the edk2-stable202102 is announced.

Best Regards,
Hao Wu


> Signed-off-by: Bandaru <purna.chandra.rao.bandaru@intel.com>
> Cc: Mateusz Albecki <mateusz.albecki@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>
> ---
>  MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c | 17
> +++++++++++++----
> MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.h |  3 ++-
>  2 files changed, 15 insertions(+), 5 deletions(-)
> 
> diff --git a/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c
> b/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c
> index 9768c2e6fb..92ff958f16 100644
> --- a/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c
> +++ b/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.c
> @@ -1,6 +1,6 @@
>  /** @file
> 
> -  Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
> +  Copyright (c) 2014 - 2021, Intel Corporation. All rights
> + reserved.<BR>
>    Copyright (c) Microsoft Corporation.<BR>
>    SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> @@ -749,7 +749,7 @@ UfsFinishDeviceInitialization (  {
>    EFI_STATUS  Status;
>    UINT8  DeviceInitStatus;
> -  UINT8  Timeout;
> +  UINT32 Timeout;
> 
>    DeviceInitStatus = 0xFF;
> 
> @@ -761,7 +761,10 @@ UfsFinishDeviceInitialization (
>      return Status;
>    }
> 
> -  Timeout = 5;
> +  //
> +  // There are cards that can take upto 600ms to clear fDeviceInit flag.
> +  //
> +  Timeout = UFS_INIT_COMPLETION_TIMEOUT;
>    do {
>      Status = UfsReadFlag (Private, UfsFlagDevInit, &DeviceInitStatus);
>      if (EFI_ERROR (Status)) {
> @@ -771,7 +774,13 @@ UfsFinishDeviceInitialization (
>      Timeout--;
>    } while (DeviceInitStatus != 0 && Timeout != 0);
> 
> -  return EFI_SUCCESS;
> +  if (Timeout == 0) {
> +    DEBUG ((DEBUG_ERROR, "UfsFinishDeviceInitialization
> DeviceInitStatus=%x EFI_TIMEOUT \n", DeviceInitStatus));
> +    return EFI_TIMEOUT;
> +  } else {
> +    DEBUG ((DEBUG_INFO, "UfsFinishDeviceInitialization Timeout left=%x
> EFI_SUCCESS \n", Timeout));
> +    return EFI_SUCCESS;
> +  }
>  }
> 
>  /**
> diff --git a/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.h
> b/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.h
> index ef33250c89..79b86f7e6b 100644
> --- a/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.h
> +++ b/MdeModulePkg/Bus/Ufs/UfsPassThruDxe/UfsPassThru.h
> @@ -1,6 +1,6 @@
>  /** @file
> 
> -  Copyright (c) 2014 - 2019, Intel Corporation. All rights reserved.<BR>
> +  Copyright (c) 2014 - 2021, Intel Corporation. All rights
> + reserved.<BR>
>    Copyright (c) Microsoft Corporation.<BR>
>    SPDX-License-Identifier: BSD-2-Clause-Patent
> 
> @@ -40,6 +40,7 @@
>  //
>  #define UFS_MAX_LUNS                12
>  #define UFS_WLUN_PREFIX             0xC1
> +#define UFS_INIT_COMPLETION_TIMEOUT 600000
> 
>  typedef struct {
>    UINT8    Lun[UFS_MAX_LUNS];
> --
> 2.16.2.windows.1