: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:: nordic,nrf-twim
.. _dtbinding_nordic_nrf_twim:

nordic,nrf-twim
###############

Vendor: :ref:`Nordic Semiconductor <dt_vendor_nordic>`

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

These nodes are "i2c" bus nodes.

.. code-block:: none

   Nordic nRF family TWIM (TWI master with EasyDMA).

   This binding can be used for nodes which can represent TWIM
   peripherals. A single SoC peripheral ID is often associated with
   multiple I2C peripherals, like a TWIM and a TWIS. You can choose
   TWIM by setting the node's "compatible" to "nordic,nrf-twim"
   and "status" to "okay", e.g. using an overlay file like this one:

       /* This is for TWIM0 -- change to "i2c1" for TWIM1, etc. */
       &i2c0 {
               compatible = "nordic,nrf-twim";
               status = "okay";
               /* other property settings can go here */
       };

   This works on any supported SoC, for all TWIM instances.

   Note: on nRF51 SoCs, use the "nordic,nrf-twi" binding instead.

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

         * - ``zephyr,concat-buf-size``
           - ``int``
           - .. code-block:: none

                Size of a concatenation buffer that the driver is to use for merging
                multiple same direction I2C messages that have no RESTART or STOP
                flag between them (see e.g. the i2c_burst_write() function) into one
                transfer on the bus.

                This property must be provided when interacting with devices like
                the SSD1306 display that cannot tolerate a repeated start and
                address appearing on the bus between message fragments. For many
                devices a concatenation buffer is not necessary.



             Default value: ``16``

         * - ``zephyr,flash-buf-max-size``
           - ``int``
           - .. code-block:: none

                TWIM peripherals cannot perform write transactions from buffers
                located in flash. If such buffers are expected to be used with
                a given instance of the TWIM peripheral, this property must be
                set to the maximum possible size of those buffers, so that the
                driver can reserve enough space in RAM to copy there the contents
                of particular buffers before requesting the actual transfers.

                If this property is not set to a value adequate for a given
                application, write transactions may fail for buffers that are
                located in flash, what in turn may cause certain components,
                like the DPS310 sensor driver, to not work.

                It is recommended to use the same value for this property and for
                the zephyr,concat-buf-size one, as both these buffering mechanisms
                can utilize the same space in RAM.



             Default value: ``16``

         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



             This property is **required**.

         * - ``easydma-maxcnt-bits``
           - ``int``
           - .. code-block:: none

                Maximum number of bits available in the EasyDMA MAXCNT register. This
                property must be set at SoC level DTS files.



             This property is **required**.

         * - ``clock-frequency``
           - ``int``
           - .. code-block:: none

                Initial clock frequency in Hz


         * - ``pinctrl-1``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the second state. See pinctrl-0.



         * - ``pinctrl-2``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the third state. See pinctrl-0.



         * - ``pinctrl-3``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fourth state. See pinctrl-0.



         * - ``pinctrl-4``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fifth state. See pinctrl-0.



         * - ``pinctrl-names``
           - ``string-array``
           - .. code-block:: none

                Names for the provided states. The number of names needs to match the
                number of states.



         * - ``memory-regions``
           - ``phandle-array``
           - .. code-block:: none

                List of memory region phandles


         * - ``memory-region-names``
           - ``string-array``
           - .. code-block:: none

                A list of names, one for each corresponding phandle in memory-region




   .. 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 "nordic,nrf-twim" compatible.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``reg``
           - ``array``
           - .. code-block:: none

                register space


             This property is **required**.

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             This property is **required**.

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``#address-cells``
           - ``int``
           - .. code-block:: none

                number of address cells in reg property


             This property is **required**.

             Constant value: ``1``

         * - ``#size-cells``
           - ``int``
           - .. code-block:: none

                number of size cells in reg property


             This property is **required**.

         * - ``status``
           - ``string``
           - .. code-block:: none

                indicates the operational status of a device


             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                name of each register space


         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                extended interrupt specifier for device


         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                name of each interrupt


         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                phandle to interrupt controller node


         * - ``label``
           - ``string``
           - .. code-block:: none

                Human readable string describing the device (used as device_get_binding() argument)



             See :ref:`zephyr:dt-important-props` for more information.

             This property is **deprecated**.

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Clock gate information


         * - ``clock-names``
           - ``string-array``
           - .. code-block:: none

                name of each clock


         * - ``dmas``
           - ``phandle-array``
           - .. code-block:: none

                DMA channels specifiers


         * - ``dma-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of DMA channel specifiers


         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channels specifiers


         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of IO channel specifiers


         * - ``mboxes``
           - ``phandle-array``
           - .. code-block:: none

                mailbox / IPM channels specifiers


         * - ``mbox-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of mailbox / IPM channel specifiers


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



         * - ``power-domain``
           - ``phandle``
           - .. code-block:: none


                Power domain the device belongs to.

                The device will be notified when the power domain it belongs to is either
                suspended or resumed.



         * - ``zephyr,pm-device-runtime-auto``
           - ``boolean``
           - .. code-block:: none

                Automatically configure the device for runtime power management after the
                init function runs.