build/dts/api/bindings/sensor/st,lis2du12-spi.html · build/dts/api/bindings/sensor/st,lis2du12-spi.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · Sensor · STMicroelectronics

ST LIS2DU12 SPI 초저전력 3축 Accelerometer 바인딩

LIS2DU12의 SPI transfer·ULP/일반 ODR·pin/software trigger·range와 DRDY routing를 정의하는 39개 property schema입니다.

Official pathbuild/dts/api/bindings/sensor/st,lis2du12-spi.html
Source filebuild/dts/api/bindings/sensor/st,lis2du12-spi.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

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

Part 1

요약·해설

공식 원문 480줄과 property 39행을 전수 대조해 required SPI frequency/register·range/ODR/performance coupling·external/software trigger·INT1/INT2 pulse/latch·SPI controls 제약을 보존했습니다.

Compatible

st,lis2du12

Vendor

STMicroelectronics

Properties

39 rows

Interface

SPI ultra-low-power accelerometer + trigger ODR

Part 2

접을 수 있는 영어 원문 전체

영어 원문 전체 펼치기
원문 SHA-256 2805E5E3CA26FC9E29285BFEB9F4FBD717F2CABFE1F5FE499EECF1EDF257161B
: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>


.. _dtbinding_st_lis2du12_spi:

st,lis2du12 (on spi bus)
########################

Vendor: :ref:`STMicroelectronics <dt_vendor_st>`

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



.. code-block:: none

   STMicroelectronics LIS2DU12 3-axis ultra-low power accelerometer sensor
   accessed through SPI bus

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.



         * - ``spi-max-frequency``
           - ``int``
           - .. code-block:: none

                Maximum clock frequency of device's SPI interface in Hz


             This property is **required**.

         * - ``duplex``
           - ``int``
           - .. code-block:: none

                Duplex mode, full or half. By default it's always full duplex thus 0
                as this is, by far, the most common mode.
                Use the macros not the actual enum value, here is the concordance
                list (see dt-bindings/spi/spi.h)
                  0    SPI_FULL_DUPLEX
                  2048 SPI_HALF_DUPLEX



             Legal values: ``0``, ``2048``

         * - ``frame-format``
           - ``int``
           - .. code-block:: none

                Motorola or TI frame format. By default it's always Motorola's,
                thus 0 as this is, by far, the most common format.
                Use the macros not the actual enum value, here is the concordance
                list (see dt-bindings/spi/spi.h)
                  0     SPI_FRAME_FORMAT_MOTOROLA
                  32768 SPI_FRAME_FORMAT_TI



             Legal values: ``0``, ``32768``

         * - ``spi-cpol``
           - ``boolean``
           - .. code-block:: none

                SPI clock polarity which indicates the clock idle state.
                If it is used, the clock idle state is logic high; otherwise, low.



         * - ``spi-cpha``
           - ``boolean``
           - .. code-block:: none

                SPI clock phase that indicates on which edge data is sampled.
                If it is used, data is sampled on the second edge; otherwise, on the first edge.



         * - ``spi-hold-cs``
           - ``boolean``
           - .. code-block:: none

                In some cases, it is necessary for the master to manage SPI chip select
                under software control, so that multiple spi transactions can be performed
                without releasing it. A typical use case is variable length SPI packets
                where the first spi transaction reads the length and the second spi transaction
                reads length bytes.



         * - ``friendly-name``
           - ``string``
           - .. code-block:: none

                Human readable string describing the sensor. It can be used to
                distinguish multiple instances of the same model (e.g., lid accelerometer
                vs. base accelerometer in a laptop) to a host operating system.

                This property is defined in the Generic Sensor Property Usages of the HID
                Usage Tables specification
                (https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).



         * - ``int1-gpios``
           - ``phandle-array``
           - .. code-block:: none

                INT1 pin

                This pin defaults to active high when produced by the sensor.
                The property value should ensure the flags properly describe
                the signal that is presented to the driver.



         * - ``int2-gpios``
           - ``phandle-array``
           - .. code-block:: none

                INT2 pin

                This pin defaults to active high when produced by the sensor.
                The property value should ensure the flags properly describe
                the signal that is presented to the driver.



         * - ``drdy-pin``
           - ``int``
           - .. code-block:: none

                Select DRDY pin number (1 or 2).

                1 = drdy is generated from INT1
                2 = drdy is generated from INT2

                This number represents which of the two interrupt pins
                (INT1 or INT2) the drdy line is attached to. This property is not
                mandatory and if not present it defaults to 1 which is the
                configuration at power-up.



             Default value: ``1``

             Legal values: ``1``, ``2``

         * - ``accel-range``
           - ``int``
           - .. code-block:: none

                Range in g. Default is power-up configuration.

                0 # LIS2DU12_DT_FS_2G  (0.061 mg/LSB)
                1 # LIS2DU12_DT_FS_4G  (0.122 mg/LSB)
                2 # LIS2DU12_DT_FS_8G  (0.244 mg/LSB)
                3 # LIS2DU12_DT_FS_16G (0.488 mg/LSB)



             Legal values: ``0``, ``1``, ``2``, ``3``

         * - ``accel-odr``
           - ``int``
           - .. code-block:: none

                Specify the default accelerometer output data rate expressed in samples per second (Hz).
                The values are taken in accordance to lis2du12_md_t enumerative in hal/st
                module. Please note that this values will also enable/disable High performance mode.
                Default is power-up configuration.

                0x00 # LIS2DU12_DT_ODR_OFF
                0x01 # LIS2DU12_DT_ODR_AT_1Hz6_ULP
                0x02 # LIS2DU12_DT_ODR_AT_3Hz_ULP
                0x03 # LIS2DU12_DT_ODR_AT_6Hz_ULP
                0x04 # LIS2DU12_DT_ODR_AT_6Hz
                0x05 # LIS2DU12_DT_ODR_AT_12Hz
                0x06 # LIS2DU12_DT_ODR_AT_25Hz
                0x07 # LIS2DU12_DT_ODR_AT_50Hz
                0x08 # LIS2DU12_DT_ODR_AT_100Hz
                0x09 # LIS2DU12_DT_ODR_AT_200Hz
                0x0a # LIS2DU12_DT_ODR_AT_400Hz
                0x0b # LIS2DU12_DT_ODR_AT_800Hz
                0x0e # LIS2DU12_DT_ODR_TRIG_PIN
                0x0f # LIS2DU12_DT_ODR_TRIG_SW



             Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``, ``8``, ``9``, ``10``, ``11``, ``14``, ``15``

         * - ``drdy-pulsed``
           - ``boolean``
           - .. code-block:: none

                Selects the pulsed mode for data-ready interrupt when enabled,
                and the latched mode when disabled.





   .. 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,lis2du12" 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().






Part 3

한국어 전문 번역

st,lis2du12

Vendor: STMicroelectronics

공식 설명

SPI bus로 접근하는 STMicroelectronics LIS2DU12 3축 ultra-low-power accelerometer

LIS2DU12 저전력·trigger 측정을 SPI로 연결

spi-max-frequency와 base compatible·reg가 필수이고, sensor 설정과 나머지 SPI mode는 선택입니다.

Acceleration

2 · 4 · 8 · 16g

ODR

ULP · normal · trigger

SPI

Frequency · duplex · frame

DRDY

INT1/INT2 · pulse/latch

ODR code 1~3은 ULP 1.6/3/6Hz, 4~11은 6~800Hz이며 14/15는 pin/software trigger입니다. 이 enum은 high-performance mode에도 영향을 줍니다.

SPI의 duplex와 frame은 공식 macro를 쓰고 CPOL/CPHA와 CS hold를 별도로 설정합니다. ODR trigger code를 SPI mode와 혼동하면 안 됩니다.

속성 전체 번역

공식 node-specific 15개와 base 24개 property를 모두 번역했습니다.

노드 전용 속성 · 15개
이름형식설명과 제약
supply-gpiosphandle-array장치 전용 전원 스위치를 제어하는 GPIO입니다. vin-supply와 함께 사용하면 먼저 레귤레이터에 전원 공급을 요청한 뒤 GPIO를 활성화합니다.
vin-supplyphandle공유 레귤레이터 노드의 phandle입니다. supply-gpios와 함께 사용하면 먼저 GPIO를 비활성화한 뒤 레귤레이터 사용을 해제합니다.
spi-max-frequencyintDevice SPI interface의 최대 clock frequency이며 Hz 단위의 필수 값입니다.
필수
duplexintSPI duplex mode입니다. 0은 SPI_FULL_DUPLEX, 2048은 SPI_HALF_DUPLEX이며 실제 숫자보다 dt-bindings/spi/spi.h macro를 사용합니다.
허용값: 0, 2048
frame-formatintSPI frame format입니다. 0은 SPI_FRAME_FORMAT_MOTOROLA, 32768은 SPI_FRAME_FORMAT_TI이며 해당 macro를 사용합니다.
허용값: 0, 32768
spi-cpolboolean설정하면 SPI clock idle state가 high이고, 없으면 low입니다.
spi-cphaboolean설정하면 두 번째 edge에서 data를 sample하고, 없으면 첫 번째 edge에서 sample합니다.
spi-hold-csboolean여러 SPI transaction 사이에서 chip select를 해제하지 않고 software가 유지하게 합니다.
friendly-namestring호스트 운영체제가 같은 모델의 센서 여러 개를 구분할 때 쓰는 이름입니다. HID Usage Tables 1.3의 22.5절에 정의되어 있습니다.
int1-gpiosphandle-arrayLIS2DU12 INT1 pin 연결입니다. Sensor output은 기본 active-high입니다. GPIO flags가 driver에 실제로 전달되는 signal을 정확히 기술해야 합니다.
int2-gpiosphandle-arrayLIS2DU12 INT2 pin 연결입니다. Sensor output은 기본 active-high입니다. GPIO flags가 driver에 실제로 전달되는 signal을 정확히 기술해야 합니다.
drdy-pinintDRDY를 INT1 또는 INT2 중 어느 pin에서 생성할지 선택합니다. 1은 INT1, 2는 INT2이며 기본값은 power-up 구성과 같은 1입니다.
기본값: 1 · 허용값: 1, 2
accel-rangeintLIS2DU12 full-scale code 0/1/2/3은 2/4/8/16g이며 감도는 0.061/0.122/0.244/0.488 mg/LSB입니다. 생략하면 power-up 구성을 사용합니다.
허용값: 0, 1, 2, 3
accel-odrintLIS2DU12 ODR code는 0 off, 1~3 ULP 1.6/3/6Hz, 4~11 일반 6/12/25/50/100/200/400/800Hz, 14 external pin trigger, 15 software trigger입니다. 선택은 high-performance mode도 바꿉니다.
허용값: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 14, 15
drdy-pulsedboolean설정하면 data-ready interrupt를 pulsed mode로, 설정하지 않으면 latched mode로 사용합니다.
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

출처

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