doc: properly define ARM_ARCH_xxx

Requires a little stub file per target, so we can neatly define the architecture. This properly includes all the cortex m core documentation finally.
5 years ago · 9e42251d6f
37 changed files with 46 additions and 3 deletions
--- a/doc/Makefile
+++ b/doc/Makefile
@ -26,6 +26,7 @@ DoxygenLayout.xml: templates/DoxygenLayout_Root.xml

 define gen_DOC_TARGET
 DOC_TARGETS += doc_$(1)
+CLEAN_TARGETS += clean_$(1)

 $(1)/:
 	@mkdir -p $$@
@ -41,6 +42,10 @@ $(1)/DoxygenLayout_$(1).xml: templates/DoxygenLayout_Device.xml | $(1)/

 doc_$(1): $(1)/doxy.sourcelist $(1)/Doxyfile $(1)/DoxygenLayout_$(1).xml
 	@(cd $(1); doxygen)
+
+clean_$(1):
+	@$(RM) -rf $(1)/doxy.sourcelist $(1)/Doxyfile $(1)/DoxygenLayout_$1.xml $(1)/doxygen_$(1).log $(1)/html $(1)/$(1).tag
+
 endef

 $(foreach TARGET_SRC_DIR, $(TARGETS), $(eval $(call gen_DOC_TARGET,$(subst /,,$(TARGET_SRC_DIR)))))
@ -48,8 +53,8 @@ $(foreach TARGET_SRC_DIR, $(TARGETS), $(eval $(call gen_DOC_TARGET,$(subst /,,$(
 html: $(DOC_TARGETS) DoxygenLayout.xml
 	doxygen

-clean:
-	@rm -rf html/ $(TARGETS_DIRS) DoxygenLayout.xml doxygen.log 
+clean: $(CLEAN_TARGETS)
+	@rm -rf html/ DoxygenLayout.xml doxygen.log
 
-.PHONY: doc html $(DOC_TARGETS)
+.PHONY: doc html $(DOC_TARGETS) $(CLEAN_TARGETS)

--- a/doc/efm32ezr32wg/doxy.custom
+++ b/doc/efm32ezr32wg/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/efm32g/doxy.custom
+++ b/doc/efm32g/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/efm32gg/doxy.custom
+++ b/doc/efm32gg/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/efm32hg/doxy.custom
+++ b/doc/efm32hg/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_6M__
--- a/doc/efm32lg/doxy.custom
+++ b/doc/efm32lg/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/efm32tg/doxy.custom
+++ b/doc/efm32tg/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/efm32wg/doxy.custom
+++ b/doc/efm32wg/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/gd32f1x0/doxy.custom
+++ b/doc/gd32f1x0/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/lm3s/doxy.custom
+++ b/doc/lm3s/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/lm4f/doxy.custom
+++ b/doc/lm4f/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/lpc13xx/doxy.custom
+++ b/doc/lpc13xx/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/lpc17xx/doxy.custom
+++ b/doc/lpc17xx/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/lpc43xx/doxy.custom
+++ b/doc/lpc43xx/doxy.custom
@ -0,0 +1,3 @@
+# Empty file to satisfy doxygen include.
+# this directory is for shared code between m3 and m4 cores of lpc43xx
+# So needs no predefined arch macros
--- a/doc/lpc43xxm0/doxy.custom
+++ b/doc/lpc43xxm0/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_6M__
--- a/doc/lpc43xxm4/doxy.custom
+++ b/doc/lpc43xxm4/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/msp432e4/doxy.custom
+++ b/doc/msp432e4/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/sam3a/doxy.custom
+++ b/doc/sam3a/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/sam3n/doxy.custom
+++ b/doc/sam3n/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/sam3s/doxy.custom
+++ b/doc/sam3s/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/sam3u/doxy.custom
+++ b/doc/sam3u/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/sam3x/doxy.custom
+++ b/doc/sam3x/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/sam4l/doxy.custom
+++ b/doc/sam4l/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/samd/doxy.custom
+++ b/doc/samd/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_6M__
--- a/doc/stm32f0/doxy.custom
+++ b/doc/stm32f0/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_6M__
--- a/doc/stm32f1/doxy.custom
+++ b/doc/stm32f1/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/stm32f2/doxy.custom
+++ b/doc/stm32f2/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/stm32f3/doxy.custom
+++ b/doc/stm32f3/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/stm32f4/doxy.custom
+++ b/doc/stm32f4/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/stm32f7/doxy.custom
+++ b/doc/stm32f7/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/stm32g0/doxy.custom
+++ b/doc/stm32g0/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_6M__
--- a/doc/stm32l0/doxy.custom
+++ b/doc/stm32l0/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_6M__
--- a/doc/stm32l1/doxy.custom
+++ b/doc/stm32l1/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7M__
--- a/doc/stm32l4/doxy.custom
+++ b/doc/stm32l4/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__
--- a/doc/swm050/doxy.custom
+++ b/doc/swm050/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_6M__
--- a/doc/templates/Doxyfile_Device
+++ b/doc/templates/Doxyfile_Device
@ -1,6 +1,7 @@
@INCLUDE				= ../Doxyfile_common
 INPUT					= ../../include/libopencm3/license.dox
@INCLUDE				= doxy.sourcelist
+@INCLUDE	= doxy.custom
 WARN_LOGFILE			= doxygen_#device#.log
 LAYOUT_FILE				= DoxygenLayout_#device#.xml
 GENERATE_TAGFILE		= #device#.tag
--- a/doc/vf6xx/doxy.custom
+++ b/doc/vf6xx/doxy.custom
@ -0,0 +1 @@
+PREDEFINED += __ARM_ARCH_7EM__