summaryrefslogtreecommitdiff
path: root/Documentation/arm/stm32/overview.rst
diff options
context:
space:
mode:
authorLudovic Barre <ludovic.barre@st.com>2018-02-26 16:39:52 +0300
committerAlexandre Torgue <alexandre.torgue@st.com>2018-03-05 11:08:34 +0300
commit40fed8d0e3833200f4b9f7cd057e37d0450a5044 (patch)
tree3a9436abed65b85af4cd33053f8e12a47d299a35 /Documentation/arm/stm32/overview.rst
parent61ea291cff9e8cc4b35d84c73b2659b628d4ff9b (diff)
downloadlinux-40fed8d0e3833200f4b9f7cd057e37d0450a5044.tar.xz
Documentation: arm: stm32: move to rst format
This patch rewrites stm32 documentation to rst (ReStructuredText) format. Signed-off-by: Ludovic Barre <ludovic.barre@st.com> Signed-off-by: Alexandre Torgue <alexandre.torgue@st.com>
Diffstat (limited to 'Documentation/arm/stm32/overview.rst')
-rw-r--r--Documentation/arm/stm32/overview.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/Documentation/arm/stm32/overview.rst b/Documentation/arm/stm32/overview.rst
new file mode 100644
index 000000000000..6be60592eaf7
--- /dev/null
+++ b/Documentation/arm/stm32/overview.rst
@@ -0,0 +1,31 @@
+========================
+STM32 ARM Linux Overview
+========================
+
+Introduction
+------------
+
+The STMicroelectronics family of Cortex-M based MCUs are supported by the
+'STM32' platform of ARM Linux. Currently only the STM32F429 (Cortex-M4)
+and STM32F746 (Cortex-M7) are supported.
+
+Configuration
+-------------
+
+A generic configuration is provided for STM32 family, and can be used as the
+default by
+ make stm32_defconfig
+
+Layout
+------
+
+All the files for multiple machine families are located in the platform code
+contained in arch/arm/mach-stm32
+
+There is a generic board board-dt.c in the mach folder which support
+Flattened Device Tree, which means, it works with any compatible board with
+Device Trees.
+
+:Authors:
+
+Maxime Coquelin <mcoquelin.stm32@gmail.com>