build/dts/api/bindings/gpio/sparkfun,micromod-gpio.html · build/dts/api/bindings/gpio/sparkfun,micromod-gpio.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · GPIO · SparkFun Electronics

SparkFun MicroMod GPIO Header 바인딩

MicroMod connector의 18개 analog·digital·general-purpose 신호 mapping를 정의하는 28개 property schema입니다.

Official pathbuild/dts/api/bindings/gpio/sparkfun,micromod-gpio.html
Source filebuild/dts/api/bindings/gpio/sparkfun,micromod-gpio.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

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

Part 1

요약·해설

공식 원문 328줄과 property 28행을 전수 대조해 18-signal connector mapping·unexposed buses·nexus boundary 제약을 보존했습니다.

Compatible

sparkfun,micromod-gpio

Vendor

SparkFun Electronics

Properties

28 rows

Interface

M.2 76-pin MicroMod header GPIO nexus

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 6D6849D5E4AB09380BF1044B15B1B633E47EFDCAF091A997A3DF96A194655F66
: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:: sparkfun,micromod-gpio
.. _dtbinding_sparkfun_micromod_gpio:

sparkfun,micromod-gpio
######################

Vendor: :ref:`SparkFun Electronics <dt_vendor_sparkfun>`

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



.. code-block:: none

   GPIO pins exposed on micromod headers.

   The micromod standard leverages the M.2 connector with 76 pins for
   swap between a myriad of supported boards and carriers.

   The micromod standard consists of two lanes with the following
   supported buses:
   * An 6-pin Power Supply header.  No pins on this header are exposed
     by this binding.
   * Reset, Boot pins and SWD pins not exposed by this binding.
   * 2 UART buses. First with RTS and CTS pins, while the 2nd with only
   RX and TX pins. Neither of them are exposed by this binding.
   * 2 i2c buses. Only the corresponding interrupt pin is exposed by
   this binding.
   * 2 SPI buses not exposed by this binding. Only SPI CS control pin
     is exposed by this binding.
   * Audio line not exposed by this binding.
   * 2 analog pins (A0 and A1).
   * 2 digital pins (D0 and D1).
   * 12 General purpose pins (G0 - G11).

   This binding provides a nexus mapping for the analog, digital and
   general purpose gpios in the order depicted below:

     - 00 -> A0                      PIN 34
     - 01 -> A1                      PIN 38
     - 02 -> D0                      PIN 10
     - 03 -> D1/CAM_TRIG             PIN 18
     - 04 -> I2C_INT#                PIN 16
     - 05 -> G0/BUS0                 PIN 40
     - 06 -> G1/BUS1                 PIN 42
     - 07 -> G2/BUS2                 PIN 44
     - 08 -> G3/BUS3                 PIN 46
     - 09 -> G4/BUS4                 PIN 48
     - 10 -> G5/BUS5                 PIN 73
     - 11 -> G6/BUS6                 PIN 71
     - 12 -> G7/BUS7                 PIN 69
     - 13 -> G8                      PIN 67
     - 14 -> G9/ADC_D-/CAM_HSYNC     PIN 65
     - 15 -> G10/ADC_D+/CAM_VSYNC    PIN 63
     - 16 -> G11/SWO                 PIN  8
     - 17 -> SPI_CS                  PIN 55

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

         * - ``gpio-map``
           - ``compound``
           - This property is **required**.

         * - ``gpio-map-mask``
           - ``compound``
           - 

         * - ``gpio-map-pass-thru``
           - ``compound``
           - 

         * - ``#gpio-cells``
           - ``int``
           - .. code-block:: none

                Number of items to expect in a GPIO specifier


             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 "sparkfun,micromod-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

한국어 전문 번역

sparkfun,micromod-gpio

Vendor: SparkFun Electronics

공식 설명

GPIO pins exposed on micromod headers.

The micromod standard leverages the M.2 connector with 76 pins for
swap between a myriad of supported boards and carriers.

The micromod standard consists of two lanes with the following
supported buses:
* An 6-pin Power Supply header.  No pins on this header are exposed
  by this binding.
* Reset, Boot pins and SWD pins not exposed by this binding.
* 2 UART buses. First with RTS and CTS pins, while the 2nd with only
RX and TX pins. Neither of them are exposed by this binding.
* 2 i2c buses. Only the corresponding interrupt pin is exposed by
this binding.
* 2 SPI buses not exposed by this binding. Only SPI CS control pin
  is exposed by this binding.
* Audio line not exposed by this binding.
* 2 analog pins (A0 and A1).
* 2 digital pins (D0 and D1).
* 12 General purpose pins (G0 - G11).

This binding provides a nexus mapping for the analog, digital and
general purpose gpios in the order depicted below:

  - 00 -> A0                      PIN 34
  - 01 -> A1                      PIN 38
  - 02 -> D0                      PIN 10
  - 03 -> D1/CAM_TRIG             PIN 18
  - 04 -> I2C_INT#                PIN 16
  - 05 -> G0/BUS0                 PIN 40
  - 06 -> G1/BUS1                 PIN 42
  - 07 -> G2/BUS2                 PIN 44
  - 08 -> G3/BUS3                 PIN 46
  - 09 -> G4/BUS4                 PIN 48
  - 10 -> G5/BUS5                 PIN 73
  - 11 -> G6/BUS6                 PIN 71
  - 12 -> G7/BUS7                 PIN 69
  - 13 -> G8                      PIN 67
  - 14 -> G9/ADC_D-/CAM_HSYNC     PIN 65
  - 15 -> G10/ADC_D+/CAM_VSYNC    PIN 63
  - 16 -> G11/SWO                 PIN  8
  - 17 -> SPI_CS                  PIN 55

MicroMod에서 GPIO로 노출되는 신호

MicroMod 규격은 76-pin M.2 connector로 processor board와 carrier board를 교체할 수 있게 합니다. 두 lane에는 전원, reset·boot·SWD, UART 2개, I2C 2개, SPI 2개, audio, analog·digital·general-purpose 신호가 있지만 이 binding은 그중 GPIO로 다룰 18개만 mapping합니다.

  • 6-pin 전원 header, reset·boot·SWD, UART 두 bus와 audio line은 노출하지 않습니다.
  • I2C는 각 bus 전체가 아니라 대응 interrupt pin만, SPI는 bus 전체가 아니라 chip-select pin만 노출합니다.
  • A0·A1 두 analog pin, D0·D1 두 digital pin, G0~G11 열두 general-purpose pin을 제공합니다.
MicroMod parent GPIO 번호와 M.2 물리 pin
Parent신호M.2 pin
00A034
01A138
02D010
03D1 / CAM_TRIG18
04I2C_INT#16
05G0 / BUS040
06G1 / BUS142
07G2 / BUS244
08G3 / BUS346
09G4 / BUS448
10G5 / BUS573
11G6 / BUS671
12G7 / BUS769
13G867
14G9 / ADC_D- / CAM_HSYNC65
15G10 / ADC_D+ / CAM_VSYNC63
16G11 / SWO8
17SPI_CS55

표의 00~17이 consumer가 connector에 요청하는 parent 번호이고, gpio-map이 이를 carrier의 실제 GPIO controller와 pin·flag specifier로 바꿉니다.

GPIO nexus 계약

gpio-map, #gpio-cells, base compatible가 필수이고 gpio-map-mask와 gpio-map-pass-thru는 선택입니다. 이 문서들은 실제 GPIO controller가 아니라 connector 번호를 실제 controller specifier로 변환하므로 gpio-controller, ngpios, GPIO hog child가 없습니다. #gpio-cells 값도 공식 page가 고정하지 않습니다.

속성 전체 번역

공식 node 4개와 base 24개 property를 모두 번역했습니다. Controller와 child property는 없습니다.

노드 전용 속성 · 4개
이름형식설명과 제약
gpio-mapcompoundNexus의 child GPIO specifier를 실제 parent GPIO specifier로 변환하는 필수 mapping입니다.
필수
gpio-map-maskcompoundGPIO nexus mapping lookup에서 비교할 cell bit를 제한하는 mask입니다.
gpio-map-pass-thrucompoundGPIO nexus translation 뒤 parent specifier로 그대로 전달할 bit를 지정합니다.
#gpio-cellsintGPIO specifier 하나에 포함될 cell 수입니다.
필수
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

출처

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