diff mbox series

[6/8] scsi: ufs: Add dev ref clock gating wait time support

Message ID 1580972212-29881-7-git-send-email-cang@codeaurora.org (mailing list archive)
State Superseded
Headers show
Series UFS driver general fixes bundle 4 | expand

Commit Message

Can Guo Feb. 6, 2020, 6:56 a.m. UTC 
In UFS version 3.0, a newly added attribute bRefClkGatingWaitTime defines
the minimum time for which the reference clock is required by device during
transition to LS-MODE or HIBERN8 state. Make this change to reflect the new
requirement by adding delays before turning off the clock.

Signed-off-by: Can Guo <cang@codeaurora.org>
Reviewed-by: Asutosh Das <asutoshd@codeaurora.org>
Reviewed-by: Bean Huo <beanhuo@micron.com>

Comments

Stanley Chu Feb. 6, 2020, 7:30 a.m. UTC | #1 
Hi Can,

On Wed, 2020-02-05 at 22:56 -0800, Can Guo wrote:
> In UFS version 3.0, a newly added attribute bRefClkGatingWaitTime defines
> the minimum time for which the reference clock is required by device during
> transition to LS-MODE or HIBERN8 state. Make this change to reflect the new
> requirement by adding delays before turning off the clock.
> 
> Signed-off-by: Can Guo <cang@codeaurora.org>
> Reviewed-by: Asutosh Das <asutoshd@codeaurora.org>
> Reviewed-by: Bean Huo <beanhuo@micron.com>

Thanks for the fix.

Reviewed-by: Stanley Chu <stanley.chu@mediatek.com>
Can Guo Feb. 6, 2020, 7:47 a.m. UTC | #2 
On 2020-02-06 15:30, Stanley Chu wrote:
> Hi Can,
> 
> On Wed, 2020-02-05 at 22:56 -0800, Can Guo wrote:
>> In UFS version 3.0, a newly added attribute bRefClkGatingWaitTime 
>> defines
>> the minimum time for which the reference clock is required by device 
>> during
>> transition to LS-MODE or HIBERN8 state. Make this change to reflect 
>> the new
>> requirement by adding delays before turning off the clock.
>> 
>> Signed-off-by: Can Guo <cang@codeaurora.org>
>> Reviewed-by: Asutosh Das <asutoshd@codeaurora.org>
>> Reviewed-by: Bean Huo <beanhuo@micron.com>
> 
> Thanks for the fix.
> 
> Reviewed-by: Stanley Chu <stanley.chu@mediatek.com>

Thank you for your review. :)

Can Guo
Avri Altman Feb. 6, 2020, 7:57 a.m. UTC | #3 
> In UFS version 3.0, a newly added attribute bRefClkGatingWaitTime defines
> the minimum time for which the reference clock is required by device during
> transition to LS-MODE or HIBERN8 state. Make this change to reflect the new
> requirement by adding delays before turning off the clock.
> 
> Signed-off-by: Can Guo <cang@codeaurora.org>
> Reviewed-by: Asutosh Das <asutoshd@codeaurora.org>
> Reviewed-by: Bean Huo <beanhuo@micron.com>
> 
> diff --git a/drivers/scsi/ufs/ufs.h b/drivers/scsi/ufs/ufs.h
> index cfe3803..990cb48 100644
> --- a/drivers/scsi/ufs/ufs.h
> +++ b/drivers/scsi/ufs/ufs.h
> @@ -167,6 +167,7 @@ enum attr_idn {
>         QUERY_ATTR_IDN_FFU_STATUS               = 0x14,
>         QUERY_ATTR_IDN_PSA_STATE                = 0x15,
>         QUERY_ATTR_IDN_PSA_DATA_SIZE            = 0x16,
> +       QUERY_ATTR_IDN_REF_CLK_GATING_WAIT_TIME = 0x17,
>  };
> 
>  /* Descriptor idn for Query requests */
> @@ -534,6 +535,8 @@ struct ufs_dev_info {
>         u16 wmanufacturerid;
>         /*UFS device Product Name */
>         u8 *model;
> +       u16 wspecversion;
> +       u32 clk_gating_wait_us;
>  };
> 
>  /**
> diff --git a/drivers/scsi/ufs/ufshcd.c b/drivers/scsi/ufs/ufshcd.c
> index e8f7f9d..76beaf9 100644
> --- a/drivers/scsi/ufs/ufshcd.c
> +++ b/drivers/scsi/ufs/ufshcd.c
> @@ -91,6 +91,9 @@
>  /* default delay of autosuspend: 2000 ms */
>  #define RPM_AUTOSUSPEND_DELAY_MS 2000
> 
> +/* Default value of wait time before gating device ref clock */
> +#define UFSHCD_REF_CLK_GATING_WAIT_US 0xFF /* microsecs */
> +
>  #define ufshcd_toggle_vreg(_dev, _vreg, _on)                           \
>         ({                                                              \
>                 int _ret;                                               \
> @@ -3281,6 +3284,29 @@ static inline int
> ufshcd_read_unit_desc_param(struct ufs_hba *hba,
>                                       param_offset, param_read_buf, param_size);
>  }
> 
> +static int ufshcd_get_ref_clk_gating_wait(struct ufs_hba *hba)
> +{
> +       int err = 0;
> +       u32 gating_wait = UFSHCD_REF_CLK_GATING_WAIT_US;
> +
> +       if (hba->dev_info.wspecversion >= 0x300) {
> +               err = ufshcd_query_attr_retry(hba,
> UPIU_QUERY_OPCODE_READ_ATTR,
> +                               QUERY_ATTR_IDN_REF_CLK_GATING_WAIT_TIME, 0, 0,
> +                               &gating_wait);
> +               if (err)
> +                       dev_err(hba->dev, "Failed reading bRefClkGatingWait. err =
> %d, use default %uus\n",
> +                                        err, gating_wait);
> +
> +               if (gating_wait == 0) {
> +                       gating_wait = UFSHCD_REF_CLK_GATING_WAIT_US;
> +                       dev_err(hba->dev, "Undefined ref clk gating wait time, use
> default %uus\n",
> +                                        gating_wait);
> +               }

You forgot to set
hba->dev_info.clk_gating_wait_us = gating_wait

Thanks,
Avri
Can Guo Feb. 6, 2020, 8:09 a.m. UTC | #4 
On 2020-02-06 15:57, Avri Altman wrote:
>> In UFS version 3.0, a newly added attribute bRefClkGatingWaitTime 
>> defines
>> the minimum time for which the reference clock is required by device 
>> during
>> transition to LS-MODE or HIBERN8 state. Make this change to reflect 
>> the new
>> requirement by adding delays before turning off the clock.
>> 
>> Signed-off-by: Can Guo <cang@codeaurora.org>
>> Reviewed-by: Asutosh Das <asutoshd@codeaurora.org>
>> Reviewed-by: Bean Huo <beanhuo@micron.com>
>> 
>> diff --git a/drivers/scsi/ufs/ufs.h b/drivers/scsi/ufs/ufs.h
>> index cfe3803..990cb48 100644
>> --- a/drivers/scsi/ufs/ufs.h
>> +++ b/drivers/scsi/ufs/ufs.h
>> @@ -167,6 +167,7 @@ enum attr_idn {
>>         QUERY_ATTR_IDN_FFU_STATUS               = 0x14,
>>         QUERY_ATTR_IDN_PSA_STATE                = 0x15,
>>         QUERY_ATTR_IDN_PSA_DATA_SIZE            = 0x16,
>> +       QUERY_ATTR_IDN_REF_CLK_GATING_WAIT_TIME = 0x17,
>>  };
>> 
>>  /* Descriptor idn for Query requests */
>> @@ -534,6 +535,8 @@ struct ufs_dev_info {
>>         u16 wmanufacturerid;
>>         /*UFS device Product Name */
>>         u8 *model;
>> +       u16 wspecversion;
>> +       u32 clk_gating_wait_us;
>>  };
>> 
>>  /**
>> diff --git a/drivers/scsi/ufs/ufshcd.c b/drivers/scsi/ufs/ufshcd.c
>> index e8f7f9d..76beaf9 100644
>> --- a/drivers/scsi/ufs/ufshcd.c
>> +++ b/drivers/scsi/ufs/ufshcd.c
>> @@ -91,6 +91,9 @@
>>  /* default delay of autosuspend: 2000 ms */
>>  #define RPM_AUTOSUSPEND_DELAY_MS 2000
>> 
>> +/* Default value of wait time before gating device ref clock */
>> +#define UFSHCD_REF_CLK_GATING_WAIT_US 0xFF /* microsecs */
>> +
>>  #define ufshcd_toggle_vreg(_dev, _vreg, _on)                          
>>  \
>>         ({                                                             
>>  \
>>                 int _ret;                                              
>>  \
>> @@ -3281,6 +3284,29 @@ static inline int
>> ufshcd_read_unit_desc_param(struct ufs_hba *hba,
>>                                       param_offset, param_read_buf, 
>> param_size);
>>  }
>> 
>> +static int ufshcd_get_ref_clk_gating_wait(struct ufs_hba *hba)
>> +{
>> +       int err = 0;
>> +       u32 gating_wait = UFSHCD_REF_CLK_GATING_WAIT_US;
>> +
>> +       if (hba->dev_info.wspecversion >= 0x300) {
>> +               err = ufshcd_query_attr_retry(hba,
>> UPIU_QUERY_OPCODE_READ_ATTR,
>> +                               
>> QUERY_ATTR_IDN_REF_CLK_GATING_WAIT_TIME, 0, 0,
>> +                               &gating_wait);
>> +               if (err)
>> +                       dev_err(hba->dev, "Failed reading 
>> bRefClkGatingWait. err =
>> %d, use default %uus\n",
>> +                                        err, gating_wait);
>> +
>> +               if (gating_wait == 0) {
>> +                       gating_wait = UFSHCD_REF_CLK_GATING_WAIT_US;
>> +                       dev_err(hba->dev, "Undefined ref clk gating 
>> wait time, use
>> default %uus\n",
>> +                                        gating_wait);
>> +               }
> 
> You forgot to set
> hba->dev_info.clk_gating_wait_us = gating_wait
> 
> Thanks,
> Avri

oops, shall add it back. Thanks.

Can Guo
diff mbox series

Patch

diff --git a/drivers/scsi/ufs/ufs.h b/drivers/scsi/ufs/ufs.h
index cfe3803..990cb48 100644
--- a/drivers/scsi/ufs/ufs.h
+++ b/drivers/scsi/ufs/ufs.h
@@ -167,6 +167,7 @@  enum attr_idn {
 	QUERY_ATTR_IDN_FFU_STATUS		= 0x14,
 	QUERY_ATTR_IDN_PSA_STATE		= 0x15,
 	QUERY_ATTR_IDN_PSA_DATA_SIZE		= 0x16,
+	QUERY_ATTR_IDN_REF_CLK_GATING_WAIT_TIME	= 0x17,
 };
 
 /* Descriptor idn for Query requests */
@@ -534,6 +535,8 @@  struct ufs_dev_info {
 	u16 wmanufacturerid;
 	/*UFS device Product Name */
 	u8 *model;
+	u16 wspecversion;
+	u32 clk_gating_wait_us;
 };
 
 /**
diff --git a/drivers/scsi/ufs/ufshcd.c b/drivers/scsi/ufs/ufshcd.c
index e8f7f9d..76beaf9 100644
--- a/drivers/scsi/ufs/ufshcd.c
+++ b/drivers/scsi/ufs/ufshcd.c
@@ -91,6 +91,9 @@ 
 /* default delay of autosuspend: 2000 ms */
 #define RPM_AUTOSUSPEND_DELAY_MS 2000
 
+/* Default value of wait time before gating device ref clock */
+#define UFSHCD_REF_CLK_GATING_WAIT_US 0xFF /* microsecs */
+
 #define ufshcd_toggle_vreg(_dev, _vreg, _on)				\
 	({                                                              \
 		int _ret;                                               \
@@ -3281,6 +3284,29 @@  static inline int ufshcd_read_unit_desc_param(struct ufs_hba *hba,
 				      param_offset, param_read_buf, param_size);
 }
 
+static int ufshcd_get_ref_clk_gating_wait(struct ufs_hba *hba)
+{
+	int err = 0;
+	u32 gating_wait = UFSHCD_REF_CLK_GATING_WAIT_US;
+
+	if (hba->dev_info.wspecversion >= 0x300) {
+		err = ufshcd_query_attr_retry(hba, UPIU_QUERY_OPCODE_READ_ATTR,
+				QUERY_ATTR_IDN_REF_CLK_GATING_WAIT_TIME, 0, 0,
+				&gating_wait);
+		if (err)
+			dev_err(hba->dev, "Failed reading bRefClkGatingWait. err = %d, use default %uus\n",
+					 err, gating_wait);
+
+		if (gating_wait == 0) {
+			gating_wait = UFSHCD_REF_CLK_GATING_WAIT_US;
+			dev_err(hba->dev, "Undefined ref clk gating wait time, use default %uus\n",
+					 gating_wait);
+		}
+	}
+
+	return err;
+}
+
 /**
  * ufshcd_memory_alloc - allocate memory for host memory space data structures
  * @hba: per adapter instance
@@ -6626,6 +6652,10 @@  static int ufs_get_device_desc(struct ufs_hba *hba)
 	dev_info->wmanufacturerid = desc_buf[DEVICE_DESC_PARAM_MANF_ID] << 8 |
 				     desc_buf[DEVICE_DESC_PARAM_MANF_ID + 1];
 
+	/* getting Specification Version in big endian format */
+	dev_info->wspecversion = desc_buf[DEVICE_DESC_PARAM_SPEC_VER] << 8 |
+				      desc_buf[DEVICE_DESC_PARAM_SPEC_VER + 1];
+
 	model_index = desc_buf[DEVICE_DESC_PARAM_PRDCT_NAME];
 	err = ufshcd_read_string_desc(hba, model_index,
 				      &dev_info->model, SD_ASCII_STD);
@@ -7003,6 +7033,8 @@  static int ufshcd_device_params_init(struct ufs_hba *hba)
 		goto out;
 	}
 
+	ufshcd_get_ref_clk_gating_wait(hba);
+
 	ufs_fixup_device_setup(hba);
 
 	if (!ufshcd_query_flag_retry(hba, UPIU_QUERY_OPCODE_READ_FLAG,