GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / iio / health / maxim,max30100.yaml
1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/iio/health/maxim,max30100.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Maxim MAX30100 heart rate and pulse oximeter sensor
8
9 maintainers:
10   - Matt Ranostay <matt.ranostay@konsulko.com>
11
12 properties:
13   compatible:
14     const: maxim,max30100
15
16   reg:
17     maxItems: 1
18
19   interrupts:
20     maxItems: 1
21     description: Connected to ADC_RDY pin.
22
23   maxim,led-current-microamp:
24     minItems: 2
25     maxItems: 2
26     description: |
27       LED current whilst the engine is running. First indexed value is
28       the configuration for the RED LED, and second value is for the IR LED.
29
30 additionalProperties: false
31
32 required:
33   - compatible
34   - reg
35   - interrupts
36
37 examples:
38   - |
39     i2c {
40         #address-cells = <1>;
41         #size-cells = <0>;
42
43         heart-rate@57 {
44             compatible = "maxim,max30100";
45             reg = <0x57>;
46             maxim,led-current-microamp = <24000 50000>;
47             interrupt-parent = <&gpio1>;
48             interrupts = <16 2>;
49         };
50     };
51 ...