: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,mems-dil24-socket
.. _dtbinding_st_mems_dil24_socket:

st,mems-dil24-socket
####################

Vendor: :ref:`STMicroelectronics N.V. <dt_vendor_st>`

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



.. code-block:: none

   GPIO pins exposed on STMicroelectronics MEMS (DIL24) socket.

   The ST Micro Electronic Mechanical Systems (MEMS) layout provides
   one standard DIL24 socket for additional MEMS adapters and other
   sensors with I2C or SPI connectivity.

   Proceeding counter-clockwise:
   * The first two pins for common power supply. No pins on this header
     are exposed by this binding.
   * A 10-pin row with analog inputs follows.
   * A 11-pin row with digital in-/outputs along opposite side.

   This binding provides a nexus mapping for 21 pins where parent
   pins 0 through 9 correspond to A0 through A9, and parent pins 10
   through 20 correspond to D0 through D10, as depicted below:

                    .---._.---.
   (3V3)     VDD  - o *       o 20  D10 <-> (INT5_Pin24 / SCx/SCL  / GP)
   (3V3)  VDD_IO  - o         o 19  D9  <-> (SA0/DEN    / GPIO3    / HP)
   (CSx)  <-- A0  0 o         o 18  D8  <-> (SA0/DRDY   / SPI_MISO / SDO)
   (SCx)  <-- A1  1 o         o 17  D7  <-> (I2C_SDA    / SPI_MOSI / SDI)
   (SDx)  <-- A2  2 o         o 16  D6  <-> (I2C_SCL    / SPI_CK   / SDC)
   (SDOx) <-- A3  3 o         o 15  D5  <-> (CS1_Pin19  / SPI_CS   / SCS)
   (N/C)  <-- A4  4 o         o 14  D4  <-> (CS2_Pin18  / CSx      / PD)
   (N/C)  <-- A5  5 o         o 13  D3  <-> (INT4_Pin17 / SDx/SDA  / FS)
   (N/C)  <-- A6  6 o         o 12  D2  <-> (INT3_Pin16 / SDOx     / ST)
   (N/C)  <-- A7  7 o         o 11  D1  <-> (INT2       / GPIO2)
   (N/C)  <-- A8  8 o         o 10  D0  <-> (INT1       / GPIO1)
   (N/C)  <-- A9  9 o         o -   GND
                    `---------´

   Additional information about the pinout can be found in the
   following ST User Manuals:
   * UM1820: X-NUCLEO-IKS01A1 shield
   * UM2121: X-NUCLEO-IKS01A2 shield
   * UM2559: X-NUCLEO-IKS01A3 shield
   * UM2633: X-NUCLEO-IKS02A1 shield
   * DB1134: STEVAL-MKI015V1 adapter board (LIS344ALH)
   * DB1014: STEVAL-MKI089V1 adapter board (LIS331DLH)
   * DB1288: STEVAL-MKI105V1 adapter board (LIS3DH)
   * DB1401: STEVAL-MKI106V1 adapter board (LSM303DLHC)
   * DB1602: STEVAL-MKI107V2 adapter board (L3GD20)
   * DB1475: STEVAL-MKI109V2 motherboard (STM32F103RE)
   * DB2985: STEVAL-MKI109V3 motherboard (STM32F401VE)
   * DB1272: STEVAL-MKI110V1 adapter board (AIS328DQ)
   * DB1624: STEVAL-MKI122V1 adapter board (LSM330DLC)
   * DB1625: STEVAL-MKI123V1 adapter board (LSM330D)
   * DB1935: STEVAL-MKI125V1 adapter board (A3G4250D)
   * DB1903: STEVAL-MKI133V1 adapter board (LSM303D)
   * DB1902: STEVAL-MKI134V1 adapter board (LIS3DSH)
   * DB1991: STEVAL-MKI135V1 adapter board (LIS2DH)
   * DB1992: STEVAL-MKI137V1 adapter board (LIS3MDL)
   * DB2266: STEVAL-MKI141V2 adapter board (HTS221)
   * DB2130: STEVAL-MKI142V1 adapter board (LPS25H)
   * DB2509: STEVAL-MKI158V1 adapter board (AIS3624DQ)
   * DB2533: STEVAL-MKI159V1 adapter board (LSM9DS1)
   * DB2534: STEVAL-MKI160V1 adapter board (LSM6DS3)
   * DB2537: STEVAL-MKI164V1 adapter board (LIS2HH12)
   * DB3072: STEVAL-MKI173V1 adapter board (LSM303AH)
   * DB3067: STEVAL-MKI174V1 adapter board (LIS2DS12)
   * DB3059: STEVAL-MKI175V1 adapter board (LIS2DE12)
   * DB3060: STEVAL-MKI176V1 adapter board (LSM6DS3H)
   * DB3056: STEVAL-MKI177V1 adapter board (LPS35HW)
   * DB3073: STEVAL-MKI178V1 adapter board (LSM6DSL)
   * DB3511: STEVAL-MKI178V2 adapter board (LSM6DSL)
   * DB3352: STEVAL-MKI181V1 adapter board (LIS2MDL)
   * DB3353: STEVAL-MKI182V1 adapter board (ISM330DLC)
   * DB3610: STEVAL-MKI182V2 adapter board (ISM330DLC)
   * DB3463: STEVAL-MKI183V1 adapter board (LPS33HW)
   * DB3481: STEVAL-MKI184V1 adapter board (ISM303DAC)
   * DB3484: STEVAL-MKI185V1 adapter board (IIS2MDC)
   * DB3616: STEVAL-MKI189V1 adapter board (LSM6DSM)
   * DB3686: STEVAL-MKI192V1 adapter board (LPS22HH)
   * DB3687: STEVAL-MKI193V1 adapter board (ASM330LHH)
   * DB3689: STEVAL-MKI194V1 adapter board (LSM6DSR)
   * DB3693: STEVAL-MKI195V1 adapter board (LSM6DSRX)
   * DB3714: STEVAL-MKI196V1 adapter board (LSM6DSO)
   * DB3721: STEVAL-MKI197V1 adapter board (LSM6DSOX)
   * DB3859: STEVAL-MKI205V1 adapter board (LPS33W)
   * DB4011: STEVAL-MKI207V1 adapter board (ISM330DHCX)
   * DB4044: STEVAL-MKI213V1 adapter board (LPS27HHW)
   * DB4223: STEVAL-MKI214V1 adapter board (LPS33K)
   * DB4222: STEVAL-MKI215V1 adapter board (LSM6DSO32)
   * DB4336: STEVAL-MKI217V1 adapter board (LSM6DSOX and LIS2MDL)
   * DB4406: STEVAL-MKI219V1 adapter board (LPS22CH)
   * DB4371: STEVAL-MKI220V1 adapter board (LPS27HHTW)
   * DB4648: STEVAL-MKI224V1 adapter board (LPS22DF)
   * DB4686: STEVAL-MKI225A adapter board (LPS28DFW)

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

         * - ``gpio-map``
           - ``compound``
           - This property is **required**.

         * - ``gpio-map-mask``
           - ``compound``
           - 

         * - ``gpio-map-pass-thru``
           - ``compound``
           - 

         * - ``#gpio-cells``
           - ``int``
           - .. code-block:: none

                Number of items to expect in a GPIO specifier


             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 "st,mems-dil24-socket" compatible.

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

         * - Name
           - Type
           - Details

         * - ``status``
           - ``string``
           - .. code-block:: none

                Indicates the operational status of the hardware or other
                resource that the node represents. In particular:

                  - "okay" means the resource is operational and, for example,
                    can be used by device drivers
                  - "disabled" means the resource is not operational and the system
                    should treat it as if it is not present

                For details, see "2.3.4 status" in Devicetree Specification v0.4.



             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                This property is a list of strings that essentially define what
                type of hardware or other resource this devicetree node
                represents. Each device driver checks for specific compatible
                property values to find the devicetree nodes that represent
                resources that the driver should manage.

                The recommended format is "vendor,device", The "vendor" part is
                an abbreviated name of the vendor. The "device" is usually from
                the datasheet.

                The compatible property can have multiple values, ordered from
                most- to least-specific. Having additional values is useful when the
                device is a specific instance of a more general family, to allow the
                system to match the most specific driver available.

                For details, see "2.3.1 compatible" in Devicetree Specification v0.4.



             This property is **required**.

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``reg``
           - ``array``
           - .. code-block:: none

                Information used to address the device. The value is specific to
                the device (i.e. is different depending on the compatible
                property).

                The "reg" property is typically a sequence of (address, length) pairs.
                Each pair is called a "register block". Values are
                conventionally written in hex.

                For details, see "2.3.6 reg" in Devicetree Specification v0.4.



             See :ref:`zephyr:dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to each register block in the "reg" property.
                For example:

                  / {
                       soc {
                           #address-cells = <1>;
                           #size-cells = <1>;

                           uart@1000 {
                               reg = <0x1000 0x2000>, <0x3000 0x4000>;
                               reg-names = "foo", "bar";
                           };
                       };
                  };

                The uart@1000 node has two register blocks:

                  - one with base address 0x1000, size 0x2000, and name "foo"
                  - another with base address 0x3000, size 0x4000, and name "bar"



         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                Information about interrupts generated by the device, encoded as an array
                of one or more interrupt specifiers. The format of the data in this property
                varies by where the device appears in the interrupt tree. Devices with the same
                "interrupt-parent" will use the same format in their interrupts properties.

                For details, see "2.4 Interrupts and Interrupt Mapping" in
                Devicetree Specification v0.4.



             See :ref:`zephyr:dt-important-props` for more information.

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                Extended interrupt specifier for device, used as an alternative to
                the "interrupts" property.

                For details, see "2.4 Interrupts and Interrupt Mapping" in
                Devicetree Specification v0.4.



         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to each interrupt generated by a device.
                The interrupts themselves are defined in either "interrupts" or
                "interrupts-extended" properties.

                For details, see "2.4 Interrupts and Interrupt Mapping" in
                Devicetree Specification v0.4.



         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                If present, this refers to the node which handles interrupts generated
                by this device.

                For details, see "2.4 Interrupts and Interrupt Mapping" in
                Devicetree Specification v0.4.



         * - ``label``
           - ``string``
           - .. code-block:: none

                Human readable string describing the device. Use of this property is
                deprecated except as needed on a case-by-case basis.

                For details, see "4.1.2 Miscellaneous Properties" in Devicetree
                Specification v0.4.



             See :ref:`zephyr:dt-important-props` for more information.

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Information about the device's clock providers. In general, this property
                should follow conventions established in the dt-schema binding:

                  https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml



         * - ``clock-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to each clock provider in the "clocks" property.



         * - ``#address-cells``
           - ``int``
           - .. code-block:: none

                This property encodes the number of <u32> cells used by address fields
                in "reg" properties in this node's children.

                For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
                Specification v0.4.



         * - ``#size-cells``
           - ``int``
           - .. code-block:: none

                This property encodes the number of <u32> cells used by size fields in
                "reg" properties in this node's children.

                For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
                Specification v0.4.



         * - ``dmas``
           - ``phandle-array``
           - .. code-block:: none

                DMA channel specifiers relevant to the device.



         * - ``dma-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to the DMA channel specifiers in the "dmas" property.



         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channel specifiers relevant to the device.



         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to the IO channel specifiers in the "io-channels" property.



         * - ``mboxes``
           - ``phandle-array``
           - .. code-block:: none

                Mailbox / IPM channel specifiers relevant to the device.



         * - ``mbox-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to the mbox specifiers in the "mboxes" property.



         * - ``power-domains``
           - ``phandle-array``
           - .. code-block:: none

                Power domain specifiers relevant to the device.



         * - ``power-domain-names``
           - ``string-array``
           - .. code-block:: none

                Optional names given to the power domain specifiers in the "power-domains" property.



         * - ``#power-domain-cells``
           - ``int``
           - .. code-block:: none

                Number of cells in power-domains property



         * - ``zephyr,deferred-init``
           - ``boolean``
           - .. code-block:: none

                Do not initialize device automatically on boot. Device should be manually
                initialized using device_init().



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



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