aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorKen Sarkies2012-12-05 15:36:44 +1030
committerKen Sarkies2013-01-08 19:48:52 +1030
commit7ec382c7d5dfdc868ab52501bebf02eb23a416a0 (patch)
tree566f06249513f04f5c88ba9b6301f56f27538dd1 /doc
parent4d234c7e27fad516f1a34698099982d7e9ced260 (diff)
STM32: Moved SPI code into the common area.
Updated the documentation so that it appears in all families Also added it to the L1 area, but is untested. An addition to the memorymap allows commonality and a #ifdef added to the spi_common_all code to exclude the case of SPI3 for L1 and F0 as SPI3 doesn't exist in those. An rcc dispatch header was added to remove same code from the spi header.
Diffstat (limited to 'doc')
-rw-r--r--doc/stm32f1/Doxyfile10
-rw-r--r--doc/stm32f1/Doxyfile_latex7
-rw-r--r--doc/stm32f1/DoxygenLayout_stm32f1.xml2
-rw-r--r--doc/stm32f2/Doxyfile8
-rw-r--r--doc/stm32f2/Doxyfile_latex7
-rw-r--r--doc/stm32f4/Doxyfile6
-rw-r--r--doc/stm32f4/Doxyfile_latex7
-rw-r--r--doc/stm32l1/Doxyfile25
-rw-r--r--doc/stm32l1/Doxyfile_latex14
9 files changed, 49 insertions, 37 deletions
diff --git a/doc/stm32f1/Doxyfile b/doc/stm32f1/Doxyfile
index ae83259..17a89c2 100644
--- a/doc/stm32f1/Doxyfile
+++ b/doc/stm32f1/Doxyfile
@@ -16,16 +16,16 @@
WARN_LOGFILE = doxygen_stm32f1.log
INPUT = ../../include/libopencm3/license.dox \
- ../../include/libopencm3/stm32/f1 \
- ../../include/libopencm3/stm32/common/gpio_common_all.h
+ ../../include/libopencm3/stm32/f1 \
+ ../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f1 \
- ../../lib/stm32/common/gpio_common_all.c
+ ../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f1/usb.h \
- ../../include/libopencm3/stm32/f1/usb_desc.h
+ ../../include/libopencm3/stm32/f1/usb_desc.h
-EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
+EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
LAYOUT_FILE = DoxygenLayout_stm32f1.xml
diff --git a/doc/stm32f1/Doxyfile_latex b/doc/stm32f1/Doxyfile_latex
index 217b6f9..97c32e7 100644
--- a/doc/stm32f1/Doxyfile_latex
+++ b/doc/stm32f1/Doxyfile_latex
@@ -18,9 +18,10 @@ WARN_LOGFILE = doxygen_stm32f1_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f1 \
- ../../include/libopencm3/stm32/common \
- ../../lib/stm32/f1 \
- ../../lib/stm32/common
+ ../../include/libopencm3/stm32/common
+
+INPUT += ../../lib/stm32/f1 \
+ ../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f1/doc-stm32f1.h \
../../include/libopencm3/stm32/f1/usb.h \
diff --git a/doc/stm32f1/DoxygenLayout_stm32f1.xml b/doc/stm32f1/DoxygenLayout_stm32f1.xml
index c3dfdf2..3e435b3 100644
--- a/doc/stm32f1/DoxygenLayout_stm32f1.xml
+++ b/doc/stm32f1/DoxygenLayout_stm32f1.xml
@@ -5,7 +5,7 @@
<tab type="pages" visible="yes" title="General Information" intro=""/>
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
- <tab type="modules" visible="yes" title="STMF1" intro=""/>
+ <tab type="modules" visible="yes" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
diff --git a/doc/stm32f2/Doxyfile b/doc/stm32f2/Doxyfile
index ff5765b..e230316 100644
--- a/doc/stm32f2/Doxyfile
+++ b/doc/stm32f2/Doxyfile
@@ -17,15 +17,15 @@ WARN_LOGFILE = doxygen_stm32f2.log
INPUT = ../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f2 \
- ../../include/libopencm3/stm32/common/gpio_common_all.h \
- ../../include/libopencm3/stm32/common/gpio_common_f24.h
+ ../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f2 \
- ../../lib/stm32/common/gpio_common_all.c \
- ../../lib/stm32/common/gpio_common_f24.c
+ ../../lib/stm32/common
EXCLUDE =
+EXCLUDE_PATTERNS =
+
LAYOUT_FILE = DoxygenLayout_stm32f2.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
diff --git a/doc/stm32f2/Doxyfile_latex b/doc/stm32f2/Doxyfile_latex
index 29bdc95..dad6848 100644
--- a/doc/stm32f2/Doxyfile_latex
+++ b/doc/stm32f2/Doxyfile_latex
@@ -18,12 +18,15 @@ WARN_LOGFILE = doxygen_stm32f2_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f2 \
- ../../include/libopencm3/stm32/common \
- ../../lib/stm32/f2 \
+ ../../include/libopencm3/stm32/common
+
+INPUT += ../../lib/stm32/f2 \
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f2/doc-stm32f2.h
+EXCLUDE_PATTERNS =
+
LAYOUT_FILE = DoxygenLayout_stm32f2.xml
GENERATE_HTML = NO
diff --git a/doc/stm32f4/Doxyfile b/doc/stm32f4/Doxyfile
index 6eff41c..9b3ba9b 100644
--- a/doc/stm32f4/Doxyfile
+++ b/doc/stm32f4/Doxyfile
@@ -17,12 +17,10 @@ WARN_LOGFILE = doxygen_stm32f4.log
INPUT = ../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f4 \
- ../../include/libopencm3/stm32/common/gpio_common_all.h \
- ../../include/libopencm3/stm32/common/gpio_common_f24.h
+ ../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f4 \
- ../../lib/stm32/common/gpio_common_all.c \
- ../../lib/stm32/common/gpio_common_f24.c
+ ../../lib/stm32/common
EXCLUDE =
diff --git a/doc/stm32f4/Doxyfile_latex b/doc/stm32f4/Doxyfile_latex
index 6f62b21..e93248c 100644
--- a/doc/stm32f4/Doxyfile_latex
+++ b/doc/stm32f4/Doxyfile_latex
@@ -18,12 +18,15 @@ WARN_LOGFILE = doxygen_stm32f4_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f4 \
- ../../include/libopencm3/stm32/common \
- ../../lib/stm32/f4 \
+ ../../include/libopencm3/stm32/common
+
+INPUT += ../../lib/stm32/f4 \
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f4/doc-stm32f4.h
+EXCLUDE_PATTERNS =
+
LAYOUT_FILE = DoxygenLayout_stm32f4.xml
GENERATE_HTML = NO
diff --git a/doc/stm32l1/Doxyfile b/doc/stm32l1/Doxyfile
index deca18b..566bb01 100644
--- a/doc/stm32l1/Doxyfile
+++ b/doc/stm32l1/Doxyfile
@@ -1,13 +1,13 @@
-# HTML Documentation for STM32F1 code level
+# HTML Documentation for STM32L1 code level
-# 14 September 2012
+# 15 December 2012
# (C) Ken Sarkies <ksarkies@internode.on.net>
#---------------------------------------------------------------------------
# Common Include File
#---------------------------------------------------------------------------
-@INCLUDE = ../Doxyfile_common
+@INCLUDE = ../Doxyfile_common
#---------------------------------------------------------------------------
# Local settings
@@ -16,18 +16,21 @@
WARN_LOGFILE = doxygen_stm32l1.log
INPUT = ../../include/libopencm3/license.dox \
- ../../include/libopencm3/stm32/l1 \
- ../../include/libopencm3/stm32/common \
- ../../lib/stm32/l1 \
- ../../lib/stm32/common
+ ../../include/libopencm3/stm32/l1 \
+ ../../include/libopencm3/stm32/common
-EXCLUDE =
+INPUT += ../../lib/stm32/l1 \
+ ../../lib/stm32/common
-EXCLUDE_PATTERNS = *_common_f24.h
+EXCLUDE = ../../include/libopencm3/stm32/common/gpio_common_f24.h
-LAYOUT_FILE = DoxygenLayout_stm32l1.xml
+EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c
-TAGFILES = ../cm3/cm3.tag=../../cm3/html \
+EXCLUDE_PATTERNS =
+
+LAYOUT_FILE = DoxygenLayout_stm32l1.xml
+
+TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = stm32l1.tag
diff --git a/doc/stm32l1/Doxyfile_latex b/doc/stm32l1/Doxyfile_latex
index 80b5600..51d217f 100644
--- a/doc/stm32l1/Doxyfile_latex
+++ b/doc/stm32l1/Doxyfile_latex
@@ -18,13 +18,17 @@ WARN_LOGFILE = doxygen_stm32l1_latex.log
INPUT = ../../include/libopencm3/docmain.dox \
../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/l1 \
- ../../include/libopencm3/stm32/common \
- ../../lib/stm32/l1 \
- ../../lib/stm32/common
+ ../../include/libopencm3/stm32/common
-EXCLUDE = ../../include/libopencm3/stm32/l1/doc-stm32l1.h
+INPUT += ../../lib/stm32/l1 \
+ ../../lib/stm32/common
-EXCLUDE_PATTERNS = *_common_f24.h
+EXCLUDE = ../../include/libopencm3/stm32/l1/doc-stm32l1.h \
+ ../../include/libopencm3/stm32/common/gpio_common_f24.h
+
+EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c
+
+EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32l1.xml