From: Bean Huo <[email protected]>
Add Real Time Clock (RTC) support for UFS device. This enhancement is crucial
for the internal maintenance operations of the UFS device. The patch enables
the device to handle both absolute and relative time information. Furthermore,
it includes periodic task to update the RTC in accordance with the UFS Spec,
ensuring the accuracy of RTC information for the device's internal processes.
RTC and qTimestamp serve distinct purposes. The RTC provides a coarse level
of granularity with, at best, approximate single-second resolution. This makes
the RTC well-suited for the device to determine the approximate age of programmed
blocks after being updated by the host. On the other hand, qTimestamp offers
nanosecond granularity and is specifically designed for synchronizing Device
Error Log entries with corresponding host-side logs.
Given that the RTC has been a standard feature since UFS Spec 2.0, and qTimestamp
was introduced in UFS Spec 4.0, the majority of UFS devices currently on the
market rely on RTC. Therefore, it is advisable to continue supporting RTC in
the Linux kernel. This ensures compatibility with the prevailing UFS device
implementations and facilitates seamless integration with existing hardware.
By maintaining support for RTC, we ensure broad compatibility and avoid potential
issues arising from deviations in device specifications across different UFS
versions.
Signed-off-by: Bean Huo <[email protected]>
Signed-off-by: Mike Bi <[email protected]>
Signed-off-by: Luca Porzio <[email protected]>
---
drivers/ufs/core/ufshcd.c | 77 +++++++++++++++++++++++++++++++++++++++
include/ufs/ufs.h | 14 +++++++
include/ufs/ufshcd.h | 4 ++
3 files changed, 95 insertions(+)
diff --git a/drivers/ufs/core/ufshcd.c b/drivers/ufs/core/ufshcd.c
index f88f20f27f93..dfc660de656f 100644
--- a/drivers/ufs/core/ufshcd.c
+++ b/drivers/ufs/core/ufshcd.c
@@ -99,6 +99,9 @@
/* Polling time to wait for fDeviceInit */
#define FDEVICEINIT_COMPL_TIMEOUT 1500 /* millisecs */
+/* Default RTC update every 10 seconds */
+#define UFS_RTC_UPDATE_INTERVAL_MS (10 * MSEC_PER_SEC)
+
/* UFSHC 4.0 compliant HC support this mode. */
static bool use_mcq_mode = true;
@@ -684,6 +687,8 @@ static void ufshcd_device_reset(struct ufs_hba *hba)
hba->dev_info.wb_enabled = false;
hba->dev_info.wb_buf_flush_enabled = false;
}
+ if (hba->dev_info.rtc_type == UFS_RTC_RELATIVE)
+ hba->dev_info.rtc_time_baseline = 0;
}
if (err != -EOPNOTSUPP)
ufshcd_update_evt_hist(hba, UFS_EVT_DEV_RESET, err);
@@ -8189,6 +8194,70 @@ static void ufs_fixup_device_setup(struct ufs_hba *hba)
ufshcd_vops_fixup_dev_quirks(hba);
}
+static int ufshcd_update_rtc(struct ufs_hba *hba)
+{
+ int err;
+ u32 val;
+ struct timespec64 ts64;
+
+ ktime_get_real_ts64(&ts64);
+ val = ts64.tv_sec - hba->dev_info.rtc_time_baseline;
+
+ ufshcd_rpm_get_sync(hba);
+ err = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_WRITE_ATTR, QUERY_ATTR_IDN_SECONDS_PASSED,
+ 0, 0, &val);
+ ufshcd_rpm_put_sync(hba);
+
+ if (err)
+ dev_err(hba->dev, "%s: Failed to update rtc %d\n", __func__, err);
+ else if (hba->dev_info.rtc_type == UFS_RTC_RELATIVE)
+ hba->dev_info.rtc_time_baseline = ts64.tv_sec;
+
+ return err;
+}
+
+static void ufshcd_rtc_work(struct work_struct *work)
+{
+ struct ufs_hba *hba;
+ bool is_busy;
+
+ hba = container_of(to_delayed_work(work), struct ufs_hba, ufs_rtc_update_work);
+
+ is_busy = ufshcd_is_ufs_dev_busy(hba);
+ /*
+ * RTC updates should not interfere with normal IO requests; we should only update the RTC
+ * when there are no ongoing requests.
+ */
+ if (!is_busy)
+ ufshcd_update_rtc(hba);
+
+ if (ufshcd_is_ufs_dev_active(hba))
+ schedule_delayed_work(&hba->ufs_rtc_update_work,
+ msecs_to_jiffies(UFS_RTC_UPDATE_INTERVAL_MS));
+}
+
+static void ufs_init_rtc(struct ufs_hba *hba, u8 *desc_buf)
+{
+ struct ufs_dev_info *dev_info = &hba->dev_info;
+ u16 periodic_rtc_update = get_unaligned_be16(&desc_buf[DEVICE_DESC_PARAM_FRQ_RTC]);
+
+ if (periodic_rtc_update & UFS_RTC_TIME_BASELINE) {
+ dev_info->rtc_type = UFS_RTC_ABSOLUTE;
+ /*
+ * The concept of measuring time in Linux as the number of seconds elapsed since
+ * 00:00:00 UTC on January 1, 1970, and UFS ABS RTC is elapsed from January 1st
+ * 2010 00:00, here we need to adjust ABS baseline.
+ */
+ dev_info->rtc_time_baseline = mktime64(2010, 1, 1, 0, 0, 0) -
+ mktime64(1970, 1, 1, 0, 0, 0);
+ } else {
+ dev_info->rtc_type = UFS_RTC_RELATIVE;
+ dev_info->rtc_time_baseline = 0;
+ }
+
+ INIT_DELAYED_WORK(&hba->ufs_rtc_update_work, ufshcd_rtc_work);
+}
+
static int ufs_get_device_desc(struct ufs_hba *hba)
{
int err;
@@ -8241,6 +8310,8 @@ static int ufs_get_device_desc(struct ufs_hba *hba)
ufshcd_temp_notif_probe(hba, desc_buf);
+ ufs_init_rtc(hba, desc_buf);
+
if (hba->ext_iid_sup)
ufshcd_ext_iid_probe(hba, desc_buf);
@@ -8794,6 +8865,8 @@ static int ufshcd_device_init(struct ufs_hba *hba, bool init_dev_params)
ufshcd_force_reset_auto_bkops(hba);
ufshcd_set_timestamp_attr(hba);
+ schedule_delayed_work(&hba->ufs_rtc_update_work,
+ msecs_to_jiffies(UFS_RTC_UPDATE_INTERVAL_MS));
/* Gear up to HS gear if supported */
if (hba->max_pwr_info.is_valid) {
@@ -9750,6 +9823,8 @@ static int __ufshcd_wl_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op)
ret = ufshcd_vops_suspend(hba, pm_op, POST_CHANGE);
if (ret)
goto set_link_active;
+
+ cancel_delayed_work_sync(&hba->ufs_rtc_update_work);
goto out;
set_link_active:
@@ -9844,6 +9919,8 @@ static int __ufshcd_wl_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)
if (ret)
goto set_old_link_state;
ufshcd_set_timestamp_attr(hba);
+ schedule_delayed_work(&hba->ufs_rtc_update_work,
+ msecs_to_jiffies(UFS_RTC_UPDATE_INTERVAL_MS));
}
if (ufshcd_keep_autobkops_enabled_except_suspend(hba))
diff --git a/include/ufs/ufs.h b/include/ufs/ufs.h
index e77ab1786856..8022d267fe8a 100644
--- a/include/ufs/ufs.h
+++ b/include/ufs/ufs.h
@@ -14,6 +14,7 @@
#include <linux/bitops.h>
#include <linux/types.h>
#include <uapi/scsi/scsi_bsg_ufs.h>
+#include <linux/time64.h>
/*
* Using static_assert() is not allowed in UAPI header files. Hence the check
@@ -551,6 +552,15 @@ struct ufs_vreg_info {
struct ufs_vreg *vdd_hba;
};
+/*
+ * UFS device descriptor wPeriodicRTCUpdate bit9 defines RTC time baseline.
+ */
+#define UFS_RTC_TIME_BASELINE BIT(9)
+enum ufs_rtc_time {
+ UFS_RTC_RELATIVE,
+ UFS_RTC_ABSOLUTE
+};
+
struct ufs_dev_info {
bool f_power_on_wp_en;
/* Keeps information if any of the LU is power on write protected */
@@ -578,6 +588,10 @@ struct ufs_dev_info {
/* UFS EXT_IID Enable */
bool b_ext_iid_en;
+
+ /* UFS RTC */
+ enum ufs_rtc_time rtc_type;
+ time64_t rtc_time_baseline;
};
/*
diff --git a/include/ufs/ufshcd.h b/include/ufs/ufshcd.h
index 7f0b2c5599cd..7bdda92fcb1c 100644
--- a/include/ufs/ufshcd.h
+++ b/include/ufs/ufshcd.h
@@ -911,6 +911,8 @@ enum ufshcd_mcq_opr {
* @mcq_base: Multi circular queue registers base address
* @uhq: array of supported hardware queues
* @dev_cmd_queue: Queue for issuing device management commands
+ * @mcq_opr: MCQ operation and runtime registers
+ * @ufs_rtc_update_work: A work for UFS RTC periodic update
*/
struct ufs_hba {
void __iomem *mmio_base;
@@ -1071,6 +1073,8 @@ struct ufs_hba {
struct ufs_hw_queue *uhq;
struct ufs_hw_queue *dev_cmd_queue;
struct ufshcd_mcq_opr_info_t mcq_opr[OPR_MAX];
+
+ struct delayed_work ufs_rtc_update_work;
};
/**
--
2.34.1
> +static void ufs_init_rtc(struct ufs_hba *hba, u8 *desc_buf) {
> + struct ufs_dev_info *dev_info = &hba->dev_info;
> + u16 periodic_rtc_update =
> +get_unaligned_be16(&desc_buf[DEVICE_DESC_PARAM_FRQ_RTC]);
> +
> + if (periodic_rtc_update & UFS_RTC_TIME_BASELINE) {
Is it allowed to ignore the update period as depicted by wPeriodicRTCUpdate?
And choose a different update period, e.g. 10 seconds instead?
If yes - then It deserve a comment IMO.
Thanks,
Avri
> + dev_info->rtc_type = UFS_RTC_ABSOLUTE;
> + /*
> + * The concept of measuring time in Linux as the number of seconds
> elapsed since
> + * 00:00:00 UTC on January 1, 1970, and UFS ABS RTC is elapsed
> from January 1st
> + * 2010 00:00, here we need to adjust ABS baseline.
> + */
> + dev_info->rtc_time_baseline = mktime64(2010, 1, 1, 0, 0, 0) -
> + mktime64(1970, 1, 1, 0, 0, 0);
> + } else {
> + dev_info->rtc_type = UFS_RTC_RELATIVE;
> + dev_info->rtc_time_baseline = 0;
> + }
> +
> + INIT_DELAYED_WORK(&hba->ufs_rtc_update_work, ufshcd_rtc_work);
> }
> +
> static int ufs_get_device_desc(struct ufs_hba *hba) {
> int err;
> @@ -8241,6 +8310,8 @@ static int ufs_get_device_desc(struct ufs_hba
> *hba)
>
> ufshcd_temp_notif_probe(hba, desc_buf);
>
> + ufs_init_rtc(hba, desc_buf);
> +
> if (hba->ext_iid_sup)
> ufshcd_ext_iid_probe(hba, desc_buf);
>
> @@ -8794,6 +8865,8 @@ static int ufshcd_device_init(struct ufs_hba *hba,
> bool init_dev_params)
> ufshcd_force_reset_auto_bkops(hba);
>
> ufshcd_set_timestamp_attr(hba);
> + schedule_delayed_work(&hba->ufs_rtc_update_work,
> +
> + msecs_to_jiffies(UFS_RTC_UPDATE_INTERVAL_MS));
>
> /* Gear up to HS gear if supported */
> if (hba->max_pwr_info.is_valid) { @@ -9750,6 +9823,8 @@ static int
> __ufshcd_wl_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op)
> ret = ufshcd_vops_suspend(hba, pm_op, POST_CHANGE);
> if (ret)
> goto set_link_active;
> +
> + cancel_delayed_work_sync(&hba->ufs_rtc_update_work);
> goto out;
>
> set_link_active:
> @@ -9844,6 +9919,8 @@ static int __ufshcd_wl_resume(struct ufs_hba
> *hba, enum ufs_pm_op pm_op)
> if (ret)
> goto set_old_link_state;
> ufshcd_set_timestamp_attr(hba);
> + schedule_delayed_work(&hba->ufs_rtc_update_work,
> +
> + msecs_to_jiffies(UFS_RTC_UPDATE_INTERVAL_MS));
> }
>
> if (ufshcd_keep_autobkops_enabled_except_suspend(hba))
> diff --git a/include/ufs/ufs.h b/include/ufs/ufs.h index
> e77ab1786856..8022d267fe8a 100644
> --- a/include/ufs/ufs.h
> +++ b/include/ufs/ufs.h
> @@ -14,6 +14,7 @@
> #include <linux/bitops.h>
> #include <linux/types.h>
> #include <uapi/scsi/scsi_bsg_ufs.h>
> +#include <linux/time64.h>
>
> /*
> * Using static_assert() is not allowed in UAPI header files. Hence the check
> @@ -551,6 +552,15 @@ struct ufs_vreg_info {
> struct ufs_vreg *vdd_hba;
> };
>
> +/*
> + * UFS device descriptor wPeriodicRTCUpdate bit9 defines RTC time
> baseline.
> + */
> +#define UFS_RTC_TIME_BASELINE BIT(9)
> +enum ufs_rtc_time {
> + UFS_RTC_RELATIVE,
> + UFS_RTC_ABSOLUTE
> +};
> +
> struct ufs_dev_info {
> bool f_power_on_wp_en;
> /* Keeps information if any of the LU is power on write protected */ @@
> -578,6 +588,10 @@ struct ufs_dev_info {
>
> /* UFS EXT_IID Enable */
> bool b_ext_iid_en;
> +
> + /* UFS RTC */
> + enum ufs_rtc_time rtc_type;
> + time64_t rtc_time_baseline;
> };
>
> /*
> diff --git a/include/ufs/ufshcd.h b/include/ufs/ufshcd.h index
> 7f0b2c5599cd..7bdda92fcb1c 100644
> --- a/include/ufs/ufshcd.h
> +++ b/include/ufs/ufshcd.h
> @@ -911,6 +911,8 @@ enum ufshcd_mcq_opr {
> * @mcq_base: Multi circular queue registers base address
> * @uhq: array of supported hardware queues
> * @dev_cmd_queue: Queue for issuing device management commands
> + * @mcq_opr: MCQ operation and runtime registers
> + * @ufs_rtc_update_work: A work for UFS RTC periodic update
> */
> struct ufs_hba {
> void __iomem *mmio_base;
> @@ -1071,6 +1073,8 @@ struct ufs_hba {
> struct ufs_hw_queue *uhq;
> struct ufs_hw_queue *dev_cmd_queue;
> struct ufshcd_mcq_opr_info_t mcq_opr[OPR_MAX];
> +
> + struct delayed_work ufs_rtc_update_work;
> };
>
> /**
> --
> 2.34.1
>
>
> > +static void ufs_init_rtc(struct ufs_hba *hba, u8 *desc_buf) {
> > + struct ufs_dev_info *dev_info = &hba->dev_info;
> > + u16 periodic_rtc_update =
> > +get_unaligned_be16(&desc_buf[DEVICE_DESC_PARAM_FRQ_RTC]);
> > +
> > + if (periodic_rtc_update & UFS_RTC_TIME_BASELINE) {
> Is it allowed to ignore the update period as depicted by
> wPeriodicRTCUpdate?
> And choose a different update period, e.g. 10 seconds instead?
> If yes - then It deserve a comment IMO.
Oh - the comment is in the 3rd patch.
Sorry - please ignore.
Thanks,
Avri
>
> Thanks,
> Avri
>
> > + dev_info->rtc_type = UFS_RTC_ABSOLUTE;
> > + /*
> > + * The concept of measuring time in Linux as the
> > + number of seconds
> > elapsed since
> > + * 00:00:00 UTC on January 1, 1970, and UFS ABS RTC is
> > + elapsed
> > from January 1st
> > + * 2010 00:00, here we need to adjust ABS baseline.
> > + */
> > + dev_info->rtc_time_baseline = mktime64(2010, 1, 1, 0, 0, 0) -
> > + mktime64(1970, 1, 1, 0, 0, 0);
> > + } else {
> > + dev_info->rtc_type = UFS_RTC_RELATIVE;
> > + dev_info->rtc_time_baseline = 0;
> > + }
> > +
> > + INIT_DELAYED_WORK(&hba->ufs_rtc_update_work,
> ufshcd_rtc_work);
> > }
> > +
> > static int ufs_get_device_desc(struct ufs_hba *hba) {
> > int err;
> > @@ -8241,6 +8310,8 @@ static int ufs_get_device_desc(struct ufs_hba
> > *hba)
> >
> > ufshcd_temp_notif_probe(hba, desc_buf);
> >
> > + ufs_init_rtc(hba, desc_buf);
> > +
> > if (hba->ext_iid_sup)
> > ufshcd_ext_iid_probe(hba, desc_buf);
> >
> > @@ -8794,6 +8865,8 @@ static int ufshcd_device_init(struct ufs_hba
> > *hba, bool init_dev_params)
> > ufshcd_force_reset_auto_bkops(hba);
> >
> > ufshcd_set_timestamp_attr(hba);
> > + schedule_delayed_work(&hba->ufs_rtc_update_work,
> > +
> > + msecs_to_jiffies(UFS_RTC_UPDATE_INTERVAL_MS));
> >
> > /* Gear up to HS gear if supported */
> > if (hba->max_pwr_info.is_valid) { @@ -9750,6 +9823,8 @@ static
> > int __ufshcd_wl_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op)
> > ret = ufshcd_vops_suspend(hba, pm_op, POST_CHANGE);
> > if (ret)
> > goto set_link_active;
> > +
> > + cancel_delayed_work_sync(&hba->ufs_rtc_update_work);
> > goto out;
> >
> > set_link_active:
> > @@ -9844,6 +9919,8 @@ static int __ufshcd_wl_resume(struct ufs_hba
> > *hba, enum ufs_pm_op pm_op)
> > if (ret)
> > goto set_old_link_state;
> > ufshcd_set_timestamp_attr(hba);
> > + schedule_delayed_work(&hba->ufs_rtc_update_work,
> > +
> > + msecs_to_jiffies(UFS_RTC_UPDATE_INTERVAL_MS));
> > }
> >
> > if (ufshcd_keep_autobkops_enabled_except_suspend(hba))
> > diff --git a/include/ufs/ufs.h b/include/ufs/ufs.h index
> > e77ab1786856..8022d267fe8a 100644
> > --- a/include/ufs/ufs.h
> > +++ b/include/ufs/ufs.h
> > @@ -14,6 +14,7 @@
> > #include <linux/bitops.h>
> > #include <linux/types.h>
> > #include <uapi/scsi/scsi_bsg_ufs.h>
> > +#include <linux/time64.h>
> >
> > /*
> > * Using static_assert() is not allowed in UAPI header files. Hence
> > the check @@ -551,6 +552,15 @@ struct ufs_vreg_info {
> > struct ufs_vreg *vdd_hba;
> > };
> >
> > +/*
> > + * UFS device descriptor wPeriodicRTCUpdate bit9 defines RTC time
> > baseline.
> > + */
> > +#define UFS_RTC_TIME_BASELINE BIT(9)
> > +enum ufs_rtc_time {
> > + UFS_RTC_RELATIVE,
> > + UFS_RTC_ABSOLUTE
> > +};
> > +
> > struct ufs_dev_info {
> > bool f_power_on_wp_en;
> > /* Keeps information if any of the LU is power on write
> > protected */ @@
> > -578,6 +588,10 @@ struct ufs_dev_info {
> >
> > /* UFS EXT_IID Enable */
> > bool b_ext_iid_en;
> > +
> > + /* UFS RTC */
> > + enum ufs_rtc_time rtc_type;
> > + time64_t rtc_time_baseline;
> > };
> >
> > /*
> > diff --git a/include/ufs/ufshcd.h b/include/ufs/ufshcd.h index
> > 7f0b2c5599cd..7bdda92fcb1c 100644
> > --- a/include/ufs/ufshcd.h
> > +++ b/include/ufs/ufshcd.h
> > @@ -911,6 +911,8 @@ enum ufshcd_mcq_opr {
> > * @mcq_base: Multi circular queue registers base address
> > * @uhq: array of supported hardware queues
> > * @dev_cmd_queue: Queue for issuing device management commands
> > + * @mcq_opr: MCQ operation and runtime registers
> > + * @ufs_rtc_update_work: A work for UFS RTC periodic update
> > */
> > struct ufs_hba {
> > void __iomem *mmio_base;
> > @@ -1071,6 +1073,8 @@ struct ufs_hba {
> > struct ufs_hw_queue *uhq;
> > struct ufs_hw_queue *dev_cmd_queue;
> > struct ufshcd_mcq_opr_info_t mcq_opr[OPR_MAX];
> > +
> > + struct delayed_work ufs_rtc_update_work;
> > };
> >
> > /**
> > --
> > 2.34.1
> >
> From: Bean Huo <[email protected]>
>
> Add Real Time Clock (RTC) support for UFS device. This enhancement is
> crucial for the internal maintenance operations of the UFS device. The patch
> enables the device to handle both absolute and relative time information.
> Furthermore, it includes periodic task to update the RTC in accordance with
> the UFS Spec, ensuring the accuracy of RTC information for the device's
> internal processes.
>
> RTC and qTimestamp serve distinct purposes. The RTC provides a coarse
> level of granularity with, at best, approximate single-second resolution. This
> makes the RTC well-suited for the device to determine the approximate age
> of programmed blocks after being updated by the host. On the other hand,
> qTimestamp offers nanosecond granularity and is specifically designed for
> synchronizing Device Error Log entries with corresponding host-side logs.
>
> Given that the RTC has been a standard feature since UFS Spec 2.0, and
> qTimestamp was introduced in UFS Spec 4.0, the majority of UFS devices
> currently on the market rely on RTC. Therefore, it is advisable to continue
> supporting RTC in the Linux kernel. This ensures compatibility with the
> prevailing UFS device implementations and facilitates seamless integration
> with existing hardware.
> By maintaining support for RTC, we ensure broad compatibility and avoid
> potential issues arising from deviations in device specifications across
> different UFS versions.
>
> Signed-off-by: Bean Huo <[email protected]>
> Signed-off-by: Mike Bi <[email protected]>
> Signed-off-by: Luca Porzio <[email protected]>
Acked-by: Avri Altman <[email protected]>
On 12/2/23 06:02, Bean Huo wrote:
> +static int ufshcd_update_rtc(struct ufs_hba *hba)
> +{
> + int err;
> + u32 val;
> + struct timespec64 ts64;
> +
> + ktime_get_real_ts64(&ts64);
> + val = ts64.tv_sec - hba->dev_info.rtc_time_baseline;
A 64-bit value is truncated to a 32-bit value. What should happen if the
right hand side is larger than what fits into a 32-bit integer? Should
a comment perhaps be added that uptimes of more than 136 years are not
supported and also for absolute times that the above code fails after
the year 2010 + 136 = 2146?
Thanks,
Bart.
On Wed, 2023-12-06 at 14:59 -1000, Bart Van Assche wrote:
> A 64-bit value is truncated to a 32-bit value. What should happen if
> the
> right hand side is larger than what fits into a 32-bit integer?
> Should
> a comment perhaps be added that uptimes of more than 136 years are
> not
> supported and also for absolute times that the above code fails after
> the year 2010 + 136 = 2146?
>
> Thanks,
>
> Bart.
Bart,
you are taking into account a broader perspective. thanks for your
review!
I will add below code in the next version:
+ if (ts64.tv_sec < hba->dev_info.rtc_time_baseline) {
+ dev_warn(hba->dev, "%s: Current time precedes previous
setting!\n", __func__);
+ return;
+ }
+ /*
+ * Absolute RTC mode has 136-year limit as of 2010. Modify UFS
Spec or choosing relative
+ * RTC mode for longer (beyond year 2146) time spans.
+ */
Kind regards,
Bean