:orphan:
.. raw:: html
.. dtcompatible:: renesas,smartbond-usbd
.. _dtbinding_renesas_smartbond_usbd:
renesas,smartbond-usbd
######################
Vendor: :ref:`Renesas Electronics Corporation `
Description
***********
These nodes are "usb" bus nodes.
.. code-block:: none
Renesas SmartBond USB device controller
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
* - ``dma-chan-rx``
- ``int``
- .. code-block:: none
DMA Channel for USB RX (0/2/4/6).
* - ``dma-chan-tx``
- ``int``
- .. code-block:: none
DMA Channel for USB TX (1/3/5/7).
* - ``dma-min-transfer-size``
- ``int``
- .. code-block:: none
Minimum transfer size required to engage DMA.
* - ``ep-out-buf-size``
- ``array``
- .. code-block:: none
Buffer size for OUT end points 0-3.
This property is **required**.
* - ``fifo-read-threshold``
- ``int``
- .. code-block:: none
RX FIFO is 64 bytes. When endpoint size is greater then 64,
FIFO warning interrupt is enabled to allow read incoming data
during frame reception.
It is possible to stay in interrupt reading whole packet at once,
but it may be more efficient for MCU to read as much data as
possible and when FIFO is hardly filled exit interrupt handler
waiting for next FIFO warning level interrupt or packet end.
When running at 96MHz code that reads FIFO based on number of
bytes stored in USB_RXSx_REG.USB_RXCOUNT takes enough time to
fill FIFO with two additional bytes.
Settings this threshold above this allows to leave interrupt
handler and wait for more bytes before next ISR. This allows
reduce overall ISR time to 1/3 of time that would be needed
if ISR read as fast as possible.
* - ``iso-out-mps``
- ``int``
- .. code-block:: none
Max packet size for ISO out endpoint
* - ``maximum-speed``
- ``string``
- .. code-block:: none
Configures USB controllers to work up to a specific speed. Valid arguments are "super-speed", "high-speed", "full-speed" and "low-speed". If this is not passed via DT, USB controllers should use their maximum hardware capability.
Legal values: ``'low-speed'``, ``'full-speed'``, ``'high-speed'``, ``'super-speed'``
* - ``vbus-gpios``
- ``phandle-array``
- .. code-block:: none
Control VBUS via GPIO pin.
.. 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 "renesas,smartbond-usbd" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``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
* - ``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.