Ambiq Bluetooth HCI SPI 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:: ambiq,bt-hci-spi
.. _dtbinding_ambiq_bt_hci_spi:

ambiq,bt-hci-spi
################

Vendor: :ref:`Ambiq Micro, Inc. <dt_vendor_ambiq>`

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



.. code-block:: none

   Bluetooth module that uses Ambiq's Bluetooth Host Controller Interface SPI
   driver (e.g. Apollo4 Blue Plus).

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

         * - ``bt-hci-name``
           - ``string``
           - .. code-block:: none

                Name of the HCI transport


             Default value: ``ambiq hci``

         * - ``bt-hci-bus``
           - ``string``
           - .. code-block:: none

                Bus of the transport


             Default value: ``BT_HCI_BUS_SPI``

             Legal values: ``'BT_HCI_BUS_VIRTUAL'``, ``'BT_HCI_BUS_USB'``, ``'BT_HCI_BUS_PCCARD'``, ``'BT_HCI_BUS_UART'``, ``'BT_HCI_BUS_RS232'``, ``'BT_HCI_BUS_PCI'``, ``'BT_HCI_BUS_SDIO'``, ``'BT_HCI_BUS_SPI'``, ``'BT_HCI_BUS_I2C'``, ``'BT_HCI_BUS_IPM'``

         * - ``bt-hci-quirks``
           - ``string-array``
           - .. code-block:: none

                HCI device quirks


         * - ``bt-hci-vs-ext``
           - ``boolean``
           - .. code-block:: none

                Zephyr HCI vendor extensions are supported


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

                This irq gpio is used to indicate there is packet ready to send to host
                from controller.



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

                This reset gpio is used to reset the Bluetooth controller.



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

                This clkreq gpio is used to send the XO32MHz clock request to host from
                controller. The host needs to enable XO32MHz when receiving low to high
                edge interrupts and disable XO32MHz when receiving high to low edge
                interrupts.





   .. 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 "ambiq,bt-hci-spi" 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


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