build/dts/api/bindings/sdhc/nxp,imx-usdhc.html · build/dts/api/bindings/sdhc/nxp,imx-usdhc.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · SDHC · NXP Semiconductors

NXP i.MX USDHC 바인딩

i.MX USDHC의 timeout·FIFO watermark·전원·card detect schema를 정의하는 46개 property schema입니다.

Official pathbuild/dts/api/bindings/sdhc/nxp,imx-usdhc.html
Source filebuild/dts/api/bindings/sdhc/nxp,imx-usdhc.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

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

Part 1

요약·해설

공식 원문 476줄과 property 46행을 전수 대조해 required register/clock resources·DTOCV timeout·read/write FIFO watermarks·distinct hyphen/underscore current fields·DAT3 detection 제약을 보존했습니다.

Compatible

nxp,imx-usdhc

Vendor

NXP Semiconductors

Properties

46 rows

Interface

i.MX USDHC + FIFO watermarks + voltage/card detect controls

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 CD5145B506EE48F98EB56CE11A3FAA59E793C8C8EB85ACCDF890CE461673536D
: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:: nxp,imx-usdhc
.. _dtbinding_nxp_imx_usdhc:

nxp,imx-usdhc
#############

Vendor: :ref:`NXP Semiconductors <dt_vendor_nxp>`

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

These nodes are "sd" bus nodes.

.. code-block:: none

   NXP imx USDHC 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

         * - ``max-current-330``
           - ``int``
           - .. code-block:: none

                Max drive current in mA at 3.3V. A value of zero indicates no maximum
                is specified by the driver.



         * - ``max-current-300``
           - ``int``
           - .. code-block:: none

                Max drive current in mA at 3.0V. A value of zero indicates no maximum
                is specified by the driver.



         * - ``max-current-180``
           - ``int``
           - .. code-block:: none

                Max drive current in mA at 1.8V. A value of zero indicates no maximum
                is specified by the driver.



         * - ``max-bus-freq``
           - ``int``
           - .. code-block:: none

                Maximum bus frequency for SD card. This should be the highest frequency
                the SDHC is capable of negotiating with cards on the bus.



             Default value: ``400000``

         * - ``min-bus-freq``
           - ``int``
           - .. code-block:: none

                Minimum bus frequency for SD card. This should be the frequency that
                cards first will select when attached to the SDHC bus



             Default value: ``400000``

         * - ``power-delay-ms``
           - ``int``
           - .. code-block:: none

                time in ms for SDHC to delay when toggling power to the SD card. This
                delay gives the card time to power up or down fully



             Default value: ``500``

         * - ``mmc-hs200-1_8v``
           - ``boolean``
           - .. code-block:: none

                The host controller supports HS200 at 1.8V



         * - ``mmc-hs400-1_8v``
           - ``boolean``
           - .. code-block:: none

                The host controller supports HS400 at 1.8V



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



         * - ``data-timeout``
           - ``int``
           - .. code-block:: none

                Data timeout, as multiple of the SD clock. See DTOCV field of USDHC



             Default value: ``15``

         * - ``read-watermark``
           - ``int``
           - .. code-block:: none

                Number of words used as read watermark level in FIFO queue for USDHC



             Default value: ``128``

         * - ``write-watermark``
           - ``int``
           - .. code-block:: none

                Number of words used as write watermark level in FIFO queue for USDHC



             Default value: ``128``

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

                Max drive current in mA at 3.3V. A value of zero indicates no maximum
                is specified by the driver.



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

                Power pin
                This pin defaults to active high when consumed by the SD card. The
                property value should ensure the flags properly describe the signal
                that is presented to the driver.



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

                Detect pin
                This pin defaults to active low when produced by the SD card. The
                property value should ensure the flags properly describe the signal
                that is presented to the driver.



         * - ``no-1-8-v``
           - ``boolean``
           - .. code-block:: none

                When the external SD card circuit does not support 1.8V, add this
                property to disable 1.8v card voltage of SD card controller.



         * - ``detect-dat3``
           - ``boolean``
           - .. code-block:: none

                Enable the host to detect an SD card via the DAT3 line of the SD card
                connection. Requires the board to define a function to pull DAT3 low or
                high using pullup/pulldown resistors.





   .. 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 "nxp,imx-usdhc" 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


             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

한국어 전문 번역

nxp,imx-usdhc

Vendor: NXP Semiconductors

공식 설명

These nodes are "sd" bus nodes.

NXP imx USDHC controller

Transfer timing과 FIFO, board card-detect를 함께 설정

이 node는 sd bus node이며 base compatible·reg·clocks가 필수입니다. Pinctrl과 interrupt는 이 공식 page에서 선택입니다.

Clock + DTOCV

Required clock, timeout 15

USDHC FIFO

Read/write watermark 128

Voltage/power

Optional 1.8V disable + pwr GPIO

Card detect

CD GPIO or DAT3

max-current-330과 max_current_330은 공식 표에 동시에 존재하고 설명도 같습니다. 이름이 다른 두 행을 합치지 않았습니다. data-timeout 기본값은 15, read/write watermark는 각각 128 words입니다.

pwr-gpios signal은 기본 active-high, cd-gpios는 기본 active-low입니다. detect-dat3는 board가 DAT3 pull-up/pull-down function을 제공해야 하며 no-1-8-v는 external circuit가 1.8V를 지원하지 않을 때 사용합니다.

속성 전체 번역

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

노드 전용 속성 · 22개
이름형식설명과 제약
max-current-330int3.3V에서 지원하는 최대 drive current이며 mA 단위입니다. 0은 driver가 최대값을 지정하지 않음을 뜻합니다.
max-current-300int3.0V에서 지원하는 최대 drive current이며 mA 단위입니다. 0은 driver가 최대값을 지정하지 않음을 뜻합니다.
max-current-180int1.8V에서 지원하는 최대 drive current이며 mA 단위입니다. 0은 driver가 최대값을 지정하지 않음을 뜻합니다.
max-bus-freqintCard와 협상할 수 있는 controller의 최대 bus frequency입니다.
기본값: 400000
min-bus-freqintCard가 처음 연결될 때 선택하는 최소 bus frequency입니다.
기본값: 400000
power-delay-msintCard power를 전환한 뒤 완전히 켜지거나 꺼질 때까지 기다리는 시간이며 millisecond 단위입니다.
기본값: 500
mmc-hs200-1_8vbooleanHost controller가 1.8V HS200 mode를 지원함을 나타냅니다.
mmc-hs400-1_8vbooleanHost controller가 1.8V HS400 mode를 지원함을 나타냅니다.
pinctrl-0phandles첫 번째 상태에서 사용할 핀 설정입니다. 구체적인 내용은 선택한 핀 컨트롤러 드라이버에 따라 달라집니다.
pinctrl-1phandles두 번째 상태에서 사용할 핀 설정입니다. pinctrl-0과 같은 형식입니다.
pinctrl-2phandles세 번째 상태에서 사용할 핀 설정입니다. pinctrl-0과 같은 형식입니다.
pinctrl-3phandles네 번째 상태에서 사용할 핀 설정입니다. pinctrl-0과 같은 형식입니다.
pinctrl-4phandles다섯 번째 상태에서 사용할 핀 설정입니다. pinctrl-0과 같은 형식입니다.
pinctrl-namesstring-array핀 설정 상태의 이름입니다. 이름 수는 정의한 상태 수와 같아야 합니다.
data-timeoutintSD clock 배수로 지정하는 data timeout이며 USDHC DTOCV field에 대응합니다. 기본값은 15입니다.
기본값: 15
read-watermarkintUSDHC FIFO queue의 read watermark level이며 word 수 단위입니다. 기본값은 128입니다.
기본값: 128
write-watermarkintUSDHC FIFO queue의 write watermark level이며 word 수 단위입니다. 기본값은 128입니다.
기본값: 128
max_current_330int3.3V 최대 drive current이며 mA 단위입니다. 0은 driver가 maximum을 지정하지 않음을 뜻합니다. 이름에 underscore를 쓰는 별도 property입니다.
pwr-gpiosphandle-arraySD card에 제시되는 signal은 기본 active-high입니다. Flags cell이 driver가 보는 실제 signal polarity를 정확히 표현해야 합니다.
cd-gpiosphandle-arraySD card가 내보내는 detect signal은 기본 active-low입니다. Flags cell이 driver가 보는 실제 signal polarity를 정확히 표현해야 합니다.
no-1-8-vbooleanExternal SD card circuit가 1.8V를 지원하지 않을 때 controller의 1.8V card voltage를 비활성화합니다.
detect-dat3booleanDAT3 line으로 SD card를 검출합니다. Board가 pull-up/pull-down resistor로 DAT3를 low/high로 만드는 function을 정의해야 합니다.
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

출처

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