CRYP device tree configuration: Difference between revisions

Latest revision as of 14:42, 28 October 2024↑

Applicable for

STM32MP13x lines, STM32MP15x lines, STM32MP21x lines, STM32MP23x lines, STM32MP25x lines

1. Article purpose[edit | edit source]↑

The purpose of this article is to explain how to configure the CRYP 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 an execution context article for guidelines on this configuration.

2. DT bindings documentation[edit | edit source]↑

The device tree binding documents are stored either in the given applicable components listed below, or in the Linux kernel repository:

OP-TEE, Linux^® Kernel:
- CRYP device tree bindings: Template:CodeSource

3. DT configuration[edit | edit source]↑

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 | edit source]↑

The CRYP 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 supporting cryptography : STM32MP15xC/F lines , STM32MP13xC/F lines , STM32MP21xC/F lines , STM32MP23xC/F lines and STM32MP25xC/F lines .

Template:Warning

3.2. DT configuration (board level)[edit | edit source]↑

The goal is to explain how to enable and configure the CRYP 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 | edit source]↑

   &cryp {
        status = "okay";
   };

4. How to configure the DT using STM32CubeMX[edit | edit source]↑

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. Then, these sections can 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 | edit source]↑

Refer to the following links for additional information:

Template:ArticleBasedOnModel

@@ Line 1: / Line 1: @@
-<noinclude>
+{{ApplicableFor
-{{ArticleBasedOnModel|[[Peripheral or framework device tree configuration model]]}}
+|MPUs list=STM32MP13x, STM32MP15x, STM32MP21x, STM32MP23x, STM32MP25x
-{{ArticleMainWriter | FabienD}}
+|MPUs checklist=STM32MP13x, STM32MP15x, STM32MP21x, STM32MP23x, STM32MP25x
-{{ArticleApprovedVersion| FabienD| LionelD| No previous approved version | BrunoB - 21Sep'18 - 8896 | 27'Sep18 }}
-[[Category:Device tree configuration]]
-[[Category:Crypto]]
-{{ReviewsComments|JCT 1840: alignment needed with the last version of the model [[Peripheral or framework device tree configuration model]]<br>
-[[Category:ToBeAlignedWithModel]]
 }}
-</noinclude>
+<noinclude></noinclude>
 == Article purpose ==
-The purpose of this article is to explain how to configure the ''CRYP''<ref name="CRYP internal peripheral"> [[CRYP internal peripheral]] </ref> ''' when the peripheral is assigned to Linux<sup>&reg;</sup> OS'''.
+The purpose of this article is to explain how to configure the [[CRYP_internal_peripheral|'''CRYP''']] 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 configuration is performed using the '''device tree mechanism'''<ref> [[Device tree]]</ref>.
+The peripheral can be assigned to different contexts/software components, depending on the final product needs. <br>Refer to [[How to assign an internal peripheral to an execution context]] article for guidelines on this configuration.
-The [[Device tree]] provides a hardware description of the ''CRYP''<ref name="CRYP internal peripheral"/>, used by STM32 ''CRYP Linux driver''.
+== 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: <br>
-The ''CRYP'' <ref name="CRYP internal peripheral"/> is represented by the ''STM32 CRYP device tree bindings''<ref>{{CodeSource | Linux kernel | Documentation/devicetree/bindings/crypto/st,stm32-cryp.txt | Documentation/devicetree/bindings/crypto/st,stm32-cryp.txt}}</ref>.
+* OP-TEE, Linux<sup>&reg;</sup> Kernel:
+** CRYP device tree bindings: {{CodeSource | Linux kernel | Documentation/devicetree/bindings/crypto/st,stm32-cryp.yaml}}
 == DT configuration ==
-This hardware description is a combination of STM32 microprocessor and board device tree files. See [[Device tree]] for explanations on device tree file split.
+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.
-The '''STM32CubeMX''' can be used to generate the board device tree. Refer to [[#How_to_configure_the_DT_using_STM32CubeMX]] for more details.
+'''STM32CubeMX''' can be used to generate the board device tree.<br> Refer to [[#How_to_configure_the_DT_using_STM32CubeMX|How to configure the DT using STM32CubeMX]] for more details.
-===DT configuration (STM32 level) ===
+===DT configuration (STM32/SoC level) ===
-The CRYP node is declared in stm32mp157c.dtsi<ref name="stm32mp157c_dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp157c.dtsi | STM32MP157C device tree file}}</ref>. It provides the hardware registers base address, clock, interrupt and reset.
- cryp1: cryp@54001000 {
+The [[CRYP_internal_peripheral|'''CRYP''']] 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.
- 	compatible = "st,stm32mp1-cryp";
- 	reg = <0x54001000 0x400>;
- 	interrupts = <GIC_SPI 79 IRQ_TYPE_LEVEL_HIGH>;
- 	clocks = <&rcc CRYP1>;
- 	resets = <&rcc CRYP1_R>;
- 	status = "disabled";
- };
-{{Warning|This device tree part is related to STM32 microprocessors. It should be kept as is, without being modified by the end-user.}}
+It is only included on SoC supporting cryptography : {{MicroprocessorDevice | device=15 | security=Advanced}}, {{MicroprocessorDevice | device=13 | security=Advanced}}, {{MicroprocessorDevice | device=21|security=Advanced}} , {{MicroprocessorDevice | device=23 |security=Advanced}} and {{MicroprocessorDevice | device=25 | security=Advanced}}.
+{{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 CRYP used on a board. This is done by setting the '''status''' property to '''okay'''.
+The goal is to explain how to enable and configure the [[CRYP_internal_peripheral|'''CRYP''']] DT nodes for a board.<br>
+Peripheral configuration should be done in specific board device tree files (board dts file).<br>
 === DT configuration examples ===
- &cryp1 {
- 	status = "okay";
+    &cryp {
- };
+         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|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 />
-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.
+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. Then, these sections can be edited to add some properties, and they are preserved from one generation to another. <br>Refer to [[STM32CubeMX]] user manual for further information.
 ==References==
-Please refer to the following links for additional information:
+Refer to the following links for additional information:
+<references />
+<noinclude>
+{{PublicationRequestId | 24663 | 2022-09-26 | }}
+{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
-<references />
+[[Category:Device tree configuration]]
+[[Category:Crypto]]
+[[Category:OP-TEE Crypto]]
+</noinclude>