Part 1
요약·해설
공식 원문 409줄과 property 34행을 전수 대조해 required register/pinmux·4단계 drive strength·VDDIO rail 선택·GPIO output 초기값 제약을 보존했습니다.
adi,max32-pinctrl
Analog Devices, Inc.
34 rows
MAX32 port/pin/function encoding + electrical pin configuration
Part 2
접을 수 있는 영어 원문 전체
영어 원문 전체 펼치기
BDE1D9ACA97453D93784F883F7A0F250E02D119E25D2DF12780054AEF0965DB4
: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:: adi,max32-pinctrl
.. _dtbinding_adi_max32_pinctrl:
adi,max32-pinctrl
#################
Vendor: :ref:`Analog Devices, Inc. <dt_vendor_adi>`
Description
***********
.. code-block:: none
MAX32 Pin controller Node
Based on pincfg-node.yaml binding.
Note: `bias-disable` are default pin configurations.
Properties
**********
Top level properties
====================
These property descriptions apply to "adi,max32-pinctrl"
nodes themselves. This page also describes child node
properties in the following sections.
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
(None)
.. 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 "adi,max32-pinctrl" 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().
Child node properties
=====================
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``bias-disable``
- ``boolean``
- .. code-block:: none
disable any pin bias
* - ``bias-pull-up``
- ``boolean``
- .. code-block:: none
enable pull-up resistor
* - ``bias-pull-down``
- ``boolean``
- .. code-block:: none
enable pull-down resistor
* - ``drive-strength``
- ``int``
- .. code-block:: none
There are 4 drive strength mode.
Mode 0: 1mA
Mode 1: 2mA
Mode 2: 4mA
Mode 3: 8mA
Default GPIO output drive strength is mode 0 for MAX32 MCUs.
For more information please take a look device user guide, datasheet.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``input-enable``
- ``boolean``
- .. code-block:: none
enable input on pin (e.g. enable an input buffer, no effect on output)
* - ``power-source``
- ``int``
- .. code-block:: none
GPIO Supply Voltage Select, Selects the voltage rail used for the pin.
0 or MAX32_VSEL_VDDIO
1 or MAX32_VSEL_VDDIOH
Legal values: ``0``, ``1``
* - ``output-enable``
- ``boolean``
- .. code-block:: none
enable output on a pin without actively driving it (e.g. enable an output
buffer)
* - ``output-low``
- ``boolean``
- .. code-block:: none
set the pin to output mode with low level
* - ``output-high``
- ``boolean``
- .. code-block:: none
set the pin to output mode with high level
* - ``pinmux``
- ``int``
- .. code-block:: none
Integer array, represents gpio pin number and mux setting.
These defines are calculated as: (pin<<8 | port<<4 | function<<0)
With:
- port: The gpio port index (0, 1, ...)
- pin: The pin offset within the port (0, 1, 2, ...)
- function: The function number, can be:
* 0 : GPIO
* 1 : Alternate Function 1
* 2 : Alternate Function 2
* 3 : Alternate Function 3
* 4 : Alternate Function 4
In case selected pin function is GPIO, pin is statically configured as
a plain input/output GPIO. Default configuration is input. Output value
can be configured by adding 'ouptut-low' or 'output-high' properties
to the pin configuration.
To simplify the usage, macro is available to generate "pinmux" field.
This macro is available here:
-include/zephyr/dt-bindings/pinctrl/max32-pinctrl.h
Some examples of macro usage:
P0.9 set as alernate function 1
{
pinmux = <MAX32_PINMUX(0, 9, AF1)>;
};
P0.9 set as alernate function 2
{
pinmux = <MAX32_PINMUX(0, 9, AF2)>;
};
P0.9 set as GPIO output high
{
pinmux = <MAX32_PINMUX(0, 9, GPIO)>;
output-high;
};
This property is **required**.
Part 3
한국어 전문 번역
adi,max32-pinctrl
Vendor: Analog Devices, Inc.
공식 설명
MAX32 pin controller node입니다.
pincfg-node.yaml binding을 기반으로 합니다.
참고: `bias-disable`은 기본 pin configuration입니다.하나의 정수에 port·pin·function을 결합
Controller node의 base compatible과 reg, 각 child의 pinmux가 필수입니다. Electrical 설정은 같은 child에 선택적으로 붙습니다.
bits 7:4
bits 15:8
bits 3:0
bias · drive · input/output
drive-strength는 mA를 직접 쓰지 않고 0~3 mode를 쓰며, power-source는 0/1로 VDDIO와 VDDIOH를 고릅니다. GPIO output 초기값은 output-low 또는 output-high로 명시합니다.
속성 전체 번역
공식 base 24개와 child 10개 property를 모두 번역했습니다.
Base binding property · 24개
공통 기본 바인딩에서 상속한 속성입니다. 이 compatible에서 사용하지 않는 속성도 공식 참조 문서에 실려 있으면 함께 표시합니다.
| 이름 | 형식 | 설명과 제약 |
|---|---|---|
wakeup-source | boolean | 이 장치를 시스템 깨우기에 사용할 수 있음을 나타냅니다. 이 속성이 있으면 깨우기 지원 플래그가 설정됩니다. 기본 상태에서는 장치의 인터럽트로 시스템을 깨우지 않으며, 실행 중에 깨우기 기능을 활성화할 수 있습니다. |
power-domain | phandle | 장치가 속한 전원 도메인의 phandle입니다. 해당 전원 도메인이 일시 중단되거나 다시 동작하면 장치에 알림이 전달됩니다. |
zephyr,pm-device-runtime-auto | boolean | 초기화 함수 실행 후 장치의 런타임 전원 관리를 자동으로 설정합니다. |
zephyr,disabling-power-states | phandles | 이 장치의 전원이 꺼지는 전원 상태 목록입니다. |
status | string | 장치의 동작 상태를 나타냅니다. 허용값: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss' |
compatible | string-array | 이 노드에 적용할 바인딩과 드라이버를 식별하는 compatible 문자열 목록입니다. 필수 |
reg | array | 장치 레지스터의 주소 범위를 지정합니다. 필수 |
reg-names | string-array | 각 register space의 이름입니다. |
interrupts | array | 장치에서 사용하는 인터럽트를 지정하는 목록입니다. |
interrupts-extended | compound | 인터럽트 컨트롤러의 phandle을 함께 지정하는 확장 형식의 인터럽트 명세입니다. |
interrupt-names | string-array | 각 interrupt의 이름입니다. |
interrupt-parent | phandle | 인터럽트 컨트롤러 노드를 가리키는 phandle입니다. |
label | string | 사람이 장치를 알아볼 수 있도록 붙이는 이름입니다. 과거에는 device_get_binding()의 인자로 사용했습니다. 사용 중단됨 |
clocks | phandle-array | 클록 게이트 또는 클록 공급원을 지정하는 phandle 배열입니다. |
clock-names | string-array | 각 clock의 이름입니다. |
#address-cells | int | 하위 노드의 reg 속성에서 주소를 나타내는 데 쓰는 셀 수입니다. |
#size-cells | int | 하위 노드의 reg 속성에서 크기를 나타내는 데 쓰는 셀 수입니다. |
dmas | phandle-array | DMA 채널을 지정하는 phandle 배열입니다. |
dma-names | string-array | 지정한 DMA 채널의 이름입니다. |
io-channels | phandle-array | I/O 채널을 지정하는 phandle 배열입니다. |
io-channel-names | string-array | 지정한 I/O 채널의 이름입니다. |
mboxes | phandle-array | 메일박스/IPM 채널을 지정하는 phandle 배열입니다. |
mbox-names | string-array | 지정한 메일박스/IPM 채널의 이름입니다. |
zephyr,deferred-init | boolean | 부팅할 때 장치를 자동으로 초기화하지 않습니다. 이후 device_init()를 호출해 직접 초기화해야 합니다. |
하위 노드 속성 · 10개
각 하위 노드에 적용되는 속성입니다.
| 이름 | 형식 | 설명과 제약 |
|---|---|---|
bias-disable | boolean | Pin의 모든 bias를 비활성화합니다. |
bias-pull-up | boolean | Pin의 pull-up resistor를 활성화합니다. |
bias-pull-down | boolean | Pin의 pull-down resistor를 활성화합니다. |
drive-strength | int | 네 가지 drive strength mode입니다. Mode 0은 1 mA, mode 1은 2 mA, mode 2는 4 mA, mode 3은 8 mA입니다. MAX32 MCU의 기본 GPIO output drive strength는 mode 0입니다. 자세한 내용은 device user guide와 datasheet를 참조합니다. 허용값: 0, 1, 2, 3 |
input-enable | boolean | Output에는 영향을 주지 않고 pin input buffer를 활성화합니다. |
power-source | int | Pin이 사용할 voltage rail을 선택하는 GPIO Supply Voltage Select입니다. 0 또는 MAX32_VSEL_VDDIO는 VDDIO, 1 또는 MAX32_VSEL_VDDIOH는 VDDIOH를 선택합니다. 허용값: 0, 1 |
output-enable | boolean | Pin을 능동 구동하지 않은 채 output buffer를 활성화합니다. |
output-low | boolean | Pin을 output mode로 전환하고 low level을 출력합니다. |
output-high | boolean | Pin을 output mode로 전환하고 high level을 출력합니다. |
pinmux | int | GPIO pin 번호와 mux 설정을 나타내는 정수입니다. 값은 (pin << 8 | port << 4 | function << 0)으로 계산합니다. port는 GPIO port index, pin은 port 안의 pin offset입니다. function 0은 GPIO, 1~4는 Alternate Function 1~4입니다. GPIO를 선택하면 pin은 일반 input/output GPIO로 정적으로 설정되며 기본은 input입니다. Output 값은 output-low 또는 output-high로 정합니다(공식 원문에는 첫 이름이 ouptut-low로 표기되어 있습니다). -include/zephyr/dt-bindings/pinctrl/max32-pinctrl.h의 MAX32_PINMUX macro를 사용할 수 있습니다. 예: MAX32_PINMUX(0, 9, AF1), MAX32_PINMUX(0, 9, AF2), 또는 MAX32_PINMUX(0, 9, GPIO)와 output-high입니다.필수 |
Source
출처
영어 원문에는 문단, 문서 지시문, 표, 코드, 코드 심벌, 경로를 그대로 보존했습니다.