ITE Enhanced I2C Controller 바인딩

: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:: ite,enhance-i2c
.. _dtbinding_ite_enhance_i2c:

ite,enhance-i2c
###############

Vendor: :ref:`ITE Tech. Inc. <dt_vendor_ite>`

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

These nodes are "i2c" bus nodes.

.. code-block:: none

   ITE enhance I2C

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

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

                Initial clock frequency in Hz


         * - ``sq-size``
           - ``int``
           - .. code-block:: none

                Size of the submission queue for blocking requests


             Default value: ``4``

         * - ``cq-size``
           - ``int``
           - .. code-block:: none

                Size of the completion queue for blocking requests


             Default value: ``4``

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

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



             This property is **required**.

         * - ``port-num``
           - ``int``
           - .. code-block:: none

                Ordinal identifying the port 0 = SMB_CHANNEL_A, 1 = SMB_CHANNEL_B, 2 = SMB_CHANNEL_C, 3 = I2C_CHANNEL_D, 4 = I2C_CHANNEL_E, 5 = I2C_CHANNEL_F,


             This property is **required**.

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

         * - ``channel-switch-sel``
           - ``int``
           - .. code-block:: none

                The default setting is as described below
                0 = I2C_CHA_LOCATE: Channel A is located at SMCLK0/SMDAT0
                1 = I2C_CHB_LOCATE: Channel B is located at SMCLK1/SMDAT1
                2 = I2C_CHC_LOCATE: Channel C is located at SMCLK2/SMDAT2
                3 = I2C_CHD_LOCATE: Channel D is located at SMCLK3/SMDAT3
                4 = I2C_CHE_LOCATE: Channel E is located at SMCLK4/SMDAT4
                5 = I2C_CHF_LOCATE: Channel F is located at SMCLK5/SMDAT5

                The following is an example of the 'channel-switch-sel' property
                being swapped between node &i2c0 and &i2c2 in the application:
                Note: The property of 'port-num' cannot be changed in the
                      application.

                Channel C is located at SMCLK0/SMDAT0:
                &i2c0 {
                       channel-switch-sel = <I2C_CHC_LOCATE>;
                       pinctrl-0 = <&i2c2_clk_gpf6_default
                                    &i2c2_data_gpf7_default>;
                       pinctrl-names = "default";
                       scl-gpios = <&gpiof 6 0>;
                       sda-gpios = <&gpiof 7 0>;
                };

                Channel A is located at SMCLK2/SMDAT2:
                &i2c2 {
                       channel-switch-sel = <I2C_CHA_LOCATE>;
                       pinctrl-0 = <&i2c0_clk_gpb3_default
                                    &i2c0_data_gpb4_default>;
                       pinctrl-names = "default";
                       scl-gpios = <&gpiob 3 0>;
                       sda-gpios = <&gpiob 4 0>;
                };

                If the property of 'channel-switch-sel' is changed, the pinctrl
                setting and recovery pin in &i2c0 and &i2c2 nodes must also be
                modified accordingly.



             This property is **required**.

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

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

                The SCL pin for the selected port.



             This property is **required**.

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

                The SDA pin for the selected port.



             This property is **required**.

         * - ``clock-gate-offset``
           - ``int``
           - .. code-block:: none

                The clock gate offsets combine the register offset from
                ECPM_BASE and the mask within that register into one value.



             This property is **required**.

         * - ``push-pull-recovery``
           - ``boolean``
           - .. code-block:: none

                This property is enabled when selecting the push-pull GPIO output
                type to drive the I2C recovery. The default is open-drain.



         * - ``prescale-scl-low``
           - ``int``
           - .. code-block:: none

                This option is used to configure the I2C speed prescaler for
                the SCL low period. When set to >= 1, it will increase the
                low period of the SCL clock and so reduce the signal frequency.
                The resulting SCL cycle time is given by the following formula:
                SCL cycle = 2 * (psr + prescale_tweak + 2) *
                            SMBus clock cycle



         * - ``data-hold-time``
           - ``int``
           - .. code-block:: none

                This option is used to configure the data hold time of the I2C.
                The unit is number of SMB clock cycles.  The time calculation
                is (data-hold-time / smb_clk) seconds.



             Default value: ``3``

             Legal values: ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``

         * - ``target-enable``
           - ``boolean``
           - .. code-block:: none

                This option is used when the I2C target is enabled. It is
                necessary to prevent the target port from being configured
                with I2C host related initialization.



         * - ``target-pio-mode``
           - ``boolean``
           - .. code-block:: none

                This option is used when the I2C target is enabled and it can
                support PIO mode for I2C target transfer.





   .. 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 "ite,enhance-i2c" compatible.

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

         * - Name
           - Type
           - Details

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



         * - ``zephyr,disabling-power-states``
           - ``phandles``
           - .. code-block:: none

                List of power states that will disable this device power.



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

                indicates the operational status of a device


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

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

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

                compatible strings


             This property is **required**.

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

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

                register space


             This property is **required**.

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

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

                name of each register space


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

                interrupts for device


             This property is **required**.

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

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


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

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


         * - ``zephyr,deferred-init``
           - ``boolean``
           - .. code-block:: none

                Do not initialize device automatically on boot. Device should be manually
                initialized using device_init().