Part 1
요약·해설
공식 원문 429줄과 property 37행을 전수 대조해 required analog timing/filter controls·optional raw-to-screen scaling·latency/noise tradeoffs 제약을 보존했습니다.
st,stmpe811
STMicroelectronics
37 rows
I2C resistive touchscreen + calibrated coordinate scaling
Part 2
접을 수 있는 영어 원문 전체
영어 원문 전체 펼치기
F1EC1A608AA1CB6D51FD7BD3540591844E78A6E8152E6314DBE5DEB38C4AF759
: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:: st,stmpe811
.. _dtbinding_st_stmpe811:
st,stmpe811 (on i2c bus)
########################
Vendor: :ref:`STMicroelectronics <dt_vendor_st>`
Description
***********
.. code-block:: none
STMPE811 I2C touchscreen 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
* - ``supply-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO specifier that controls power to the device.
This property should be provided when the device has a dedicated
switch that controls power to the device. The supply state is
entirely the responsibility of the device driver.
Contrast with vin-supply.
* - ``vin-supply``
- ``phandle``
- .. code-block:: none
Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.
This property should be provided when device power is supplied
by a shared regulator. The supply state is dependent on the
request status of all devices fed by the regulator.
Contrast with supply-gpios. If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.
* - ``int-gpios``
- ``phandle-array``
- .. code-block:: none
Interrupt GPIO. Used by the controller to signal touch data is
available. Active low.
* - ``screen-width``
- ``int``
- .. code-block:: none
Screen width for scaling the reported coordinates.
Default: raw touchscreen resolution.
* - ``screen-height``
- ``int``
- .. code-block:: none
Screen height for scaling the reported coordinates.
Default: raw touchscreen resolution.
* - ``raw-x-min``
- ``int``
- .. code-block:: none
Signed raw X axis start for scaling the reported coordinates.
No effect if screen size is not set.
* - ``raw-y-min``
- ``int``
- .. code-block:: none
Signed raw Y axis start for scaling the reported coordinates.
No effect if screen size is not set.
* - ``raw-x-max``
- ``int``
- .. code-block:: none
Raw X axis end for scaling the reported coordinates.
No effect if screen size is not set.
* - ``raw-y-max``
- ``int``
- .. code-block:: none
Raw Y axis end for scaling the reported coordinates.
No effect if screen size is not set.
* - ``panel-driver-settling-time-us``
- ``int``
- .. code-block:: none
Panel driver settling time (microseconds). For large panels (> 6"), a capacitor of 10 nF
is recommended at the touchscreen terminals for noise filtering.
As a general rule, 1-5 nF capacitors require around 500 us settling time, and 5-10 nF need
around 1 ms. When a larger capacitor is used, this value should be changed, as it can
lead to inaccuracy of the measurement.
This property is **required**.
Legal values: ``10``, ``100``, ``500``, ``1000``, ``5000``, ``10000``, ``50000``, ``100000``
* - ``touch-detect-delay-us``
- ``int``
- .. code-block:: none
Touch detect delay (microseconds) is the delay from the activation of the pull-up resistor
in the X+ line to the time the device performs touch detection.
If no capacitor, or a smaller capacitor is used, this value can be lowered to
minimize detection latency, but it could lower the position stability.
This property is **required**.
Legal values: ``10``, ``50``, ``100``, ``500``, ``1000``, ``5000``, ``10000``, ``50000``
* - ``touch-average-control``
- ``int``
- .. code-block:: none
Average control (number of samples).
This parameter can be set to any of the possible values.
Higher values result in more filtering of noise, but also introduce
more latency in the touch detection process.
Use cases that require low touch detection latency
may benefit from using a lower value for this parameter,
at the cost of less noise filtering.
This property is **required**.
Legal values: ``1``, ``2``, ``4``, ``8``
* - ``tracking-index``
- ``int``
- .. code-block:: none
Tracking index determines the minimal distance between
the current touch position and the previous touch position.
If the distance is shorter than the tracking index, it is discarded.
Lowering the tracking index increases the frequency of touch events,
but also increases the load on the system.
This property is **required**.
Legal values: ``0``, ``4``, ``8``, ``16``, ``32``, ``64``, ``92``, ``127``
.. 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 "st,stmpe811" 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
device address on i2c bus
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().
Part 3
한국어 전문 번역
st,stmpe811
Vendor: STMicroelectronics
공식 설명
STMPE811 I2C touchscreen controllerSTMPE811 touchscreen controller
Base compatible와 I2C address인 reg, 그리고 panel-driver-settling-time-us·touch-detect-delay-us·touch-average-control·tracking-index가 필수입니다.
Analog timing과 filtering
- Settling time: 큰 panel과 큰 filtering capacitor일수록 늘려 measurement inaccuracy를 피함
- Touch detect delay: 줄이면 latency는 낮아지지만 position stability가 떨어질 수 있음
- Average control: 1·2·4·8 samples, 값이 클수록 noise filtering과 latency가 함께 증가
- Tracking index: 이동 거리가 이 값보다 작으면 버림, 낮출수록 event 빈도와 system load 증가
screen-width·screen-height를 설정하면 raw X/Y 범위를 output 좌표로 scaling합니다. Raw min/max는 screen size가 없으면 효과가 없습니다.
공식 권고는 6 inch보다 큰 panel에서 terminal에 10 nF capacitor를 쓰는 것이며 1~5 nF는 약 500 us, 5~10 nF는 약 1 ms settling을 예로 듭니다.
속성 전체 번역
공식 node 13개와 base 24개 property를 모두 번역했습니다.
노드 전용 속성 · 13개
| 이름 | 형식 | 설명과 제약 |
|---|---|---|
supply-gpios | phandle-array | 장치 전용 전원 스위치를 제어할 GPIO를 지정합니다. 드라이버가 전원 공급 상태를 관리합니다. |
vin-supply | phandle | 장치에 전원을 공급하는 공유 레귤레이터 노드의 phandle입니다. |
int-gpios | phandle-array | Controller가 touch data 준비를 알리는 active-low interrupt GPIO입니다. |
screen-width | int | 보고 좌표를 scaling할 screen width입니다. 기본 동작은 raw touchscreen resolution입니다. |
screen-height | int | 보고 좌표를 scaling할 screen height입니다. 기본 동작은 raw touchscreen resolution입니다. |
raw-x-min | int | 보고 좌표 scaling에 사용할 signed raw X 시작값입니다. Screen size를 설정하지 않으면 효과가 없습니다. |
raw-y-min | int | 보고 좌표 scaling에 사용할 signed raw Y 시작값입니다. Screen size를 설정하지 않으면 효과가 없습니다. |
raw-x-max | int | 보고 좌표 scaling에 사용할 raw X 끝값입니다. Screen size를 설정하지 않으면 효과가 없습니다. |
raw-y-max | int | 보고 좌표 scaling에 사용할 raw Y 끝값입니다. Screen size를 설정하지 않으면 효과가 없습니다. |
panel-driver-settling-time-us | int | Touch panel driver가 안정되도록 기다릴 시간이며 microsecond 단위입니다. 필수 · 허용값: 10, 100, 500, 1000, 5000, 10000, 50000, 100000 |
touch-detect-delay-us | int | X+ line pull-up 활성화 뒤 touch detection까지 기다릴 시간이며 microsecond 단위입니다. 필수 · 허용값: 10, 50, 100, 500, 1000, 5000, 10000, 50000 |
touch-average-control | int | Touch position 하나를 만들 때 평균낼 sample 수입니다. 필수 · 허용값: 1, 2, 4, 8 |
tracking-index | int | 현재 position과 이전 position 사이에서 event로 인정할 최소 거리입니다. 필수 · 허용값: 0, 4, 8, 16, 32, 64, 92, 127 |
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()를 호출해 직접 초기화해야 합니다. |
Source
출처
영어 원문에는 문단, 문서 지시문, 표, 코드, 코드 심벌, 경로를 그대로 보존했습니다.