:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: ti,tmag3001
.. _dtbinding_ti_tmag3001:

ti,tmag3001 (on i2c bus)
########################

Vendor: :ref:`Texas Instruments <dt_vendor_ti>`

Description
***********



.. code-block:: none

   TMAG3001 Low-Power 3D Linear and Angle Hall-Effect Sensor With I2C Interface
   and Wake Up Detection in WCSP.

   See the specification for the default I2C address.

   The specification of the sensor can be found at:
     https://www.ti.com/lit/ds/symlink/tmag3001.pdf

   Currently, this driver shares implementation with tmag5273. When setting the
   enum properties in a .dts or .dtsi file you may include
   `zephyr/dt-bindings/sensor/tmag5273.h` and use the macros defined there.

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

         * - ``operation-mode``
           - ``int``
           - .. code-block:: none

                Sensor mode used if set to "active".
                Defaults to continuous sampling (TMAG5273_DT_OPER_MODE_CONTINUOUS).

                - 0 # TMAG5273_DT_OPER_MODE_CONTINUOUS (continuous)
                - 1 # TMAG5273_DT_OPER_MODE_STANDBY    (standby)



             Legal values: ``0``, ``1``

         * - ``axis``
           - ``int``
           - .. code-block:: none

                Magnet axis channel inputs.
                Defaults to measure all axis (TMAG5273_DT_AXIS_XYZ).

                - 0  # TMAG5273_DT_AXIS_NONE
                - 1  # TMAG5273_DT_AXIS_X
                - 2  # TMAG5273_DT_AXIS_Y
                - 3  # TMAG5273_DT_AXIS_Z
                - 4  # TMAG5273_DT_AXIS_XY
                - 5  # TMAG5273_DT_AXIS_XZ
                - 6  # TMAG5273_DT_AXIS_YZ
                - 7  # TMAG5273_DT_AXIS_XYZ
                - 8  # TMAG5273_DT_AXIS_XYX (pseudo-simultaneous sampling)
                - 9  # TMAG5273_DT_AXIS_YXY (pseudo-simultaneous sampling)
                - 10 # TMAG5273_DT_AXIS_YZY (pseudo-simultaneous sampling)
                - 11 # TMAG5273_DT_AXIS_XZX (pseudo-simultaneous sampling)



             Default value: ``7``

             Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``

         * - ``temperature``
           - ``boolean``
           - .. code-block:: none

                Select for temperature measurement.



         * - ``range``
           - ``int``
           - .. code-block:: none

                XYZ-measurement range for magnetic-field value.
                Defaults to lower range (higher resolution; TMAG5273_DT_AXIS_RANGE_LOW).

                - 0 # TMAG5273_DT_AXIS_RANGE_LOW      (+/-40 mT (TMAG5273A1) or +/-133 mT (TMAG5273A2))
                - 1 # TMAG5273_DT_AXIS_RANGE_HIGH     (+/-80 mT (TMAG5273A1) or +/-266 mT (TMAG5273A2))
                - 2 # TMAG5273_DT_AXIS_RANGE_RUNTIME  (@runtime (initial value is: "high"))



             Default value: ``1``

             Legal values: ``0``, ``1``, ``2``

         * - ``int-gpios``
           - ``phandle-array``
           - .. code-block:: none

                The INT signal connection.

                The signal is active-low as produced by the sensor.
                Either used for interrupt signaling, or triggering a conversion.



         * - ``temperature-coefficient``
           - ``int``
           - .. code-block:: none

                Selects the magnet temperature coefficient.
                Defaults to none (TMAG5273_DT_TEMP_COEFF_NONE).

                  - 0 # TMAG5273_DT_TEMP_COEFF_NONE    (none)
                  - 1 # TMAG5273_DT_TEMP_COEFF_NDBFE   (0.12 %/deg C (NdBFe))
                  - 2 # TMAG5273_DT_TEMP_COEFF_CERAMIC (0.2 %/deg C (Ceramic))

                Ignored if temperature is not measured.



             Legal values: ``0``, ``1``, ``2``

         * - ``trigger-conversion-via-int``
           - ``boolean``
           - .. code-block:: none

                Selects initiation of a single conversion based on a trigger via
                the INT-pin if enabled, and via I2C-command if disabled.

                Used in "standby"-, "wakeup-and-sleep"- and "sleep"-mode.
                Using I2C-conversion trigger may result in (handled) I2C-errors.



         * - ``angle-magnitude-axis``
           - ``int``
           - .. code-block:: none

                Enables angle calculation, magnetic gain, and offset corrections
                between two selected magnetic channels.
                Defaults to no additional calculations (TMAG5273_DT_ANGLE_MAG_NONE).

                - 0 # TMAG5273_DT_ANGLE_MAG_NONE    (deactivated)
                - 1 # TMAG5273_DT_ANGLE_MAG_XY      (x/y)
                - 2 # TMAG5273_DT_ANGLE_MAG_YZ      (y/z)
                - 3 # TMAG5273_DT_ANGLE_MAG_XZ      (x/z)
                - 4 # TMAG5273_DT_ANGLE_MAG_RUNTIME (@runtime (initial value is: "deactivated"))



             Legal values: ``0``, ``1``, ``2``, ``3``, ``4``

         * - ``ch-mag-gain-correction``
           - ``int``
           - .. code-block:: none

                Channel for the magnitude gain correction.
                Defaults to 1st channel.

                  - 0 # TMAG5273_DT_CORRECTION_CH_1 (1st channel)
                  - 1 # TMAG5273_DT_CORRECTION_CH_2 (2nd channel)

                Only active if angle-magnitude-calculation is active.



             Legal values: ``0``, ``1``

         * - ``average-mode``
           - ``int``
           - .. code-block:: none

                Enables additional sampling of the sensor data to reduce the noise effect
                (or to increase resolution).

                Note that averaging will influence the output data rate.
                Defaults to 2x averaging (TMAG5273_DT_AVERAGING_2X).

                - 0 # TMAG5273_DT_AVERAGING_NONE  (10.0-kSPS (3-axes) or 20-kSPS   (1 axis))
                - 1 # TMAG5273_DT_AVERAGING_2X    (5.7-kSPS  (3-axes) or 13.3-kSPS (1 axis))
                - 2 # TMAG5273_DT_AVERAGING_4X    (3.1-kSPS  (3-axes) or 8.0-kSPS  (1 axis))
                - 3 # TMAG5273_DT_AVERAGING_8X    (1.6-kSPS  (3-axes) or 4.4-kSPS  (1 axis))
                - 4 # TMAG5273_DT_AVERAGING_16X   (0.8-kSPS  (3-axes) or 2.4-kSPS  (1 axis))
                - 5 # TMAG5273_DT_AVERAGING_32X   (0.4-kSPS  (3-axes) or 1.2-kSPS  (1 axis))



             Default value: ``1``

             Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``

         * - ``crc-enabled``
           - ``boolean``
           - .. code-block:: none

                Activate I2C CRC byte to be sent.



         * - ``low-noise``
           - ``boolean``
           - .. code-block:: none

                Select low-noise mode when enabled, and low-power mode when disabled.



         * - ``ignore-diag-fail``
           - ``boolean``
           - .. code-block:: none

                Ignore detected diagnostic fail.
                According to the manual, this should be done if VCC < 2.3V.



         * - ``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 "ti,tmag3001" 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: ``'ok'``, ``'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 <u32> 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 <u32> 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



         * - ``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.