Difference between revisions of "RNG device tree configuration"

[quality revision] [quality revision]
m (DT configuration (board level))
 
m (Cleanup)
 




1 Article purpose[edit]

This article explains how to configure the RNG internal peripheral when it is assigned to the Linux® OS. In that case, it is controlled by the Hardware random framework.

The configuration is performed using the device tree mechanism that provides a hardware description of the RNG peripheral, used by the STM32 RNG Linux driver.

2 DT bindings documentation[edit]

The RNG is represented by the STM32 RNG device tree bindings[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]

The RNG node is declared in stm32mp157c.dtsi[2]. It describes the hardware register address, clock and reset.

 rng1: rng@54003000 {                                           Comments
 	compatible = "st,stm32-rng";
 	reg = <0x54003000 0x400>;                               --> Register location and length
 	clocks = <&rcc RNG1_K>;
 	resets = <&rcc RNG1_R>;
 	status = "disabled";
 };
Warning.png 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]

This part is used to enable the RNG used on a board which is done by setting the status property to okay.

A clock-error-detect property is available depending the clock choosen for entropy. It can be enabled to manage the clock detection.

3.3 DT configuration examples[edit]

&rng1 {
	status = "okay";
	clock-error-detect;
};

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 | LionelD}}
{{ArticleApprovedVersion| LionelD| FabienD(Passed 26Jun'18)| No previous approved version | AlainF - 08Oct'18 - 8900| 29'Oct18}}

[[Category:Device tree configuration]]
[[Category:Security]]</noinclude>

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

The configuration is performed using the [[Device tree|device tree]] mechanism that provides a hardware description of the RNG peripheral, used by the STM32 RNG Linux driver.

== DT bindings documentation ==
The [[RNG internal peripheral|''RNG'']] is represented by the ''STM32 RNG device tree bindings''<ref>{{CodeSource | Linux kernel | Documentation/devicetree/bindings/rng/st,stm32-rng.txt | Device tree bindings}}</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) ===
The RNG node is declared in stm32mp157c.dtsi<ref>{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp157c.dtsi | STM32MP157C device tree}}</ref>. It describes the hardware register address, clock and reset.

  rng1: rng@54003000 {                                          {{highlight| Comments}}
  	compatible = "st,stm32-rng";
  	reg = <0x54003000 0x400>;                               {{highlight|--> Register location and length}}
  	clocks = <&rcc RNG1_K>;
  	resets = <&rcc RNG1_R>;
  	status = "disabled";
  };
{{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) ===
This part is used to enable the RNG used on a board which is done by setting the '''status''' property to '''okay'''.

A clock-error-detect property is available depending the clock choosen for entropy. It can be enabled to manage the clock detection.

=== DT configuration examples ===
 &rng1 {
 	status = "okay";
 	clock-error-detect;
 };

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

{{ArticleBasedOnModel|[[Peripheral or framework device tree configuration model]]}}
{{PublicationRequestId | 8900 | 2018-10-08 | AlainF}}
[[Category:Device tree configuration]]
[[Category:Security]]</noinclude>
Line 1: Line 1:
<noinclude>
 
{{ArticleBasedOnModel|[[Peripheral or framework device tree configuration model]]}}
 
{{ArticleMainWriter | LionelD}}
 
{{ArticleApprovedVersion| LionelD| FabienD(Passed 26Jun'18)| No previous approved version | AlainF - 08Oct'18 - 8900| 29'Oct18}}
 
 
[[Category:Device tree configuration]]
 
[[Category:Security]]
 
</noinclude>
 
 
 
== Article purpose ==
 
== Article purpose ==
 
This article explains how to configure the [[RNG internal peripheral|'''RNG''' internal peripheral]] when it is assigned to the Linux<sup>&reg;</sup> OS. In that case, it is controlled by the [[Hardware random overview|Hardware random framework]].
 
This article explains how to configure the [[RNG internal peripheral|'''RNG''' internal peripheral]] when it is assigned to the Linux<sup>&reg;</sup> OS. In that case, it is controlled by the [[Hardware random overview|Hardware random framework]].
Line 52: Line 43:
   
 
<references/>
 
<references/>
  +
  +
<noinclude>
  +
{{ArticleBasedOnModel|[[Peripheral or framework device tree configuration model]]}}
  +
{{PublicationRequestId | 8900 | 2018-10-08 | AlainF}}
  +
[[Category:Device tree configuration]]
  +
[[Category:Security]]
  +
</noinclude>

Attachments

Discussions