Difference between revisions of "IWDG device tree configuration"

[quality revision] [quality revision]
m (DT configuration (board level))
 
m
 
Template:ArticleMainWriter Template:ArticleApprovedVersion

1 Article purpose[edit]

This article explains how to configure the IWDG internal peripheral when it is assigned to the Linux® OS. In that case, it is controlled by the IWDG Framework (see watchdog overview).

The configuration is performed using the device tree mechanism that provides a hardware description of the IWDG peripheral.

2 DT bindings documentation[edit]

The IWDG internal peripheral is a watchdog device. Refer to st,stm32-iwdg.txt [1] for the corresponding binding document.

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]

The IWDG peripheral node is located in stm32mp157cstm32mp151.dtsi [2] file.

iwdg2: iwdg@5a002000 {
	compatible = "st,stm32mp1-iwdg";
	reg = <0x5a002000 0x400>;			/* Registers location and length */
	clocks = <&rcc IWDG2>, <&rcc CK_LSI>;		/* phandles on clocks needed */
	clock-names = "pclk", "lsi";
	status = "disabled";
};
Warning.png This device tree part is related to STM32 microprocessors. It should be kept as is, without being modified by the end-user.

3.2 DT configuration (board level)[edit]

This part is used to enable the IWDG hardware on a board, and define a custom timeout (timeout-sec) in seconds:

&iwdg2 {
	timeout-sec = <32>;	/* Watchdog timeout value in seconds */
	status = "okay";
};

3.3 DT configuration examples[edit]

Only the timeout-sec parameter can be modified, as illustrated above.

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]


<noinclude>

{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
{{ArticleMainWriter | LudovicB}}
{{ArticleApprovedVersion | LudovicB | AlexandreT (Passed 4July'18), ChristopheR (Done 4July'18) | No previous approved version | AnneJ - 07Jan'19 - 10152 | 17Jan'19}}
[[Category:Device tree configuration]]
[[Category:Watchdog]]</noinclude>

== Article purpose ==
This article explains how to configure the [[IWDG internal peripheral|'''IWDG''' internal peripheral]] when it is assigned to the Linux<sup>&reg;</sup> OS. In that case, it is controlled by the IWDG Framework (see [[Watchdog overview|watchdog overview]]).

The configuration is performed using the [[Device tree|device tree]] mechanism that provides a hardware description of the IWDG peripheral.

== DT bindings documentation ==
The [[IWDG internal peripheral|'''IWDG''' internal peripheral]] is a watchdog device. 
Refer to st,stm32-iwdg.txt <ref>{{CodeSource | Linux kernel | Documentation/devicetree/bindings/watchdog/st,stm32-iwdg.txt}}</ref> for the corresponding binding document.

== 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) ===
The IWDG peripheral node is located in ''stm32mp157cstm32mp151.dtsi'' <ref>{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp157cstm32mp151.dtsi | arch/arm/boot/dts/stm32mp157cstm32mp151.dtsi}}</ref> file. 
<pre>

iwdg2: iwdg@5a002000 {
	compatible = "st,stm32mp1-iwdg";
	reg = <0x5a002000 0x400>;			/* Registers location and length */
	clocks = <&rcc IWDG2>, <&rcc CK_LSI>;		/* phandles on clocks needed */
	clock-names = "pclk", "lsi";
	status = "disabled";
};</pre>

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

=== DT configuration (board level) ===
This part is used to enable the IWDG hardware on a board, and define a custom timeout (timeout-sec) in seconds:<pre>

&iwdg2 {
	timeout-sec = <32>;	/* Watchdog timeout value in seconds */
	status = "okay";
};</pre>


=== DT configuration examples ===
Only the timeout-sec parameter can be modified, as illustrated above.

==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==<references />

<noinclude>

[[Category:Device tree configuration]]
[[Category:Watchdog]]
{{PublicationRequestId | 10152 | 2019-01-07 | AnneJ}}
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}</noinclude>
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<noinclude>
 
{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
 
{{ArticleMainWriter | LudovicB}}
 
{{ArticleApprovedVersion | LudovicB | AlexandreT (Passed 4July'18), ChristopheR (Done 4July'18) | No previous approved version | AnneJ - 07Jan'19 - 10152 | 17Jan'19}}
 
[[Category:Device tree configuration]]
 
[[Category:Watchdog]]
 
</noinclude>
 
 
 
== Article purpose ==
 
== Article purpose ==
 
This article explains how to configure the [[IWDG internal peripheral|'''IWDG''' internal peripheral]] when it is assigned to the Linux<sup>&reg;</sup> OS. In that case, it is controlled by the IWDG Framework (see [[Watchdog overview|watchdog overview]]).
 
This article explains how to configure the [[IWDG internal peripheral|'''IWDG''' internal peripheral]] when it is assigned to the Linux<sup>&reg;</sup> OS. In that case, it is controlled by the IWDG Framework (see [[Watchdog overview|watchdog overview]]).
Line 22: Line 14:
   
 
===DT configuration (STM32 level) ===
 
===DT configuration (STM32 level) ===
The IWDG peripheral node is located in ''stm32mp157c.dtsi'' <ref>{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp157c.dtsi | arch/arm/boot/dts/stm32mp157c.dtsi}}</ref> file.  
+
The IWDG peripheral node is located in ''stm32mp151.dtsi'' <ref>{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp151.dtsi | arch/arm/boot/dts/stm32mp151.dtsi}}</ref> file.  
   
 
<pre>
 
<pre>
Line 53: Line 45:
 
==References==
 
==References==
 
<references />
 
<references />
  +
  +
<noinclude>
  +
[[Category:Device tree configuration]]
  +
[[Category:Watchdog]]
  +
{{PublicationRequestId | 10152 | 2019-01-07 | AnneJ}}
  +
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
  +
</noinclude>