Part 1
요약·해설
공식 원문 523줄과 property 43행을 전수 대조해 3.4 Mbit/s master behavior·mode/line tuning groups·exact legal values 제약을 보존했습니다.
Compatible
atmel,sam-i2c-twim
Vendor
Atmel Corporation
Properties
43 rows
Interface
SAM4L TWIM up to 3.4 Mbit/s + slew/drive tuning
Part 2
접을 수 있는 영어 원문 전체
영어 원문 전체 펼치기
원문 SHA-256
BC26F118FDC5A8C776B28A019E277878424F92F2A50514337B5552ED5574E855
: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-i2c-twim
.. _dtbinding_atmel_sam_i2c_twim:
atmel,sam-i2c-twim
##################
Vendor: :ref:`Atmel Corporation <dt_vendor_atmel>`
Description
***********
These nodes are "i2c" bus nodes.
.. code-block:: none
Atmel SAM4L Family I2C (TWIM) node
The Atmel Two-wire Master Interface (TWIM) interconnects components on a
unique two-wire bus, made up of one clock line and one data line with speeds
of up to 3.4 Mbit/s, based on a byte-oriented transfer format. The TWIM is
always a bus master and can transfer sequential or single bytes. Multiple
master capability is supported. Arbitration of the bus is performed
internally and relinquishes the bus automatically if the bus arbitration is
lost.
When using speeds above standard mode, user may need adjust clock and data
lines slew and strength parameters. In general, slew 0 and minimal strength
is enough for short buses and light loads. As a reference, the below
is the lowest power configuration:
std-clk-slew-lim = <0>;
std-clk-strength-low = "0.5";
std-data-slew-lim = <0>;
std-data-strength-low = "0.5";
hs-clk-slew-lim = <0>;
hs-clk-strength-high = "0.5";
hs-clk-strength-low = "0.5";
hs-data-slew-lim = <0>;
hs-data-strength-low = "0.5";
For best performances, user can tune the slope curves using an osciloscope.
The tuning should be performed by groups defined <mode>-<line>. The prefix
std-<line> configures fast/fast-plus mode speeds and hs-<line> selects the
high speed mode. The tune should be performed for both clock and data lines
on both speed modes.
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
* - ``clock-frequency``
- ``int``
- .. code-block:: none
Initial clock frequency in Hz
* - ``sq-size``
- ``int``
- .. code-block:: none
Size of the submission queue for blocking requests
Default value: ``4``
* - ``cq-size``
- ``int``
- .. code-block:: none
Size of the completion queue for blocking requests
Default value: ``4``
* - ``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.
* - ``std-clk-slew-lim``
- ``int``
- .. code-block:: none
Slew limit of the TWCK output buffer. This should be adjusted with
std-clk-strength-low to fine tune the TWCK slope.
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``std-clk-strength-low``
- ``string``
- .. code-block:: none
Pull-down drive strength of the TWCK output buffer in fast/fast plus
mode. This should be adjusted to provide proper TWCK line fall time.
The value represents the port output current in mA when signal on
low level.
This property is **required**.
Legal values: ``'0.5'``, ``'1.0'``, ``'1.6'``, ``'3.1'``, ``'6.2'``, ``'9.3'``, ``'15.5'``, ``'21.8'``
* - ``std-data-slew-lim``
- ``int``
- .. code-block:: none
Slew limit of the TWD output buffer. This should be adjusted with
std-data-strength-low to fine tune the TWD slope.
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``std-data-strength-low``
- ``string``
- .. code-block:: none
Pull-down drive strength of the TWD output buffer in fast/fast plus
mode. This should be adjusted to provide proper TWD line fall time.
The value represents the port output current in mA when signal on
low level.
This property is **required**.
Legal values: ``'0.5'``, ``'1.0'``, ``'1.6'``, ``'3.1'``, ``'6.2'``, ``'9.3'``, ``'15.5'``, ``'21.8'``
* - ``hs-clk-slew-lim``
- ``int``
- .. code-block:: none
Slew limit of the TWCK output buffer in high speed mode. This
should be adjusted with both hs-clk-strength-high and
hs-clk-strength-low to fine tune the TWCK slope.
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``hs-clk-strength-high``
- ``string``
- .. code-block:: none
Pull-up drive strength of the TWCK output buffer in high speed
mode. This should be adjusted to provide proper TWCK line rise time.
The value represents the port output current in mA when signal on
high level.
This property is **required**.
Legal values: ``'0.5'``, ``'1.0'``, ``'1.5'``, ``'3.0'``
* - ``hs-clk-strength-low``
- ``string``
- .. code-block:: none
Pull-down drive strength of the TWCK output buffer in high speed
mode. This should be adjusted to provide proper TWCK line fall time.
The value represents the port output current in mA when signal on
low level.
This property is **required**.
Legal values: ``'0.5'``, ``'1.0'``, ``'1.6'``, ``'3.1'``, ``'6.2'``, ``'9.3'``, ``'15.5'``, ``'21.8'``
* - ``hs-data-slew-lim``
- ``int``
- .. code-block:: none
Slew limit of the TWD output buffer in high speed mode. This
should be adjusted with hs-data-strength-low to fine tune the TWD
slope.
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``hs-data-strength-low``
- ``string``
- .. code-block:: none
Pull-down drive strength of the TWD output buffer in high speed
mode. This should be adjusted to provide proper TWD line fall time.
The value represents the port output current in mA when signal on
low level.
Legal values: ``'0.5'``, ``'1.0'``, ``'1.6'``, ``'3.1'``, ``'6.2'``, ``'9.3'``, ``'15.5'``, ``'21.8'``
* - ``hs-master-code``
- ``int``
- .. code-block:: none
3-bit code to be prefixed with 0b00001 to form a unique
8-bit HS-mode master code (0000 1XXX)
This property is **required**.
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
.. 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-i2c-twim" 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
This property is **required**.
Constant value: ``1``
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
This property is **required**.
* - ``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-i2c-twim
Vendor: Atmel Corporation
공식 설명
These nodes are "i2c" bus nodes.
Atmel SAM4L Family I2C (TWIM) node
The Atmel Two-wire Master Interface (TWIM) interconnects components on a
unique two-wire bus, made up of one clock line and one data line with speeds
of up to 3.4 Mbit/s, based on a byte-oriented transfer format. The TWIM is
always a bus master and can transfer sequential or single bytes. Multiple
master capability is supported. Arbitration of the bus is performed
internally and relinquishes the bus automatically if the bus arbitration is
lost.
When using speeds above standard mode, user may need adjust clock and data
lines slew and strength parameters. In general, slew 0 and minimal strength
is enough for short buses and light loads. As a reference, the below
is the lowest power configuration:
std-clk-slew-lim = <0>;
std-clk-strength-low = "0.5";
std-data-slew-lim = <0>;
std-data-strength-low = "0.5";
hs-clk-slew-lim = <0>;
hs-clk-strength-high = "0.5";
hs-clk-strength-low = "0.5";
hs-data-slew-lim = <0>;
hs-data-strength-low = "0.5";
For best performances, user can tune the slope curves using an osciloscope.
The tuning should be performed by groups defined <mode>-<line>. The prefix
std-<line> configures fast/fast-plus mode speeds and hs-<line> selects the
high speed mode. The tune should be performed for both clock and data lines
on both speed modes.SAM4L Two-wire Master Interface
TWIM은 clock 한 선과 data 한 선으로 구성된 byte-oriented two-wire bus에서 최대 3.4 Mbit/s로 동작합니다. 항상 bus master이며 연속 byte와 single byte를 전송하고 multi-master arbitration을 내부에서 처리합니다. Arbitration을 잃으면 bus를 자동으로 놓습니다.
Base compatible·reg·interrupts·clocks·#address-cells·#size-cells가 필수이고 #address-cells는 1로 고정됩니다.
clock-frequency와 blocking request용 sq-size·cq-size는 선택입니다. 두 queue 크기의 기본값은 각각 4입니다.
pinctrl-0부터 pinctrl-4와 pinctrl-names는 선택이며 실제 state 내용은 pin controller 구현을 따릅니다.
Fast/Fast-plus와 High-speed 신호 조정
Standard mode보다 빠른 bus에서는 clock·data line의 slew와 drive strength를 board 부하에 맞춰 조정해야 할 수 있습니다. 짧고 부하가 가벼운 bus의 lowest-power 참고값은 모든 slew를 0, strength를 "0.5"로 두는 구성입니다.
std-clk
TWCK slew + low pull-down, Fast/Fast-plus
std-data
TWD slew + low pull-down, Fast/Fast-plus
hs-clk
TWCK slew + high pull-up + low pull-down
hs-data
TWD slew + low pull-down, High-speed
공식 문서는 oscilloscope로 slope curve를 보며 mode-line 묶음별로 조정하고 두 mode의 clock·data 모두 확인하도록 안내합니다. Slew는 0~3입니다. Low-level strength는 0.5·1.0·1.6·3.1·6.2·9.3·15.5·21.8 mA, high-level clock strength는 0.5·1.0·1.5·3.0 mA만 허용합니다.
hs-data-strength-low만 선택이고 나머지 8개 신호 조정 property는 필수입니다. hs-master-code도 필수이며 0~7의 3-bit 값을 0b00001 뒤에 붙여 0000 1XXX를 만듭니다.
속성 전체 번역
공식 node 19개와 base 24개 property를 모두 번역했습니다.
노드 전용 속성 · 19개
| 이름 | 형식 | 설명과 제약 |
|---|---|---|
clock-frequency | int | I2C bus의 초기 clock frequency이며 Hz 단위입니다. |
sq-size | int | 완료를 기다리는 요청에 사용할 제출 큐의 크기입니다. 기본값은 4입니다. 기본값: 4 |
cq-size | int | 완료를 기다리는 요청에 사용할 완료 큐의 크기입니다. 기본값은 4입니다. 기본값: 4 |
pinctrl-0 | phandles | 첫 번째 상태에서 사용할 핀 설정입니다. 구체적인 내용은 선택한 핀 컨트롤러 드라이버에 따라 달라집니다. |
pinctrl-1 | phandles | 두 번째 상태에서 사용할 핀 설정입니다. pinctrl-0과 같은 형식입니다. |
pinctrl-2 | phandles | 세 번째 상태에서 사용할 핀 설정입니다. pinctrl-0과 같은 형식입니다. |
pinctrl-3 | phandles | 네 번째 상태에서 사용할 핀 설정입니다. pinctrl-0과 같은 형식입니다. |
pinctrl-4 | phandles | 다섯 번째 상태에서 사용할 핀 설정입니다. pinctrl-0과 같은 형식입니다. |
pinctrl-names | string-array | 핀 설정 상태의 이름입니다. 이름 수는 정의한 상태 수와 같아야 합니다. |
std-clk-slew-lim | int | Fast/Fast-plus mode TWCK 출력 buffer의 slew limit입니다. std-clk-strength-low와 함께 TWCK slope를 조정합니다. 필수 · 허용값: 0, 1, 2, 3 |
std-clk-strength-low | string | Fast/Fast-plus mode에서 TWCK가 low일 때의 pull-down drive current이며 mA 문자열로 지정합니다. 필수 · 허용값: '0.5', '1.0', '1.6', '3.1', '6.2', '9.3', '15.5', '21.8' |
std-data-slew-lim | int | Fast/Fast-plus mode TWD 출력 buffer의 slew limit입니다. std-data-strength-low와 함께 TWD slope를 조정합니다. 필수 · 허용값: 0, 1, 2, 3 |
std-data-strength-low | string | Fast/Fast-plus mode에서 TWD가 low일 때의 pull-down drive current이며 mA 문자열로 지정합니다. 필수 · 허용값: '0.5', '1.0', '1.6', '3.1', '6.2', '9.3', '15.5', '21.8' |
hs-clk-slew-lim | int | High-speed mode TWCK 출력 buffer의 slew limit입니다. High·low drive strength와 함께 slope를 조정합니다. 필수 · 허용값: 0, 1, 2, 3 |
hs-clk-strength-high | string | High-speed mode에서 TWCK가 high일 때의 pull-up drive current이며 mA 문자열로 지정합니다. 필수 · 허용값: '0.5', '1.0', '1.5', '3.0' |
hs-clk-strength-low | string | High-speed mode에서 TWCK가 low일 때의 pull-down drive current이며 mA 문자열로 지정합니다. 필수 · 허용값: '0.5', '1.0', '1.6', '3.1', '6.2', '9.3', '15.5', '21.8' |
hs-data-slew-lim | int | High-speed mode TWD 출력 buffer의 slew limit입니다. hs-data-strength-low와 함께 slope를 조정합니다. 필수 · 허용값: 0, 1, 2, 3 |
hs-data-strength-low | string | High-speed mode에서 TWD가 low일 때의 pull-down drive current이며 mA 문자열로 지정합니다. 허용값: '0.5', '1.0', '1.6', '3.1', '6.2', '9.3', '15.5', '21.8' |
hs-master-code | int | 0b00001 뒤에 붙여 8-bit HS-mode master code 0000 1XXX를 만드는 3-bit 값입니다. 필수 · 허용값: 0, 1, 2, 3, 4, 5, 6, 7 |
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 속성에서 주소를 나타내는 데 쓰는 셀 수입니다. 필수 · 고정값: 1 |
#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()를 호출해 직접 초기화해야 합니다. |
Source
출처
영어 원문에는 문단, 문서 지시문, 표, 코드, 코드 심벌, 경로를 그대로 보존했습니다.