rtc: add new ioctl interface and BSM support
Alexandre Belloni
maintainerv2 cover rtc: add new ioctl interface and BSM support
This adds a new ioctl interface allowing to get and set extended parameters on RTCs. While its main goal is to support backup switch mode, it also intends to fix a long time issue. Until now, it was not possible to know what features were supported by an RTC before actually trying to make use of it and see that succeed or fail. In order to make tests more reliable and allow userspace to take the correct decision, the features are now exposed.
Changes in v2:
- Fix rv3032 direct mode value
- return earlier once BSM is set
Alexandre Belloni (7):
rtc: add alarm related features
rtc: add parameter ioctl
rtc: expose correction feature
rtc: add correction parameter
rtc: add BSM parameter
rtc: rv3028: add BSM support
rtc: rv3032: allow setting BSM
drivers/rtc/class.c | 3 ++ drivers/rtc/dev.c | 65 ++++++++++++++++++++++++++++++++++ drivers/rtc/rtc-rv3028.c | 74 ++++++++++++++++++++++++++++++++++++++ drivers/rtc/rtc-rv3032.c | 76 ++++++++++++++++++++++++++++++++++++++++ include/linux/rtc.h | 2 ++ include/uapi/linux/rtc.h | 31 +++++++++++++++- 6 files changed, 250 insertions(+), 1 deletion(-)
Signature · 1 line
2.31.1
Alexandre Belloni
maintainerPATCH v2 1/7 rtc: add alarm related features
Add more alarm related features to be declared by drivers.
--- include/uapi/linux/rtc.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
include/uapi/linux/rtc.h +3 -1
@@ -114,7 +114,9 @@ struct rtc_pll_info {#define RTC_FEATURE_ALARM 0#define RTC_FEATURE_ALARM_RES_MINUTE 1#define RTC_FEATURE_NEED_WEEK_DAY 2 -#define RTC_FEATURE_CNT 3 +#define RTC_FEATURE_ALARM_RES_2S 3 +#define RTC_FEATURE_UPDATE_INTERRUPT 4 +#define RTC_FEATURE_CNT 5#define RTC_MAX_FREQ 8192
Signature · 1 line
2.31.1
Alexandre Belloni
maintainerPATCH v2 2/7 rtc: add parameter ioctl
In reply to Alexandre BelloniAdd an ioctl allowing to get and set extra parameters for an RTC. For now, only handle getting available features.
--- drivers/rtc/dev.c | 40 ++++++++++++++++++++++++++++++++++++++++ include/uapi/linux/rtc.h | 18 ++++++++++++++++++ 2 files changed, 58 insertions(+)
drivers/rtc/dev.c +40 -0
@@ -208,6 +208,7 @@ static long rtc_dev_ioctl(struct file *file,const struct rtc_class_ops *ops = rtc->ops;struct rtc_time tm;struct rtc_wkalrm alarm; +struct rtc_param param;void __user *uarg = (void __user *)arg; err =mutex_lock_interruptible (&rtc->ops_lock);
@@ -221,6 +222,7 @@ static long rtc_dev_ioctl(struct file *file,switch (cmd) {case RTC_EPOCH_SET :case RTC_SET_TIME : +case RTC_PARAM_SET :if (!capable (CAP_SYS_TIME )) err = -EACCES ;break ;
@@ -382,6 +384,44 @@ static long rtc_dev_ioctl(struct file *file, err = -EFAULT ;return err; +case RTC_PARAM_GET : +if (copy_from_user (¶m, uarg,sizeof (param))) { +mutex_unlock (&rtc->ops_lock); +return -EFAULT ; + } + +switch (param.param) { +long offset; +case RTC_PARAM_FEATURES : +if (param.index !=0 ) + err = -EINVAL ; + param.uvalue = rtc->features[0 ]; +break ; + +default : + err = -EINVAL ; + } + +if (!err) +if (copy_to_user (uarg, ¶m,sizeof (param))) + err = -EFAULT ; + +break ; + +case RTC_PARAM_SET : +if (copy_from_user (¶m, uarg,sizeof (param))) { +mutex_unlock (&rtc->ops_lock); +return -EFAULT ; + } + +switch (param.param) { +case RTC_PARAM_FEATURES : +default : + err = -EINVAL ; + } + +break ; +default :/* Finally try the driver's ioctl interface */ if (ops->ioctl) {
include/uapi/linux/rtc.h +18 -0
@@ -14,6 +14,7 @@#include <linux/const.h> #include <linux/ioctl.h> +#include <linux/types.h> /* * The struct used to pass data via the following ioctl. Similar to the
@@ -66,6 +67,17 @@ struct rtc_pll_info {long pll_clock;/* base PLL frequency */ }; +struct rtc_param { +__u64 param; +union { +__u64 uvalue; +__s64 svalue; +__u64 ptr; + }; +__u32 index; +__u32 __pad; +}; +/* * ioctl calls that are permitted to the /dev/rtc interface, if * any of the RTC drivers are enabled.
@@ -95,6 +107,9 @@ struct rtc_pll_info {#define RTC_PLL_GET _IOR('p', 0x11, struct rtc_pll_info)/* Get PLL correction */ #define RTC_PLL_SET _IOW('p', 0x12, struct rtc_pll_info)/* Set PLL correction */ +#define RTC_PARAM_GET _IOW('p', 0x13, struct rtc_param)/* Get parameter */ +#define RTC_PARAM_SET _IOW('p', 0x14, struct rtc_param)/* Set parameter */ +#define RTC_VL_DATA_INVALID _BITUL(0)/* Voltage too low, RTC data is invalid */ #define RTC_VL_BACKUP_LOW _BITUL(1)/* Backup voltage is low */ #define RTC_VL_BACKUP_EMPTY _BITUL(2)/* Backup empty or not present */
@@ -118,6 +133,9 @@ struct rtc_pll_info {#define RTC_FEATURE_UPDATE_INTERRUPT 4#define RTC_FEATURE_CNT 5 +/* parameter list */ +#define RTC_PARAM_FEATURES 0 +#define RTC_MAX_FREQ 8192
Signature · 1 line
2.31.1
Alexandre Belloni
maintainerPATCH v2 3/7 rtc: expose correction feature
In reply to Alexandre BelloniAdd a new feature for RTCs able to correct the oscillator imprecision. This is also called offset or trimming. Such drivers have a .set_offset callback, use that to set the feature bit from the core.
--- drivers/rtc/class.c | 3 +++ include/uapi/linux/rtc.h | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-)
drivers/rtc/class.c +3 -0
@@ -389,6 +389,9 @@ int __devm_rtc_register_device(struct module *owner, struct rtc_device *rtc)if (!rtc->ops->set_alarm)clear_bit (RTC_FEATURE_ALARM , rtc->features); +if (rtc->ops->set_offset) +set_bit (RTC_FEATURE_CORRECTION , rtc->features); + rtc->owner = owner;rtc_device_get_offset (rtc);
include/uapi/linux/rtc.h +2 -1
@@ -131,7 +131,8 @@ struct rtc_param {#define RTC_FEATURE_NEED_WEEK_DAY 2#define RTC_FEATURE_ALARM_RES_2S 3#define RTC_FEATURE_UPDATE_INTERRUPT 4 -#define RTC_FEATURE_CNT 5 +#define RTC_FEATURE_CORRECTION 5 +#define RTC_FEATURE_CNT 6/* parameter list */ #define RTC_PARAM_FEATURES 0
Signature · 1 line
2.31.1
Alexandre Belloni
maintainerPATCH v2 4/7 rtc: add correction parameter
In reply to Alexandre BelloniAdd a new parameter allowing the get and set the correction using ioctls instead of just sysfs.
--- drivers/rtc/dev.c | 19 +++++++++++++++++++ include/uapi/linux/rtc.h | 1 + 2 files changed, 20 insertions(+)
drivers/rtc/dev.c +19 -0
@@ -398,6 +398,16 @@ static long rtc_dev_ioctl(struct file *file, param.uvalue = rtc->features[0 ];break ; +case RTC_PARAM_CORRECTION : +mutex_unlock (&rtc->ops_lock); +if (param.index !=0 ) +return -EINVAL ; + err =rtc_read_offset (rtc, &offset); +mutex_lock (&rtc->ops_lock); +if (err ==0 ) + param.svalue = offset; +break ; +default : err = -EINVAL ; }
@@ -416,6 +426,15 @@ static long rtc_dev_ioctl(struct file *file,switch (param.param) {case RTC_PARAM_FEATURES : + err = -EINVAL ; +break ; + +case RTC_PARAM_CORRECTION : +mutex_unlock (&rtc->ops_lock); +if (param.index !=0 ) +return -EINVAL ; +return rtc_set_offset (rtc, param.svalue); +default : err = -EINVAL ; }
include/uapi/linux/rtc.h +1 -0
@@ -136,6 +136,7 @@ struct rtc_param {/* parameter list */ #define RTC_PARAM_FEATURES 0 +#define RTC_PARAM_CORRECTION 1#define RTC_MAX_FREQ 8192
Signature · 1 line
2.31.1
Alexandre Belloni
maintainerPATCH v2 5/7 rtc: add BSM parameter
In reply to Alexandre BelloniBSM or Backup Switch Mode is a common feature on RTCs, allowing to select how the RTC will decide when to switch from its primary power supply to the backup power supply. It is necessary to be able to set it from userspace as there are uses cases where it has to be done dynamically.
Supported values are:
RTC_BSM_DISABLED: disabled
RTC_BSM_DIRECT: switching will happen as soon as Vbackup > Vdd
RTC_BSM_LEVEL: switching will happen around a threshold, usually with an hysteresis
RTC_BSM_STANDBY: switching will not happen until Vdd > Vbackup, this is useful to ensure the RTC doesn't draw any power until the device is first powered on.
--- drivers/rtc/dev.c | 10 ++++++++-- include/linux/rtc.h | 2 ++ include/uapi/linux/rtc.h | 9 ++++++++- 3 files changed, 18 insertions(+), 3 deletions(-)
drivers/rtc/dev.c +8 -2
@@ -409,7 +409,10 @@ static long rtc_dev_ioctl(struct file *file,break ;default : - err = -EINVAL ; +if (rtc->ops->param_get) + err = rtc->ops->param_get (rtc->dev.parent, ¶m); +else + err = -EINVAL ; }if (!err)
@@ -436,7 +439,10 @@ static long rtc_dev_ioctl(struct file *file,return rtc_set_offset (rtc, param.svalue);default : - err = -EINVAL ; +if (rtc->ops->param_set) + err = rtc->ops->param_set (rtc->dev.parent, ¶m); +else + err = -EINVAL ; }break ;
include/linux/rtc.h +2 -0
@@ -66,6 +66,8 @@ struct rtc_class_ops {int (*alarm_irq_enable)(struct device *,unsigned int enabled);int (*read_offset)(struct device *,long *offset);int (*set_offset)(struct device *,long offset); +int (*param_get)(struct device *,struct rtc_param *param); +int (*param_set)(struct device *,struct rtc_param *param); };struct rtc_device ;
include/uapi/linux/rtc.h +8 -1
@@ -132,11 +132,18 @@ struct rtc_param {#define RTC_FEATURE_ALARM_RES_2S 3#define RTC_FEATURE_UPDATE_INTERRUPT 4#define RTC_FEATURE_CORRECTION 5 -#define RTC_FEATURE_CNT 6 +#define RTC_FEATURE_BACKUP_SWITCH_MODE 6 +#define RTC_FEATURE_CNT 7/* parameter list */ #define RTC_PARAM_FEATURES 0#define RTC_PARAM_CORRECTION 1 +#define RTC_PARAM_BACKUP_SWITCH_MODE 2 + +#define RTC_BSM_DISABLED 0 +#define RTC_BSM_DIRECT 1 +#define RTC_BSM_LEVEL 2 +#define RTC_BSM_STANDBY 3#define RTC_MAX_FREQ 8192
Signature · 1 line
2.31.1
Alexandre Belloni
maintainerPATCH v2 6/7 rtc: rv3028: add BSM support
In reply to Alexandre BelloniBackup Switch Mode controls how the RTC decides when to switch to the backup power supply. As it is disabled by default, provide a way to enable and configure it.
--- drivers/rtc/rtc-rv3028.c | 74 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+)
drivers/rtc/rtc-rv3028.c +74 -0
@@ -10,6 +10,7 @@#include <linux/clk-provider.h> #include <linux/bcd.h> +#include <linux/bitfield.h> #include <linux/bitops.h> #include <linux/i2c.h> #include <linux/interrupt.h>
@@ -80,6 +81,10 @@#define RV3028_BACKUP_TCE BIT(5)#define RV3028_BACKUP_TCR_MASK GENMASK(1,0) +#define RV3028_BACKUP_BSM GENMASK(3,2) + +#define RV3028_BACKUP_BSM_DSM 0x1 +#define RV3028_BACKUP_BSM_LSM 0x3#define OFFSET_STEP_PPT 953674
@@ -512,6 +517,71 @@ static int rv3028_set_offset(struct device *dev, long offset) } +static int rv3028_param_get (struct device *dev,struct rtc_param *param) +{ +struct rv3028_data *rv3028 =dev_get_drvdata (dev); +int ret; + +switch (param->param) { +u32 value; + +case RTC_PARAM_BACKUP_SWITCH_MODE : + ret =regmap_read (rv3028->regmap,RV3028_BACKUP , &value); +if (ret <0 ) +return ret; + + value =FIELD_GET (RV3028_BACKUP_BSM , value); + +switch (value) { +case RV3028_BACKUP_BSM_DSM : + param->uvalue =RTC_BSM_DIRECT ; +break ; +case RV3028_BACKUP_BSM_LSM : + param->uvalue =RTC_BSM_LEVEL ; +break ; +default : + param->uvalue =RTC_BSM_DISABLED ; + } +break ; + +default : +return -EINVAL ; + } + +return 0 ; +} + +static int rv3028_param_set (struct device *dev,struct rtc_param *param) +{ +struct rv3028_data *rv3028 =dev_get_drvdata (dev); + +switch (param->param) { +u8 mode; +case RTC_PARAM_BACKUP_SWITCH_MODE : +switch (param->uvalue) { +case RTC_BSM_DISABLED : + mode =0 ; +break ; +case RTC_BSM_DIRECT : + mode =RV3028_BACKUP_BSM_DSM ; +break ; +case RTC_BSM_LEVEL : + mode =RV3028_BACKUP_BSM_LSM ; +break ; +default : +return -EINVAL ; + } + +return rv3028_update_cfg (rv3028,RV3028_BACKUP ,RV3028_BACKUP_BSM , +FIELD_PREP (RV3028_BACKUP_BSM , mode)); + +default : +return -EINVAL ; + } + +return 0 ; +} +static int rv3028_ioctl (struct device *dev,unsigned int cmd,unsigned long arg) {struct rv3028_data *rv3028 =dev_get_drvdata (dev);
@@ -776,6 +846,8 @@ static const struct rtc_class_ops rv3028_rtc_ops = { .read_offset = rv3028_read_offset, .set_offset = rv3028_set_offset, .ioctl = rv3028_ioctl, + .param_get = rv3028_param_get, + .param_set = rv3028_param_set, };static const struct regmap_config regmap_config = {
@@ -878,6 +950,8 @@ static int rv3028_probe(struct i2c_client *client)if (ret)return ret; +set_bit (RTC_FEATURE_BACKUP_SWITCH_MODE , rv3028->rtc->features); + rv3028->rtc->range_min =RTC_TIMESTAMP_BEGIN_2000 ; rv3028->rtc->range_max =RTC_TIMESTAMP_END_2099 ; rv3028->rtc->ops = &rv3028_rtc_ops;
Signature · 1 line
2.31.1
Alexandre Belloni
maintainerPATCH v2 7/7 rtc: rv3032: allow setting BSM
In reply to Alexandre BelloniBackup Switch Mode is currently set properly when the trickle charger is enabled. However, in the case of a non-rechargeable battery, it is necessary to be able to enable it, only allow that when the trickle charger is disabled.
--- drivers/rtc/rtc-rv3032.c | 76 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+)
drivers/rtc/rtc-rv3032.c +76 -0
@@ -106,6 +106,7 @@struct rv3032_data {struct regmap *regmap;struct rtc_device *rtc; +bool trickle_charger_set;#ifdef CONFIG_COMMON_CLK struct clk_hw clkout_hw;#endif
@@ -402,6 +403,75 @@ static int rv3032_set_offset(struct device *dev, long offset) FIELD_PREP(RV3032_OFFSET_MSK, offset)); } +static int rv3032_param_get (struct device *dev,struct rtc_param *param) +{ +struct rv3032_data *rv3032 =dev_get_drvdata (dev); +int ret; + +switch (param->param) { +u32 value; + +case RTC_PARAM_BACKUP_SWITCH_MODE : + ret =regmap_read (rv3032->regmap,RV3032_PMU , &value); +if (ret <0 ) +return ret; + + value =FIELD_GET (RV3032_PMU_BSM , value); + +switch (value) { +case RV3032_PMU_BSM_DSM : + param->uvalue =RTC_BSM_DIRECT ; +break ; +case RV3032_PMU_BSM_LSM : + param->uvalue =RTC_BSM_LEVEL ; +break ; +default : + param->uvalue =RTC_BSM_DISABLED ; + } + +break ; + +default : +return -EINVAL ; + } + +return 0 ; +} + +static int rv3032_param_set (struct device *dev,struct rtc_param *param) +{ +struct rv3032_data *rv3032 =dev_get_drvdata (dev); + +switch (param->param) { +u8 mode; +case RTC_PARAM_BACKUP_SWITCH_MODE : +if (rv3032->trickle_charger_set) +return -EINVAL ; + +switch (param->uvalue) { +case RTC_BSM_DISABLED : + mode =0 ; +break ; +case RTC_BSM_DIRECT : + mode =RV3032_PMU_BSM_DSM ; +break ; +case RTC_BSM_LEVEL : + mode =RV3032_PMU_BSM_LSM ; +break ; +default : +return -EINVAL ; + } + +return rv3032_update_cfg (rv3032,RV3032_PMU ,RV3032_PMU_BSM , +FIELD_PREP (RV3032_PMU_BSM , mode)); + +default : +return -EINVAL ; + } + +return 0 ; +} +static int rv3032_ioctl (struct device *dev,unsigned int cmd,unsigned long arg) {struct rv3032_data *rv3032 =dev_get_drvdata (dev);
@@ -541,6 +611,8 @@ static int rv3032_trickle_charger_setup(struct device *dev, struct rv3032_data *return 0 ; } + rv3032->trickle_charger_set = true; +return rv3032_update_cfg (rv3032,RV3032_PMU ,RV3032_PMU_TCR |RV3032_PMU_TCM |RV3032_PMU_BSM , val |FIELD_PREP (RV3032_PMU_TCR , i));
@@ -813,6 +885,8 @@ static const struct rtc_class_ops rv3032_rtc_ops = { .read_alarm = rv3032_get_alarm, .set_alarm = rv3032_set_alarm, .alarm_irq_enable = rv3032_alarm_irq_enable, + .param_get = rv3032_param_get, + .param_set = rv3032_param_set, };static const struct regmap_config regmap_config = {
@@ -883,6 +957,8 @@ static int rv3032_probe(struct i2c_client *client)rv3032_trickle_charger_setup (&client->dev, rv3032); +set_bit (RTC_FEATURE_BACKUP_SWITCH_MODE , rv3032->rtc->features); + rv3032->rtc->range_min =RTC_TIMESTAMP_BEGIN_2000 ; rv3032->rtc->range_max =RTC_TIMESTAMP_END_2099 ; rv3032->rtc->ops = &rv3032_rtc_ops;
Signature · 1 line
2.31.1