Documentation/devicetree/bindings/iio/health/maxim,max30100.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/iio/health/maxim,max30100.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/iio/health/maxim,max30100.yaml
Extension
.yaml
Size
1404 bytes
Lines
60
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/health/maxim,max30100.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Maxim MAX30100 heart rate and pulse oximeter sensor

maintainers:
  - Matt Ranostay <matt.ranostay@konsulko.com>

properties:
  compatible:
    const: maxim,max30100

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1
    description: Connected to ADC_RDY pin.

  maxim,led-current-microamp:
    minItems: 2
    maxItems: 2
    description: |
      LED current whilst the engine is running. First indexed value is
      the configuration for the RED LED, and second value is for the IR LED.

  maxim,pulse-width-us:
    description: |
      LED pulse width in microseconds. Appropriate pulse width depends on
      factors such as optical window absorption, LED-to-sensor distance,
      and expected reflectivity of the skin or contact surface.
    enum: [200, 400, 800, 1600]
    default: 1600

additionalProperties: false

required:
  - compatible
  - reg
  - interrupts

examples:
  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        heart-rate@57 {
            compatible = "maxim,max30100";
            reg = <0x57>;
            maxim,led-current-microamp = <24000 50000>;
            interrupt-parent = <&gpio1>;
            interrupts = <16 2>;
        };
    };
...

Annotation

Implementation Notes