Documentation/devicetree/bindings/iio/pressure/honeywell,hsc030pa.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/iio/pressure/honeywell,hsc030pa.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Honeywell TruStability HSC and SSC pressure sensor series
   8
   9 description: |
  10   support for Honeywell TruStability HSC and SSC digital pressure sensor
  11   series.
  12
  13   These sensors have either an I2C, an SPI or an analog interface. Only the
  14   digital versions are supported by this driver.
  15
  16   There are 118 models with different pressure ranges available in each family.
  17   The vendor calls them "HSC series" and "SSC series". All of them have an
  18   identical programming model but differ in pressure range, unit and transfer
  19   function.
  20
  21   To support different models one needs to specify the pressure range as well
  22   as the transfer function. Pressure range can either be provided via
  23   pressure-triplet (directly extracted from the part number) or in case it's
  24   a custom chip via numerical range limits converted to pascals.
  25
  26   The transfer function defines the ranges of raw conversion values delivered
  27   by the sensor. pmin-pascal and pmax-pascal corespond to the minimum and
  28   maximum pressure that can be measured.
  29
  30   Please note that in case of an SPI-based sensor, the clock signal should not
  31   exceed 800kHz and the MOSI signal is not required.
  32
  33   Specifications about the devices can be found at:
  34   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
  35   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
  36
  37 maintainers:
  38   - Petre Rodan <petre.rodan@subdimension.ro>
  39
  40 properties:
  41   compatible:
  42     const: honeywell,hsc030pa
  43
  44   reg:
  45     maxItems: 1
  46
  47   honeywell,transfer-function:
  48     description: |
  49       Transfer function which defines the range of valid values delivered by
  50       the sensor.
  51       0 - A, 10% to 90% of 2^14
  52       1 - B, 5% to 95% of 2^14
  53       2 - C, 5% to 85% of 2^14
  54       3 - F, 4% to 94% of 2^14
  55     enum: [0, 1, 2, 3]
  56     $ref: /schemas/types.yaml#/definitions/uint32
  57
  58   honeywell,pressure-triplet:
  59     description: |
  60       Case-sensitive five character string that defines pressure range, unit
  61       and type as part of the device nomenclature. In the unlikely case of a
  62       custom chip, set to "NA" and provide pmin-pascal and pmax-pascal.
  63     enum: [001BA, 1.6BA, 2.5BA, 004BA, 006BA, 010BA, 1.6MD, 2.5MD, 004MD,
  64            006MD, 010MD, 016MD, 025MD, 040MD, 060MD, 100MD, 160MD, 250MD,
  65            400MD, 600MD, 001BD, 1.6BD, 2.5BD, 004BD, 2.5MG, 004MG, 006MG,
  66            010MG, 016MG, 025MG, 040MG, 060MG, 100MG, 160MG, 250MG, 400MG,
  67            600MG, 001BG, 1.6BG, 2.5BG, 004BG, 006BG, 010BG, 100KA, 160KA,
  68            250KA, 400KA, 600KA, 001GA, 160LD, 250LD, 400LD, 600LD, 001KD,
  69            1.6KD, 2.5KD, 004KD, 006KD, 010KD, 016KD, 025KD, 040KD, 060KD,
  70            100KD, 160KD, 250KD, 400KD, 250LG, 400LG, 600LG, 001KG, 1.6KG,
  71            2.5KG, 004KG, 006KG, 010KG, 016KG, 025KG, 040KG, 060KG, 100KG,
  72            160KG, 250KG, 400KG, 600KG, 001GG, 015PA, 030PA, 060PA, 100PA,
  73            150PA, 0.5ND, 001ND, 002ND, 004ND, 005ND, 010ND, 020ND, 030ND,
  74            001PD, 005PD, 015PD, 030PD, 060PD, 001NG, 002NG, 004NG, 005NG,
  75            010NG, 020NG, 030NG, 001PG, 005PG, 015PG, 030PG, 060PG, 100PG,
  76            150PG, NA]
  77     $ref: /schemas/types.yaml#/definitions/string
  78
  79   honeywell,pmin-pascal:
  80     description: |
  81       Minimum pressure value the sensor can measure in pascal.
  82       To be specified only if honeywell,pressure-triplet is set to "NA".
  83
  84   honeywell,pmax-pascal:
  85     description: |
  86       Maximum pressure value the sensor can measure in pascal.
  87       To be specified only if honeywell,pressure-triplet is set to "NA".
  88
  89   vdd-supply:
  90     description:
  91       Provide VDD power to the sensor (either 3.3V or 5V depending on the chip)
  92
  93   spi-max-frequency:
  94     maximum: 800000
  95
  96 required:
  97   - compatible
  98   - reg
  99   - honeywell,transfer-function
 100   - honeywell,pressure-triplet
 101
 102 allOf:
 103   - $ref: /schemas/spi/spi-peripheral-props.yaml
 104
 105 additionalProperties: false
 106
 107 dependentSchemas:
 108   honeywell,pmin-pascal:
 109     properties:
 110       honeywell,pressure-triplet:
 111         const: NA
 112   honeywell,pmax-pascal:
 113     properties:
 114       honeywell,pressure-triplet:
 115         const: NA
 116
 117 examples:
 118   - |
 119     i2c {
 120         #address-cells = <1>;
 121         #size-cells = <0>;
 122
 123         pressure@28 {
 124             compatible = "honeywell,hsc030pa";
 125             reg = <0x28>;
 126             honeywell,transfer-function = <0>;
 127             honeywell,pressure-triplet = "030PA";
 128         };
 129     };
 130   - |
 131     spi {
 132         #address-cells = <1>;
 133         #size-cells = <0>;
 134
 135         pressure@0 {
 136             compatible = "honeywell,hsc030pa";
 137             reg = <0>;
 138             spi-max-frequency = <800000>;
 139             honeywell,transfer-function = <0>;
 140             honeywell,pressure-triplet = "NA";
 141             honeywell,pmin-pascal = <0>;
 142             honeywell,pmax-pascal = <200000>;
 143         };
 144     };
 145 ...