diff mbox series

[2/3] dt-bindings: iio: chemical: sensirion,senxx: Add yaml description

Message ID 20250206061521.2546108-3-Hermes.Zhang@axis.com (mailing list archive)
State Changes Requested
Headers show
Series [1/3] iio: add IIO_MOD_NOX modifier | expand

Commit Message

Hermes Zhang Feb. 6, 2025, 6:15 a.m. UTC
Add documentation for the SEN5x/SEN6x environmental sensor from Sensirion.

Signed-off-by: Hermes Zhang <Hermes.Zhang@axis.com>
---
 .../iio/chemical/sensirion,senxx.yaml         | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml

Comments

Conor Dooley Feb. 6, 2025, 6:20 p.m. UTC | #1
On Thu, Feb 06, 2025 at 02:15:16PM +0800, Hermes Zhang wrote:
> Add documentation for the SEN5x/SEN6x environmental sensor from Sensirion.
> 
> Signed-off-by: Hermes Zhang <Hermes.Zhang@axis.com>
> ---
>  .../iio/chemical/sensirion,senxx.yaml         | 49 +++++++++++++++++++
>  1 file changed, 49 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
> new file mode 100644
> index 000000000000..4d998eabe441
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml

filename matching a compatible please.

> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/chemical/sensirion,senxx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Sensirion SEN5x/SEN6x environmental sensor
> +
> +maintainers:
> +  - Hermes Zhang <chenhuiz@axis.com>
> +
> +description: |
> +  The SEN5x/SEN6x is a sensor module family combining the measurement of air
> +  quality parameters: particulate matter, VOC, NOx, humidity, and temperature.
> +
> +  Datasheet:
> +  https://sensirion.com/media/documents/6791EFA0/62A1F68F/Sensirion_Datasheet_Environmental_Node_SEN5x.pdf
> +  https://sensirion.com/media/documents/FAFC548D/6731FFFA/Sensirion_Datasheet_SEN6x.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - sensirion,sen50
> +      - sensirion,sen54
> +      - sensirion,sen55
> +      - sensirion,sen60
> +      - sensirion,sen65
> +      - sensirion,sen66

I'd like a note in the commit message as to how all of these devices are
different please.

> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg

No supplies needed for this device? Seems like you would need at least
one, no?

> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      sen55@69 {
> +        compatible = "sensirion,sen55";
> +        reg = <0x69>;
> +      };
> +    };
> -- 
> 2.45.2
>
Hermes Zhang Feb. 8, 2025, 7:07 a.m. UTC | #2
Hi,

On 2025/2/7 2:20, Conor Dooley wrote:
> diff --git a/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
> new file mode 100644
> index 000000000000..4d998eabe441
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
> filename matching a compatible please.
So sensirion,sen66.yaml?
> +  https://sensirion.com/media/documents/6791EFA0/62A1F68F/Sensirion_Datasheet_Environmental_Node_SEN5x.pdf
> +  https://sensirion.com/media/documents/FAFC548D/6731FFFA/Sensirion_Datasheet_SEN6x.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - sensirion,sen50
> +      - sensirion,sen54
> +      - sensirion,sen55
> +      - sensirion,sen60
> +      - sensirion,sen65
> +      - sensirion,sen66
> I'd like a note in the commit message as to how all of these devices are
> different please.
Sure, will fix in v2.
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +required:
>> +  - compatible
>> +  - reg
> No supplies needed for this device? Seems like you would need at least
> one, no?

You mean the vdd-supply? The chip require a e.g. 3.3v VDD, but in our 
HW, we have no gpio/regulator to control it, connect directly by the HW, 
should I still need to have one vdd-supply here?


Best Regards,

Hermes
Conor Dooley Feb. 11, 2025, 6:44 p.m. UTC | #3
On Sat, Feb 08, 2025 at 03:07:08PM +0800, Hermes Zhang wrote:
> Hi,
> 
> On 2025/2/7 2:20, Conor Dooley wrote:
> > diff --git a/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
> > new file mode 100644
> > index 000000000000..4d998eabe441
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
> > filename matching a compatible please.
> So sensirion,sen66.yaml?
> > +  https://sensirion.com/media/documents/6791EFA0/62A1F68F/Sensirion_Datasheet_Environmental_Node_SEN5x.pdf
> > +  https://sensirion.com/media/documents/FAFC548D/6731FFFA/Sensirion_Datasheet_SEN6x.pdf
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - sensirion,sen50
> > +      - sensirion,sen54
> > +      - sensirion,sen55
> > +      - sensirion,sen60
> > +      - sensirion,sen65
> > +      - sensirion,sen66
> > I'd like a note in the commit message as to how all of these devices are
> > different please.
> Sure, will fix in v2.
> > > +
> > > +  reg:
> > > +    maxItems: 1
> > > +
> > > +required:
> > > +  - compatible
> > > +  - reg
> > No supplies needed for this device? Seems like you would need at least
> > one, no?
> 
> You mean the vdd-supply? The chip require a e.g. 3.3v VDD, but in our HW, we
> have no gpio/regulator to control it, connect directly by the HW, should I
> still need to have one vdd-supply here?

Might not be controllable in your case, but if the device needs power
from somewhere it should have one in the binding.
Hermes Zhang Feb. 12, 2025, 6:27 a.m. UTC | #4
On 2025/2/12 2:44, Conor Dooley wrote:
> On Sat, Feb 08, 2025 at 03:07:08PM +0800, Hermes Zhang wrote:
>> Hi,
>>
>> On 2025/2/7 2:20, Conor Dooley wrote:
>>> diff --git a/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
>>> new file mode 100644
>>> index 000000000000..4d998eabe441
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
>>> filename matching a compatible please.
>> So sensirion,sen66.yaml?
>>> +  https://sensirion.com/media/documents/6791EFA0/62A1F68F/Sensirion_Datasheet_Environmental_Node_SEN5x.pdf
>>> +  https://sensirion.com/media/documents/FAFC548D/6731FFFA/Sensirion_Datasheet_SEN6x.pdf
>>> +
>>> +properties:
>>> +  compatible:
>>> +    enum:
>>> +      - sensirion,sen50
>>> +      - sensirion,sen54
>>> +      - sensirion,sen55
>>> +      - sensirion,sen60
>>> +      - sensirion,sen65
>>> +      - sensirion,sen66
>>> I'd like a note in the commit message as to how all of these devices are
>>> different please.
>> Sure, will fix in v2.
>>>> +
>>>> +  reg:
>>>> +    maxItems: 1
>>>> +
>>>> +required:
>>>> +  - compatible
>>>> +  - reg
>>> No supplies needed for this device? Seems like you would need at least
>>> one, no?
>> You mean the vdd-supply? The chip require a e.g. 3.3v VDD, but in our HW, we
>> have no gpio/regulator to control it, connect directly by the HW, should I
>> still need to have one vdd-supply here?
> Might not be controllable in your case, but if the device needs power
> from somewhere it should have one in the binding.

OK, I see. I will add it in v2. Thanks.


Best Regards,

Hermes
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
new file mode 100644
index 000000000000..4d998eabe441
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/chemical/sensirion,senxx.yaml
@@ -0,0 +1,49 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/chemical/sensirion,senxx.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sensirion SEN5x/SEN6x environmental sensor
+
+maintainers:
+  - Hermes Zhang <chenhuiz@axis.com>
+
+description: |
+  The SEN5x/SEN6x is a sensor module family combining the measurement of air
+  quality parameters: particulate matter, VOC, NOx, humidity, and temperature.
+
+  Datasheet:
+  https://sensirion.com/media/documents/6791EFA0/62A1F68F/Sensirion_Datasheet_Environmental_Node_SEN5x.pdf
+  https://sensirion.com/media/documents/FAFC548D/6731FFFA/Sensirion_Datasheet_SEN6x.pdf
+
+properties:
+  compatible:
+    enum:
+      - sensirion,sen50
+      - sensirion,sen54
+      - sensirion,sen55
+      - sensirion,sen60
+      - sensirion,sen65
+      - sensirion,sen66
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      sen55@69 {
+        compatible = "sensirion,sen55";
+        reg = <0x69>;
+      };
+    };