build/dts/api/bindings/input/adc-keys.html · build/dts/api/bindings/input/adc-keys.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · Input · Generic or vendor-independent

ADC Resistor-Ladder Keys 바인딩

ADC resistor ladder의 단일·동시 key voltage threshold mapping를 정의하는 28개 property schema입니다.

Official pathbuild/dts/api/bindings/input/adc-keys.html
Source filebuild/dts/api/bindings/input/adc-keys.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

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

Part 1

요약·해설

공식 원문 360줄과 property 28행을 전수 대조해 required ADC channel and key-up threshold·per-key threshold arrays·multi-key voltage mapping 제약을 보존했습니다.

Compatible

adc-keys

Vendor

Generic or vendor-independent

Properties

28 rows

Interface

ADC resistor ladder + per-key voltage thresholds

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 73CAF8504E641A2A87E55AC82F568CC2823BEB8A4927553AE54FD367A4281684
: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:: adc-keys
.. _dtbinding_adc_keys:

adc-keys
########

Vendor: :ref:`Generic or vendor-independent <dt_no_vendor>`

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



.. code-block:: none

   Input driver for ADC attached resistor ladder buttons.

   The driver itself does not calculate each possible combination of resistor
   values. Instead, users are required to specify the voltage for each single
   key press or for combinations of key presses.

   Example:

   #include <dt-bindings/input/input-event-codes.h>

   / {
           buttons {
                   compatible = "adc-keys";
                   io-channels = <&adc 2>;
                   keyup-threshold-mv = <0>;

                   key_0 {
                           press-thresholds-mv = <1650>,  /* KEY0 */
                                                 <2536>;  /* KEY0 + KEY1 */
                           zephyr,code = <INPUT_KEY_0>;
                   };

                   key_1 {
                           press-thresholds-mv = <2300>,  /* KEY1 */
                                                 <2536>;  /* KEY0 + KEY1 */
                           zephyr,code = <INPUT_KEY_1>;
                   };
           };
   };

Properties
**********

Top level properties
====================


These property descriptions apply to "adc-keys"
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.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``sample-period-ms``
           - ``int``
           - .. code-block:: none

                Sample period in milliseconds.
                If not specified defaults to 20.



             Default value: ``20``

         * - ``keyup-threshold-mv``
           - ``int``
           - .. code-block:: none

                Millivolt value to which all the keys are considered up.



             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 "adc-keys" 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

                Phandle to an ADC channel.


             This property is **required**.

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

   * - ``press-thresholds-mv``
     - ``array``
     - .. code-block:: none

          Array of millivolt values to consider a key pressed.



       This property is **required**.

   * - ``zephyr,code``
     - ``int``
     - .. code-block:: none

          Key code to emit.


       This property is **required**.

Part 3

한국어 전문 번역

adc-keys

Vendor: Generic or vendor-independent

공식 설명

Input driver for ADC attached resistor ladder buttons.

The driver itself does not calculate each possible combination of resistor
values. Instead, users are required to specify the voltage for each single
key press or for combinations of key presses.

Example:

#include <dt-bindings/input/input-event-codes.h>

/ {
        buttons {
                compatible = "adc-keys";
                io-channels = <&adc 2>;
                keyup-threshold-mv = <0>;

                key_0 {
                        press-thresholds-mv = <1650>,  /* KEY0 */
                                              <2536>;  /* KEY0 + KEY1 */
                        zephyr,code = <INPUT_KEY_0>;
                };

                key_1 {
                        press-thresholds-mv = <2300>,  /* KEY1 */
                                              <2536>;  /* KEY0 + KEY1 */
                        zephyr,code = <INPUT_KEY_1>;
                };
        };
};

ADC resistor-ladder buttons

Driver는 resistor 조합을 자동 계산하지 않습니다. 사용자가 각 단일 key와 동시 key 조합에서 측정될 voltage를 직접 press-thresholds-mv 배열로 제공해야 합니다.

Parent의 keyup-threshold-mv, base io-channels·compatible가 필수이고 sample 주기는 기본 20 ms입니다. 각 child는 press-thresholds-mv와 발생시킬 zephyr,code가 필수입니다.

공식 예의 조합 판정

  • KEY0: 1650 mV, KEY0+KEY1: 2536 mV
  • KEY1: 2300 mV, KEY0+KEY1: 2536 mV
  • 동시 press voltage 2536 mV를 두 child threshold 배열에 모두 넣어 두 key event와 연결

Threshold 정렬, tolerance와 hysteresis는 이 공식 schema가 별도 property로 정의하지 않습니다.

속성 전체 번역

공식 node 2개, base 24개, child 2개 property를 모두 번역했습니다.

노드 전용 속성 · 2개
이름형식설명과 제약
sample-period-msintADC resistor-ladder key를 다시 sample하는 주기이며 millisecond 단위입니다.
기본값: 20
keyup-threshold-mvint모든 key가 released 상태로 간주되는 ADC voltage threshold입니다.
필수
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()를 호출해 직접 초기화해야 합니다.
하위 노드 속성 · 2개

각 하위 노드에 적용되는 속성입니다.

이름형식설명과 제약
press-thresholds-mvarray해당 key 또는 key 조합이 pressed 상태로 판정되는 millivolt 값 배열입니다.
필수
zephyr,codeintKey press 때 발생시킬 Zephyr input key code입니다.
필수

Source

출처

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