Skip to contentSkip to conversation

dt-bindings: abx80x: Add autocal-filter property

PATCH In review Kevin P. Fleming 3 participants 7 messages Jun 15, 2020 – Sep 15, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v3 1/3 dt-bindings: abx80x: Add autocal-filter property

Add a property to allow control of the autocalibration filter capacitor.

Cc Alessandro Zummo <[email protected]>
Cc Alexandre Belloni <[email protected]>
Cc Rob Herring <[email protected]>

To: [email protected]
To: [email protected]
---
v3: corrected whitespace

 Documentation/devicetree/bindings/rtc/abracon,abx80x.txt | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +8 -0
index 2405e35a1bc0f..1b606e33d1a83 100644
@@ -29,3 +29,11 @@ and valid to enable charging:
  - "abracon,tc-diode": should be "standard" (0.6V) or "schottky" (0.3V)
  - "abracon,tc-resistor": should be <0>, <3>, <6> or <11>. 0 disables the output
                           resistor, the other values are in kOhm.
+
+All of the devices can have a 47pf capacitor attached to increase the
+autocalibration accuracy of their RC oscillators. To enable or disable usage
+of the capacitor the following property can be defined:
+
+ - "abracon,autocal-filter": should be <0> or <1>. 0 indicates that there
+                             is no capacitor attached, 1 indicates that there
+                             is a capacitor attached.
Signature · 1 line
2.26.2
#1 lore raw

PATCH 2/3 rtc: abx80x: Add utility function for writing configuration key

Writing one of key two values into the configuration key register is a common operation, so a utility function has been added to provide consistent behavior and eliminate code duplication.

Cc Alessandro Zummo <[email protected]>
Cc Alexandre Belloni <[email protected]>

To: [email protected]

---
 drivers/rtc/rtc-abx80x.c | 39 ++++++++++++++++-----------------------
 1 file changed, 16 insertions(+), 23 deletions(-)
drivers/rtc/rtc-abx80x.c +16 -23
index 803725b3a02c3..daa6f27040e61 100644
@@ -117,6 +117,16 @@ struct abx80x_priv {
 	struct watchdog_device wdog;
 };
 
+static int abx80x_write_config_key(struct i2c_client *client, u8 key)
+{
+	if (i2c_smbus_write_byte_data(client, ABX8XX_REG_CFG_KEY, key) < 0) {
+		dev_err(&client->dev, "Unable to write configuration key\n");
+		return -EIO;
+	}
+
+	return 0;
+}
+
 static int abx80x_is_rc_mode(struct i2c_client *client)
 {
 	int flags = 0;
@@ -140,12 +150,8 @@ static int abx80x_enable_trickle_charger(struct i2c_client *client,
 	 * Write the configuration key register to enable access to the Trickle
 	 * register
 	 */
-	err = i2c_smbus_write_byte_data(client, ABX8XX_REG_CFG_KEY,
-					ABX8XX_CFG_KEY_MISC);
-	if (err < 0) {
-		dev_err(&client->dev, "Unable to write configuration key\n");
+	if (abx80x_write_config_key(client, ABX8XX_CFG_KEY_MISC) < 0)
 		return -EIO;
-	}
 
 	err = i2c_smbus_write_byte_data(client, ABX8XX_REG_TRICKLE,
 					ABX8XX_TRICKLE_CHARGE_ENABLE |
@@ -358,12 +364,8 @@ static int abx80x_rtc_set_autocalibration(struct device *dev,
 	}
 
 	/* Unlock write access to Oscillator Control Register */
-	retval = i2c_smbus_write_byte_data(client, ABX8XX_REG_CFG_KEY,
-					   ABX8XX_CFG_KEY_OSC);
-	if (retval < 0) {
-		dev_err(dev, "Failed to write CONFIG_KEY register\n");
-		return retval;
-	}
+	if (abx80x_write_config_key(client, ABX8XX_CFG_KEY_OSC) < 0)
+		return -EIO;
 
 	retval = i2c_smbus_write_byte_data(client, ABX8XX_REG_OSC, flags);
 
@@ -450,12 +452,8 @@ static ssize_t oscillator_store(struct device *dev,
 		flags |= (ABX8XX_OSC_OSEL);
 
 	/* Unlock write access on Oscillator Control register */
-	retval = i2c_smbus_write_byte_data(client, ABX8XX_REG_CFG_KEY,
-					   ABX8XX_CFG_KEY_OSC);
-	if (retval < 0) {
-		dev_err(dev, "Failed to write CONFIG_KEY register\n");
-		return retval;
-	}
+	if (abx80x_write_config_key(client, ABX8XX_CFG_KEY_OSC) < 0)
+		return -EIO;
 
 	retval = i2c_smbus_write_byte_data(client, ABX8XX_REG_OSC, flags);
 	if (retval < 0) {
@@ -762,13 +760,8 @@ static int abx80x_probe(struct i2c_client *client,
 		 * Write the configuration key register to enable access to
 		 * the config2 register
 		 */
-		err = i2c_smbus_write_byte_data(client, ABX8XX_REG_CFG_KEY,
-						ABX8XX_CFG_KEY_MISC);
-		if (err < 0) {
-			dev_err(&client->dev,
-				"Unable to write configuration key\n");
+		if (abx80x_write_config_key(client, ABX8XX_CFG_KEY_MISC) < 0)
 			return -EIO;
-		}
 
 		err = i2c_smbus_write_byte_data(client, ABX8XX_REG_OUT_CTRL,
 						data | ABX8XX_OUT_CTRL_EXDS);
Signature · 1 line
2.26.2
#2 lore raw

PATCH v3 3/3 rtc: abx80x: Add support for autocalibration filter capacitor

In reply to Kevin P. Fleming

All of the parts supported by this driver can make use of a small capacitor to improve the accuracy of the autocalibration process for their RC oscillators. If a capacitor is connected, a configuration register must be set to enable its use, so a new Device Tree property has been added for that purpose.

Cc Alessandro Zummo <[email protected]>
Cc Alexandre Belloni <[email protected]>
Cc Rob Herring <[email protected]>

To: [email protected]
To: [email protected]
---
v3: corrected failure to initialize variable

 drivers/rtc/rtc-abx80x.c | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)
drivers/rtc/rtc-abx80x.c +35 -1
index daa6f27040e61..1b428fe2029ef 100644
@@ -77,6 +77,10 @@
 #define ABX8XX_CFG_KEY_OSC	0xa1
 #define ABX8XX_CFG_KEY_MISC	0x9d
 
+#define ABX8XX_REG_AFCTRL	0x26
+#define ABX8XX_AUTOCAL_FILTER_DISABLE	0x00
+#define ABX8XX_AUTOCAL_FILTER_ENABLE	0xa0
+
 #define ABX8XX_REG_ID0		0x28
 
 #define ABX8XX_REG_OUT_CTRL	0x30
@@ -141,6 +145,26 @@ static int abx80x_is_rc_mode(struct i2c_client *client)
 	return (flags & ABX8XX_OSS_OMODE) ? 1 : 0;
 }
 
+static int abx80x_set_autocal_filter(struct i2c_client *client, u8 filter_cfg)
+{
+	int err;
+
+	/*
+	 * Write the configuration key register to enable access to the AFCTRL
+	 * register
+	 */
+	if (abx80x_write_config_key(client, ABX8XX_CFG_KEY_MISC) < 0)
+		return -EIO;
+
+	err = i2c_smbus_write_byte_data(client, ABX8XX_REG_AFCTRL, filter_cfg);
+	if (err < 0) {
+		dev_warn(&client->dev, "Unable to write autocal filter register\n");
+		return -EIO;
+	}
+
+	return 0;
+}
+
 static int abx80x_enable_trickle_charger(struct i2c_client *client,
 					 u8 trickle_cfg)
 {
@@ -678,7 +702,8 @@ static int abx80x_probe(struct i2c_client *client,
 {
 	struct device_node *np = client->dev.of_node;
 	struct abx80x_priv *priv;
-	int i, data, err, trickle_cfg = -EINVAL;
+	int i, data, err, filter_cfg;
+	int trickle_cfg = -EINVAL;
 	char buf[7];
 	unsigned int part = id->driver_data;
 	unsigned int partnumber;
@@ -824,6 +849,15 @@ static int abx80x_probe(struct i2c_client *client,
 			return err;
 	}
 
+	if (of_property_read_u32(np, "abracon,autocal_filter", &filter_cfg) == 0) {
+		err = abx80x_set_autocal_filter(client,
+						filter_cfg ?
+						ABX8XX_AUTOCAL_FILTER_ENABLE :
+						ABX8XX_AUTOCAL_FILTER_DISABLE);
+		if (err)
+			return err;
+	}
+
 	if (client->irq > 0) {
 		dev_info(&client->dev, "IRQ %d supplied\n", client->irq);
 		err = devm_request_threaded_irq(&client->dev, client->irq, NULL,
Signature · 1 line
2.26.2
maintainer
#3 lore raw
In reply to Kevin P. Fleming
Quoted 20 lines · Kevin P. Fleming

Add a property to allow control of the autocalibration filter capacitor.

Cc Alessandro Zummo <[email protected]>
Cc Alexandre Belloni <[email protected]>
Cc Rob Herring <[email protected]>

To: [email protected]
To: [email protected]
---
v3: corrected whitespace

 Documentation/devicetree/bindings/rtc/abracon,abx80x.txt | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +0 -0
index 2405e35a1bc0f..1b606e33d1a83 100644
@@ -29,3 +29,11 @@ and valid to enable charging:
  - "abracon,tc-diode": should be "standard" (0.6V) or "schottky" (0.3V)

Documentation/devicetree/bindings/rtc/abracon,abx80x.txt and valid to enable charging: · line 39

Quoted 10 lines
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +8 -0
  - "abracon,tc-resistor": should be <0>, <3>, <6> or <11>. 0 disables the output
                           resistor, the other values are in kOhm.
+
+All of the devices can have a 47pf capacitor attached to increase the
+autocalibration accuracy of their RC oscillators. To enable or disable usage
+of the capacitor the following property can be defined:
+
+ - "abracon,autocal-filter": should be <0> or <1>. 0 indicates that there
+                             is no capacitor attached, 1 indicates that there
+                             is a capacitor attached.

What does not present mean? If you don't have a defined meaning (such as maintain the default/bootloader initialized setting), then make this boolean.

Rob

#4 lore raw
Quoted 28 lines · Rob Herring
Quoted 26 lines · Kevin P. Fleming

Add a property to allow control of the autocalibration filter capacitor.

Cc Alessandro Zummo <[email protected]>
Cc Alexandre Belloni <[email protected]>
Cc Rob Herring <[email protected]>

To: [email protected]
To: [email protected]
---
v3: corrected whitespace

 Documentation/devicetree/bindings/rtc/abracon,abx80x.txt | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +4 -0
index 2405e35a1bc0f..1b606e33d1a83 100644
@@ -29,3 +29,11 @@ and valid to enable charging:
  - "abracon,tc-diode": should be "standard" (0.6V) or "schottky" (0.3V)
  - "abracon,tc-resistor": should be <0>, <3>, <6> or <11>. 0 disables the output
                           resistor, the other values are in kOhm.
+
+All of the devices can have a 47pf capacitor attached to increase the
+autocalibration accuracy of their RC oscillators. To enable or disable usage
+of the capacitor the following property can be defined:
Quoted 8 lines

Documentation/devicetree/bindings/rtc/abracon,abx80x.txt and valid to enable charging: · line 39

Quoted 4 lines
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +4 -0
+
+ - "abracon,autocal-filter": should be <0> or <1>. 0 indicates that there
+                             is no capacitor attached, 1 indicates that there
+                             is a capacitor attached.

What does not present mean? If you don't have a defined meaning (such as maintain the default/bootloader initialized setting), then make this boolean.

That is the intended meaning (leave the current setting unmodified). I can add that to the documentation so it is clear.

#5 lore raw

Hi Kevin,

nitpick, the subject prefix should be dt-bindings: prefix: abx80x:

Quoted 38 lines · Kevin P. Fleming
Quoted 28 lines · Rob Herring
Quoted 26 lines · Kevin P. Fleming

Add a property to allow control of the autocalibration filter capacitor.

Cc Alessandro Zummo <[email protected]>
Cc Alexandre Belloni <[email protected]>
Cc Rob Herring <[email protected]>

To: [email protected]
To: [email protected]
---
v3: corrected whitespace

 Documentation/devicetree/bindings/rtc/abracon,abx80x.txt | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +4 -0
index 2405e35a1bc0f..1b606e33d1a83 100644
@@ -29,3 +29,11 @@ and valid to enable charging:
  - "abracon,tc-diode": should be "standard" (0.6V) or "schottky" (0.3V)
  - "abracon,tc-resistor": should be <0>, <3>, <6> or <11>. 0 disables the output
                           resistor, the other values are in kOhm.
+
+All of the devices can have a 47pf capacitor attached to increase the
+autocalibration accuracy of their RC oscillators. To enable or disable usage
+of the capacitor the following property can be defined:
Quoted 8 lines

Documentation/devicetree/bindings/rtc/abracon,abx80x.txt and valid to enable charging: · line 39

Quoted 4 lines
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +4 -0
+
+ - "abracon,autocal-filter": should be <0> or <1>. 0 indicates that there
+                             is no capacitor attached, 1 indicates that there
+                             is a capacitor attached.

What does not present mean? If you don't have a defined meaning (such as maintain the default/bootloader initialized setting), then make this boolean.

Quoted 2 lines

That is the intended meaning (leave the current setting unmodified). I can add that to the documentation so it is clear.

Can you do that and send v4 please?

Signature · 3 lines
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#6 lore raw
In reply to Rob Herring

Hi Rob,

Quoted 27 lines · Rob Herring
Quoted 26 lines · Kevin P. Fleming

Add a property to allow control of the autocalibration filter capacitor.

Cc Alessandro Zummo <[email protected]>
Cc Alexandre Belloni <[email protected]>
Cc Rob Herring <[email protected]>

To: [email protected]
To: [email protected]
---
v3: corrected whitespace

 Documentation/devicetree/bindings/rtc/abracon,abx80x.txt | 8 ++++++++
 1 file changed, 8 insertions(+)
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +4 -0
index 2405e35a1bc0f..1b606e33d1a83 100644
@@ -29,3 +29,11 @@ and valid to enable charging:
  - "abracon,tc-diode": should be "standard" (0.6V) or "schottky" (0.3V)
  - "abracon,tc-resistor": should be <0>, <3>, <6> or <11>. 0 disables the output
                           resistor, the other values are in kOhm.
+
+All of the devices can have a 47pf capacitor attached to increase the
+autocalibration accuracy of their RC oscillators. To enable or disable usage
+of the capacitor the following property can be defined:
Quoted 8 lines

Documentation/devicetree/bindings/rtc/abracon,abx80x.txt and valid to enable charging: · line 39

Quoted 4 lines
Documentation/devicetree/bindings/rtc/abracon,abx80x.txt +4 -0
+
+ - "abracon,autocal-filter": should be <0> or <1>. 0 indicates that there
+                             is no capacitor attached, 1 indicates that there
+                             is a capacitor attached.

What does not present mean? If you don't have a defined meaning (such as maintain the default/bootloader initialized setting), then make this boolean.

We discussed that on the previous revision. Not present means keeping the current value. Like most RTC registers, this is battery backed and it is expected to persist across reboots. If it has ever been initialized to a value, (e.g. by the bootloader), then we need a way to have the driver not change it.

Signature · 3 lines
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com