build/dts/api/bindings/ieee802154/decawave,dw1000.html · build/dts/api/bindings/ieee802154/decawave,dw1000.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · IEEE 802.15.4 · Qorvo, Inc (formerly Decawave)

Decawave DW1000 IEEE 802.15.4 UWB 바인딩

DW1000 UWB transceiver의 SPI·IRQ/reset과 antenna delay를 정의하는 36개 property schema입니다.

Official pathbuild/dts/api/bindings/ieee802154/decawave,dw1000.html
Source filebuild/dts/api/bindings/ieee802154/decawave,dw1000.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

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

Part 1

요약·해설

공식 원문 403줄과 property 36행을 전수 대조해 IRQ/reset polarity·optional TX/RX antenna delays·SPI and power sequencing 제약을 보존했습니다.

Compatible

decawave,dw1000

Vendor

Qorvo, Inc (formerly Decawave)

Properties

36 rows

Interface

SPI UWB + active-high IRQ + active-low reset

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 995393C0F94508BFFC58FD58EE3555FDDF31E5A6FB8D84991B68EEF72E58EA14
: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:: decawave,dw1000
.. _dtbinding_decawave_dw1000:

decawave,dw1000 (on spi bus)
############################

Vendor: :ref:`Qorvo, Inc (formerly Decawave) <dt_vendor_decawave>`

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



.. code-block:: none

   Decawave DW1000 802.15.4 UWB transceiver

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

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

                GPIO specifier that controls power to the device.

                This property should be provided when the device has a dedicated
                switch that controls power to the device.  The supply state is
                entirely the responsibility of the device driver.

                Contrast with vin-supply.



         * - ``vin-supply``
           - ``phandle``
           - .. code-block:: none

                Reference to the regulator that controls power to the device.
                The referenced devicetree node must have a regulator compatible.

                This property should be provided when device power is supplied
                by a shared regulator.  The supply state is dependent on the
                request status of all devices fed by the regulator.

                Contrast with supply-gpios.  If both properties are provided
                then the regulator must be requested before the supply GPIOS is
                set to an active state, and the supply GPIOS must be set to an
                inactive state before releasing the regulator.



         * - ``spi-max-frequency``
           - ``int``
           - .. code-block:: none

                Maximum clock frequency of device's SPI interface in Hz


             This property is **required**.

         * - ``duplex``
           - ``int``
           - .. code-block:: none

                Duplex mode, full or half. By default it's always full duplex thus 0
                as this is, by far, the most common mode.
                Use the macros not the actual enum value, here is the concordance
                list (see dt-bindings/spi/spi.h)
                  0    SPI_FULL_DUPLEX
                  2048 SPI_HALF_DUPLEX



             Legal values: ``0``, ``2048``

         * - ``frame-format``
           - ``int``
           - .. code-block:: none

                Motorola or TI frame format. By default it's always Motorola's,
                thus 0 as this is, by far, the most common format.
                Use the macros not the actual enum value, here is the concordance
                list (see dt-bindings/spi/spi.h)
                  0     SPI_FRAME_FORMAT_MOTOROLA
                  32768 SPI_FRAME_FORMAT_TI



             Legal values: ``0``, ``32768``

         * - ``spi-cpol``
           - ``boolean``
           - .. code-block:: none

                SPI clock polarity which indicates the clock idle state.
                If it is used, the clock idle state is logic high; otherwise, low.



         * - ``spi-cpha``
           - ``boolean``
           - .. code-block:: none

                SPI clock phase that indicates on which edge data is sampled.
                If it is used, data is sampled on the second edge; otherwise, on the first edge.



         * - ``spi-hold-cs``
           - ``boolean``
           - .. code-block:: none

                In some cases, it is necessary for the master to manage SPI chip select
                under software control, so that multiple spi transactions can be performed
                without releasing it. A typical use case is variable length SPI packets
                where the first spi transaction reads the length and the second spi transaction
                reads length bytes.



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

                Interrupt pin.
                The interrupt pin IRQ of DW1000 is active high output. If connected directly the MCU pin should be configured as active high.


             This property is **required**.

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

                RESET pin.
                The RESET pin of DW1000 is active low. If connected directly the MCU pin should be configured as active low.


             This property is **required**.

         * - ``tx-ant-delay``
           - ``int``
           - .. code-block:: none

                Transmitter antenna delay.


         * - ``rx-ant-delay``
           - ``int``
           - .. code-block:: none

                Receiver antenna delay.




   .. 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 "decawave,dw1000" 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


             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

한국어 전문 번역

decawave,dw1000

Vendor: Qorvo, Inc (formerly Decawave)

공식 설명

Decawave DW1000 802.15.4 UWB transceiver

Decawave DW1000 UWB transceiver

supply-gpios와 vin-supply는 선택입니다. 둘 다 쓰면 regulator를 먼저 요청한 뒤 supply GPIO를 active로 만들고, 종료할 때 GPIO를 inactive로 만든 뒤 regulator를 해제해야 합니다.

spi-max-frequency와 base compatible·reg가 필수입니다. duplex 허용값은 0과 2048, frame-format은 0과 32768이며 실제 숫자 대신 SPI binding macro 사용을 권장합니다.

IRQ

int-gpios 필수 · active-high output

RESET

reset-gpios 필수 · active-low

Ranging calibration

선택 TX/RX antenna delay

IRQ와 RESET을 MCU에 직접 연결하면 각각 active-high, active-low polarity로 구성해야 합니다. tx-ant-delay와 rx-ant-delay는 선택이며 공식 표는 단위, 기본값, calibration 절차와 허용 범위를 더 설명하지 않습니다.

UWB channel, preamble, data rate, PAN ID와 ranging algorithm을 이 devicetree page에 임의로 추가하지 않았습니다.

속성 전체 번역

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

노드 전용 속성 · 12개
이름형식설명과 제약
supply-gpiosphandle-array장치 전용 전원 스위치를 제어할 GPIO를 지정합니다. 드라이버가 전원 공급 상태를 관리합니다.
vin-supplyphandle장치에 전원을 공급하는 공유 레귤레이터 노드의 phandle입니다.
spi-max-frequencyint장치의 SPI 인터페이스가 허용하는 최대 클록 주파수입니다. 단위는 Hz입니다.
필수
duplexintSPI 양방향 통신 방식입니다. 0은 전이중(SPI_FULL_DUPLEX), 2048은 반이중(SPI_HALF_DUPLEX)입니다.
허용값: 0, 2048
frame-formatintSPI 프레임 형식입니다. 0은 SPI_FRAME_FORMAT_MOTOROLA, 32768은 SPI_FRAME_FORMAT_TI를 뜻합니다.
허용값: 0, 32768
spi-cpolbooleanSPI 클록의 극성입니다. 이 속성을 설정하면 유휴 상태에서 클록이 High이고, 설정하지 않으면 Low입니다.
spi-cphabooleanSPI 클록의 위상입니다. 이 속성을 설정하면 두 번째 클록 에지에서, 설정하지 않으면 첫 번째 에지에서 데이터를 읽습니다.
spi-hold-csboolean여러 SPI 전송 사이에도 칩 선택 신호를 해제하지 않고 유지하도록 요청합니다.
int-gpiosphandle-arrayDW1000의 active-high IRQ output GPIO입니다. MCU에 직접 연결하면 active-high로 구성합니다.
필수
reset-gpiosphandle-arrayPanel 또는 display controller의 hardware reset GPIO입니다.
필수
tx-ant-delayintDW1000 transmitter antenna delay 값입니다.
rx-ant-delayintDW1000 receiver antenna delay 값입니다.
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

출처

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