:orphan:
.. raw:: html
.. dtcompatible:: nxp,imx-usdhc
.. _dtbinding_nxp_imx_usdhc:
nxp,imx-usdhc
#############
Vendor: :ref:`NXP Semiconductors `
Description
***********
These nodes are "sd" bus nodes.
.. code-block:: none
NXP imx USDHC 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
* - ``data-timeout``
- ``int``
- .. code-block:: none
Data timeout, as multiple of the SD clock. See DTOCV field of USDHC
Default value: ``15``
* - ``read-watermark``
- ``int``
- .. code-block:: none
Number of words used as read watermark level in FIFO queue for USDHC
Default value: ``128``
* - ``write-watermark``
- ``int``
- .. code-block:: none
Number of words used as write watermark level in FIFO queue for USDHC
Default value: ``128``
* - ``max_current_330``
- ``int``
- .. code-block:: none
Max drive current in mA at 3.3V. A value of zero indicates no maximum
is specified by the driver.
* - ``pwr-gpios``
- ``phandle-array``
- .. code-block:: none
Power pin
This pin defaults to active high when consumed by the SD card. The
property value should ensure the flags properly describe the signal
that is presented to the driver.
* - ``cd-gpios``
- ``phandle-array``
- .. code-block:: none
Detect pin
This pin defaults to active low when produced by the SD card. The
property value should ensure the flags properly describe the signal
that is presented to the driver.
* - ``no-1-8-v``
- ``boolean``
- .. code-block:: none
When the external SD card circuit does not support 1.8V, add this
property to disable 1.8v card voltage of SD card controller.
* - ``detect-dat3``
- ``boolean``
- .. code-block:: none
Enable the host to detect an SD card via the DAT3 line of the SD card
connection. Requires the board to define a function to pull DAT3 low or
high using pullup/pulldown resistors.
* - ``max-current-330``
- ``int``
- .. code-block:: none
Max drive current in mA at 3.3V. A value of zero indicates no maximum
is specified by the driver.
* - ``max-current-300``
- ``int``
- .. code-block:: none
Max drive current in mA at 3.0V. A value of zero indicates no maximum
is specified by the driver.
* - ``max-current-180``
- ``int``
- .. code-block:: none
Max drive current in mA at 1.8V. A value of zero indicates no maximum
is specified by the driver.
* - ``max-bus-freq``
- ``int``
- .. code-block:: none
Maximum bus frequency for SD card. This should be the highest frequency
the SDHC is capable of negotiating with cards on the bus.
Default value: ``400000``
* - ``min-bus-freq``
- ``int``
- .. code-block:: none
Minimum bus frequency for SD card. This should be the frequency that
cards first will select when attached to the SDHC bus
Default value: ``400000``
* - ``power-delay-ms``
- ``int``
- .. code-block:: none
time in ms for SDHC to delay when toggling power to the SD card. This
delay gives the card time to power up or down fully
Default value: ``500``
* - ``mmc-hs200-1_8v``
- ``boolean``
- .. code-block:: none
The host controller supports HS200 at 1.8V
* - ``mmc-hs400-1_8v``
- ``boolean``
- .. code-block:: none
The host controller supports HS400 at 1.8V
* - ``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.
.. 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 "nxp,imx-usdhc" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
register space
This property is **required**.
See :ref:`dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
This property is **required**.
* - ``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-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**.
* - ``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.