Nordic nRF SPIM EasyDMA 바인딩

: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:: nordic,nrf-spim
.. _dtbinding_nordic_nrf_spim:

nordic,nrf-spim
###############

Vendor: :ref:`Nordic Semiconductor <dt_vendor_nordic>`

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

These nodes are "spi" bus nodes.

.. code-block:: none

   Nordic nRF family SPIM (SPI master with EasyDMA)

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

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

                Clock frequency the SPI peripheral is being driven at, in Hz.



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

                An array of chip select GPIOs to use. Each element
                in the array specifies a GPIO. The index in the array
                corresponds to the child node that the CS gpio controls.

                Example:

                  spi@... {
                          cs-gpios = <&gpio0 23 GPIO_ACTIVE_LOW>,
                                        <&gpio1 10 GPIO_ACTIVE_LOW>,
                                        ...;

                          spi-device@0 {
                                  reg = <0>;
                                  ...
                          };
                          spi-device@1 {
                                  reg = <1>;
                                  ...
                          };
                          ...
                  };

                The child node "spi-device@0" specifies a SPI device with
                chip select controller gpio0, pin 23, and devicetree
                GPIO flags GPIO_ACTIVE_LOW. Similarly, "spi-device@1" has CS GPIO
                controller gpio1, pin 10, and flags GPIO_ACTIVE_LOW. Additional
                devices can be configured in the same way.

                If unsure about the flags cell, GPIO_ACTIVE_LOW is generally a safe
                choice for a typical "CSn" pin. GPIO_ACTIVE_HIGH may be used if
                intervening hardware inverts the signal to the peripheral device or
                the line itself is active high.

                If this property is not defined, no chip select GPIOs are set.
                SPI controllers with dedicated CS pins do not need to define
                the cs-gpios property.



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



         * - ``max-frequency``
           - ``int``
           - .. code-block:: none

                Maximum data rate the SPI peripheral can be driven at, in Hz. This
                property must be set at SoC level DTS files.



             This property is **required**.

         * - ``overrun-character``
           - ``int``
           - .. code-block:: none

                The overrun character (ORC) is used when all bytes from the TX buffer
                are sent, but the transfer continues due to RX. Defaults to 0xff
                (line high), the most common value used in SPI transfers.



             Default value: ``255``

         * - ``easydma-maxcnt-bits``
           - ``int``
           - .. code-block:: none

                Maximum number of bits available in the EasyDMA MAXCNT register. This
                property must be set at SoC level DTS files.



             This property is **required**.

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

                Optional bi-directional line that allows SPI master to indicate to SPI
                slave (by setting the line high) that a transfer is to occur, so that
                the latter can prepare (and indicate its readiness) for handling that
                transfer when it is actually needed, and stay in any desired low-power
                state otherwise.
                The protocol is as follows:
                - initially, SPI slave configures its WAKE line pin as an input and SPI
                  master keeps the line in the low state
                - when a transfer is to be performed, SPI master configures its WAKE
                  line pin as an input with pull-up; this changes the line state to
                  high but allows SPI slave to override that state
                - when SPI slave detects the high state of the WAKE line, it prepares
                  for the transfer and when everything is ready, it drives the WAKE
                  line low by configuring its pin as an output
                - the generated high-to-low transition on the WAKE line is a signal
                  to SPI master that it can proceed with the transfer
                - SPI slave releases the line by configuring its pin back to be an input
                  and SPI master again keeps the line in the low state
                Please note that the line must be configured and properly handled on
                both sides for the mechanism to work correctly.



         * - ``memory-regions``
           - ``phandle-array``
           - .. code-block:: none

                List of memory region phandles


         * - ``memory-region-names``
           - ``string-array``
           - .. code-block:: none

                A list of names, one for each corresponding phandle in memory-region


         * - ``anomaly-58-workaround``
           - ``boolean``
           - .. code-block:: none

                Enables the workaround for the nRF52832 SoC SPIM PAN 58 anomaly.
                Must be used in conjunction with
                CONFIG_SOC_NRF52832_ALLOW_SPIM_DESPITE_PAN_58=y



         * - ``rx-delay-supported``
           - ``boolean``
           - .. code-block:: none

                Indicates if the SPIM instance has the capability of delaying MISO
                sampling. This property needs to be defined at SoC level DTS files.



         * - ``rx-delay``
           - ``int``
           - .. code-block:: none

                Number of 64 MHz clock cycles (15.625 ns) delay from the sampling edge
                of SCK (leading or trailing, depending on the CPHA setting used) until
                the input serial data on MISO is actually sampled. This property does
                not have any effect if the rx-delay-supported property is not set.



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



   .. 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 "nordic,nrf-spim" 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


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

                number of address cells in reg property


             This property is **required**.

             Constant value: ``1``

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

                number of size cells in reg property


             This property is **required**.

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