build/dts/api/bindings/misc/zephyr,swdp-gpio.html · build/dts/api/bindings/misc/zephyr,swdp-gpio.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · Misc · Zephyr-specific binding

Zephyr GPIO Bit-Bang SWD Port 바인딩

GPIO로 구현하는 Serial Wire Debug Port와 bus transceiver 제어를 정의하는 31개 property schema입니다.

Official pathbuild/dts/api/bindings/misc/zephyr,swdp-gpio.html
Source filebuild/dts/api/bindings/misc/zephyr,swdp-gpio.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

본문 기준: Zephyr 3.7.0 LTS3 · 이후 유지보수 패치는 별도입니다.

Part 1

요약·해설

공식 원문 381줄과 property 31행을 전수 대조해 required clock/data pins·shared versus split SWDIO·transceiver output-enable controls 제약을 보존했습니다.

Compatible

zephyr,swdp-gpio

Vendor

Zephyr-specific binding

Properties

31 rows

Interface

SWCLK/SWDIO GPIO bit-banging + optional level shifters

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 41923279AEEEF2732EFE41157F36A76F6326047C5D0765368CD355D61F02D3A2
: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:`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


             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


             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


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






Part 3

한국어 전문 번역

zephyr,swdp-gpio

Vendor: Zephyr-specific binding

공식 설명

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.

GPIO toggling으로 SWD protocol 구현

clk-gpios는 SWCLK output, dio-gpios는 SWDIO input이며 둘 다 필수입니다. 별도 output pin이 없으면 dio-gpios가 bidirectional SWDIO output도 담당합니다.

SWDIO wiring 선택
Direct/bidirectional

dio-gpios ↔ SWDIO

Split output

dio input + dout output

Output buffer control

dnoe-gpios

All transceivers

optional noe-gpios

Dual-supply level shifter를 쓰면 dout-gpios와 dnoe-gpios로 output path를 분리할 수 있고 noe-gpios로 전체 transceiver를 disable할 수 있습니다. reset-gpios는 target reset output입니다.

port-write-cycles는 GPIO port write 한 번에 필요한 processor cycle 수이며 필수입니다. CPU clock과 GPIO clock이 다를 수 있으므로 SoC 문서의 값을 사용합니다. Base compatible도 필수이고 reg는 선택입니다.

속성 전체 번역

공식 node 7개와 base 24개 property를 모두 번역했습니다.

노드 전용 속성 · 7개
이름형식설명과 제약
clk-gpiosphandle-arraySWD SWCLK output에 사용할 GPIO입니다.
필수
dio-gpiosphandle-arraySWDIO input에 사용할 GPIO입니다. 별도 output pin이 없으면 SWDIO output도 이 pin을 사용합니다.
필수
dout-gpiosphandle-arraySWDIO output 전용으로 선택할 수 있는 GPIO입니다.
dnoe-gpiosphandle-array선택적인 dout-gpios 뒤 output buffer를 비활성화하는 GPIO입니다.
noe-gpiosphandle-arrayBus transceiver가 있을 때 모든 transceiver를 비활성화하는 선택 GPIO입니다.
reset-gpiosphandle-arrayTarget RESET output에 사용할 선택 GPIO입니다.
port-write-cyclesintI/O port write 한 번에 필요한 processor cycle 수입니다. CPU와 GPIO clock 차이를 반영합니다.
필수
Base binding property · 24개

공통 기본 바인딩에서 상속한 속성입니다. 이 compatible에서 사용하지 않는 속성도 공식 참조 문서에 실려 있으면 함께 표시합니다.

이름형식설명과 제약
wakeup-sourceboolean이 장치를 시스템 깨우기에 사용할 수 있음을 나타냅니다. 이 속성이 있으면 깨우기 지원 플래그가 설정됩니다. 기본 상태에서는 장치의 인터럽트로 시스템을 깨우지 않으며, 실행 중에 깨우기 기능을 활성화할 수 있습니다.
power-domainphandle장치가 속한 전원 도메인의 phandle입니다. 해당 전원 도메인이 일시 중단되거나 다시 동작하면 장치에 알림이 전달됩니다.
zephyr,pm-device-runtime-autoboolean초기화 함수 실행 후 장치의 런타임 전원 관리를 자동으로 설정합니다.
zephyr,disabling-power-statesphandles이 장치의 전원이 꺼지는 전원 상태 목록입니다.
statusstring장치의 동작 상태를 나타냅니다.
허용값: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'
compatiblestring-array이 노드에 적용할 바인딩과 드라이버를 식별하는 compatible 문자열 목록입니다.
필수
regarray장치 레지스터의 주소 범위를 지정합니다.
reg-namesstring-array각 register space의 이름입니다.
interruptsarray장치에서 사용하는 인터럽트를 지정하는 목록입니다.
interrupts-extendedcompound인터럽트 컨트롤러의 phandle을 함께 지정하는 확장 형식의 인터럽트 명세입니다.
interrupt-namesstring-array각 interrupt의 이름입니다.
interrupt-parentphandle인터럽트 컨트롤러 노드를 가리키는 phandle입니다.
labelstring사람이 장치를 알아볼 수 있도록 붙이는 이름입니다. 과거에는 device_get_binding()의 인자로 사용했습니다.
사용 중단됨
clocksphandle-array클록 게이트 또는 클록 공급원을 지정하는 phandle 배열입니다.
clock-namesstring-array각 clock의 이름입니다.
#address-cellsint하위 노드의 reg 속성에서 주소를 나타내는 데 쓰는 셀 수입니다.
#size-cellsint하위 노드의 reg 속성에서 크기를 나타내는 데 쓰는 셀 수입니다.
dmasphandle-arrayDMA 채널을 지정하는 phandle 배열입니다.
dma-namesstring-array지정한 DMA 채널의 이름입니다.
io-channelsphandle-arrayI/O 채널을 지정하는 phandle 배열입니다.
io-channel-namesstring-array지정한 I/O 채널의 이름입니다.
mboxesphandle-array메일박스/IPM 채널을 지정하는 phandle 배열입니다.
mbox-namesstring-array지정한 메일박스/IPM 채널의 이름입니다.
zephyr,deferred-initboolean부팅할 때 장치를 자동으로 초기화하지 않습니다. 이후 device_init()를 호출해 직접 초기화해야 합니다.

Source

출처

영어 원문에는 문단, 문서 지시문, 표, 코드, 코드 심벌, 경로를 그대로 보존했습니다.