build/dts/api/bindings/timer/atmel,sam-tc.html · build/dts/api/bindings/timer/atmel,sam-tc.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · Timer · Atmel Corporation

Atmel SAM Timer Counter 바인딩

0~2 channel 선택, TCCLKS/MCLK source, CMR/RC override와 external TIO pin configuration를 정의하는 35개 property schema입니다.

Official pathbuild/dts/api/bindings/timer/atmel,sam-tc.html
Source filebuild/dts/api/bindings/timer/atmel,sam-tc.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

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

Part 1

요약·해설

공식 원문 377줄과 property 35행을 전수 대조해 optional channel and custom register fields·MCLK bypass restrictions·required register/IRQ/clock resources 제약을 보존했습니다.

Compatible

atmel,sam-tc

Vendor

Atmel Corporation

Properties

35 rows

Interface

Atmel SAM Timer Counter channel

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 91702B250DE24C6A352BF0A2E8CF71BD55BDD79CC5807314AA7C2557A9A2C9A8
: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:: atmel,sam-tc
.. _dtbinding_atmel_sam_tc:

atmel,sam-tc
############

Vendor: :ref:`Atmel Corporation <dt_vendor_atmel>`

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



.. code-block:: none

   Atmel SAM Timer Counter (TC) node

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

         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



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



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

                Timer / Counter channel to use, channel 0 is the default.
                Valid range: 0 - 2



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

                Clock source selection as defined by TCCLKS bit-field of TC_CMR
                register. Consult the datasheet for the details.



         * - ``nodivclk``
           - ``boolean``
           - .. code-block:: none

                If set to true the `clk` property is ignored. Instead the TC module is
                driven directly via MCLK. Only supported on sam4e, same70, same70b,
                samv71, samv71b SoC series.



         * - ``reg-cmr``
           - ``int``
           - .. code-block:: none

                Alternate value of the CMR (Channel Mode Register) register.
                If specified this value will be written to the register during driver
                instance initialization instead of the default. It can be used to
                configure the timer / counter in the custom mode. Together with other
                properties like channel-num, pinctrl-0 this allows e.g. to configure
                the driver to count events generated on the TIOA, TIOB signal connected
                to the external pin.



         * - ``reg-rc``
           - ``int``
           - .. code-block:: none

                Register C compare/match value. RC can be used as compare/match unit
                for an specific timer unit. Their use depends on how timer channel
                is configured,see reg-cmr. It can be used as trigger for both input
                capture or counter mode, or even as event source. The RC register
                behavior is SoC dependent. For more information and use cases,
                check SoC datasheet and application notes.





   .. 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 "atmel,sam-tc" 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


             This property is **required**.

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

한국어 전문 번역

atmel,sam-tc

Vendor: Atmel Corporation

공식 설명

Atmel SAM Timer Counter (TC) node

한 TC block에서 channel과 동작 mode를 선택

channel은 0~2 중 사용할 channel을 고르며 기본은 0입니다. clk는 TC_CMR의 TCCLKS 선택값이고, nodivclk를 사용하면 이를 무시하고 지원 SoC에서 MCLK로 직접 구동합니다.

Clock source

clk or direct MCLK

TC channel 0..2

channel selection

CMR / RC

Mode and compare value

TIOA / TIOB

Optional external event pins

reg-cmr는 driver 기본 mode 대신 custom Channel Mode Register 값을 쓰고, reg-rc는 compare/match 값으로 사용합니다. Pin control과 함께 외부 TIOA/TIOB event counting, capture, compare event를 구성할 수 있지만 실제 bit 의미와 RC 동작은 SoC datasheet가 최종 기준입니다.

Base compatible, reg, interrupts, clocks는 필수입니다.

속성 전체 번역

공식 node-specific 11개와 base binding 24개 property를 모두 번역했습니다.

노드 전용 속성 · 11개
이름형식설명과 제약
pinctrl-0phandles첫 번째 상태에서 사용할 핀 설정의 phandle 목록입니다. 구체적인 내용은 선택한 핀 컨트롤러 드라이버에 따릅니다.
pinctrl-1phandles두 번째 상태에서 사용할 핀 설정입니다.
pinctrl-2phandles세 번째 상태에서 사용할 핀 설정입니다.
pinctrl-3phandles네 번째 상태에서 사용할 핀 설정입니다.
pinctrl-4phandles다섯 번째 상태에서 사용할 핀 설정입니다.
pinctrl-namesstring-array각 pinctrl 상태의 이름을 나열한 배열입니다. 이름 수는 정의한 상태 수와 같아야 합니다.
channelint사용할 Timer/Counter channel입니다. 기본 channel은 0이고 유효 범위는 0~2입니다.
clkintTC_CMR register의 TCCLKS bit field에 정의된 clock source selection 값입니다. 정확한 값은 SoC datasheet를 확인해야 합니다.
nodivclkboolean설정하면 clk property를 무시하고 TC module을 MCLK로 직접 구동합니다. 공식 목록의 SAM4E/SAME70/SAMV71 계열에서만 지원됩니다.
reg-cmrint초기화 때 기본값 대신 Channel Mode Register에 기록할 대체 값입니다. External TIOA/TIOB event counting 같은 custom mode 구성에 사용합니다.
reg-rcintRegister C compare/match 값입니다. Channel mode에 따라 input capture trigger, counter compare 또는 event source로 사용되며 동작은 SoC에 따라 다릅니다.
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

출처

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