build/dts/api/bindings/sensor/bosch,bmi08x-accel-i2c.html · build/dts/api/bindings/sensor/bosch,bmi08x-accel-i2c.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · Sensor · Bosch Sensortec GmbH

Bosch BMI08x Accelerometer I2C 바인딩

BMI08x accelerometer의 필수 frequency/full-scale·INT1/2 bit field·gyro data-sync schema를 정의하는 35개 property schema입니다.

Official pathbuild/dts/api/bindings/sensor/bosch,bmi08x-accel-i2c.html
Source filebuild/dts/api/bindings/sensor/bosch,bmi08x-accel-i2c.rst
Source versionZephyr 3.7.0
TranslationFull · reviewed

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

Part 1

요약·해설

공식 원문 403줄과 property 35행을 전수 대조해 required I2C identity plus accel-hz/fs·eight frequency and eight full-scale choices·INT A/B/C mappings·polarity/drive/direction bits·gyro phandle synchronization 제약을 보존했습니다.

Compatible

bosch,bmi08x-accel-i2c

Vendor

Bosch Sensortec GmbH

Properties

35 rows

Interface

BMI08x accelerometer I2C + INT1/INT2 mapping/config + data sync

Part 2

접을 수 있는 영어 원문 전체

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

bosch,bmi08x-accel (on i2c bus)
###############################

Vendor: :ref:`Bosch Sensortec GmbH <dt_vendor_bosch>`

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



.. code-block:: none

   BMI08X Accel inertial measurement unit

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.



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



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

                This property specifies the connection for INT, because the
                Zephyr driver maps all interrupts to INT.  The signal defaults
                to output low when produced by the sensor.



         * - ``int1-map-io``
           - ``int``
           - .. code-block:: none

                Bit[0]: Map Interrupt A to INT1, Accel Data Ready
                Bit[1]: Map Interrupt B to INT1
                Bit[2]: Map Interrupt C to INT1



         * - ``int2-map-io``
           - ``int``
           - .. code-block:: none

                Bit[0]: Map Interrupt A to INT2, Accel Data Ready
                Bit[1]: Map Interrupt B to INT2
                Bit[2]: Map Interrupt C to INT2



         * - ``int1-conf-io``
           - ``int``
           - .. code-block:: none

                Bit[0]: reserved
                Bit[1]: if set to 1, INT1 is active high, otherwise it's active low
                Bit[2]: if set to 1, INT1 is open-drain, otherwise it's push-pull
                Bit[3]: if set to 1, enable INT1 as an output pin
                Bit[4]: if set to 1, enable INT1 as an input pin
                Bit[7:5] : reserved



         * - ``int2-conf-io``
           - ``int``
           - .. code-block:: none

                Bit[0]: reserved
                Bit[1]: if set to 1, INT2 is active high, otherwise it's active low
                Bit[2]: if set to 1, INT2 is open-drain, otherwise it's push-pull
                Bit[3]: if set to 1, enable INT2 as an output pin
                Bit[4]: if set to 1, enable INT2 as an input pin
                Bit[7:5] : reserved



         * - ``accel-hz``
           - ``string``
           - .. code-block:: none

                Default frequency of accelerometer. (Unit - Hz)



             This property is **required**.

             Legal values: ``'12.5'``, ``'25'``, ``'50'``, ``'100'``, ``'200'``, ``'400'``, ``'800'``, ``'1600'``

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

                Default full scale of accelerometer. (Unit - g)



             This property is **required**.

             Legal values: ``2``, ``3``, ``4``, ``6``, ``8``, ``12``, ``16``, ``24``

         * - ``data-sync``
           - ``phandle``
           - .. code-block:: none

                Enables data sync if defined. This is to point to the bmi08x-gyro definition
                that is within the same IC as the bmi08x-accel.





   .. 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 "bosch,bmi08x-accel" 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

한국어 전문 번역

bosch,bmi08x-accel-i2c

Vendor: Bosch Sensortec GmbH

공식 설명

BMI08X Accel inertial measurement unit

Accelerometer 설정과 gyroscope synchronization

accel-hz, accel-fs, base compatible·reg가 필수입니다. Frequency는 12.5~1600Hz의 8개 string, full-scale은 2~24g의 8개 값 중 고릅니다.

Accel sampling

Required Hz + full-scale

Interrupt A/B/C

Map to INT1 / INT2

INT configuration

Polarity · drive · input/output

data-sync

Phandle → paired gyro

int1-map-io·int2-map-io의 bits 0~2가 Interrupt A/B/C를 각 pin에 mapping합니다. int1-conf-io·int2-conf-io는 polarity, open-drain/push-pull, input/output enable을 설정합니다.

data-sync는 같은 IC의 BMI08x gyroscope node를 가리키는 phandle입니다. 일반 boolean이 아니며 accel과 gyro의 두 definition을 연결합니다.

속성 전체 번역

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

노드 전용 속성 · 11개
이름형식설명과 제약
supply-gpiosphandle-arrayDevice 전용 power switch를 제어하는 GPIO입니다. Supply state는 driver가 전적으로 관리합니다. vin-supply와 함께 있으면 regulator를 먼저 요청한 뒤 GPIO를 active로 만듭니다.
vin-supplyphandleShared regulator node의 phandle입니다. 여러 consumer의 요청 상태에 따라 supply가 유지됩니다. supply-gpios와 함께 있으면 GPIO를 inactive로 만든 뒤 regulator를 해제합니다.
friendly-namestring같은 model의 여러 sensor instance를 host OS가 구분할 수 있게 하는 사람이 읽을 수 있는 이름입니다. HID Usage Tables 1.3의 Generic Sensor Property Usages(section 22.5)에 정의됩니다.
int-gpiosphandle-arrayZephyr driver가 모든 interrupt를 INT로 mapping하므로 INT connection을 지정합니다. Sensor가 생성하는 signal은 기본 output-low입니다.
int1-map-iointBit 0은 Interrupt A(Accel Data Ready), bit 1은 Interrupt B, bit 2는 Interrupt C를 INT1에 mapping합니다.
int2-map-iointBit 0은 Interrupt A(Accel Data Ready), bit 1은 Interrupt B, bit 2는 Interrupt C를 INT2에 mapping합니다.
int1-conf-iointINT1 configuration bit field입니다. Bit 1은 1 active-high/0 active-low, bit 2는 1 open-drain/0 push-pull, bit 3은 output enable, bit 4는 input enable이며 bit 0과 7:5는 reserved입니다.
int2-conf-iointINT2 configuration bit field입니다. Bit 1은 1 active-high/0 active-low, bit 2는 1 open-drain/0 push-pull, bit 3은 output enable, bit 4는 input enable이며 bit 0과 7:5는 reserved입니다.
accel-hzstring필수 accelerometer 기본 frequency이며 Hz 단위입니다. Legal string은 12.5·25·50·100·200·400·800·1600입니다.
필수 · 허용값: '12.5', '25', '50', '100', '200', '400', '800', '1600'
accel-fsint필수 accelerometer full-scale이며 g 단위입니다. Legal 값은 2·3·4·6·8·12·16·24입니다.
필수 · 허용값: 2, 3, 4, 6, 8, 12, 16, 24
data-syncphandle같은 IC 안의 bosch,bmi08x-gyro definition을 가리키는 phandle입니다. 정의하면 accelerometer와 gyroscope data sync를 활성화합니다.
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

출처

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