Infineon CYW43xxx Bluetooth HCI UART 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:: infineon,cyw43xxx-bt-hci
.. _dtbinding_infineon_cyw43xxx_bt_hci:

infineon,cyw43xxx-bt-hci
########################

Vendor: :ref:`Infineon Technologies <dt_vendor_infineon>`

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



.. code-block:: none

   CYW43xxx Connectivity that uses Zephyr's Bluetooth Host Controller Interface UART
   driver.

   Example of enabling CYW43xxx device:

     &uart2 {
       status = "okay";
       current-speed = <115200>;

       /* HCI-UART pins*/
       pinctrl-0 = <&p3_1_scb2_uart_tx &p3_0_scb2_uart_rx
                    &p3_2_scb2_uart_rts &p3_3_scb2_uart_cts>;
       pinctrl-names = "default";

       /* HW Flow control must be enabled for HCI H4 */
       hw-flow-control;

       bt-hci {
         status = "okay";
         compatible = "infineon,cyw43xxx-bt-hci";
         bt-reg-on-gpios = <&gpio_prt3 4 (GPIO_ACTIVE_HIGH)>;

         fw-download-speed = <3000000>;
       };
     };

   NOTE1: The UART bus speed (current_speed) for zephyr_bt_uart should be the same
          as the default baudrate defined in CYW43xx firmware (default 115200).

   NOTE2: Use fw-download-speed and hci-operation-speed properties to configure UART
          speeds for firmware download (fw-download-speed) and HCI operation
          (hci-operation-speed).
          If hci-operation-speed or fw-download-speed are not defined in bt-hci node,
          cyw43xx driver will use bus/current-speed as default speed.

   NOTE3: CYW43xxx requires fetch binary files of BT controller. To fetch binary blobs:
          west blobs fetch hal_infineon

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-reg-on-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Power-up/down gpio to control the internal regulators used
                by the Bluetooth section of CYW43xx device.



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

                Bluetooth device wake-up gpio. Signal from the host to the
                CYW43xx indicating that the host requires attention.



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

                Host wake-up gpio. Signal from the CYW43xx to the host
                indicating that the CYW43xx requires attention.



         * - ``hci-operation-speed``
           - ``int``
           - .. code-block:: none

                HCI UART boudrate for feature operation. If not defined
                bus/current-speed will be used as default.



         * - ``fw-download-speed``
           - ``int``
           - .. code-block:: none

                HCI UART boudrate for FW download operation. If not defined
                bus/current-speed will be used as default.





   .. 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 "infineon,cyw43xxx-bt-hci" 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().