Difference between revisions of "ETZPC device tree configuration"

[checked revision] [quality revision]
m
m (Update to new device tree model)
Applicable for STM32MP13x lines, STM32MP15x lines

1 Article purpose[edit]

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

The peripheral is can be assigned to OP-TEE software component. It can be used by TF-A SP-MIN, but only for STM32MP15x lines More info.pngdifferent 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/SoC level)[edit]

The objective of this chapter is to explain how to configure the DT nodes related to the ETZPC on STM32 microprocessors. The ETZPC node is located in the device tree file for the software components, supporting the peripheral and listed in the above DT bindings documentation paragraph.

  • for STM32MP13x lines Warning.png in stm32mp131.dtsi [2]
  • for STM32MP15x lines More info.png in stm32mp151.dtsi [3]

It describes the hardware register address, clock and status.

etzpc: etzpc@5C007000 {
	compatible = "st,stm32-etzpc";
	reg = <0x5C007000 0x400>;
	clocks = <&rcc TZPC>;
	status = "disabled";
	secure-status = "okay";
};

It is only included on SoC supporting secure boot.

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 ETZPC DT nodes for a board.

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

The ETZPC node in the board dedicated device tree file is used to configure the status of securable peripherals. The "st,decprot" property must only contain the list of peripherals for which the user wants a different status than the one configured by default in the ETZPC. Refer to the ETZPC chapter of the reference manual [41] for more details.

To fill the "st,decprot" property, a DECPROT helper macro is provided. Its definition is in a dedicated header file:

  • for STM32MP13x lines Warning.png in stm32mp13-etzpc.h [52]
  • for STM32MP15x lines More info.png in stm32mp15-etzpc.h [6]

It includes three parameters: the peripheral ID in the ETZPC list of peripherals, the domain, and a lock status. Additional information on these parameters can be found in the device tree bindings documentation [1].

3.3 DT configuration examples[edit]

Below an example of peripheral configuration:

&etzpc {
	st,decprot = <
		DECPROT(STM32MP1_ETZPC_USART1_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
		DECPROT(STM32MP1_ETZPC_SPI6_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
		DECPROT(STM32MP1_ETZPC_I2C4_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
		DECPROT(STM32MP1_ETZPC_I2C6_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
		DECPROT(STM32MP1_ETZPC_RNG1_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
		DECPROT(STM32MP1_ETZPC_HASH1_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
		DECPROT(STM32MP1_ETZPC_CRYP1_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
	>;
};

By default these peripherals are secure only. They can then be configured to be used by the non-secure world in read and write modes.

Below another example of peripheral assignment (here the RNG2) to the MCU. This is only available on STM32MP15x lines More info.png, as there is no MCU in STM32MP13x lines Warning.png. By default this peripheral is assigned to the MPU non-secure world.

&etzpc {
	st,decprot = <
		DECPROT(STM32MP1_ETZPC_RNG2_ID, DECPROT_MCU_ISOLATION, DECPROT_UNLOCK)
	>;
};

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 [[ETZPC internal peripheral|'''ETZPC''']] 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 is can be assigned to [[OP-TEE_overview|OP-TEE]] software component.
It can be used by [[TF-A_overview|TF-A]] SP-MIN, but only for {{MicroprocessorDevice | device=15}}.

== DT bindings documentation ==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>

* OP-TEE:
** st,stm32-etzpc.yaml<ref name=bindings>, TF-A SP-Min for {{MicroprocessorDevice | device=15}}:
** ETZPC device tree bindings : {{CodeSource | OP-TEE_OS | documentation/devicetree/bindings/soc/stm32/st,stm32-etzpc.yaml | st,stm32-etzpc.yaml}}</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 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/SoC level) ===
The objective of this chapter is to explain how to configure the DT nodes related to the ETZPC on STM32 microprocessors.

The ETZPC[[ETZPC internal peripheral|'''ETZPC''']] 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. * for {{MicroprocessorDevice | device=13}} in stm32mp131.dtsi <ref name="stm32mp131.dtsi">{{CodeSource | OP-TEE_OS | core/arch/arm/dts/stm32mp131.dtsi | stm32mp131.dtsi}}</ref>

* for {{MicroprocessorDevice | device=15}} in stm32mp151.dtsi <ref name="stm32mp151.dtsi">{{CodeSource | OP-TEE_OS | core/arch/arm/dts/stm32mp151.dtsi | stm32mp151.dtsi}}</ref>

It describes the hardware register address, clock and status. 

 etzpc: etzpc@5C007000 {
 	compatible = "st,stm32-etzpc";
 	reg = <0x5C007000 0x400>;
 	clocks = <&rcc TZPC>;
 	status = "disabled";
 	secure-status = "okay";
 };

{{

It is only included on SoC supporting secure boot.

{{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 [[ETZPC internal peripheral|'''ETZPC''']] DT nodes for a board.<br>


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


The ETZPC node in the board dedicated device tree file is used to configure the status of securable peripherals. The "st,decprot" property must only contain the list of peripherals for which the user wants a different status than the one configured by default in the ETZPC. Refer to the ETZPC chapter of the reference manual <ref>[[STM32MP15 resources#Reference manuals|STM32MP15 reference manuals]]</ref> for more details.

To fill the "st,decprot" property, a DECPROT helper macro is provided. Its definition is in a dedicated header file:
* for {{MicroprocessorDevice | device=13}}  in stm32mp13-etzpc.h <ref name="stm32mp13-etzpc.h">{{CodeSource | OP-TEE_OS | core/include/dt-bindings/soc/stm32mp13-etzpc.h | stm32mp13-etzpc.h}}</ref>

* for {{MicroprocessorDevice | device=15}}  in stm32mp15-etzpc.h <ref name="stm32mp15-etzpc.h">{{CodeSource | OP-TEE_OS | core/include/dt-bindings/soc/stm32mp15-etzpc.h | stm32mp15-etzpc.h}}</ref>



It includes three parameters: the peripheral ID in the ETZPC list of peripherals, the domain, and a lock status. Additional information on these parameters can be found in the device tree bindings documentation <ref name=bindings/>.

=== DT configuration examples ===
Below an example of peripheral configuration:=== DT configuration examples ===
&etzpc {
 	st,decprot = <
 		DECPROT(STM32MP1_ETZPC_USART1_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
 		DECPROT(STM32MP1_ETZPC_SPI6_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
 		DECPROT(STM32MP1_ETZPC_I2C4_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
 		DECPROT(STM32MP1_ETZPC_I2C6_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
 		DECPROT(STM32MP1_ETZPC_RNG1_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
 		DECPROT(STM32MP1_ETZPC_HASH1_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
 		DECPROT(STM32MP1_ETZPC_CRYP1_ID, DECPROT_NS_RW, DECPROT_UNLOCK)
 	>;
 };

By default these peripherals are secure only. They can then be configured to be used by the non-secure world in read and write modes.

Below another example of peripheral assignment (here the RNG2) to the MCU. This is only available on {{MicroprocessorDevice | device=15}}, as there is no MCU in {{MicroprocessorDevice | device=13}}. By default this peripheral is assigned to the MPU non-secure world.
 &etzpc {
 	st,decprot = <
 		DECPROT(STM32MP1_ETZPC_RNG2_ID, DECPROT_MCU_ISOLATION, DECPROT_UNLOCK)
 	>;
 };

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

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>

[[Category:Device tree configuration]]
[[Category:OP-TEE Firewall]]
{{PublicationRequestId | 10428 | 2019-01-30 | AnneJ}}
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}</noinclude>
Line 1: Line 1:
  +
<noinclude>{{ApplicableFor
  +
|MPUs list=STM32MP13x, STM32MP15x
  +
|MPUs checklist=STM32MP13x, STM32MP15x
  +
}}</noinclude>
  +
 
== Article purpose ==
 
== Article purpose ==
The purpose of this article is to explain how to configure the [[ETZPC internal peripheral]] 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 purpose of this article is to explain how to configure the [[ETZPC internal peripheral|'''ETZPC''']] 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 is assigned to [[OP-TEE_overview|OP-TEE]] software component.
+
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 .
It can be used by [[TF-A_overview|TF-A]] SP-MIN, but only for {{MicroprocessorDevice | device=15}}.
 
   
 
== DT bindings documentation ==
 
== DT bindings documentation ==
The device tree binding documents are stored either in the given applicable components listed below, or in the Linux kernel repository:
+
 
* OP-TEE:
+
The device tree binding documents are stored either in the given applicable components listed below, or in the Linux kernel repository: <br>
** st,stm32-etzpc.yaml<ref name=bindings>{{CodeSource | OP-TEE_OS | documentation/devicetree/bindings/soc/stm32/st,stm32-etzpc.yaml | st,stm32-etzpc.yaml}}</ref>
+
 
  +
* OP-TEE, TF-A SP-Min for {{MicroprocessorDevice | device=15}}:
  +
** ETZPC device tree bindings : {{CodeSource | OP-TEE_OS | documentation/devicetree/bindings/soc/stm32/st,stm32-etzpc.yaml}}
   
 
== DT configuration ==
 
== DT configuration ==
Line 16: Line 22:
   
 
===DT configuration (STM32/SoC level) ===
 
===DT configuration (STM32/SoC level) ===
The objective of this chapter is to explain how to configure the DT nodes related to the ETZPC on STM32 microprocessors.
 
   
The ETZPC 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.
+
The [[ETZPC internal peripheral|'''ETZPC''']] 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.  
* for {{MicroprocessorDevice | device=13}} in stm32mp131.dtsi <ref name="stm32mp131.dtsi">{{CodeSource | OP-TEE_OS | core/arch/arm/dts/stm32mp131.dtsi | stm32mp131.dtsi}}</ref>
 
* for {{MicroprocessorDevice | device=15}} in stm32mp151.dtsi <ref name="stm32mp151.dtsi">{{CodeSource | OP-TEE_OS | core/arch/arm/dts/stm32mp151.dtsi | stm32mp151.dtsi}}</ref>
 
It describes the hardware register address, clock and status.  
 
   
etzpc: etzpc@5C007000 {
+
It is only included on SoC supporting secure boot.
compatible = "st,stm32-etzpc";
 
reg = <0x5C007000 0x400>;
 
clocks = <&rcc TZPC>;
 
status = "disabled";
 
secure-status = "okay";
 
};
 
   
 
{{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.}}
   
 
=== DT configuration (board level) ===
 
=== DT configuration (board level) ===
The objective of this chapter is to explain how to enable and configure the ETZPC DT nodes for a board.<br>
 
   
Peripheral configuration should be done in specific board device tree files (board dts file and [[Pinctrl device tree configuration|pinctrl dtsi file]]).<br>
+
The objective of this chapter is to explain how to enable and configure the [[ETZPC internal peripheral|'''ETZPC''']] DT nodes for a board.<br>
  +
 
  +
Peripheral configuration should be done in specific board device tree files (board dts file).<br>
   
 
The ETZPC node in the board dedicated device tree file is used to configure the status of securable peripherals. The "st,decprot" property must only contain the list of peripherals for which the user wants a different status than the one configured by default in the ETZPC. Refer to the ETZPC chapter of the reference manual <ref>[[STM32MP15 resources#Reference manuals|STM32MP15 reference manuals]]</ref> for more details.
 
The ETZPC node in the board dedicated device tree file is used to configure the status of securable peripherals. The "st,decprot" property must only contain the list of peripherals for which the user wants a different status than the one configured by default in the ETZPC. Refer to the ETZPC chapter of the reference manual <ref>[[STM32MP15 resources#Reference manuals|STM32MP15 reference manuals]]</ref> for more details.
Line 43: Line 40:
 
* for {{MicroprocessorDevice | device=13}}  in stm32mp13-etzpc.h <ref name="stm32mp13-etzpc.h">{{CodeSource | OP-TEE_OS | core/include/dt-bindings/soc/stm32mp13-etzpc.h | stm32mp13-etzpc.h}}</ref>
 
* for {{MicroprocessorDevice | device=13}}  in stm32mp13-etzpc.h <ref name="stm32mp13-etzpc.h">{{CodeSource | OP-TEE_OS | core/include/dt-bindings/soc/stm32mp13-etzpc.h | stm32mp13-etzpc.h}}</ref>
 
* for {{MicroprocessorDevice | device=15}}  in stm32mp15-etzpc.h <ref name="stm32mp15-etzpc.h">{{CodeSource | OP-TEE_OS | core/include/dt-bindings/soc/stm32mp15-etzpc.h | stm32mp15-etzpc.h}}</ref>
 
* for {{MicroprocessorDevice | device=15}}  in stm32mp15-etzpc.h <ref name="stm32mp15-etzpc.h">{{CodeSource | OP-TEE_OS | core/include/dt-bindings/soc/stm32mp15-etzpc.h | stm32mp15-etzpc.h}}</ref>
 
It includes three parameters: the peripheral ID in the ETZPC list of peripherals, the domain, and a lock status. Additional information on these parameters can be found in the device tree bindings documentation <ref name=bindings/>.
 
   
 
=== DT configuration examples ===
 
=== DT configuration examples ===
Below an example of peripheral configuration:
+
 
 
  &etzpc {
 
  &etzpc {
 
  st,decprot = <
 
  st,decprot = <
Line 62: Line 57:
 
By default these peripherals are secure only. They can then be configured to be used by the non-secure world in read and write modes.
 
By default these peripherals are secure only. They can then be configured to be used by the non-secure world in read and write modes.
   
Below another example of peripheral assignment (here the RNG2) to the MCU. This is only available on {{MicroprocessorDevice | device=15}}, as there is no MCU in {{MicroprocessorDevice | device=13}}. By default this peripheral is assigned to the MPU non-secure world.
+
Below another example of peripheral assignment (here the RNG2) to the MCU. This is only available on {{MicroprocessorDevice | device=15}}. By default this peripheral is assigned to the MPU non-secure world.
 
  &etzpc {
 
  &etzpc {
 
  st,decprot = <
 
  st,decprot = <
Line 75: Line 70:
 
==References==
 
==References==
 
Refer to the following links for additional information:
 
Refer to the following links for additional information:
 
 
<references />
 
<references />