STM32 OCTOSPI Bus 바인딩

: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,stm32-ospi
.. _dtbinding_st_stm32_ospi:

st,stm32-ospi
#############

Vendor: :ref:`STMicroelectronics <dt_vendor_st>`

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

These nodes are "ospi" bus nodes.

.. code-block:: none

   STM32 OSPI device representation. Enabling a stm32 octospi node in a board
   description would typically requires this:

       &octospi {
           pinctrl-0 = <&octospi_clk_pe9 &octospi_ncs_pe10 &octospi_dqs_pe11
                        &octospi_io0_pe12 &octospi_io1_pe13
                        &octospi_io2_pe14 &octospi_io3_pe15
                        &octospi_io4_pe16 &octospi_io5_pe17
                        &octospi_io6_pe18 &octospi_io7_pe19>;

           dmas = <&dma1 5 41 0x10000>;
           dma-names = "tx_rx";

           status = "okay";
       };

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

         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



             This property is **required**.

         * - ``pinctrl-1``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the second state. See pinctrl-0.



         * - ``pinctrl-2``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the third state. See pinctrl-0.



         * - ``pinctrl-3``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fourth state. See pinctrl-0.



         * - ``pinctrl-4``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fifth state. See pinctrl-0.



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

                Names for the provided states. The number of names needs to match the
                number of states.



             This property is **required**.

         * - ``dlyb-bypass``
           - ``boolean``
           - .. code-block:: none

                Enables Delay Block (DLYB) Bypass.



         * - ``ssht-enable``
           - ``boolean``
           - .. code-block:: none

                Enables Sample Shifting half-cycle.

                It is recommended to be enabled in STR mode and disabled in DTR mode.



         * - ``io-low-port``
           - ``string``
           - .. code-block:: none

                Specifies which port of the OCTOSPI IO Manager is used for the IO[3:0] pins.

                If absent, then `IOPORT_<n>_LOW` is used where `n` is the OSPI
                instance number.

                Note: You might need to enable the OCTOSPI I/O manager clock to use the
                      property. Please refer to Reference Manual.
                      The clock can be enabled in the devicetree.



             Legal values: ``'IOPORT_NONE'``, ``'IOPORT_1_LOW'``, ``'IOPORT_1_HIGH'``, ``'IOPORT_2_LOW'``, ``'IOPORT_2_HIGH'``

         * - ``io-high-port``
           - ``string``
           - .. code-block:: none

                Specifies which port of the OCTOSPI IO Manager is used for the IO[7:4] pins.

                If absent, then `IOPORT_<n>_HIGH` is used where `n` is the OSPI
                instance number.

                Can be set to `IOPORT_NONE` for Single SPI, Dual SPI and Quad SPI.

                Note: You might need to enable the OCTOSPI I/O manager clock to use the
                      property. Please refer to Reference Manual.
                      The clock can be enabled in the devicetree.



             Legal values: ``'IOPORT_NONE'``, ``'IOPORT_1_LOW'``, ``'IOPORT_1_HIGH'``, ``'IOPORT_2_LOW'``, ``'IOPORT_2_HIGH'``

         * - ``clk-port``
           - ``int``
           - .. code-block:: none

                Specifies which port of the OCTOSPI IO Manager is used for the clk pin.

                If absent, then n is used where `n` is the OSPI
                instance number.

                Note: You might need to enable the OCTOSPI I/O manager clock to use the
                      property. Please refer to Reference Manual.
                      The clock can be enabled in the devicetree.



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

         * - ``dqs-port``
           - ``int``
           - .. code-block:: none

                Specifies which port of the OCTOSPI IO Manager is used for the dqs pin.

                If absent, then n is used where `n` is the OSPI
                instance number.

                Note: You might need to enable the OCTOSPI I/O manager clock to use the
                      property. Please refer to Reference Manual.
                      The clock can be enabled in the devicetree.



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

         * - ``ncs-port``
           - ``int``
           - .. code-block:: none

                Specifies which port of the OCTOSPI IO Manager is used for the ncs pin.

                If absent, then n is used where `n` is the OSPI
                instance number.

                Note: You might need to enable the OCTOSPI I/O manager clock to use the
                      property. Please refer to Reference Manual.
                      The clock can be enabled in the devicetree.



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



   .. 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,stm32-ospi" 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


             This property is **required**.

             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


             This property is **required**.

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

                Optional DMA channel specifier, required for DMA transactions.
                For example dmas for TX/RX on OSPI
                   dmas = <&dma1 5 41 0x10000>;

                With, in each cell of the dmas specifier:
                - &dma1: dma controller phandle
                - 5: channel number (0 to Max-Channel minus 1). From 0 to 15 on stm32u5x.
                - 41: slot number (request which could be given by the DMAMUX)
                - 0x10000: channel configuration (only for srce/dest data size, priority)

                Notes:
                  - On series supporting DMAMUX, the DMA phandle should be provided
                    but DMAMUX node should also be enabled in the DTS.
                  - For channel configuration, only the config bits priority and
                    periph/mem datasize are used. The periph/mem datasize must be equal,
                    0 is a correct value.
                   - There is no Fifo used by this DMA peripheral.

                For example dmas for TX/RX on OSPI
                   dmas = <&dma1 5 41 0x10000>;



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

                DMA channel name. If DMA should be used, expected value is "tx_rx".

                For example
                   dma-names = "tx_rx";



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