Re: [PATCH v2 1/2] dt-bindings: iio: pressure: add honeywell,hsc030

[Krzysztof Kozlowski]

On 17/11/2023 20:22, Petre Rodan wrote:
> Adds binding for digital Honeywell TruStability HSC and SSC series pressure 
> and temperature sensors.
> 
> Datasheet:
>  [HSC] https://prod-edam.honeywell.com/content/dam/honeywell-edam/sps/siot/en-us/products/sensors/pressure-sensors/board-mount-pressure-sensors/trustability-hsc-series/documents/sps-siot-trustability-hsc-series-high-accuracy-board-mount-pressure-sensors-50099148-a-en-ciid-151133.pdf
>  [SSC] https://prod-edam.honeywell.com/content/dam/honeywell-edam/sps/siot/en-us/products/sensors/pressure-sensors/board-mount-pressure-sensors/trustability-ssc-series/documents/sps-siot-trustability-ssc-series-standard-accuracy-board-mount-pressure-sensors-50099533-a-en-ciid-151134.pdf
> 
> Signed-off-by: Petre Rodan <petre.rodan@xxxxxxxxxxxxxxx>
> ---
> 
> Changes for v2:
> - Removed redundant quotations reported by robh's bot
> - Fixed yamllint warnings
> 
> I'm failing to run 'make DT_CHECKER_FLAGS=-m dt_binding_check' due to
> python errors and exceptions
> ---
>  .../iio/pressure/honeywell,hsc030pa.yaml      | 156 ++++++++++++++++++
>  1 file changed, 156 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml b/Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml
> new file mode 100644
> index 000000000000..c7e5d3bd5ef4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml
> @@ -0,0 +1,156 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/pressure/honeywell,hsc030pa.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Honeywell TruStability HSC and SSC pressure sensor families
> +
> +description: |
> +  support for Honeywell TruStability HSC and SSC digital pressure sensor
> +  families.
> +
> +  These sensors have either an I2C, an SPI or an analog interface. Only the
> +  digital versions are supported by this driver.
> +
> +  There are 118 models with different pressure ranges available in each family.
> +  The vendor calls them "HSC series" and "SSC series". All of them have an
> +  identical programming model but differ in pressure range, unit and transfer
> +  function.
> +
> +  To support different models one need to specify the pressure range as well as
> +  the transfer function. Pressure range can either be provided via range_str or
> +  in case it's a custom chip via numerical range limits converted to pascals.
> +
> +  The transfer function defines the ranges of raw conversion values delivered
> +  by the sensor. pmin-pascal and pmax-pascal corespond to the minimum and
> +  maximum pressure that can be measured.
> +
> +  Specifications about the devices can be found at:
> +  https://prod-edam.honeywell.com/content/dam/honeywell-edam/sps/siot/en-us/products/sensors/pressure-sensors/board-mount-pressure-sensors/trustability-hsc-series/documents/sps-siot-trustability-hsc-series-high-accuracy-board-mount-pressure-sensors-50099148-a-en-ciid-151133.pdf
> +  https://prod-edam.honeywell.com/content/dam/honeywell-edam/sps/siot/en-us/products/sensors/pressure-sensors/board-mount-pressure-sensors/trustability-ssc-series/documents/sps-siot-trustability-ssc-series-standard-accuracy-board-mount-pressure-sensors-50099533-a-en-ciid-151134.pdf
> +
> +maintainers:
> +  - Petre Rodan <petre.rodan@xxxxxxxxxxxxxxx>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - honeywell,hsc

Way too generic

> +      - honeywell,ssc

Way too generic

> +
> +  reg:
> +    maxItems: 1
> +
> +  honeywell,transfer-function:
> +    description: |
> +      Transfer function which defines the range of valid values delivered by
> +      the sensor.
> +      0 - A, 10% to 90% of 2^14
> +      1 - B, 5% to 95% of 2^14
> +      2 - C, 5% to 85% of 2^14
> +      3 - F, 4% to 94% of 2^14
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +
> +  honeywell,range_str:

No underscores in property names.

"str" is redundant. Instead say what is it, because "range" is way too
vague.

> +    description: |
> +      Five character string that defines "pressure range, unit and type"
> +      as part of the device nomenclature. In the unlikely case of a custom
> +      chip, set to "NA" and provide honeywell,pmin-pascal honeywell,pmax-pascal
> +    enum: [001BA, 1.6BA, 2.5BA, 004BA, 006BA, 010BA, 1.6MD, 2.5MD, 004MD,
> +           006MD, 010MD, 016MD, 025MD, 040MD, 060MD, 100MD, 160MD, 250MD,
> +           400MD, 600MD, 001BD, 1.6BD, 2.5BD, 004BD, 2.5MG, 004MG, 006MG,
> +           010MG, 016MG, 025MG, 040MG, 060MG, 100MG, 160MG, 250MG, 400MG,
> +           600MG, 001BG, 1.6BG, 2.5BG, 004BG, 006BG, 010BG, 100KA, 160KA,
> +           250KA, 400KA, 600KA, 001GA, 160LD, 250LD, 400LD, 600LD, 001KD,
> +           1.6KD, 2.5KD, 004KD, 006KD, 010KD, 016KD, 025KD, 040KD, 060KD,
> +           100KD, 160KD, 250KD, 400KD, 250LG, 400LG, 600LG, 001KG, 1.6KG,
> +           2.5KG, 004KG, 006KG, 010KG, 016KG, 025KG, 040KG, 060KG, 100KG,
> +           160KG, 250KG, 400KG, 600KG, 001GG, 015PA, 030PA, 060PA, 100PA,
> +           150PA, 0.5ND, 001ND, 002ND, 004ND, 005ND, 010ND, 020ND, 030ND,
> +           001PD, 005PD, 015PD, 030PD, 060PD, 001NG, 002NG, 004NG, 005NG,
> +           010NG, 020NG, 030NG, 001PG, 005PG, 015PG, 030PG, 060PG, 100PG,
> +           150PG, NA]
> +    $ref: /schemas/types.yaml#/definitions/string
> +
> +  honeywell,pmin-pascal:
> +    description: |
> +      Minimum pressure value the sensor can measure in pascal.
> +      To be specified only if honeywell,range_str is set to "NA".
> +    $ref: /schemas/types.yaml#/definitions/int32

That's uint32. Why do you need negative values?

> +
> +  honeywell,pmax-pascal:
> +    description: |
> +      Maximum pressure value the sensor can measure in pascal.
> +      To be specified only if honeywell,range_str is set to "NA".
> +    $ref: /schemas/types.yaml#/definitions/int32

Ditto

> +
> +  vdd-supply:
> +    description: |
> +      Provide VDD power to the sensor (either 3.3V or 5V depending on the chip).
> +      Optional, activate only if required by the target board.

Drop the last sentence. The supplies are required not by target board
but by hardware. I also do not understand what "activate" means in terms
of bindings and DTS.

> +
> +  spi-max-frequency:
> +    description: SPI clock to be kept between 50 and 800kHz

Drop description, add minimum/maximum constraints if worth.

> +
> +  clock-frequency:
> +    description: i2c clock to be kept between 100 and 400kHz

Drop, that's not really an I2C device property. Your driver must use
common clock framework.

> +
> +required:
> +  - compatible
> +  - reg
> +  - honeywell,transfer-function
> +  - honeywell,range_str
> +  - clock-frequency

Why?

> +  - spi-max-frequency
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    i2c {
> +        status = "okay";

?!? Drop

> +        clock-frequency = <400000>;

Drop

> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        HSCMRNN030PA2A3@28 {

Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation

Plus, upper case is not allowed...

> +          status = "okay";

Drop. BTW status never comes first!

> +          compatible = "honeywell,hsc";
> +          reg = <0x28>;
> +
> +          honeywell,transfer-function = <0>;
> +          honeywell,range_str = "030PA";
> +        };
> +    };
> +
> +    spi {
> +        # note that MOSI is not required by this sensor

This should be then part of description, not example.

> +        status = "okay";

Drop

> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        HSCMLNN100PASA3@0 {

Eh...

> +          status = "okay";

Drop

> +          compatible = "honeywell,hsc";
> +          reg = <0>;
> +          spi-max-frequency = <800000>;
> +
> +          honeywell,transfer-function = <0>;
> +          honeywell,range_str = "100PA";
> +        };
> +
> +        HSC_CUSTOM_CHIP@0 {

Drop, not needed. One example is enough.

> +          status = "okay";
> +          compatible = "honeywell,hsc";
> +          reg = <1>;
> +          spi-max-frequency = <800000>;

Also, your indentation is broken.

Use 4 spaces for example indentation.

> +
> +          honeywell,transfer-function = <0>;
> +          honeywell,range_str = "NA";
> +          honeywell,pmin-pascal = <0>;
> +          honeywell,pmax-pascal = <206850>;
> +        };
> +

No stray blank lines.

Best regards,
Krzysztof