xref: /freebsd/sys/contrib/device-tree/Bindings/iio/pressure/honeywell,mprls0025pa.yaml (revision 5b56413d04e608379c9a306373554a8e4d321bc0) 
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,mprls0025pa.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Honeywell mprls0025pa pressure sensor
8
9maintainers:
10  - Andreas Klinger <ak@it-klinger.de>
11
12description: |
13  Honeywell pressure sensor of model mprls0025pa.
14
15  This sensor has an I2C and SPI interface. Only the I2C interface is
16  implemented.
17
18  There are many models with different pressure ranges available. The vendor
19  calls them "mpr series". All of them have the identical programming model and
20  differ in the pressure range, unit and transfer function.
21
22  To support different models one need to specify the pressure range as well as
23  the transfer function. Pressure range needs to be converted from its unit to
24  pascal.
25
26  The transfer function defines the ranges of numerical values delivered by the
27  sensor. The minimal range value stands for the minimum pressure and the
28  maximum value also for the maximum pressure with linear relation inside the
29  range.
30
31  Specifications about the devices can be found at:
32    https://prod-edam.honeywell.com/content/dam/honeywell-edam/sps/siot/en-us/
33      products/sensors/pressure-sensors/board-mount-pressure-sensors/
34      micropressure-mpr-series/documents/
35      sps-siot-mpr-series-datasheet-32332628-ciid-172626.pdf
36
37properties:
38  compatible:
39    const: honeywell,mprls0025pa
40
41  reg:
42    maxItems: 1
43
44  interrupts:
45    maxItems: 1
46
47  reset-gpios:
48    description:
49      Optional GPIO for resetting the device.
50      If not present the device is not reset during the probe.
51    maxItems: 1
52
53  honeywell,pmin-pascal:
54    description:
55      Minimum pressure value the sensor can measure in pascal.
56
57  honeywell,pmax-pascal:
58    description:
59      Maximum pressure value the sensor can measure in pascal.
60
61  honeywell,transfer-function:
62    description: |
63      Transfer function which defines the range of valid values delivered by the
64      sensor.
65      1 - A, 10% to 90% of 2^24 (1677722 .. 15099494)
66      2 - B, 2.5% to 22.5% of 2^24 (419430 .. 3774874)
67      3 - C, 20% to 80% of 2^24 (3355443 .. 13421773)
68    $ref: /schemas/types.yaml#/definitions/uint32
69
70  vdd-supply:
71    description: provide VDD power to the sensor.
72
73required:
74  - compatible
75  - reg
76  - honeywell,pmin-pascal
77  - honeywell,pmax-pascal
78  - honeywell,transfer-function
79  - vdd-supply
80
81additionalProperties: false
82
83examples:
84  - |
85    #include <dt-bindings/gpio/gpio.h>
86    #include <dt-bindings/interrupt-controller/irq.h>
87    i2c {
88        #address-cells = <1>;
89        #size-cells = <0>;
90
91        pressure@18 {
92            compatible = "honeywell,mprls0025pa";
93            reg = <0x18>;
94            reset-gpios = <&gpio3 19 GPIO_ACTIVE_HIGH>;
95            interrupt-parent = <&gpio3>;
96            interrupts = <21 IRQ_TYPE_EDGE_FALLING>;
97            honeywell,pmin-pascal = <0>;
98            honeywell,pmax-pascal = <172369>;
99            honeywell,transfer-function = <1>;
100            vdd-supply = <&vcc_3v3>;
101        };
102    };
103