Difference between revisions of "DMAMUX device tree configuration"

[quality revision] [quality revision]
m
 
m (DT bindings documentation)
 
Template:ArticleMainWriter Template:ArticleApprovedVersion

1 Article purpose[edit]

This article explains how to configure the DMAMUX internal peripheral when it is assigned to the Linux® OS. In that case, it is controlled by the Dmaengine overview.

The configuration is performed using the Device tree mechanism that provides a hardware description of the DMAMUX internal peripheral, used by the STM32 DMAMUX Linux driver and by the DMA framework.

The hardware description is a combination of:

  • STM32 DMAMUX peripheral
  • and STM32 DMAMUX client

If the peripheral is assigned to another execution context, refer to How to assign an internal peripheral to a runtime context article for guidelines on peripheral assignment and configuration.

2 DT bindings documentation[edit]

Complete device tree bindings can be found at this location: [1].

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 split.

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]

At device level, DMAMUX is declared as follows:


dmamux1: dma-router@48002000 {
    compatible = "st,stm32h7-dmamux";
    reg = <0x48002000 
0x1c>
0x40>;
    #dma-cells = <3>;
    dma-requests = <128>;
    dma-masters = <&dma1 &dma2>;
    dma-channels = <16>;
    clocks = <&rcc DMAMUX>;
    resets = <&rcc DMAMUX_R>;
};

The DTS file is located under source/arch/arm/boot/dts/stm32mp157cstm32mp151.dtsi

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]

No board device tree configuration is required.
The whole configuration remains at STM32 level.

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.
The STM32CubeMX may not support all the properties described 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]

Please refer to the following links for additional information:


<noinclude>

{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
{{ArticleMainWriter|Pierre-YvesM}}
{{ArticleApprovedVersion | Pierre-YvesM | AlexandreT(Passed 26Oct'18) | No previous approved version | AnneJ- 31Oct'18 - 9467 | 08Nov'18}}
[[Category:Device tree configuration]]
[[Category:DMA]]</noinclude>

== Article purpose ==
This article explains how to configure the [[DMAMUX internal peripheral]] when it is assigned to the Linux<sup>&reg;</sup> OS. In that case, it is controlled by the [[Dmaengine overview]]. 

The configuration is performed using the [[Device tree]] mechanism that provides a hardware description of the [[DMAMUX internal peripheral]], used by the STM32 DMAMUX Linux driver and by the [[Dmaengine overview|DMA framework]].

The hardware description is a combination of:
* STM32 DMAMUX peripheral
* and STM32 DMAMUX client
If the peripheral is assigned to another execution context, refer to [[How to assign an internal peripheral to a runtime context]] article for guidelines on peripheral assignment and configuration.
== DT bindings documentation ==
Complete device tree bindings can be found at this location: <ref>{{CodeSource | Linux kernel | Documentation/devicetree/bindings/dma/st,stm32-dmamux.txtyaml}}</ref>.

== 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 split.

'''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) ===
At device level, DMAMUX is declared as follows:
<pre class="brush:c; tab-size:8;gutter:true;">

dmamux1: dma-router@48002000 {
    compatible = "st,stm32h7-dmamux";
    reg = <0x48002000 0x1c0x40>;
    #dma-cells = <3>;
    dma-requests = <128>;
    dma-masters = <&dma1 &dma2>;
    dma-channels = <16>;
    clocks = <&rcc DMAMUX>;    resets = <&rcc DMAMUX_R>;};</pre>


The DTS file is located under {{CodeSource | Linux kernel | source/arch/arm/boot/dts/stm32mp157cstm32mp151.dtsi}}

{{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) ===
No board device tree configuration is required.<br>

The whole configuration remains at STM32 level.

==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 may not support all the properties described 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==
Please refer to the following links for additional information:
<references />

<noinclude>

[[Category:Device tree configuration]]
[[Category:DMA]]
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
{{PublicationRequestId | 9467  | 2018-10-31 | AnneJ}}</noinclude>
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<noinclude>
 
{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
 
{{ArticleMainWriter|Pierre-YvesM}}
 
{{ArticleApprovedVersion | Pierre-YvesM | AlexandreT(Passed 26Oct'18) | No previous approved version | AnneJ- 31Oct'18 - 9467 | 08Nov'18}}
 
[[Category:Device tree configuration]]
 
[[Category:DMA]]
 
</noinclude>
 
 
 
== Article purpose ==
 
== Article purpose ==
 
This article explains how to configure the [[DMAMUX internal peripheral]] when it is assigned to the Linux<sup>&reg;</sup> OS. In that case, it is controlled by the [[Dmaengine overview]].  
 
This article explains how to configure the [[DMAMUX internal peripheral]] when it is assigned to the Linux<sup>&reg;</sup> OS. In that case, it is controlled by the [[Dmaengine overview]].  
Line 15: Line 7:
 
* STM32 DMAMUX peripheral
 
* STM32 DMAMUX peripheral
 
* and STM32 DMAMUX client
 
* and STM32 DMAMUX client
  +
  +
If the peripheral is assigned to another execution context, refer to [[How to assign an internal peripheral to a runtime context]] article for guidelines on peripheral assignment and configuration.
   
 
== DT bindings documentation ==
 
== DT bindings documentation ==
Complete device tree bindings can be found at this location: <ref>{{CodeSource | Linux kernel | Documentation/devicetree/bindings/dma/stm32-dmamux.txt}}</ref>.
+
Complete device tree bindings can be found at this location: <ref>{{CodeSource | Linux kernel | Documentation/devicetree/bindings/dma/st,stm32-dmamux.yaml}}</ref>.
   
 
== DT configuration ==
 
== DT configuration ==
Line 27: Line 21:
 
At device level, DMAMUX is declared as follows:
 
At device level, DMAMUX is declared as follows:
   
<pre class="brush:c; tab-size:8;gutter:true;">
+
<pre>
 
dmamux1: dma-router@48002000 {
 
dmamux1: dma-router@48002000 {
 
     compatible = "st,stm32h7-dmamux";
 
     compatible = "st,stm32h7-dmamux";
     reg = <0x48002000 0x1c>;
+
     reg = <0x48002000 0x40>;
 
     #dma-cells = <3>;
 
     #dma-cells = <3>;
 
     dma-requests = <128>;
 
     dma-requests = <128>;
Line 36: Line 30:
 
     dma-channels = <16>;
 
     dma-channels = <16>;
 
     clocks = <&rcc DMAMUX>;
 
     clocks = <&rcc DMAMUX>;
  +
    resets = <&rcc DMAMUX_R>;
 
};
 
};
 
</pre>
 
</pre>
   
The DTS file is located under {{CodeSource | Linux kernel | source/arch/arm/boot/dts/stm32mp157c.dtsi}}
+
The DTS file is located under {{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp151.dtsi}}
   
 
{{Warning|This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.}}
 
{{Warning|This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.}}
Line 55: Line 50:
   
 
<references />
 
<references />
  +
  +
<noinclude>
  +
[[Category:Device tree configuration]]
  +
[[Category:DMA]]
  +
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
  +
{{PublicationRequestId | 9467  | 2018-10-31 | AnneJ}}
  +
</noinclude>