Difference between revisions of "ETZPC device tree configuration"

[quality revision] [quality revision]
(Created page with "<noinclude> {{ArticleBasedOnModel | Peripheral or framework device tree configuration model}} {{ArticleMainWriter | YannG}} {{ArticleApprovedVersion | Jean-ChristopheT | N...")
 
imported>Frq08728
 




1 Article purpose[edit]

This article explains how to configure the ETZPC internal peripheral.

The configuration is performed using the device tree mechanism that provides a hardware description of the ETZPC peripheral, used by TF-A or OP-TEE.

2 DT bindings documentation[edit]

The ETZPC device tree bindings [1] describe all the required and optional properties.

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 ETZPC node is in the stm32mp157c-security.dtsi [2] file. 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";
};

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]

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 [3] for more details.

To fill the "st,decprot" property, a DECPROT helper macro is provided. Its definition is in a dedicated header file [4]. 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. 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.
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:

Under construction.png Coming soon
<noinclude>

{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
{{ArticleMainWriter | YannG}}
{{ArticleApprovedVersion| YannG | NicolasLB, LionelD, GeraldB  | Jean-ChristopheT | Nobody | No previous approved version | AnneJ - 30Jan'19 - 10428 | 31Jan'19}}
Automatic approval (article under construction) | 28Jan’19}}[[Category:Device tree configuration]]
[[Category:Trusted Firmware-A (TF-A)]]
[[Category:OP-TEE secure OS]]</noinclude>


== Article purpose ==
This article explains how to configure the [[ETZPC internal peripheral]].

The configuration is performed using the [[Device tree|device tree]] mechanism that provides a hardware description of the ETZPC peripheral, used by [[TF-A_overview|TF-A]] or [[OP-TEE_overview|OP-TEE]].

== DT bindings documentation ==
The ETZPC device tree bindings <ref name=bindings>{{CodeSource | TF-A | docs/devicetree/bindings/soc/st,stm32-etzpc.txt}}</ref> describe all the required and optional properties.

== 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 ETZPC node is in the stm32mp157c-security.dtsi <ref>{{CodeSource | TF-A | fdts/stm32mp157c-security.dtsi}}</ref> file. 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";
 };

{{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 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 <ref>{{CodeSource | TF-A | include/dt-bindings/soc/st,stm32-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:
 &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. 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 />

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 />{{UnderConstruction}}
Line 2: Line 2:
 
{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
 
{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
 
{{ArticleMainWriter | YannG}}
 
{{ArticleMainWriter | YannG}}
{{ArticleApprovedVersion | Jean-ChristopheT | Nobody | No previous approved version | Automatic approval (article under construction) | 28Jan’19}}
+
{{ArticleApprovedVersion| YannG | NicolasLB, LionelD, GeraldB | No previous approved version | AnneJ - 30Jan'19 - 10428 | 31Jan'19}}
  +
 
 
[[Category:Device tree configuration]]
 
[[Category:Device tree configuration]]
 
[[Category:Trusted Firmware-A (TF-A)]]
 
[[Category:Trusted Firmware-A (TF-A)]]
 
[[Category:OP-TEE secure OS]]
 
[[Category:OP-TEE secure OS]]
 
</noinclude>
 
</noinclude>
{{UnderConstruction}}
+
 
  +
== Article purpose ==
  +
This article explains how to configure the [[ETZPC internal peripheral]].
  +
 
  +
The configuration is performed using the [[Device tree|device tree]] mechanism that provides a hardware description of the ETZPC peripheral, used by [[TF-A_overview|TF-A]] or [[OP-TEE_overview|OP-TEE]].
  +
 
  +
== DT bindings documentation ==
  +
The ETZPC device tree bindings <ref name=bindings>{{CodeSource | TF-A | docs/devicetree/bindings/soc/st,stm32-etzpc.txt}}</ref> describe all the required and optional properties.
  +
 
  +
== 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 ETZPC node is in the stm32mp157c-security.dtsi <ref>{{CodeSource | TF-A | fdts/stm32mp157c-security.dtsi}}</ref> file. 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";
  +
};
  +
 
  +
{{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 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 <ref>{{CodeSource | TF-A | include/dt-bindings/soc/st,stm32-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:
  +
&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. 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 />
  +
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 />

Attachments

Discussions