: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:: zephyr,swdp-gpio
.. _dtbinding_zephyr_swdp_gpio:

zephyr,swdp-gpio
################

Vendor: :ref:`Zephyr-specific binding <dt_vendor_zephyr>`

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



.. code-block:: none

   This is a representation of the Serial Wire Debug Port interface
   implementation by GPIO bit-banging.

   Schematic using dual-supply bus transceiver and separate dout and dnoe pins

          VCC_3V3                      VCC_REF
             ^                           ^
             |       +-------------+     |
             +-------|vcca     vccb|-----+
                     |             |
    clk-gpios -------|a           b|-------------- SWD CLK
                     |             |
    noe-gpios -------|dir       gnd|-----+
                     +-------------+     |
                      74LVC1T45          v
                                        GND


          VCC_3V3                      VCC_REF
             ^                           ^
             |       +-------------+     |
             +-------|vcca     vccb|-----+
                     |             |
    dio-gpios -------|a           b|------------*- SWD DIO
                     |             |            |
             +-------|dir       gnd|-----+      |
             |       +-------------+     |      |
             v        74LVC1T45          v      |
            GND                         GND     |
                                                |
                                                |
          VCC_3V3                      VCC_REF  |
             ^                           ^      |
             |       +-------------+     |      |
             +-------|vcca     vccb|-----+      |
                     |             |            |
   dout-gpios -------|a           b|------------+
                     |             |
   dnoe-gpios -------|dir       gnd|-----+
                     +-------------+     |
                      74LVC1T45          v
                                        GND

   Direct connection using only dio pin for SWD DIO.

    clk-gpios ------------------------------------ SWD CLK

    dio-gpios ------------------------------------ SWD DIO

   Of course, bidirectional bus transceiver between dio and SWD DIO can also be
   used together with noe pin to enable/disable transceivers.

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

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

                GPIO pin used for SWCLK output


             This property is **required**.

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

                GPIO pin used for SWDIO input. This pin is also used for the SWDIO output
                if separate output pin is not defined.



             This property is **required**.

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

                Optional GPIO pin used for SWDIO output.



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

                GPIO pin used to disable the SWDIO output buffer behind optional
                pin dout-gpios.



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

                Optional pin to disable all bus transceivers if any are present.



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

                Optional GPIO pin used for RESET output.



         * - ``port-write-cycles``
           - ``int``
           - .. code-block:: none

                Number of processor cycles for I/O Port write operations.For example, the
                GPIO clock may be different from the CPU clock. This can usually be
                found in the SoC documentation.



             This property is **required**.



   .. 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 "zephyr,swdp-gpio" 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:`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``
           - ``array``
           - .. code-block:: none

                register space


             See :ref:`zephyr: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


             See :ref:`zephyr: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:`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


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


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