diff mbox series

[v5,4/4] rtc: ds1307: add frequency_test_enable sysfs attribute to check tick on m41txx

Message ID 20180516103251.74707-4-giulio.benetti@micronovasrl.com
State Superseded
Headers show
Series [v5,1/4] rtc: ds1307: fix data pointer to m41t0 | expand

Commit Message

Giulio Benetti May 16, 2018, 10:32 a.m. UTC 
On m41txx you can enable open-drain OUT pin to check if offset is ok.
Enabling OUT pin with frequency_test_enable attribute, OUT pin will tick
512 times faster than 1s tick base.

Enable or Disable FT bit on CONTROL register if freq_test is 1 or 0.

Signed-off-by: Giulio Benetti <giulio.benetti@micronovasrl.com>
---
V3 => V4:
* change attribute from freq_test to frequency_test_enable
* use regmap_update_bits instead of regmap_write
V4 => V5:
* update commit log

 drivers/rtc/rtc-ds1307.c | 99 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)

Comments

Andy Shevchenko May 16, 2018, 8:22 p.m. UTC | #1 
On Wed, May 16, 2018 at 1:32 PM, Giulio Benetti
<giulio.benetti@micronovasrl.com> wrote:
> On m41txx you can enable open-drain OUT pin to check if offset is ok.
> Enabling OUT pin with frequency_test_enable attribute, OUT pin will tick
> 512 times faster than 1s tick base.
>
> Enable or Disable FT bit on CONTROL register if freq_test is 1 or 0.
>
> Signed-off-by: Giulio Benetti <giulio.benetti@micronovasrl.com>

> +static ssize_t frequency_test_enable_store(struct device *dev,
> +                                          struct device_attribute *attr,
> +                                          const char *buf, size_t count)
> +{
> +       struct ds1307 *ds1307 = dev_get_drvdata(dev);
> +       unsigned long freq_test = 0;
> +       int retval;
> +
> +       retval = kstrtoul(buf, 10, &freq_test);
> +       if ((retval < 0) || (retval > 1)) {

kstrtobool() then?

> +               dev_err(dev, "Failed to store RTC Frequency Test attribute\n");

> +               return -EINVAL;

...and do not shadow actual error code.

> +       }
> +
> +       regmap_update_bits(ds1307->regmap, M41TXX_REG_CONTROL, M41TXX_BIT_FT,
> +                          freq_test ? M41TXX_BIT_FT : 0);
> +

> +       return retval ? retval : count;

Does the condition make any sense?

> +}

> +static ssize_t frequency_test_enable_show(struct device *dev,
> +                                         struct device_attribute *attr,
> +                                         char *buf)
> +{

> +       int freq_test_en = 0;

> +       if (ctrl_reg & M41TXX_BIT_FT)
> +               freq_test_en = true;
> +       else
> +               freq_test_en = false;
> +
> +       return sprintf(buf, "%d\n", freq_test_en);

So, is it boolean or integer? This code makes it confusing a lot.

> +}
Giulio Benetti May 16, 2018, 9:02 p.m. UTC | #2 
Hi,

Il 16/05/2018 22:22, Andy Shevchenko ha scritto:
> On Wed, May 16, 2018 at 1:32 PM, Giulio Benetti
> <giulio.benetti@micronovasrl.com> wrote:
>> On m41txx you can enable open-drain OUT pin to check if offset is ok.
>> Enabling OUT pin with frequency_test_enable attribute, OUT pin will tick
>> 512 times faster than 1s tick base.
>>
>> Enable or Disable FT bit on CONTROL register if freq_test is 1 or 0.
>>
>> Signed-off-by: Giulio Benetti <giulio.benetti@micronovasrl.com>
> 
>> +static ssize_t frequency_test_enable_store(struct device *dev,
>> +                                          struct device_attribute *attr,
>> +                                          const char *buf, size_t count)
>> +{
>> +       struct ds1307 *ds1307 = dev_get_drvdata(dev);
>> +       unsigned long freq_test = 0;
>> +       int retval;
>> +
>> +       retval = kstrtoul(buf, 10, &freq_test);
>> +       if ((retval < 0) || (retval > 1)) {
> 
> kstrtobool() then?

Yes, you're right.

> 
>> +               dev_err(dev, "Failed to store RTC Frequency Test attribute\n");
> 
>> +               return -EINVAL;
> 
> ...and do not shadow actual error code.

Ok

> 
>> +       }
>> +
>> +       regmap_update_bits(ds1307->regmap, M41TXX_REG_CONTROL, M41TXX_BIT_FT,
>> +                          freq_test ? M41TXX_BIT_FT : 0);
>> +
> 
>> +       return retval ? retval : count;
> 
> Does the condition make any sense?

You're right, not at all.
I changed it into:
"return count;"

> 
>> +}
> 
>> +static ssize_t frequency_test_enable_show(struct device *dev,
>> +                                         struct device_attribute *attr,
>> +                                         char *buf)
>> +{
> 
>> +       int freq_test_en = 0;
> 
>> +       if (ctrl_reg & M41TXX_BIT_FT)
>> +               freq_test_en = true;
>> +       else
>> +               freq_test_en = false;
>> +
>> +       return sprintf(buf, "%d\n", freq_test_en);
> 
> So, is it boolean or integer? This code makes it confusing a lot.

It is a boolean, so now I've updated with this:

if (ctrl_reg & M41TXX_BIT_FT)
	return scnprintf(buf, PAGE_SIZE, "on\n");
else
	return scnprintf(buf, PAGE_SIZE, "off\n");

> 
>> +}
> 

Thank you very much for review

Giulio Benetti
Alexandre Belloni May 16, 2018, 9:10 p.m. UTC | #3 
On 16/05/2018 23:02:16+0200, Giulio Benetti wrote:
> > > +static ssize_t frequency_test_enable_show(struct device *dev,
> > > +                                         struct device_attribute *attr,
> > > +                                         char *buf)
> > > +{
> > 
> > > +       int freq_test_en = 0;
> > 
> > > +       if (ctrl_reg & M41TXX_BIT_FT)
> > > +               freq_test_en = true;
> > > +       else
> > > +               freq_test_en = false;
> > > +
> > > +       return sprintf(buf, "%d\n", freq_test_en);
> > 
> > So, is it boolean or integer? This code makes it confusing a lot.
> 
> It is a boolean, so now I've updated with this:
> 
> if (ctrl_reg & M41TXX_BIT_FT)
> 	return scnprintf(buf, PAGE_SIZE, "on\n");
> else
> 	return scnprintf(buf, PAGE_SIZE, "off\n");
> 

No, it has to be consistent with what you write.

Here, you'd write 0 or 1 in the file and read off or on...
Giulio Benetti May 16, 2018, 9:15 p.m. UTC | #4 
Hi,

Il 16/05/2018 23:10, Alexandre Belloni ha scritto:
> On 16/05/2018 23:02:16+0200, Giulio Benetti wrote:
>>>> +static ssize_t frequency_test_enable_show(struct device *dev,
>>>> +                                         struct device_attribute *attr,
>>>> +                                         char *buf)
>>>> +{
>>>
>>>> +       int freq_test_en = 0;
>>>
>>>> +       if (ctrl_reg & M41TXX_BIT_FT)
>>>> +               freq_test_en = true;
>>>> +       else
>>>> +               freq_test_en = false;
>>>> +
>>>> +       return sprintf(buf, "%d\n", freq_test_en);
>>>
>>> So, is it boolean or integer? This code makes it confusing a lot.
>>
>> It is a boolean, so now I've updated with this:
>>
>> if (ctrl_reg & M41TXX_BIT_FT)
>> 	return scnprintf(buf, PAGE_SIZE, "on\n");
>> else
>> 	return scnprintf(buf, PAGE_SIZE, "off\n");
>>
> 
> No, it has to be consistent with what you write.
> 
> Here, you'd write 0 or 1 in the file and read off or on...

I'm submitting too many patches, without waiting, sorry.
I've submitted v6 patchset(too early), can you please take a look there 
and tell if I'm on the right path? On that I've change also _store 
function with kstrtobool().

I'm sorry I'm doing so much confusion.
I'm trying to learn to make it the best way.

> 
>
diff mbox series

Patch

diff --git a/drivers/rtc/rtc-ds1307.c b/drivers/rtc/rtc-ds1307.c
index 2797d01bfa1d..de98ddc39515 100644
--- a/drivers/rtc/rtc-ds1307.c
+++ b/drivers/rtc/rtc-ds1307.c
@@ -1053,6 +1053,99 @@  static int m41txx_rtc_set_offset(struct device *dev, long offset)
 				  ctrl_reg);
 }
 
+static ssize_t frequency_test_enable_store(struct device *dev,
+					   struct device_attribute *attr,
+					   const char *buf, size_t count)
+{
+	struct ds1307 *ds1307 = dev_get_drvdata(dev);
+	unsigned long freq_test = 0;
+	int retval;
+
+	retval = kstrtoul(buf, 10, &freq_test);
+	if ((retval < 0) || (retval > 1)) {
+		dev_err(dev, "Failed to store RTC Frequency Test attribute\n");
+		return -EINVAL;
+	}
+
+	regmap_update_bits(ds1307->regmap, M41TXX_REG_CONTROL, M41TXX_BIT_FT,
+			   freq_test ? M41TXX_BIT_FT : 0);
+
+	return retval ? retval : count;
+}
+
+static ssize_t frequency_test_enable_show(struct device *dev,
+					  struct device_attribute *attr,
+					  char *buf)
+{
+	struct ds1307 *ds1307 = dev_get_drvdata(dev);
+	int freq_test_en = 0;
+	unsigned int ctrl_reg;
+
+	regmap_read(ds1307->regmap, M41TXX_REG_CONTROL, &ctrl_reg);
+
+	if (ctrl_reg & M41TXX_BIT_FT)
+		freq_test_en = true;
+	else
+		freq_test_en = false;
+
+	return sprintf(buf, "%d\n", freq_test_en);
+}
+
+static DEVICE_ATTR_RW(frequency_test_enable);
+
+static struct attribute *rtc_freq_test_attrs[] = {
+	&dev_attr_frequency_test_enable.attr,
+	NULL,
+};
+
+static const struct attribute_group rtc_freq_test_attr_group = {
+	.attrs		= rtc_freq_test_attrs,
+};
+
+static void rtc_calib_remove_sysfs_group(void *_dev)
+{
+	struct device *dev = _dev;
+
+	sysfs_remove_group(&dev->kobj, &rtc_freq_test_attr_group);
+}
+
+static int ds1307_add_frequency_test(struct ds1307 *ds1307)
+{
+	int err = 0;
+
+	switch (ds1307->type) {
+	case m41t0:
+	case m41t00:
+	case m41t11:
+		/* Export sysfs entries */
+		err = sysfs_create_group(&(ds1307->dev)->kobj,
+					 &rtc_freq_test_attr_group);
+		if (err) {
+			dev_err(ds1307->dev,
+				"Failed to create sysfs group: %d\n",
+				err);
+			return err;
+		}
+
+		err = devm_add_action_or_reset(ds1307->dev,
+					       rtc_calib_remove_sysfs_group,
+					       ds1307->dev);
+		if (err) {
+			dev_err(ds1307->dev,
+				"Failed to add sysfs cleanup action: %d\n",
+				err);
+			sysfs_remove_group(&(ds1307->dev)->kobj,
+					   &rtc_freq_test_attr_group);
+			return err;
+		}
+		break;
+	default:
+		break;
+	}
+
+	return err;
+}
+
 /*----------------------------------------------------------------------*/
 
 static int ds1307_nvram_read(void *priv, unsigned int offset, void *val,
@@ -1794,6 +1887,12 @@  static int ds1307_probe(struct i2c_client *client,
 	if (err)
 		return err;
 
+	err = ds1307_add_frequency_test(ds1307);
+	if (err) {
+		rtc_device_unregister(ds1307->rtc);
+		return err;
+	}
+
 	if (chip->nvram_size) {
 		struct nvmem_config nvmem_cfg = {
 			.name = "ds1307_nvram",