build/dts/api/bindings/sensor/nxp,fxos8700-i2c.html · build/dts/api/bindings/sensor/nxp,fxos8700-i2c.rst 공식 원문 ↗

Zephyr 3.7.0 · Devicetree · Sensor · NXP Semiconductors

NXP FXOS8700 I2C 6축 Sensor 바인딩

FXOS8700의 가속도·자기장 측정과 pulse/vector threshold register를 정의하는 42개 property schema입니다.

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

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

Part 1

요약·해설

공식 원문 497줄과 property 42행을 전수 대조해 required I2C address·active-high reset and active-low interrupts·2/4/8g range·pulse timing·magnetic vector threshold bytes 제약을 보존했습니다.

Compatible

nxp,fxos8700

Vendor

NXP Semiconductors

Properties

42 rows

Interface

I2C accelerometer + magnetometer + pulse detector

Part 2

접을 수 있는 영어 원문 전체

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

nxp,fxos8700 (on i2c bus)
#########################

Vendor: :ref:`NXP Semiconductors <dt_vendor_nxp>`

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



.. code-block:: none

   FXOS8700 6-axis accelerometer/magnetometer sensor

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



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

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



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

                INT1 pin
                This pin defaults to active low 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 low when produced by the sensor.
                The property value should ensure the flags properly describe
                the signal that is presented to the driver.



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

                Range in g


             Default value: ``8``

             Legal values: ``8``, ``4``, ``2``

         * - ``power-mode``
           - ``int``
           - .. code-block:: none

                Power mode


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

         * - ``pulse-cfg``
           - ``int``
           - .. code-block:: none

                Pulse configuration register


             Default value: ``63``

         * - ``pulse-thsx``
           - ``int``
           - .. code-block:: none

                Pulse X-axis threshold
                Threshold to start the pulse-event detection procedure on the X-axis.
                Threshold values for each axis are unsigned 7-bit numbers with a fixed
                resolution of 0.063 g/LSB, corresponding to an 8g acceleration
                full-scale range.



             Default value: ``32``

         * - ``pulse-thsy``
           - ``int``
           - .. code-block:: none

                Pulse Y-axis threshold
                Threshold to start the pulse-event detection procedure on the Y-axis.
                Threshold values for each axis are unsigned 7-bit numbers with a fixed
                resolution of 0.063 g/LSB, corresponding to an 8g acceleration
                full-scale range.



             Default value: ``32``

         * - ``pulse-thsz``
           - ``int``
           - .. code-block:: none

                Pulse Z-axis threshold
                Threshold to start the pulse-event detection procedure on the Z-axis.
                Threshold values for each axis are unsigned 7-bit numbers with a fixed
                resolution of 0.063 g/LSB, corresponding to an 8g acceleration
                full-scale range.



             Default value: ``64``

         * - ``pulse-tmlt``
           - ``int``
           - .. code-block:: none

                Pulse time limit
                The maximum time interval that can elapse between the start of the
                acceleration on the selected channel exceeding the specified threshold
                and the end when the channel acceleration goes back below the specified
                threshold. The resolution depends upon the sample rate (ODR) and the
                high-pass filter configuration (HP_FILTER_CUTOFF[pls_hpf_en]). For
                ODR=800 Hz and pls_hpf_en=0, the resolution is 0.625 ms/LSB.



             Default value: ``24``

         * - ``pulse-ltcy``
           - ``int``
           - .. code-block:: none

                Pulse latency
                The time interval that starts after the first pulse detection where the
                pulse-detection function ignores the start of a new pulse. The
                resolution depends upon the sample rate (ODR) and the high-pass filter
                configuration (HP_FILTER_CUTOFF[pls_hpf_en]). For ODR=800 Hz and
                pls_hpf_en=0, the resolution is 1.25 ms/LSB.



             Default value: ``40``

         * - ``pulse-wind``
           - ``int``
           - .. code-block:: none

                Pulse window
                The maximum interval of time that can elapse after the end of the
                latency interval in which the start of the second pulse event must be
                detected provided the device has been configured for double pulse
                detection. The detected second pulse width must be shorter than the
                time limit constraint specified by the PULSE_TMLT register, but the end
                of the double pulse need not finish within the time specified by the
                PULSE_WIND register. The resolution depends upon the sample rate (ODR)
                and the high-pass filter configuration (HP_FILTER_CUTOFF[pls_hpf_en]).
                For ODR=800 Hz and pls_hpf_en=0, the resolution is 1.25 ms/LSB.



             Default value: ``60``

         * - ``mag-vecm-cfg``
           - ``int``
           - .. code-block:: none

                Magnetic vector-magnitude configuration register


             Default value: ``78``

         * - ``mag-vecm-ths-msb``
           - ``int``
           - .. code-block:: none

                Magnetic vector-magnitude threshold most significant byte.
                Resolution is 0.1 uT/LSB.



         * - ``mag-vecm-ths-lsb``
           - ``int``
           - .. code-block:: none

                Magnetic vector-magnitude threshold least significant byte.
                Resolution is 0.1 uT/LSB.



             Default value: ``90``



   .. 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 "nxp,fxos8700" 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

한국어 전문 번역

nxp,fxos8700

Vendor: NXP Semiconductors

공식 설명

FXOS8700 6-axis accelerometer/magnetometer sensor

Accelerometer와 magnetometer를 하나의 I2C node로 구성

Base compatible·reg가 필수입니다. Reset은 기본 active-high input이고 INT1·INT2는 기본 active-low output입니다.

Acceleration XYZ

2g · 4g · 8g

Pulse detector

Threshold · limit · latency · window

Magnetic vector

Configuration · MSB · LSB

I2C

Required address

Pulse threshold는 8g full-scale에서 0.063 g/LSB입니다. 시간 register의 해상도는 ODR와 high-pass filter에 따라 달라지며 원문이 제시한 ODR=800 Hz·filter off 조건만 명시했습니다.

mag-vecm-ths-msb에는 formal default가 없고 LSB에만 기본값 90이 있습니다. 두 byte를 하나의 임의 기본값으로 합치지 않았습니다.

속성 전체 번역

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

노드 전용 속성 · 18개
이름형식설명과 제약
supply-gpiosphandle-array장치 전용 전원 스위치를 제어하는 GPIO입니다. vin-supply와 함께 사용하면 먼저 레귤레이터에 전원 공급을 요청한 뒤 GPIO를 활성화합니다.
vin-supplyphandle공유 레귤레이터 노드의 phandle입니다. supply-gpios와 함께 사용하면 먼저 GPIO를 비활성화한 뒤 레귤레이터 사용을 해제합니다.
friendly-namestring호스트 운영체제가 같은 모델의 센서 여러 개를 구분할 때 쓰는 이름입니다. HID Usage Tables 1.3의 22.5절에 정의되어 있습니다.
reset-gpiosphandle-arrayFXOS8700 RST input입니다. Sensor가 소비할 때 기본 active-high이며 flags가 driver에 보이는 실제 signal을 기술해야 합니다.
int1-gpiosphandle-arrayFXOS8700 INT1 output입니다. Sensor가 생성할 때 기본 active-low이며 flags가 실제 signal을 기술해야 합니다.
int2-gpiosphandle-arrayFXOS8700 INT2 output입니다. Sensor가 생성할 때 기본 active-low이며 flags가 실제 signal을 기술해야 합니다.
rangeintAccelerometer full-scale range이며 g 단위입니다. 기본값은 8이고 8, 4, 2만 허용됩니다.
기본값: 8 · 허용값: 8, 4, 2
power-modeintPower mode register 값이며 0, 1, 2, 3만 허용됩니다. 이 schema는 숫자별 mode 이름을 정의하지 않습니다.
허용값: 0, 1, 2, 3
pulse-cfgintPulse detection configuration register 값이며 기본값은 63입니다.
기본값: 63
pulse-thsxintX축 pulse event 검출을 시작하는 unsigned 7-bit threshold입니다. 8g full-scale에서 0.063 g/LSB이고 기본값은 32입니다.
기본값: 32
pulse-thsyintY축 pulse event 검출을 시작하는 unsigned 7-bit threshold입니다. 8g full-scale에서 0.063 g/LSB이고 기본값은 32입니다.
기본값: 32
pulse-thszintZ축 pulse event 검출을 시작하는 unsigned 7-bit threshold입니다. 8g full-scale에서 0.063 g/LSB이고 기본값은 64입니다.
기본값: 64
pulse-tmltint선택 축이 threshold를 넘은 뒤 다시 아래로 내려올 때까지 허용하는 최대 pulse 시간입니다. ODR=800 Hz, pls_hpf_en=0이면 0.625 ms/LSB이고 기본값은 24입니다.
기본값: 24
pulse-ltcyint첫 pulse 검출 뒤 새 pulse 시작을 무시하는 latency입니다. ODR=800 Hz, pls_hpf_en=0이면 1.25 ms/LSB이고 기본값은 40입니다.
기본값: 40
pulse-windintDouble-pulse 검출에서 첫 pulse 뒤 두 번째 pulse가 시작될 수 있는 시간 window입니다. ODR=800 Hz, pls_hpf_en=0이면 1.25 ms/LSB이고 기본값은 60입니다.
기본값: 60
mag-vecm-cfgintMagnetic vector-magnitude configuration register 값이며 기본값은 78입니다.
기본값: 78
mag-vecm-ths-msbintMagnetic vector-magnitude threshold의 most significant byte입니다. 해상도는 0.1 uT/LSB이며 formal default는 없습니다.
mag-vecm-ths-lsbintMagnetic vector-magnitude threshold의 least significant byte입니다. 해상도는 0.1 uT/LSB이며 기본값은 90입니다.
기본값: 90
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

출처

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