Nuvoton NPCX eSPI TAF binding

: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:: nuvoton,npcx-espi-taf
.. _dtbinding_nuvoton_npcx_espi_taf:

nuvoton,npcx-espi-taf
#####################

Vendor: :ref:`Nuvoton Technology Corporation <dt_vendor_nuvoton>`

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

These nodes are "espi" bus nodes.

.. code-block:: none

   The target flash devices accessed by Nuvoton eSPI TAF controller.

   Representation:

     espi_taf: espitaf@4000a000 {
       compatible = "nuvoton,npcx-espi-taf";
       reg = <0x4000a000 0x2000>;

       mapped-addr = <0x68000000>;
       max-read-sz = "NPCX_ESPI_TAF_MAX_READ_REQ_64B";
       erase-sz = "NPCX_ESPI_TAF_ERASE_BLOCK_SIZE_4KB";

       #address-cells = <1>;
       #size-cells = <1>;
       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.



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



         * - ``mapped-addr``
           - ``int``
           - .. code-block:: none

                Mapped memory address of direct read access for flash.



             This property is **required**.

         * - ``erase-sz``
           - ``string``
           - .. code-block:: none

                Erase block size of target flash. The default was 4KB Erase Block Size.
                All Intel platforms require support for at least 4 KB Erase Block Size.



             This property is **required**.

             Default value: ``NPCX_ESPI_TAF_ERASE_BLOCK_SIZE_4KB``

             Legal values: ``'NPCX_ESPI_TAF_ERASE_BLOCK_SIZE_4KB'``, ``'NPCX_ESPI_TAF_ERASE_BLOCK_SIZE_32KB'``, ``'NPCX_ESPI_TAF_ERASE_BLOCK_SIZE_64KB'``, ``'NPCX_ESPI_TAF_ERASE_BLOCK_SIZE_128KB'``

         * - ``max-read-sz``
           - ``string``
           - .. code-block:: none

                Maximum read request size of flash access channel. The default was 64 bytes.
                This value is recommended in datasheet.



             This property is **required**.

             Default value: ``NPCX_ESPI_TAF_MAX_READ_REQ_64B``

             Legal values: ``'NPCX_ESPI_TAF_MAX_READ_REQ_64B'``, ``'NPCX_ESPI_TAF_MAX_READ_REQ_128B'``, ``'NPCX_ESPI_TAF_MAX_READ_REQ_256B'``, ``'NPCX_ESPI_TAF_MAX_READ_REQ_512B'``, ``'NPCX_ESPI_TAF_MAX_READ_REQ_1024B'``, ``'NPCX_ESPI_TAF_MAX_READ_REQ_2048B'``, ``'NPCX_ESPI_TAF_MAX_READ_REQ_4096B'``



   .. 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 "nuvoton,npcx-espi-taf" 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


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