Difference between revisions of "PKA device tree configuration"

[quality revision] [pending revision]
m
m
 
Applicable for STM32MP13x lines

1 Article purpose[edit]

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

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 .

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 PKA node is located in the device tree file for the software components, supporting the peripheral and listed in the above DT bindings documentation paragraph.

It is only included on SoC STM32 MPU devices 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 PKA DT nodes for a board.

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


3.3 DT configuration examples[edit]

   &pka {
        status = "okay";
   };

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 the STM32CubeMX user manual for further information.

5 References[edit]

Refer to the following links for additional information:




<noinclude>{{ApplicableFor
|MPUs list=STM32MP13x
|MPUs checklist=STM32MP13x
, STM32MP15x}}</noinclude>


== Article purpose ==
The purpose of this article is to explain how to configure the [[PKA_internal_peripheral|'''PKA''']] 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 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 .

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


* TF-A BL2, OP-TEE:
** PKA device tree bindings : {{CodeSource | OP-TEE_OS | documentation/devicetree/bindings/crypto/st,stm32-pka.yaml}}

== 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 [[PKA_internal_peripheral|'''PKA''']] 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. 

It is only included on SoC STM32 MPU devices 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 [[PKA_internal_peripheral|'''PKA''']] DT nodes for a board.<br>


Peripheral configuration should be done in specific board device tree files (board dts file).<br>


=== DT configuration examples ===

    &pka {
         status = "okay";
    };

==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_MPU|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 the [[STM32CubeMX]] user manual for further information.

==References==
Refer to the following links for additional information:<references />

<noinclude>

{{PublicationRequestId | 24114 | 2022-07-27 | }}
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
[[Category:Device tree configuration]]
[[Category:OP-TEE Crypto]]</noinclude>
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<noinclude>{{ApplicableFor
 
<noinclude>{{ApplicableFor
 
|MPUs list=STM32MP13x
 
|MPUs list=STM32MP13x
|MPUs checklist=STM32MP13x
+
|MPUs checklist=STM32MP13x, STM32MP15x
 
}}</noinclude>
 
}}</noinclude>
   
Line 25: Line 25:
 
The [[PKA_internal_peripheral|'''PKA''']] 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 [[PKA_internal_peripheral|'''PKA''']] 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.  
   
It is only included on SoC supporting secure boot.
+
It is only included on STM32 MPU devices 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.}}
 
{{Warning|This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.}}
Line 43: Line 43:
   
 
==How to configure the DT using STM32CubeMX==
 
==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]] tool can be used to configure the STM32MPU device and get the corresponding [[Device_tree#STM32_MPU|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.
+
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 the [[STM32CubeMX]] user manual for further information.
   
 
==References==
 
==References==
Line 51: Line 51:
   
 
<noinclude>
 
<noinclude>
  +
{{PublicationRequestId | 24114 | 2022-07-27 | }}
 
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
 
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
 
 
[[Category:Device tree configuration]]
 
[[Category:Device tree configuration]]
 
[[Category:OP-TEE Crypto]]
 
[[Category:OP-TEE Crypto]]
 
</noinclude>
 
</noinclude>