: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:: nxp,mipi-csi2rx
.. _dtbinding_nxp_mipi_csi2rx:

nxp,mipi-csi2rx
###############

Vendor: :ref:`NXP Semiconductors N.V. <dt_vendor_nxp>`

.. note::

   An implementation of a driver matching this compatible is available in
   :zephyr_file:`drivers/video/video_mcux_mipi_csi2rx.c`.

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



.. code-block:: none

   NXP MIPI CSI-2 Rx interface

Properties
**********

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


These property descriptions apply to "nxp,mipi-csi2rx"
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.

      (None)

   .. 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,mipi-csi2rx" compatible.

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

         * - Name
           - Type
           - Details

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

                indicates the operational status of a device


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

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

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

                compatible strings


             This property is **required**.

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

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

                register space


             See :ref:`zephyr: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:`zephyr: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:`zephyr: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


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

                Power domain specifiers


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

                Provided names of power domain specifiers


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






Level 3 child node properties
=============================

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

   * - Name
     - Type
     - Details

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

          Label of the 'remote-endpoint' subnode that interfaces with this endpoint.
          This property is used as a 'work-around' to be able to declare the remote
          endpoint and should be replaced by a "remote-endpoint" phandle property when
          Zephyr devicetree supports circular dependency in the future.



       This property is **required**.

   * - ``bus-type``
     - ``int``
     - .. code-block:: none

          Data bus type.



       Legal values: ``1``, ``2``, ``3``, ``4``, ``5``, ``6``

   * - ``data-shift``
     - ``int``
     - .. code-block:: none

          On parallel data busses, if bus-width is used to specify the number of
          data lines, data-shift can be used to specify which data lines are used,
          e.g. "bus-width=<8>; data-shift=<2>;" means, that lines 9:2 are used.



   * - ``hsync-active``
     - ``int``
     - .. code-block:: none

          Active state of the HSYNC signal



       Legal values: ``0``, ``1``

   * - ``vsync-active``
     - ``int``
     - .. code-block:: none

          Active state of the VSYNC signal.



       Legal values: ``0``, ``1``

   * - ``pclk-sample``
     - ``int``
     - .. code-block:: none

          Sample data on falling, rising or both edges of the pixel clock signal.



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

   * - ``link-frequencies``
     - ``array``
     - .. code-block:: none

          Allowed data bus frequencies. For MIPI CSI-2, for instance, this is the
          actual frequency of the bus, not bits per clock per lane value.



   * - ``clock-lane``
     - ``int``
     - .. code-block:: none

          Physical clock lane index. Position of an entry determines the logical
          lane number, while the value of an entry indicates physical lane, e.g. for
          a MIPI CSI-2 bus we could have "clock-lane = <0>;", which places the
          clock lane on hardware lane 0. This property is valid for serial busses
          only (e.g. MIPI CSI-2).



   * - ``data-lanes``
     - ``array``
     - .. code-block:: none

          An array of physical data lane indexes. Position of an entry determines
          the logical lane number, while the value of an entry indicates physical
          lane, e.g. for 2-lane MIPI CSI-2 bus we could have "data-lanes = <1 2>;",
          assuming the clock lane is on hardware lane 0. If the hardware does not
          support lane reordering, monotonically incremented values shall be used
          from 0 or 1 onwards, depending on whether or not there is also a clock
          lane. This property is valid for serial busses only (e.g. MIPI CSI-2).



   * - ``bus-width``
     - ``int``
     - .. code-block:: none

          Number of data lines actively used, only valid for parallel busses.