:orphan:
.. raw:: html
.. dtcompatible:: maxim,max30101
.. _dtbinding_maxim_max30101:
maxim,max30101 (on i2c bus)
###########################
.. sidebar:: Overview
:Name: ``maxim,max30101``
:Vendor: :ref:`Maxim Integrated Products `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=maxim,max30101>` using
this compatible
:Driver: :zephyr_file:`drivers/sensor/maxim/max30101/max30101.c`
Description
***********
.. code-block:: none
MAX30101 heart rate sensor
Properties
**********
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``irq-gpios``
- ``phandle-array``
- .. code-block:: none
Active low interrupt signal. It is an open drain signal, so it
require either hardware or software pull-up.
* - ``fifo-rollover-en``
- ``boolean``
- .. code-block:: none
Controls the behavior of the FIFO when the FIFO becomes completely
filled with data. If set, the FIFO address rolls over to zero and the
FIFO continues to fill with new data. If not set, then the FIFO is
not updated until FIFO_DATA is read or the WRITE/READ pointer
positions are changed.
* - ``fifo-watermark``
- ``int``
- .. code-block:: none
Configure the trigger for the FIFO_WATERMARK interrupt (e.g. if set to 2,
then the flag is set when the 30th word is written to the FIFO).
Default set to 0, same as after Power Reset. Range: 0 - 15.
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``12``, ``13``, ``14``, ``15``
* - ``acq-mode``
- ``string``
- .. code-block:: none
Set the operation mode of the MAX30101.
This property is **required**.
Legal values: ``'multi-led'``, ``'heart-rate'``, ``'spo2'``
* - ``smp-ave``
- ``int``
- .. code-block:: none
To reduce the amount of data throughput, adjacent samples (in each
individual channel) can be averaged and decimated on the chip.
Default set to 1 for no averaging, same as after Power Reset.
Default value: ``1``
Legal values: ``1``, ``2``, ``4``, ``8``, ``16``, ``32``
* - ``adc-rge``
- ``int``
- .. code-block:: none
Set the ADC's full-scale range at 18 bits resolution.
Default set to 8192, compromise between precision and consumption.
Default value: ``8192``
Legal values: ``2048``, ``4096``, ``8192``, ``16384``
* - ``smp-sr``
- ``int``
- .. code-block:: none
Set the effective sampling rate with one sample consisting of one
pulse/conversion per active LED channel. In SpO2 mode, these means
one IR pulse/conversion and one red pulse/conversion per sample
period. Only one RED pulse/conversion in HR mode.
Default set to 50 Hz, same as after Power Reset.
Default value: ``50``
Legal values: ``50``, ``100``, ``200``, ``400``, ``800``, ``1000``, ``1600``, ``3200``
* - ``led-pw``
- ``int``
- .. code-block:: none
Set the pulse width for each LED to control the integration time
of the ADC in us. The ADC resolution is directly related to the
integration time.
Default set to 69 us, same as after Power Reset.
Default value: ``69``
Legal values: ``69``, ``118``, ``215``, ``411``
* - ``led-pa``
- ``uint8-array``
- .. code-block:: none
Set the pulse amplitude to control the LED current. The actual
measured LED current for each part can vary significantly due to the
trimming methodology.
[0]: Red LED
[1]: IR LED
[2]: Green LED
Default set to [0xff, 0xff, 0xff], activate any chosen LED channel.
Value range: 0x00 - 0xFF | 0.0 mA - 50.0 mA
Default value: ``[255, 255, 255]``
* - ``led-slot``
- ``array``
- .. code-block:: none
Set which LED are active in each time slot for Multi-LED mode only.
0: None (Disabled)
1: Red LED
2: InfraRed LED
3: Green LED
Default set to [0, 0, 0, 0], no LED activated in multi-LED mode.
User needs to choose wich LED is active for each slot.
NOTE: If a LED is present on multiple slots, `sensor_channel_get`
will result in the averaging of the values.
Default value: ``[0, 0, 0, 0]``
* - ``friendly-name``
- ``string``
- .. code-block:: none
Human readable string describing the sensor. It can be used to
distinguish multiple instances of the same model (e.g., lid accelerometer
vs. base accelerometer in a laptop) to a host operating system.
This property is defined in the Generic Sensor Property Usages of the HID
Usage Tables specification
(https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).
* - ``supply-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO specifier that controls power to the device.
This property should be provided when the device has a dedicated
switch that controls power to the device. The supply state is
entirely the responsibility of the device driver.
Contrast with vin-supply.
* - ``vin-supply``
- ``phandle``
- .. code-block:: none
Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.
This property should be provided when device power is supplied
by a shared regulator. The supply state is dependent on the
request status of all devices fed by the regulator.
Contrast with supply-gpios. If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.
.. group-tab:: Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
.. group-tab:: Base properties
Properties inherited from the base binding file, which defines
common properties that may be set on many nodes. Not all of these
may apply to the "maxim,max30101" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
* - ``clock-names``
- ``string-array``
- .. code-block:: none
Optional names given to each clock provider in the "clocks" property.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" property.
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``wakeup-source``
- ``boolean``
- .. code-block:: none
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
* - ``zephyr,disabling-power-states``
- ``phandles``
- .. code-block:: none
List of power states that will disable this device power.