Last edited 11 months ago

SDMMC device tree configuration

Applicable for STM32MP13x lines, STM32MP15x lines, STM32MP25x lines

1. Article purpose[edit source]

The purpose of this article is to explain how to configure the SDMMC using the device tree mechanism, relying on the bindings documentation, that is the description of the required and optional device-tree properties.

The peripheral can be assigned to different contexts/software components, depending on the final product needs. Refer to How to assign an internal peripheral to an execution context article for guidelines on this configuration.

2. DT bindings documentation[edit source]

The device tree binding documents are stored either in the given applicable components listed below, or in the Linux kernel repository:

3. DT configuration[edit source]

This hardware description is a combination of the STM32 microprocessor device tree files (.dtsi extension) and board device tree files (.dts extension). See the Device tree for an explanation of the device-tree file organization.

STM32CubeMX can be used to generate the board device tree. Refer to How to configure the DT using STM32CubeMX for more details.

3.1. DT configuration (STM32 level)[edit source]

The SDMMC node is located in the device tree file for the software components, supporting the peripheral and listed in the above DT bindings documentation paragraph.

Warning white.png Warning
This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.

3.2. DT configuration (board level)[edit source]

The objective of this chapter is to explain how to enable and configure the SDMMC DT nodes for a board.

Peripheral configuration should be done in specific board device tree files (board dts file and pinctrl dtsi file).

The SDMMC peripheral may connect to one SD card, one eMMC™ device or one SDIO card.

   &sdmmc1{                                                  Comments     
       pinctrl-names = "default", "opendrain", "sleep";      --> For pinctrl configuration, please refer to Pinctrl device tree configuration
       pinctrl-0 = <&sdmmc1_b4_pins_a &sdmmc1_dir_pins_a>;
       pinctrl-1 = <&sdmmc1_b4_od_pins_a &sdmmc1_dir_pins_a>;
       pinctrl-2 = <&sdmmc1_b4_sleep_pins_a &sdmmc1_dir_sleep_pins_a>;
       st,neg-edge;                                          --> Generate data and command on sdmmc clock falling edge
       st,sig-dir;                                           --> Allow to select direction polarity of an external transceiver
       st,use-ckin;                                          --> Use sdmmc_ckin pin from an external transceiver to sample the receive data
       bus-width = <4>;                                      --> Number of data lines, can be 1, 4 or 8
       vmmc-supply = <&vdd_sd>;                              --> Supply node for card's power
       vqmmc-supply = <&sd_switch>;                          --> Supply node for IO line power
       status = "okay";                                      --> Enable the node
   };

Below optional properties have to be used when an external transceiver is connected:

  • st,sig-dir: This property allows to select external transceiver direction signals polarity. When this property is set, the voltage transceiver IOs are driven as output when the direction signals are high. Without setting this property, the voltage transceiver IOs are driven as output when the direction signals are low.
  • st,use-ckin: By setting this property, the sdmmc_ckin pin from an external transceiver is used to sample the receive data.
Warning white.png Warning
On STM32MP15x lines More info.png, the HS200 mode for eMMC™ and SDR104 mode for SD/SDIO are not supported: see STM32MP15_ecosystem_errata_sheet, section 2.3.19

3.3. DT configuration examples[edit source]

Below example shows how to configure the SDMMC when an eMMC™ is connected with 8 data lines.

   &sdmmc2{                                                  Comments     
       pinctrl-names = "default", "opendrain", "sleep";      
       pinctrl-0 = <&sdmmc2_b4_pins_a &sdmmc2_dir_pins_a>;
       pinctrl-1 = <&sdmmc2_b4_od_pins_a &sdmmc2_dir_pins_a>;
       pinctrl-2 = <&sdmmc2_b4_sleep_pins_a &sdmmc2_dir_sleep_pins_a>;             
       non-removable;                                        --> Non-removable slot, assume always present
       no-sd;                                                --> Avoid to send SD command during initialization
       no-sdio;                                              --> Avoid to send SDIO command during initialization
       st,neg-edge;                                           
       bus-width = <8>;                                    
       vmmc-supply = <&v3v3>;                      
       vqmmc-supply = <&vdd>;
       mmc-ddr-3_3v;                                         --> Host supports eMMCDDR 3.3V                         
       status = "okay";                                     
   };

Below example shows how to configure the SDMMC to SD card (4 data lines) with an external transceiver.

   &sdmmc1{                                                  Comments     
       pinctrl-names = "default", "opendrain", "sleep";    
       pinctrl-0 = <&sdmmc1_b4_pins_a &sdmmc1_dir_pins_a>;
       pinctrl-1 = <&sdmmc1_b4_od_pins_a &sdmmc1_dir_pins_a>;
       pinctrl-2 = <&sdmmc1_b4_sleep_pins_a &sdmmc1_dir_sleep_pins_a>;               
       broken-cd;                                            --> use polling mode for card detection
       st,neg-edge;
       st,sig-dir;
       st,use-ckin;                                    
       bus-width = <4>;
       sd-uhs-sdr12;                                         --> sd modes supported
       sd-uhs-sdr25;
       sd-uhs-sdr50;
       sd-uhs-ddr50;
       vmmc-supply = <&vdd_sd>;                      
       vqmmc-supply = <&sd_switch>;                          
       status = "okay";                                     
   };

4. How to configure the DT using STM32CubeMX[edit source]

The STM32CubeMX tool can be used to configure the STM32MPU device and get the corresponding platform configuration device tree files.
STM32CubeMX may not support all the properties described in DT binding files listed in the above DT bindings documentation paragraph. If so, the tool inserts user sections in the generated device tree. These sections can then be edited to add some properties, and they are preserved from one generation to another. Refer to STM32CubeMX user manual for further information.

5. References[edit source]

Refer to the following links for additional information: