aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Barre <ludovic.barre@foss.st.com>2021-04-21 18:01:10 +0200
committerAnton Komlev <Anton.Komlev@arm.com>2021-05-06 00:39:13 +0200
commit1098de81ff7df8dad9b30f3280725247c1019930 (patch)
tree36ff896181c088367caee7f18607062a2ce897a4
parent76e9c4aca05bf7a366041303f49aa615497408b7 (diff)
downloadtrusted-firmware-m-1098de81ff7df8dad9b30f3280725247c1019930.tar.gz
platform: stm: update rst documentation for multi platform
This patch updates rst documentation for manage multi platform. -stm index lists SOC and Board supported by stmicroelectronics -Soc documentation are defined in stm/common/<SOC> directory -Board documentation are defined in stm/<Board> directory The content of stm/readme.rst file is splited to: -common/stm32l5xx/readme.rst => Soc -nucleo_l552ze_q/readme.rst => Board -stm32l562e_dk/readme.rst => Board Change-Id: Id2d29281ad6054a8a9305893c2c82466b89a9167 Signed-off-by: Ludovic Barre <ludovic.barre@foss.st.com>
-rw-r--r--platform/ext/index.rst2
-rw-r--r--platform/ext/target/stm/common/stm32l5xx/readme.rst64
-rw-r--r--platform/ext/target/stm/index.rst24
-rw-r--r--platform/ext/target/stm/nucleo_l552ze_q/readme.rst22
-rw-r--r--platform/ext/target/stm/readme.rst104
-rw-r--r--platform/ext/target/stm/stm32l562e_dk/readme.rst21
6 files changed, 132 insertions, 105 deletions
diff --git a/platform/ext/index.rst b/platform/ext/index.rst
index edd2cf63b..7fa6b74f0 100644
--- a/platform/ext/index.rst
+++ b/platform/ext/index.rst
@@ -37,7 +37,7 @@ Supported Platforms
:caption: STM
:glob:
- target/stm/**
+ target/stm/index
.. toctree::
:maxdepth: 4
diff --git a/platform/ext/target/stm/common/stm32l5xx/readme.rst b/platform/ext/target/stm/common/stm32l5xx/readme.rst
new file mode 100644
index 000000000..89a663431
--- /dev/null
+++ b/platform/ext/target/stm/common/stm32l5xx/readme.rst
@@ -0,0 +1,64 @@
+-------
+STM32L5
+-------
+
+TF-M is supported on STM32L5 family
+
+https://www.st.com/en/microcontrollers-microprocessors/stm32l5-series.html
+
+https://www.st.com/resource/en/user_manual/dm00678763-getting-started-with-stm32cubel5-tfm-application-stmicroelectronics.pdf
+
+Directory content
+^^^^^^^^^^^^^^^^^
+
+- stm/common/stm32l5xx/stm32l5xx_hal:
+ Content from https://github.com/STMicroelectronics/stm32l5xx_hal_driver.git
+
+- stm/common/stm32l5xx/Device:
+ Content from https://github.com/STMicroelectronics/cmsis_device_l5.git
+
+- stm/common/stm32l5xx/bl2:
+ stm32l5xx bl2 code specific from https://github.com/STMicroelectronics/STM32CubeL5.git (Projects/STM32L562E-DK/Applications/TFM)
+
+- stm/common/stm32l5xx/secure:
+ stm32l5xx Secure porting adaptation from https://github.com/STMicroelectronics/STM32CubeL5.git (Projects/STM32L562E-DK/Applications/TFM)
+
+- stm/common/stm32l5xx/boards:
+ Adaptation and tools specific to stm32 board using stm32l5xx soc from https://github.com/STMicroelectronics/STM32CubeL5.git (Projects/STM32L562E-DK/Applications/TFM)
+
+- stm/common/stm32l5xx/CMSIS_Driver:
+ Flash and uart driver for stm32l5xx platform
+
+- stm/common/stm32l5xx/Native_Driver:
+ Random generator and tickless implementation
+
+Specific Software Requirements
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+STM32_Programmer_CLI is required.(see https://www.st.com/en/development-tools/stm32cubeprog.html)
+
+
+Write software on target
+^^^^^^^^^^^^^^^^^^^^^^^^
+In build folder:
+
+ - ``postbuild.sh``: Updates regression.sh and TFM_UPDATE.sh scripts according to flash_layout.h
+ - ``regression.sh``: Sets platform option bytes config and erase platform
+ - ``TFM_UPDATE.sh``: Writes bl2, secure, and non secure image in target
+
+
+Connect board to USB and Execute the 3 scripts in following order to update platform:
+postbuild.sh, regression.sh, TFM_UPDATE.sh
+
+The virtual com port from STLINK is used for TFM log and serial port configuration should be:
+
+ - Baud rate = 115200
+ - Data = 8 bits
+ - Parity = none
+ - Stop = 1 bit
+ - Flow control = none
+
+-------------
+
+*Copyright (c) 2019 STMicroelectronics. All rights reserved.*
+*SPDX-License-Identifier: BSD-3-Clause*
diff --git a/platform/ext/target/stm/index.rst b/platform/ext/target/stm/index.rst
new file mode 100644
index 000000000..b974c9a5a
--- /dev/null
+++ b/platform/ext/target/stm/index.rst
@@ -0,0 +1,24 @@
+==================
+STMICROELECTRONICS
+==================
+
+This document contains SOC and boards supported by stm32.
+
+.. toctree::
+ :maxdepth: 1
+ :caption: SOC
+ :glob:
+
+ common/stm*/**
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Boards
+ :glob:
+
+ nucleo*/**
+ stm32*/**
+
+--------------
+
+*Copyright (c) 2021, stmicroelectronics All rights reserved.*
diff --git a/platform/ext/target/stm/nucleo_l552ze_q/readme.rst b/platform/ext/target/stm/nucleo_l552ze_q/readme.rst
new file mode 100644
index 000000000..448aa1196
--- /dev/null
+++ b/platform/ext/target/stm/nucleo_l552ze_q/readme.rst
@@ -0,0 +1,22 @@
+NUCLEO-L552ZE-Q
+^^^^^^^^^^^^^^^
+
+STM32 Nucleo-144 development board with STM32L552ZE MCU, SMPS, supports Arduino, ST Zio and morpho connectivity
+https://www.st.com/en/evaluation-tools/nucleo-l552ze-q.html
+
+Configuration and Build
+"""""""""""""""""""""""
+
+GNUARM compilation is available for targets STM_NUCLEO_L552ZE_Q and STM_DISCO_L562QE
+and build the selected configuration as follow.
+
+``> mkdir build && cd build``
+
+``> cmake .. -DTFM_PLATFORM=stm/nucleo_l552ze_q -DCMAKE_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -G"Unix Makefiles"``
+
+``> cmake --build ./ -- install``
+
+-------------
+
+*Copyright (c) 2019 STMicroelectronics. All rights reserved.*
+*SPDX-License-Identifier: BSD-3-Clause*
diff --git a/platform/ext/target/stm/readme.rst b/platform/ext/target/stm/readme.rst
deleted file mode 100644
index e1311b35e..000000000
--- a/platform/ext/target/stm/readme.rst
+++ /dev/null
@@ -1,104 +0,0 @@
-STMicroelectronics
-##################
-
-TF-M is supported on STM32L5 family
-
-https://www.st.com/en/microcontrollers-microprocessors/stm32l5-series.html
-
-https://www.st.com/resource/en/user_manual/dm00678763-getting-started-with-stm32cubel5-tfm-application-stmicroelectronics.pdf
-
-
-*****************
-Directory content
-*****************
-
-stm/stm32l562e_dk: STM32L562E-DK
-================================
-Discovery kit with STM32L562QE MCU :
-https://www.st.com/en/evaluation-tools/stm32l562e-dk.html
-
-stm/nucleo_l552ze_q: NUCLEO-L552ZE-Q
-====================================
-STM32 Nucleo-144 development board with STM32L552ZE MCU, SMPS, supports Arduino, ST Zio and morpho connectivity
-https://www.st.com/en/evaluation-tools/nucleo-l552ze-q.html
-
-
-stm/common/stm32l5xx/stm32l5xx_hal
-==================================
-Content from https://github.com/STMicroelectronics/stm32l5xx_hal_driver.git
-
-stm/common/stm32l5xx/Device
-===========================
-Content from https://github.com/STMicroelectronics/cmsis_device_l5.git
-
-stm/common/stm32l5xx/bl2
-========================
-stm32l5xx bl2 code specific from https://github.com/STMicroelectronics/STM32CubeL5.git
-(Projects/STM32L562E-DK/Applications/TFM)
-
-stm/common/stm32l5xx/secure
-===========================
-stm32l5xx Secure porting adaptation from https://github.com/STMicroelectronics/STM32CubeL5.git
-(Projects/STM32L562E-DK/Applications/TFM)
-
-stm/common/stm32l5xx/boards
-===========================
-Adaptation and tools specific to stm32 board using stm32l5xx soc
-from https://github.com/STMicroelectronics/STM32CubeL5.git
-(Projects/STM32L562E-DK/Applications/TFM)
-
-stm/common/stm32l5xx/CMSIS_Driver
-=================================
-Flash and uart driver for stm32l5xx platform
-
-stm/common/stm32l5xx/Native_Driver
-==================================
-random generator and tickless implementation
-
-
-***************************************
-Building and running software on target
-***************************************
-
-Specific Software Requirements
-==============================
-
-STM32_Programmer_CLI is required.(see https://www.st.com/en/development-tools/stm32cubeprog.html)
-
-Configuration and Build
-=======================
-GNUARM compilation is available for targets STM_NUCLEO_L552ZE_Q and STM_DISCO_L562QE
-and build the selected configuration as follow.
-
-``> mkdir build && cd build``
-
-``> cmake .. -DTFM_PLATFORM=stm/nucleo_l552ze_q -DCMAKE_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -G"Unix Makefiles"``
-
-``> cmake .. -DTFM_PLATFORM=stm/stm32l562e_dk -DCMAKE_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -G"Unix Makefiles"``
-
-``> cmake --build ./ -- install``
-
-Write software on target
-========================
-In build folder:
-
- - ``postbuild.sh``: Updates regression.sh and TFM_UPDATE.sh scripts according to flash_layout.h
- - ``regression.sh``: Sets platform option bytes config and erase platform
- - ``TFM_UPDATE.sh``: Writes bl2, secure, and non secure image in target
-
-
-Connect board to USB and Execute the 3 scripts in following order to update platform:
-postbuild.sh, regression.sh, TFM_UPDATE.sh
-
-The virtual com port from STLINK is used for TFM log and serial port configuration should be:
-
- - Baud rate = 115200
- - Data = 8 bits
- - Parity = none
- - Stop = 1 bit
- - Flow control = none
-
--------------
-
-*Copyright (c) 2019 STMicroelectronics. All rights reserved.*
-*SPDX-License-Identifier: BSD-3-Clause*
diff --git a/platform/ext/target/stm/stm32l562e_dk/readme.rst b/platform/ext/target/stm/stm32l562e_dk/readme.rst
new file mode 100644
index 000000000..5ad6dad1c
--- /dev/null
+++ b/platform/ext/target/stm/stm32l562e_dk/readme.rst
@@ -0,0 +1,21 @@
+STM32L562E-DK
+^^^^^^^^^^^^^
+
+Discovery kit with STM32L562QE MCU :
+https://www.st.com/en/evaluation-tools/stm32l562e-dk.html
+
+Configuration and Build
+=======================
+GNUARM compilation is available for targets STM_NUCLEO_L552ZE_Q and STM_DISCO_L562QE
+and build the selected configuration as follow.
+
+``> mkdir build && cd build``
+
+``> cmake .. -DTFM_PLATFORM=stm/nucleo_l552ze_q -DCMAKE_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake -G"Unix Makefiles"``
+
+``> cmake --build ./ -- install``
+
+-------------
+
+*Copyright (c) 2019 STMicroelectronics. All rights reserved.*
+*SPDX-License-Identifier: BSD-3-Clause*