: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:: nuvoton,numaker-tcpc
.. _dtbinding_nuvoton_numaker_tcpc:

nuvoton,numaker-tcpc
####################

Vendor: :ref:`Nuvoton Technology Corporation <dt_vendor_nuvoton>`

.. note::

   An implementation of a driver matching this compatible is available in
   :zephyr_file:`drivers/usb_c/tcpc/ucpd_numaker.c`.

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



.. code-block:: none

   Nuvoton NuMaker USB Type-C port controller

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

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

                Reset information


             This property is **required**.

         * - ``vconn-overcurrent-event-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of VCONN overcurrent event



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``vconn-discharge-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of VCONN discharge



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``vconn-enable-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of VCONN enable



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``vbus-overcurrent-event-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of VBUS overcurrent event



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``vbus-forceoff-event-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of VBUS force-off event



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``frs-tx-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of fast role swap tx



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``vbus-discharge-enable-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of VBUS discharge enable



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``vbus-sink-enable-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of VBUS sink enable



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``vbus-source-enable-polarity``
           - ``string``
           - .. code-block:: none

                Polarity of VBUS source enable



             Legal values: ``'low-active'``, ``'high-active'``

         * - ``vbus-divide``
           - ``string``
           - .. code-block:: none

                VBUS measurement divider



             This property is **required**.

             Legal values: ``'no-divide'``, ``'divide-10'``, ``'divide-20'``

         * - ``dead-battery``
           - ``boolean``
           - .. code-block:: none

                Determine if USB-C Dead Battery pull-down resistor should be
                applied to the CC lines.



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

         * - ``gpios``
           - ``phandle-array``
           - This property is **required**.

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

                Valid names of GPIO:
                "vbus-detect": GPIO for VBUS detect (must)
                "vbus-discharge": GPIO for VBUS discharge (option)
                "vconn-discharge": GPIO for VCONN discharge (option)



             This property is **required**.

         * - ``adc-measure-timer-trigger-rate``
           - ``int``
           - .. code-block:: none

                Rate of timer-triggered EADC measurement (Hz).
                This is ignored when none of above is specified.
                The default is chosen by following BSP sample,
                and is to update UTCPD in a proper rate.



             Default value: ``100``

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

                Name of each reset


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





   .. 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 "nuvoton,numaker-tcpc" 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.

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

                Clock gate information


             This property is **required**.

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

                EADC channels for measuring VBUS/VCONN voltage



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

                Valid names of EADC channels:
                "chn-vbus": EADC channel for measuring VBUS voltage (option)
                "chn-vconn": EADC channel for measuring VCONN voltage (option)



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

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

                name of each clock


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

                number of address cells in reg property


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

                number of size cells in reg property


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

                DMA channels specifiers


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

                Provided names of DMA 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


         * - ``power-domains``
           - ``phandle-array``
           - .. code-block:: none

                Power domain specifiers


         * - ``power-domain-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of power domain specifiers


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