Add support for DTS bindings to the shtc driver
The patches add the compatible table and of_property_read_bool to the
shtc1.c. Newly created Yaml document has been released to the
Documentation/devicetree/hwmon/sensirion,shtc1.yaml
Signed-off-by: Chris Ruehl <[email protected]>
---
Version 4
Fix errors report by make dt_binding_check (devicetree)
Set maintainers for the yaml document to my own.
Version 3
Fix errors report with checkpatch.pl
Correct logic, add (!) when check for sensirion,low_precision
Version 2
remove the #ifdef CONFIG_OF
ignore platform data if dev->of_node is valid
use boolean only therefor use sensirion,low_precise to fit the logic
add missing driver.of_match_table entry
Version 1
initial version
Add support for DTS bindings for the sensirion shtc1,shtw1 and shtc3.
Signed-off-by: Chris Ruehl <[email protected]>
Reviewed-by: Guenter Roeck <[email protected]>
---
drivers/hwmon/shtc1.c | 25 ++++++++++++++++++++++---
1 file changed, 22 insertions(+), 3 deletions(-)
diff --git a/drivers/hwmon/shtc1.c b/drivers/hwmon/shtc1.c
index a0078ccede03..827d421b2b8f 100644
--- a/drivers/hwmon/shtc1.c
+++ b/drivers/hwmon/shtc1.c
@@ -14,6 +14,7 @@
#include <linux/err.h>
#include <linux/delay.h>
#include <linux/platform_data/shtc1.h>
+#include <linux/of.h>
/* commands (high precision mode) */
static const unsigned char shtc1_cmd_measure_blocking_hpm[] = { 0x7C, 0xA2 };
@@ -196,6 +197,7 @@ static int shtc1_probe(struct i2c_client *client,
enum shtcx_chips chip = id->driver_data;
struct i2c_adapter *adap = client->adapter;
struct device *dev = &client->dev;
+ struct device_node *np = dev->of_node;
if (!i2c_check_functionality(adap, I2C_FUNC_I2C)) {
dev_err(dev, "plain i2c transactions not supported\n");
@@ -233,8 +235,14 @@ static int shtc1_probe(struct i2c_client *client,
data->client = client;
data->chip = chip;
- if (client->dev.platform_data)
- data->setup = *(struct shtc1_platform_data *)dev->platform_data;
+ if (np) {
+ data->setup.blocking_io = of_property_read_bool(np, "sensirion,blocking_io");
+ data->setup.high_precision = !of_property_read_bool(np, "sensicon,low_precision");
+ } else {
+ if (client->dev.platform_data)
+ data->setup = *(struct shtc1_platform_data *)dev->platform_data;
+ }
+
shtc1_select_command(data);
mutex_init(&data->update_lock);
@@ -257,8 +265,19 @@ static const struct i2c_device_id shtc1_id[] = {
};
MODULE_DEVICE_TABLE(i2c, shtc1_id);
+static const struct of_device_id shtc1_of_match[] = {
+ { .compatible = "sensirion,shtc1" },
+ { .compatible = "sensirion,shtw1" },
+ { .compatible = "sensirion,shtc3" },
+ { }
+};
+MODULE_DEVICE_TABLE(of, shtc1_of_match);
+
static struct i2c_driver shtc1_i2c_driver = {
- .driver.name = "shtc1",
+ .driver = {
+ .name = "shtc1",
+ .of_match_table = shtc1_of_match,
+ },
.probe = shtc1_probe,
.id_table = shtc1_id,
};
--
2.20.1
Add documentation for the newly added DTS support in the shtc1 driver.
To align with the drivers logic to have high precision by default
a boolean sensirion,low_precision is used to switch to low precision.
Signed-off-by: Chris Ruehl <[email protected]>
---
.../bindings/hwmon/sensirion,shtc1.yaml | 60 +++++++++++++++++++
1 file changed, 60 insertions(+)
create mode 100644 Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
diff --git a/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
new file mode 100644
index 000000000000..6725a7b646b7
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
@@ -0,0 +1,60 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwmon/sensirion,shtc1.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sensirion SHTC1 Humidity and Temperature Sensor IC
+
+maintainers:
+ - [email protected]
+
+description: |
+ The SHTC1, SHTW1 and SHTC3 are digital humidity and temperature sensor
+ designed especially for battery-driven high-volume consumer electronics
+ applications.
+ For further information refere to Documentation/hwmon/shtc1.rst
+
+ This binding document describes the binding for the hardware monitor
+ portion of the driver.
+
+properties:
+ compatible:
+ enum:
+ - sensirion,shtc1
+ - sensirion,shtw1
+ - sensirion,shtc3
+
+ reg:
+ maxItems: 1
+ description: I2C address 0x70
+
+ sensirion,blocking_io:
+ $ref: /schemas/types.yaml#definitions/flag
+ description:
+ If set the i2c bus hold until measure finished.
+
+ sensirion,low_precision:
+ $ref: /schemas/types.yaml#definitions/flag
+ description:
+ If set aquire data with low precision (not recommended).
+ The driver aquire data with high precision by default.
+
+required:
+ - compatible
+ - reg
+
+examples:
+ - |
+ i2c1 {
+ status = "okay";
+ clock-frequency = <400000>;
+
+ shtc3@70 {
+ compatible = "sensirion,shtc3";
+ reg = <0x70>
+ sensirion,blocking_io;
+ status = "okay";
+ };
+ };
+...
--
2.20.1
On Wed, 08 Jul 2020 12:07:47 +0800, Chris Ruehl wrote:
> Add documentation for the newly added DTS support in the shtc1 driver.
> To align with the drivers logic to have high precision by default
> a boolean sensirion,low_precision is used to switch to low precision.
>
> Signed-off-by: Chris Ruehl <[email protected]>
> ---
> .../bindings/hwmon/sensirion,shtc1.yaml | 60 +++++++++++++++++++
> 1 file changed, 60 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
>
My bot found errors running 'make dt_binding_check' on your patch:
Error: Documentation/devicetree/bindings/hwmon/sensirion,shtc1.example.dts:26.13-14 syntax error
FATAL ERROR: Unable to parse input tree
scripts/Makefile.lib:315: recipe for target 'Documentation/devicetree/bindings/hwmon/sensirion,shtc1.example.dt.yaml' failed
make[1]: *** [Documentation/devicetree/bindings/hwmon/sensirion,shtc1.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
Makefile:1347: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2
See https://patchwork.ozlabs.org/patch/1324936
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure dt-schema is up to date:
pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade
Please check and re-submit.
On Wed, Jul 08, 2020 at 12:07:47PM +0800, Chris Ruehl wrote:
> Add documentation for the newly added DTS support in the shtc1 driver.
> To align with the drivers logic to have high precision by default
> a boolean sensirion,low_precision is used to switch to low precision.
>
> Signed-off-by: Chris Ruehl <[email protected]>
> ---
> .../bindings/hwmon/sensirion,shtc1.yaml | 60 +++++++++++++++++++
> 1 file changed, 60 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
>
> diff --git a/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
> new file mode 100644
> index 000000000000..6725a7b646b7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/sensirion,shtc1.yaml
> @@ -0,0 +1,60 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/hwmon/sensirion,shtc1.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Sensirion SHTC1 Humidity and Temperature Sensor IC
> +
> +maintainers:
> + - [email protected]
> +
> +description: |
> + The SHTC1, SHTW1 and SHTC3 are digital humidity and temperature sensor
> + designed especially for battery-driven high-volume consumer electronics
> + applications.
> + For further information refere to Documentation/hwmon/shtc1.rst
> +
> + This binding document describes the binding for the hardware monitor
> + portion of the driver.
> +
> +properties:
> + compatible:
> + enum:
> + - sensirion,shtc1
> + - sensirion,shtw1
> + - sensirion,shtc3
> +
> + reg:
> + maxItems: 1
> + description: I2C address 0x70
If 0x70 is the only address, then do:
reg:
const: 0x70
> +
> + sensirion,blocking_io:
s/_/-/
> + $ref: /schemas/types.yaml#definitions/flag
> + description:
> + If set the i2c bus hold until measure finished.
> +
> + sensirion,low_precision:
> + $ref: /schemas/types.yaml#definitions/flag
s/_/-/
> + description:
> + If set aquire data with low precision (not recommended).
> + The driver aquire data with high precision by default.
> +
> +required:
> + - compatible
> + - reg
> +
> +examples:
> + - |
> + i2c1 {
> + status = "okay";
Don't show status in examples.
> + clock-frequency = <400000>;
> +
> + shtc3@70 {
> + compatible = "sensirion,shtc3";
> + reg = <0x70>
> + sensirion,blocking_io;
> + status = "okay";
> + };
> + };
> +...
> --
> 2.20.1
>
Hi Rob,
On 10/7/2020 12:51 am, Rob Herring wrote:
> On Wed, Jul 08, 2020 at 12:07:47PM +0800, Chris Ruehl wrote:
>> Add documentation for the newly added DTS support in the shtc1 driver.
>> To align with the drivers logic to have high precision by default
>
> If 0x70 is the only address, then do:
>
> reg:
> const: 0x70
yes, that make sense.
>
>> +
>> + sensirion,blocking_io:
>
> s/_/-/
done!
>> +
>> +examples:
>> + - |
>> + i2c1 {
>> + status = "okay";
>
> Don't show status in examples.
Thanks for your advice.
updated and patch set v5 is out soon.
Chris