Difference between revisions of "QUADSPI device tree configuration"

[quality revision] [quality revision]
m
m
 
Applicable for STM32MP13x lines, STM32MP15x lines

1 Article purpose[edit]

The purpose of this article is to explain how to configure the QUADSPI 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 a runtime context article for guidelines on this configuration.

2 DT bindings documentation[edit]

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]

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]

The QUADSPI 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]

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

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

   &qspi {                                                   Comments
       pinctrl-names = "default", "sleep";                   --> For pinctrl configuration, please refer to Pinctrl device tree configuration
       pinctrl-0 = <&qspi_clk_test_pins_a
                    &qspi_bk1_test_pins_a &qspi_bk2_pins_a>b
                    &qspi_cs1_test_pins_b
                    &qspi_bk2_test_pins_b
                    &qspi_cs2_test_pins_b>;
       pinctrl-1 = <&qspi_clk_test_sleep_pins_a
                    &qspi_bk1_test_sleep_pins_a &qspi_bk2_sleep_pins_a>b
                    &qspi_cs1_test_sleep_pins_b
                    &qspi_bk2_test_sleep_pins_b
                    &qspi_cs2_test_sleep_pins_b>;
       reg = <0x58003000 0x1000>,
             <0x70000000 0x4000000>;                         --> Overwrite the memory map to the Flash device size, avoid the waste of virtual memory that will not be used
       #address-cells = <1>;
       #size-cells = <0>;
       status = "okay";                                      --> Enable the node

flash0: mx66l51235l@0 { compatible = "jedec,spi-nor"; reg = <0>; --> Chip select number spi-rx-bus-width = <4>; --> The bus width (number of data wires used) spi-max-frequency = <108000000>; --> Maximum SPI clocking speed of device in Hz #address-cells = <1>; #size-cells = <1>; }; };

3.3 DT configuration example[edit]

The below example shows how to configure the QUADSPI peripheral when 1 SPI-NAND Flash and 1 SPI-NOR Flash memories are connected.

   &qspi {                                                    
       pinctrl-names = "default", "sleep";                    
       pinctrl-0 = <&qspi_clk_test_pins_a
                    &qspi_bk1_test_pins_a &qspi_bk2_pins_a>b
                    &qspi_cs1_test_pins_b
                    &qspi_bk2_test_pins_b
                    &qspi_cs2_test_pins_b>;
       pinctrl-1 = <&qspi_clk_test_sleep_pins_a
                    &qspi_bk1_test_sleep_pins_a &qspi_bk2_sleep_pins_a>b
                    &qspi_cs1_test_sleep_pins_b
                    &qspi_bk2_test_sleep_pins_b
                    &qspi_cs2_test_sleep_pins_b>;
       reg = <0x58003000 0x1000>,
             <0x70000000 0x4000000>;                          
       #address-cells = <1>;
       #size-cells = <0>;
       status = "okay";
flash0: mx66l51235l@0 { compatible = "jedec,spi-nor"; reg = <0>; spi-rx-bus-width = <4>; spi-max-frequency = <108000000>; #address-cells = <1>; #size-cells = <1>; };
flash1: mt29f2g01abagd@1 { compatible = "spi-nand"; reg = <1>; spi-rx-bus-width = <4>; spi-tx-bus-width = <4>; spi-max-frequency = <133000000>; #address-cells = <1>; #size-cells = <1>; }; };

The below example, possible with ecosystem release ≥ v4.1.0 More info.png , shows how to configure the QUADSPI peripheral to use it as a communication channel using up to 8 qspi lines. It can be used to communicate with a FPGA. To enable the usage of the 8 qspi lines, the following properties are mandatory:

  • the chip select pins need to be removed from pinctrl-0 and pinctrl-1 properties.
  • cs-gpios properties must be populated in the controller node.
  • spi-rx-bus-width and spi-tx-bus-width properties must be set to 8 in the device node.
   &qspi {                                                    
       pinctrl-names = "default", "sleep";                    
       pinctrl-0 = <&qspi_clk_test_pins_a
                    &qspi_bk1_test_pins_b
                    &qspi_bk2_test_pins_b>;
       pinctrl-1 = <&qspi_clk_test_sleep_pins_a
                    &qspi_bk1_test_sleep_pins_b
                    &qspi_bk2_test_sleep_pins_b>;
       reg = <0x58003000 0x1000>,
             <0x70000000 0x4000000>;                          
       #address-cells = <1>;
       #size-cells = <0>;
       status = "okay";
       cs-gpios = <&gpiob 6 GPIO_ACTIVE_LOW>;

fpga@0 { compatible = "fpga"; reg = <0>; spi-rx-bus-width = <8>; spi-tx-bus-width = <8>; spi-max-frequency = <108000000>; #address-cells = <1>; #size-cells = <1>; }; };

4 How to configure the DT using STM32CubeMX[edit]

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]

Refer to the following links for additional information:




<noinclude>{{ApplicableFor
|MPUs list=STM32MP13x, STM32MP15x
|MPUs checklist=STM32MP13x,STM32MP15x
}}</noinclude>


== Article purpose ==
The purpose of this article is to explain how to configure the [[QUADSPI internal peripheral|'''QUADSPI''']] using the [[Device tree|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 a runtime context]] article for guidelines on this configuration.

== DT bindings documentation ==
The device tree binding documents are stored either in the given applicable components listed below, or in the Linux kernel repository: <br>


* TF-A BL2, U-Boot, OP-TEE, Linux<sup>&reg;</sup> OS:
** Generic SPI-NOR / SPI-NAND Flash memory device tree bindings: {{CodeSource | Linux kernel | Documentation/devicetree/bindings/spi/spi-controller.yaml}}.
** QUADSPI device tree bindings: {{CodeSource | Linux kernel | Documentation/devicetree/bindings/spi/st,stm32-qspi.yaml}}.

== DT configuration ==
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|How to configure the DT using STM32CubeMX]] for more details.

===DT configuration (STM32 level) ===
The QUADSPI node is located in the [[STM32 MPU device_tree#Device tree structure|device tree file]] for the software components, supporting the peripheral and listed in the above [[#DT bindings documentation|DT bindings documentation]] paragraph.

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

=== DT configuration (board level) ===
The objective of this chapter is to explain how to enable and configure the QUADSPI DT nodes for a board.

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

    &qspi {                                                   {{highlight|Comments}}
        pinctrl-names = "default", "sleep";                   {{highlight|--> For pinctrl configuration, please refer to [[Pinctrl device tree configuration]]}}
        pinctrl-0 = <&qspi_clk_pins_a &qspi_bk1_pins_a &qspi_bk2_pins_a><&qspi_clk_test_pins_a
                     &qspi_bk1_test_pins_b
                     &qspi_cs1_test_pins_b
                     &qspi_bk2_test_pins_b
                     &qspi_cs2_test_pins_b>;
        pinctrl-1 = <&qspi_clk_sleep_pins_a &qspi_bk1_sleep_pins_a &qspi_bk2_sleep_pins_a><&qspi_clk_test_sleep_pins_a
                     &qspi_bk1_test_sleep_pins_b
                     &qspi_cs1_test_sleep_pins_b
                     &qspi_bk2_test_sleep_pins_b
                     &qspi_cs2_test_sleep_pins_b>;
        reg = <0x58003000 0x1000>,<0x70000000 0x4000000>;                         {{highlight|--> Overwrite the memory map to the Flash device size, avoid the waste of virtual memory that will not be used}}
        #address-cells = <1>;
        #size-cells = <0>;
        status = "okay";                                      {{highlight|--> Enable the node}}<br>

        flash0: mx66l51235l@0 {     
            compatible = "jedec,spi-nor";                                  
            reg = <0>;                                        {{highlight|--> Chip select number}}
            spi-rx-bus-width = <4>;                           {{highlight|--> The bus width (number of data wires used)}}
            spi-max-frequency = <108000000>;                  {{highlight|--> Maximum SPI clocking speed of device in Hz}}
            #address-cells = <1>;
            #size-cells = <1>;
        };
    };

=== DT configuration example ===
The below example shows how to configure the QUADSPI peripheral when 1 SPI-NAND Flash and 1 SPI-NOR Flash memories are connected.

    &qspi {                                                    
        pinctrl-names = "default", "sleep";                    
        pinctrl-0 = <&qspi_clk_pins_a &qspi_bk1_pins_a &qspi_bk2_pins_a><&qspi_clk_test_pins_a
                     &qspi_bk1_test_pins_b
                     &qspi_cs1_test_pins_b
                     &qspi_bk2_test_pins_b
                     &qspi_cs2_test_pins_b>;
        pinctrl-1 = <&qspi_clk_sleep_pins_a &qspi_bk1_sleep_pins_a &qspi_bk2_sleep_pins_a><&qspi_clk_test_sleep_pins_a
                     &qspi_bk1_test_sleep_pins_b
                     &qspi_cs1_test_sleep_pins_b
                     &qspi_bk2_test_sleep_pins_b
                     &qspi_cs2_test_sleep_pins_b>;
        reg = <0x58003000 0x1000>,<0x70000000 0x4000000>;                          
        #address-cells = <1>;
        #size-cells = <0>;
        status = "okay";<br>

        flash0: mx66l51235l@0 {                                 
            compatible = "jedec,spi-nor";
            reg = <0>;
            spi-rx-bus-width = <4>;
            spi-max-frequency = <108000000>;
            #address-cells = <1>;
            #size-cells = <1>;
        };<br>

        flash1: mt29f2g01abagd@1 {                             
            compatible = "spi-nand";
            reg = <1>;
            spi-rx-bus-width = <4>;
            spi-tx-bus-width = <4>;
            spi-max-frequency = <133000000>;
            #address-cells = <1>;
            #size-cells = <1>;
        };
    };
==The below example, possible with {{EcosystemRelease | revision =4.1.0 |range = and after}},  shows how to configure the QUADSPI peripheral to use it as a communication channel using up to 8 qspi lines. It can be used to communicate with a FPGA.
To enable the usage of the 8 qspi lines, the following properties are mandatory:
* the chip select pins need to be removed from pinctrl-0 and pinctrl-1 properties.
* cs-gpios properties must be populated in the controller node.
* spi-rx-bus-width and spi-tx-bus-width properties must be set to 8 in the device node.

    &qspi {                                                    
        pinctrl-names = "default", "sleep";                    
        pinctrl-0 = <&qspi_clk_test_pins_a
                     &qspi_bk1_test_pins_b
                     &qspi_bk2_test_pins_b>;
        pinctrl-1 = <&qspi_clk_test_sleep_pins_a
                     &qspi_bk1_test_sleep_pins_b
                     &qspi_bk2_test_sleep_pins_b>;
        reg = <0x58003000 0x1000>,<0x70000000 0x4000000>;                          
        #address-cells = <1>;
        #size-cells = <0>;
        status = "okay";
        cs-gpios = <&gpiob 6 GPIO_ACTIVE_LOW>;<br>

        fpga@0 {                                 
            compatible = "fpga";
            reg = <0>;
            spi-rx-bus-width = <8>;
            spi-tx-bus-width = <8>;
            spi-max-frequency = <108000000>;
            #address-cells = <1>;
            #size-cells = <1>;
        };
    };

==How to configure the DT using STM32CubeMX==
The [[STM32CubeMX]] tool can be used to configure the STM32MPU device and get the corresponding [[Device_tree#STM32_MPU|platform configuration device tree]] files.<br />

STM32CubeMX may not support all the properties described in DT binding files listed in the above [[#DT bindings documentation|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.

==References==
Refer to the following links for additional information:<references />

<noinclude>

{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
{{PublicationRequestId | 8899 |2018-10-10 |  AlainF}}
[[Category:Device tree configuration]]
[[Category:Mass storage]]</noinclude>
(5 intermediate revisions by 3 users not shown)
Line 33: Line 33:
 
     &qspi {                                                  {{highlight|Comments}}
 
     &qspi {                                                  {{highlight|Comments}}
 
         pinctrl-names = "default", "sleep";                  {{highlight|--> For pinctrl configuration, please refer to [[Pinctrl device tree configuration]]}}
 
         pinctrl-names = "default", "sleep";                  {{highlight|--> For pinctrl configuration, please refer to [[Pinctrl device tree configuration]]}}
         pinctrl-0 = <&qspi_clk_pins_a &qspi_bk1_pins_a &qspi_bk2_pins_a>;
+
         pinctrl-0 = <&qspi_clk_test_pins_a
         pinctrl-1 = <&qspi_clk_sleep_pins_a &qspi_bk1_sleep_pins_a &qspi_bk2_sleep_pins_a>;
+
                    &qspi_bk1_test_pins_b
  +
                    &qspi_cs1_test_pins_b
  +
                    &qspi_bk2_test_pins_b
  +
                    &qspi_cs2_test_pins_b>;
  +
         pinctrl-1 = <&qspi_clk_test_sleep_pins_a
  +
                    &qspi_bk1_test_sleep_pins_b
  +
                    &qspi_cs1_test_sleep_pins_b
  +
                    &qspi_bk2_test_sleep_pins_b
  +
                    &qspi_cs2_test_sleep_pins_b>;
 
         reg = <0x58003000 0x1000>,
 
         reg = <0x58003000 0x1000>,
 
               <0x70000000 0x4000000>;                        {{highlight|--> Overwrite the memory map to the Flash device size, avoid the waste of virtual memory that will not be used}}
 
               <0x70000000 0x4000000>;                        {{highlight|--> Overwrite the memory map to the Flash device size, avoid the waste of virtual memory that will not be used}}
Line 55: Line 63:
 
     &qspi {                                                     
 
     &qspi {                                                     
 
         pinctrl-names = "default", "sleep";                     
 
         pinctrl-names = "default", "sleep";                     
         pinctrl-0 = <&qspi_clk_pins_a &qspi_bk1_pins_a &qspi_bk2_pins_a>;
+
         pinctrl-0 = <&qspi_clk_test_pins_a
         pinctrl-1 = <&qspi_clk_sleep_pins_a &qspi_bk1_sleep_pins_a &qspi_bk2_sleep_pins_a>;
+
                    &qspi_bk1_test_pins_b
  +
                    &qspi_cs1_test_pins_b
  +
                    &qspi_bk2_test_pins_b
  +
                    &qspi_cs2_test_pins_b>;
  +
         pinctrl-1 = <&qspi_clk_test_sleep_pins_a
  +
                    &qspi_bk1_test_sleep_pins_b
  +
                    &qspi_cs1_test_sleep_pins_b
  +
                    &qspi_bk2_test_sleep_pins_b
  +
                    &qspi_cs2_test_sleep_pins_b>;
 
         reg = <0x58003000 0x1000>,
 
         reg = <0x58003000 0x1000>,
 
               <0x70000000 0x4000000>;                           
 
               <0x70000000 0x4000000>;                           
Line 76: Line 92:
 
             spi-tx-bus-width = <4>;
 
             spi-tx-bus-width = <4>;
 
             spi-max-frequency = <133000000>;
 
             spi-max-frequency = <133000000>;
  +
            #address-cells = <1>;
  +
            #size-cells = <1>;
  +
        };
  +
    };
  +
  +
The below example, possible with {{EcosystemRelease | revision =4.1.0 |range = and after}},  shows how to configure the QUADSPI peripheral to use it as a communication channel using up to 8 qspi lines. It can be used to communicate with a FPGA.
  +
To enable the usage of the 8 qspi lines, the following properties are mandatory:
  +
* the chip select pins need to be removed from pinctrl-0 and pinctrl-1 properties.
  +
* cs-gpios properties must be populated in the controller node.
  +
* spi-rx-bus-width and spi-tx-bus-width properties must be set to 8 in the device node.
  +
  +
    &qspi {                                                   
  +
        pinctrl-names = "default", "sleep";                   
  +
        pinctrl-0 = <&qspi_clk_test_pins_a
  +
                    &qspi_bk1_test_pins_b
  +
                    &qspi_bk2_test_pins_b>;
  +
        pinctrl-1 = <&qspi_clk_test_sleep_pins_a
  +
                    &qspi_bk1_test_sleep_pins_b
  +
                    &qspi_bk2_test_sleep_pins_b>;
  +
        reg = <0x58003000 0x1000>,
  +
              <0x70000000 0x4000000>;                         
  +
        #address-cells = <1>;
  +
        #size-cells = <0>;
  +
        status = "okay";
  +
        cs-gpios = <&gpiob 6 GPIO_ACTIVE_LOW>;<br>
  +
        fpga@0 {                               
  +
            compatible = "fpga";
  +
            reg = <0>;
  +
            spi-rx-bus-width = <8>;
  +
            spi-tx-bus-width = <8>;
  +
            spi-max-frequency = <108000000>;
 
             #address-cells = <1>;
 
             #address-cells = <1>;
 
             #size-cells = <1>;
 
             #size-cells = <1>;
Line 82: Line 129:
   
 
==How to configure the DT using STM32CubeMX==
 
==How to configure the DT using STM32CubeMX==
The [[STM32CubeMX]] tool can be used to configure the STM32MPU device and get the corresponding [[Device_tree#STM32|platform configuration device tree]] files.<br />
+
The [[STM32CubeMX]] tool can be used to configure the STM32MPU device and get the corresponding [[Device_tree#STM32_MPU|platform configuration device tree]] files.<br />
 
STM32CubeMX may not support all the properties described in DT binding files listed in the above [[#DT bindings documentation|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.
 
STM32CubeMX may not support all the properties described in DT binding files listed in the above [[#DT bindings documentation|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.