diff --git a/Makefile b/Makefile index c69b4a2b..3132684b 100644 --- a/Makefile +++ b/Makefile @@ -86,7 +86,8 @@ install: lib @printf " INSTALL scripts\n" $(Q)$(INSTALL) -m 0644 scripts/*.scr $(SHAREDIR) -doc: + +html doc: $(Q)$(MAKE) -C doc html clean: $(IRQ_DEFN_FILES:=.cleanhdr) $(LIB_DIRS:=.clean) $(EXAMPLE_DIRS:=.clean) doc.clean styleclean diff --git a/doc/Doxyfile b/doc/Doxyfile index f5380da0..f9c0a5a0 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -19,14 +19,3 @@ LAYOUT_FILE = DoxygenLayout.xml GENERATE_LATEX = NO -TAGFILES = ./cm3/cm3.tag=../cm3/html \ - ./stm32/stm32.tag=../stm32/html \ - ./stm32f1/stm32f1.tag=../stm32f1/html \ - ./stm32f4/stm32f4.tag=../stm32f4/html \ - ./lm3s/lm3s.tag=../lm3s/html \ - ./lm4f/lm4f.tag=../lm4f/html \ - ./lpc13xx/lpc13xx.tag=../lpc13xx/html \ - ./lpc17xx/lpc17xx.tag=../lpc17xx/html \ - ./lpc43xx/lpc43xx.tag=../lpc43xx/html - - diff --git a/doc/HACKING b/doc/HACKING index b4cb1751..d67684bb 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -11,18 +11,7 @@ structure is important and should be maintained. Each of the subdirectories has a configuration file, a layout file and subdirectories for the documentation. Doxygen is intended to be run inside these subdirectories. The Makefile will handle this in the appropriate -order. Tag files are generated and used by other doxygen runs to resolve links. - -Tagfiles --------- - -Tagfiles contain all information about the document, and are used to resolve -references in other documents. The groups defined in these external documents -are not shown when EXTERNAL_GROUPS = NO. The high level tagfiles must be -generated before any others so order is important. - -As well as the processor families, a "cm3" subdirectory is used to generate -a tagfile to integrate the CM3 common core defines. +order. Markup ------ @@ -50,6 +39,32 @@ date and version number must be omitted as it will be included from the family files. There must not be any reference to family groupings as these common files will be incorporated into multiple family groups. +The common files should not be included in an application explicitly. Also the +doxygen preprocessor must be enabled to ensure that all macros and defines are +included. This means that common header files need to have a section at the top +of the file of the type (eg for gpio_common_f24.h): + +/** @cond */ +#ifdef LIBOPENCM3_GPIO_H +/** @endcond */ + +and at the end of the file: + +/** @cond */ +#else +#warning "gpio_common_f24.h should not be included explicitly, only via gpio.h" +#endif +/** @endcond */ + +This will stop the compiler preprocessor from including the common header file +unless the device family header file has also been included. The doxygen +conditional clauses are needed to stop the doxygen preprocessor seeing this +statement and so excluding processing of the common file contents. + +/** @cond */ +#if defined(LIBOPENCM3_GPIO_H) || defined(LIBOPENCM3_GPIO_COMMON_F24_H) +/** @endcond */ + Each helper function must have a header with an @brief, and where appropriate additional description, @parameter and @return elements. These latter must describe the allowable parameter ranges preferably with reference to a suitable diff --git a/doc/cm3/DoxygenLayout_cm3.xml b/doc/cm3/DoxygenLayout_cm3.xml index b4e2c740..9311b149 100644 --- a/doc/cm3/DoxygenLayout_cm3.xml +++ b/doc/cm3/DoxygenLayout_cm3.xml @@ -4,6 +4,7 @@ + diff --git a/doc/efm32g/Doxyfile b/doc/efm32g/Doxyfile index c163b891..a3a65c76 100644 --- a/doc/efm32g/Doxyfile +++ b/doc/efm32g/Doxyfile @@ -23,10 +23,8 @@ EXCLUDE = LAYOUT_FILE = DoxygenLayout_efm32g.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html \ - GENERATE_TAGFILE = efm32g.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/efm32gg/Doxyfile b/doc/efm32gg/Doxyfile index 8b063b90..1b939004 100644 --- a/doc/efm32gg/Doxyfile +++ b/doc/efm32gg/Doxyfile @@ -23,10 +23,8 @@ EXCLUDE = LAYOUT_FILE = DoxygenLayout_efm32gg.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html \ - GENERATE_TAGFILE = efm32gg.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/efm32lg/Doxyfile b/doc/efm32lg/Doxyfile index 30a594a6..2139da58 100644 --- a/doc/efm32lg/Doxyfile +++ b/doc/efm32lg/Doxyfile @@ -23,10 +23,8 @@ EXCLUDE = LAYOUT_FILE = DoxygenLayout_efm32lg.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html \ - GENERATE_TAGFILE = efm32lg.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/efm32tg/Doxyfile b/doc/efm32tg/Doxyfile index d104ff79..1610f21f 100644 --- a/doc/efm32tg/Doxyfile +++ b/doc/efm32tg/Doxyfile @@ -23,10 +23,8 @@ EXCLUDE = LAYOUT_FILE = DoxygenLayout_efm32tg.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html \ - GENERATE_TAGFILE = efm32tg.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/lm3s/Doxyfile b/doc/lm3s/Doxyfile index 56100e24..d7feff22 100644 --- a/doc/lm3s/Doxyfile +++ b/doc/lm3s/Doxyfile @@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \ LAYOUT_FILE = DoxygenLayout_lm3s.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = lm3s.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/lm4f/Doxyfile b/doc/lm4f/Doxyfile index b0c1b6d5..284ac7ab 100644 --- a/doc/lm4f/Doxyfile +++ b/doc/lm4f/Doxyfile @@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \ LAYOUT_FILE = DoxygenLayout_lm4f.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = lm4f.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/lpc13xx/Doxyfile b/doc/lpc13xx/Doxyfile index d231b1a0..d8284fc5 100644 --- a/doc/lpc13xx/Doxyfile +++ b/doc/lpc13xx/Doxyfile @@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \ LAYOUT_FILE = DoxygenLayout_lpc13xx.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = lpc13xx.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/lpc17xx/Doxyfile b/doc/lpc17xx/Doxyfile index d9ee1f2d..0dba6631 100644 --- a/doc/lpc17xx/Doxyfile +++ b/doc/lpc17xx/Doxyfile @@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \ LAYOUT_FILE = DoxygenLayout_lpc17xx.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = lpc17xx.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/lpc43xx/Doxyfile b/doc/lpc43xx/Doxyfile index 582d8044..fc6a3114 100644 --- a/doc/lpc43xx/Doxyfile +++ b/doc/lpc43xx/Doxyfile @@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \ LAYOUT_FILE = DoxygenLayout_lpc43xx.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = lpc43xx.tag -ENABLE_PREPROCESSING = NO +ENABLE_PREPROCESSING = YES diff --git a/doc/stm32f0/Doxyfile b/doc/stm32f0/Doxyfile index f890ec44..725499db 100644 --- a/doc/stm32f0/Doxyfile +++ b/doc/stm32f0/Doxyfile @@ -13,26 +13,26 @@ # Local settings #--------------------------------------------------------------------------- -WARN_LOGFILE = doxygen_stm32f0.log +WARN_LOGFILE = doxygen_stm32f0.log -INPUT = ../../include/libopencm3/license.dox \ +INPUT = ../../include/libopencm3/license.dox \ ../../include/libopencm3/stm32/f0 \ ../../include/libopencm3/stm32/common -INPUT += ../../lib/stm32/f0 \ +INPUT += ../../lib/stm32/f0 \ ../../lib/stm32/common -EXCLUDE = ../../include/libopencm3/stm32/f0/usb.h \ +EXCLUDE = ../../include/libopencm3/stm32/f0/usb.h \ ../../include/libopencm3/stm32/f0/usb_desc.h -EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c +EXCLUDE_PATTERNS = *_common_*f24.h *_common_*f24.c \ + *_common_*f234.h *_common_*f234.c \ + *_common_*f124.h *_common_*f124.c -LAYOUT_FILE = DoxygenLayout_stm32f0.xml +LAYOUT_FILE = DoxygenLayout_stm32f0.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html +GENERATE_TAGFILE = stm32f0.tag -GENERATE_TAGFILE = stm32f0.tag - -ENABLE_PREPROCESSING = YES +ENABLE_PREPROCESSING = YES diff --git a/doc/stm32f1/Doxyfile b/doc/stm32f1/Doxyfile index f3e27d4d..6a816afc 100644 --- a/doc/stm32f1/Doxyfile +++ b/doc/stm32f1/Doxyfile @@ -25,12 +25,13 @@ INPUT += ../../lib/stm32/f1 \ EXCLUDE = ../../include/libopencm3/stm32/f1/usb.h \ ../../include/libopencm3/stm32/f1/usb_desc.h -EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c +EXCLUDE_PATTERNS = *_common_*f24.h *_common_*f24.c \ + *_common_*f234.h *_common_*f234.c \ + *_common_*f024.h *_common_*f024.c \ + *_common_*f03.h *_common_*f03.c LAYOUT_FILE = DoxygenLayout_stm32f1.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = stm32f1.tag ENABLE_PREPROCESSING = YES diff --git a/doc/stm32f2/Doxyfile b/doc/stm32f2/Doxyfile index 085972ca..ed08e1e7 100644 --- a/doc/stm32f2/Doxyfile +++ b/doc/stm32f2/Doxyfile @@ -22,14 +22,14 @@ INPUT = ../../include/libopencm3/license.dox \ INPUT += ../../lib/stm32/f2 \ ../../lib/stm32/common -EXCLUDE = +EXCLUDE = -EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c +EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c \ + *_common_*f013.h *_common_*f013.c \ + *_common_*f03.h *_common_*f03.c LAYOUT_FILE = DoxygenLayout_stm32f2.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = stm32f2.tag ENABLE_PREPROCESSING = YES diff --git a/doc/stm32f3/Doxyfile b/doc/stm32f3/Doxyfile index 4db5b2cd..afecf1be 100644 --- a/doc/stm32f3/Doxyfile +++ b/doc/stm32f3/Doxyfile @@ -22,15 +22,11 @@ INPUT += ../../lib/stm32/f3 \ EXCLUDE = ../../include/libopencm3/stm32/f3/usb.h \ ../../include/libopencm3/stm32/f3/usb_desc.h -EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c -EXCLUDE_PATTERNS += *_common_f124.h *_common_f124.c -EXCLUDE_PATTERNS += *_common_l1f24.h *_common_l1f24.c -EXCLUDE_PATTERNS += *_common_bcd.h *_common_bcd.c +EXCLUDE_PATTERNS = *_common_*f*24.h *_common_*f*24.c \ + *_common_bcd.h *_common_bcd.c LAYOUT_FILE = DoxygenLayout_stm32f3.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = stm32f3.tag ENABLE_PREPROCESSING = YES diff --git a/doc/stm32f4/Doxyfile b/doc/stm32f4/Doxyfile index 7ec24d6a..38617a19 100644 --- a/doc/stm32f4/Doxyfile +++ b/doc/stm32f4/Doxyfile @@ -22,14 +22,14 @@ INPUT = ../../include/libopencm3/license.dox \ INPUT += ../../lib/stm32/f4 \ ../../lib/stm32/common -EXCLUDE = +EXCLUDE = -EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c +EXCLUDE_PATTERNS = *_common_f*3.h *_common_f*3.c \ + *_common_*f013.h *_common_*f013.c \ + *_common_*f03.h *_common_*f03.c LAYOUT_FILE = DoxygenLayout_stm32f4.xml -TAGFILES = ../cm3/cm3.tag=../../cm3/html - GENERATE_TAGFILE = stm32f4.tag ENABLE_PREPROCESSING = YES diff --git a/doc/stm32l1/Doxyfile b/doc/stm32l1/Doxyfile index c6c65674..34908e85 100644 --- a/doc/stm32l1/Doxyfile +++ b/doc/stm32l1/Doxyfile @@ -7,7 +7,7 @@ # Common Include File #--------------------------------------------------------------------------- -@INCLUDE = ../Doxyfile_common +@INCLUDE = ../Doxyfile_common #--------------------------------------------------------------------------- # Local settings @@ -16,26 +16,28 @@ WARN_LOGFILE = doxygen_stm32l1.log INPUT = ../../include/libopencm3/license.dox \ - ../../include/libopencm3/stm32/l1 \ - ../../include/libopencm3/stm32/common + ../../include/libopencm3/stm32/l1 \ + ../../include/libopencm3/stm32/common INPUT += ../../lib/stm32/l1 \ - ../../lib/stm32/common + ../../lib/stm32/common EXCLUDE = ../../include/libopencm3/stm32/common/gpio_common_f24.h \ - ../../include/libopencm3/stm32/common/timer_common_f24.h + ../../include/libopencm3/stm32/common/timer_common_f24.h \ + ../../include/libopencm3/stm32/common/crypto_common_f24.h \ + ../../include/libopencm3/stm32/common/hash_common_f24.h EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c \ - ../../lib/stm32/common/timer_common_f24.c + ../../lib/stm32/common/timer_common_f24.c \ + ../../lib/stm32/common/crypto_common_f24.c \ + ../../lib/stm32/common/hash_common_f24.c EXCLUDE_PATTERNS = -LAYOUT_FILE = DoxygenLayout_stm32l1.xml - -TAGFILES = ../cm3/cm3.tag=../../cm3/html +LAYOUT_FILE = DoxygenLayout_stm32l1.xml GENERATE_TAGFILE = stm32l1.tag -ENABLE_PREPROCESSING = YES +ENABLE_PREPROCESSING = YES diff --git a/doc/usb/Doxyfile b/doc/usb/Doxyfile index ff48cb33..fcd2745d 100644 --- a/doc/usb/Doxyfile +++ b/doc/usb/Doxyfile @@ -24,8 +24,6 @@ EXCLUDE_PATTERNS = LAYOUT_FILE = DoxygenLayout_usb.xml -TAGFILES = - GENERATE_TAGFILE = usb.tag ENABLE_PREPROCESSING = NO diff --git a/include/libopencm3/stm32/common/exti_common_all.h b/include/libopencm3/stm32/common/exti_common_all.h index 339ebf52..33be9fdf 100644 --- a/include/libopencm3/stm32/common/exti_common_all.h +++ b/include/libopencm3/stm32/common/exti_common_all.h @@ -1,3 +1,8 @@ +/** @addtogroup exti_defines + * + * @author @htmlonly © @endhtmlonly 2010 + * Mark Butler + */ /* * This file is part of the libopencm3 project. * @@ -22,6 +27,7 @@ /** @endcond */ #ifndef LIBOPENCM3_EXTI_COMMON_ALL_H #define LIBOPENCM3_EXTI_COMMON_ALL_H +/**@{*/ #include #include @@ -74,6 +80,7 @@ void exti_select_source(uint32_t exti, uint32_t gpioport); uint32_t exti_get_flag_status(uint32_t exti); END_DECLS +/**@}*/ #endif /** @cond */ diff --git a/include/libopencm3/stm32/common/exti_common_l1f24.h b/include/libopencm3/stm32/common/exti_common_l1f24.h index b7161159..d01848a5 100644 --- a/include/libopencm3/stm32/common/exti_common_l1f24.h +++ b/include/libopencm3/stm32/common/exti_common_l1f24.h @@ -1,3 +1,8 @@ +/** @addtogroup exti_defines + * + * @author @htmlonly © @endhtmlonly 2010 + * Mark Butler + */ /* * This file is part of the libopencm3 project. * @@ -22,6 +27,7 @@ /** @endcond */ #ifndef LIBOPENCM3_EXTI_COMMON_F24_H #define LIBOPENCM3_EXTI_COMMON_F24_H +/**@{*/ #include #include @@ -31,6 +37,7 @@ #define EXTI20 (1 << 20) #define EXTI21 (1 << 21) #define EXTI22 (1 << 22) +/**@}*/ #endif /** @cond */ diff --git a/include/libopencm3/stm32/common/gpio_common_all.h b/include/libopencm3/stm32/common/gpio_common_all.h index b4c1a0e6..99145e94 100644 --- a/include/libopencm3/stm32/common/gpio_common_all.h +++ b/include/libopencm3/stm32/common/gpio_common_all.h @@ -1,12 +1,11 @@ /** @addtogroup gpio_defines - -@author @htmlonly © @endhtmlonly 2011 -Fergus Noble -@author @htmlonly © @endhtmlonly 2012 -Ken Sarkies - -*/ - + * + * @author @htmlonly © @endhtmlonly 2011 + * Fergus Noble + * @author @htmlonly © @endhtmlonly 2012 + * Ken Sarkies + * + */ /* * This file is part of the libopencm3 project. * @@ -32,7 +31,7 @@ The order of header inclusion is important. gpio.h includes the device specific memorymap.h header before including this header file.*/ /** @cond */ -#if defined(LIBOPENCM3_GPIO_H) || defined(LIBOPENCM3_GPIO_COMMON_F24_H) +#if defined(LIBOPENCM3_GPIO_H) /** @endcond */ #ifndef LIBOPENCM3_GPIO_COMMON_ALL_H #define LIBOPENCM3_GPIO_COMMON_ALL_H diff --git a/include/libopencm3/stm32/common/gpio_common_f234.h b/include/libopencm3/stm32/common/gpio_common_f234.h index 0b4191db..e574a1b9 100644 --- a/include/libopencm3/stm32/common/gpio_common_f234.h +++ b/include/libopencm3/stm32/common/gpio_common_f234.h @@ -1,11 +1,11 @@ /** @addtogroup gpio_defines - -@author @htmlonly © @endhtmlonly 2011 -Fergus Noble -@author @htmlonly © @endhtmlonly 2012 -Ken Sarkies - -*/ + * + * @author @htmlonly © @endhtmlonly 2011 + * Fergus Noble + * @author @htmlonly © @endhtmlonly 2012 + * Ken Sarkies + * + */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/common/gpio_common_f24.h b/include/libopencm3/stm32/common/gpio_common_f24.h index 2b37b97f..21b6b8ae 100644 --- a/include/libopencm3/stm32/common/gpio_common_f24.h +++ b/include/libopencm3/stm32/common/gpio_common_f24.h @@ -1,11 +1,11 @@ /** @addtogroup gpio_defines - -@author @htmlonly © @endhtmlonly 2011 -Fergus Noble -@author @htmlonly © @endhtmlonly 2012 -Ken Sarkies - -*/ + * + * @author @htmlonly © @endhtmlonly 2011 + * Fergus Noble + * @author @htmlonly © @endhtmlonly 2012 + * Ken Sarkies + * + */ /* * This file is part of the libopencm3 project. * @@ -103,6 +103,7 @@ specific memorymap.h header before including this header file.*/ #define GPIOH_AFRH GPIO_AFRH(GPIOH) #define GPIOI_AFRH GPIO_AFRH(GPIOI) +/**@}*/ #endif /** @cond */ #else diff --git a/include/libopencm3/stm32/common/hash_common_f24.h b/include/libopencm3/stm32/common/hash_common_f24.h index 2c83f55a..f7ea91f6 100644 --- a/include/libopencm3/stm32/common/hash_common_f24.h +++ b/include/libopencm3/stm32/common/hash_common_f24.h @@ -1,10 +1,9 @@ /** @addtogroup hash_defines - -@author @htmlonly © @endhtmlonly 2013 -Mikhail Avkhimenia - -*/ - + * + * @author @htmlonly © @endhtmlonly 2013 + * Mikhail Avkhimenia + * + */ /* * This file is part of the libopencm3 project. * @@ -26,7 +25,9 @@ Mikhail Avkhimenia /**@{*/ +/** @cond */ #ifdef LIBOPENCM3_HASH_H +/** @endcond */ #ifndef LIBOPENCM3_HASH_COMMON_F24_H #define LIBOPENCM3_HASH_COMMON_F24_H @@ -174,6 +175,9 @@ void hash_get_result(uint32_t *data); END_DECLS /**@}*/ #endif +/** @cond */ #else #warning "hash_common_f24.h should not be included explicitly, only via hash.h" #endif +/** @endcond */ + diff --git a/include/libopencm3/stm32/common/i2c_common_all.h b/include/libopencm3/stm32/common/i2c_common_all.h index a9edab88..81f81b8c 100644 --- a/include/libopencm3/stm32/common/i2c_common_all.h +++ b/include/libopencm3/stm32/common/i2c_common_all.h @@ -1,9 +1,8 @@ /** @addtogroup i2c_defines - -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - -*/ - + * + * @author @htmlonly © @endhtmlonly 2010 Thomas Otto + * + */ /* * This file is part of the libopencm3 project. * @@ -28,7 +27,7 @@ The order of header inclusion is important. i2c.h includes the device specific memorymap.h header before including this header file.*/ /** @cond */ -#if defined(LIBOPENCM3_I2C_H) || defined(LIBOPENCM3_I2C_COMMON_F24_H) +#if defined(LIBOPENCM3_I2C_H) /** @endcond */ #ifndef LIBOPENCM3_I2C_COMMON_ALL_H #define LIBOPENCM3_I2C_COMMON_ALL_H diff --git a/include/libopencm3/stm32/common/rcc_common_all.h b/include/libopencm3/stm32/common/rcc_common_all.h index 7892683d..b6cb08e1 100644 --- a/include/libopencm3/stm32/common/rcc_common_all.h +++ b/include/libopencm3/stm32/common/rcc_common_all.h @@ -1,4 +1,8 @@ - +/** @addtogroup rcc_defines + * + * @author @htmlonly © @endhtmlonly 2013 + * Frantisek Burian + */ /* * This file is part of the libopencm3 project. * @@ -29,6 +33,7 @@ #ifndef LIBOPENCM3_RCC_COMMON_ALL_H #define LIBOPENCM3_RCC_COMMON_ALL_H +/**@{*/ BEGIN_DECLS @@ -44,6 +49,12 @@ void rcc_periph_reset_hold(enum rcc_periph_rst rst); void rcc_periph_reset_release(enum rcc_periph_rst rst); END_DECLS +/**@}*/ #endif +/** @cond */ +#else +#warning "rcc_common_all.h should not be included explicitly, only via rcc.h" #endif +/** @endcond */ + diff --git a/include/libopencm3/stm32/common/spi_common_all.h b/include/libopencm3/stm32/common/spi_common_all.h index 6fc25599..fbd1e9c4 100644 --- a/include/libopencm3/stm32/common/spi_common_all.h +++ b/include/libopencm3/stm32/common/spi_common_all.h @@ -1,9 +1,8 @@ /** @addtogroup spi_defines - -@author @htmlonly © @endhtmlonly 2009 Uwe Hermann - -*/ - + * + * @author @htmlonly © @endhtmlonly 2009 Uwe Hermann + * + */ /* * This file is part of the libopencm3 project. * @@ -28,7 +27,7 @@ The order of header inclusion is important. spi.h includes the device specific memorymap.h header before including this header file.*/ /** @cond */ -#if defined(LIBOPENCM3_SPI_H) || defined(LIBOPENCM3_SPI_COMMON_F24_H) +#if defined(LIBOPENCM3_SPI_H) /** @endcond */ #ifndef LIBOPENCM3_SPI_COMMON_ALL_H #define LIBOPENCM3_SPI_COMMON_ALL_H diff --git a/include/libopencm3/stm32/common/syscfg_common_l1f234.h b/include/libopencm3/stm32/common/syscfg_common_l1f234.h index e96dc399..80393306 100644 --- a/include/libopencm3/stm32/common/syscfg_common_l1f234.h +++ b/include/libopencm3/stm32/common/syscfg_common_l1f234.h @@ -1,3 +1,9 @@ +/** @addtogroup syscfg_defines + * + * @author @htmlonly © @endhtmlonly 2011 + * Fergus Noble + * + */ /* * This file is part of the libopencm3 project. * @@ -27,7 +33,7 @@ specific memorymap.h header before including this header file.*/ #ifndef LIBOPENCM3_SYSCFG_COMMON_L1F234_H #define LIBOPENCM3_SYSCFG_COMMON_L1F234_H - +/**@{*/ #include @@ -47,6 +53,7 @@ specific memorymap.h header before including this header file.*/ #define SYSCFG_CMPCR MMIO32(SYSCFG_BASE + 0x20) #endif +/**@}*/ /** @cond */ #else diff --git a/include/libopencm3/stm32/common/timer_common_all.h b/include/libopencm3/stm32/common/timer_common_all.h index 29cf10c2..7eea4ae8 100644 --- a/include/libopencm3/stm32/common/timer_common_all.h +++ b/include/libopencm3/stm32/common/timer_common_all.h @@ -1,9 +1,8 @@ /** @addtogroup timer_defines - -@author @htmlonly © @endhtmlonly 2009 Piotr Esden-Tempski - -*/ - + * + * @author @htmlonly © @endhtmlonly 2009 Piotr Esden-Tempski + * + */ /* * This file is part of the libopencm3 project. * @@ -30,7 +29,7 @@ The order of header inclusion is important. timer.h includes the device specific memorymap.h header before including this header file.*/ /** @cond */ -#if defined(LIBOPENCM3_TIMER_H) || defined(LIBOPENCM3_TIMER_COMMON_F24_H) +#if defined(LIBOPENCM3_TIMER_H) /** @endcond */ #ifndef LIBOPENCM3_TIMER_COMMON_H #define LIBOPENCM3_TIMER_COMMON_H diff --git a/include/libopencm3/stm32/common/usart_common_all.h b/include/libopencm3/stm32/common/usart_common_all.h index bf583e19..adab105f 100644 --- a/include/libopencm3/stm32/common/usart_common_all.h +++ b/include/libopencm3/stm32/common/usart_common_all.h @@ -1,9 +1,8 @@ /** @addtogroup usart_defines - -@author @htmlonly © @endhtmlonly 2009 Uwe Hermann - -*/ - + * + * @author @htmlonly © @endhtmlonly 2009 Uwe Hermann + * + */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f0/cec.h b/include/libopencm3/stm32/f0/cec.h index 7a483c44..687e1dd5 100644 --- a/include/libopencm3/stm32/f0/cec.h +++ b/include/libopencm3/stm32/f0/cec.h @@ -31,6 +31,7 @@ #ifndef LIBOPENCM3_CEC_H #define LIBOPENCM3_CEC_H +/**@{*/ #include #include @@ -122,5 +123,6 @@ BEGIN_DECLS END_DECLS +/**@}*/ #endif diff --git a/include/libopencm3/stm32/f0/comparator.h b/include/libopencm3/stm32/f0/comparator.h index 60be4841..14111710 100644 --- a/include/libopencm3/stm32/f0/comparator.h +++ b/include/libopencm3/stm32/f0/comparator.h @@ -32,6 +32,7 @@ #ifndef LIBOPENCM3_COMP_H #define LIBOPENCM3_COMP_H +/**@{*/ #include #include @@ -121,5 +122,6 @@ void comp_select_hyst(uint8_t id, uint32_t hyst); void comp_select_speed(uint8_t id, uint32_t speed); END_DECLS +/**@}*/ #endif diff --git a/include/libopencm3/stm32/f0/crc.h b/include/libopencm3/stm32/f0/crc.h index b7b611b3..4c1ee9bb 100644 --- a/include/libopencm3/stm32/f0/crc.h +++ b/include/libopencm3/stm32/f0/crc.h @@ -32,6 +32,7 @@ #ifndef LIBOPENCM3_CRC_H #define LIBOPENCM3_CRC_H +/**@{*/ #include #include @@ -67,5 +68,6 @@ BEGIN_DECLS END_DECLS +/**@}*/ #endif diff --git a/include/libopencm3/stm32/f0/exti.h b/include/libopencm3/stm32/f0/exti.h index da58a013..436c0f71 100644 --- a/include/libopencm3/stm32/f0/exti.h +++ b/include/libopencm3/stm32/f0/exti.h @@ -32,8 +32,10 @@ #ifndef LIBOPENCM3_EXTI_H #define LIBOPENCM3_EXTI_H +/**@{*/ #include #include +/**@}*/ #endif diff --git a/include/libopencm3/stm32/f0/rcc.h b/include/libopencm3/stm32/f0/rcc.h index 21e95815..24fc2c06 100644 --- a/include/libopencm3/stm32/f0/rcc.h +++ b/include/libopencm3/stm32/f0/rcc.h @@ -1,9 +1,13 @@ /** @defgroup rcc_defines RCC Defines * - * @brief libopencm3 STM32F0xx Reset and Clock Control + * @brief Defined Constants and Types for the STM32F0xx Reset and Clock +Control * * @ingroup STM32F0xx_defines * + * @author @htmlonly © @endhtmlonly 2013 + * Frantisek Burian + * * @version 1.0.0 * * @date 29 Jun 2013 diff --git a/include/libopencm3/stm32/f0/syscfg.h b/include/libopencm3/stm32/f0/syscfg.h index 54d6f1ac..ba6ff6f5 100644 --- a/include/libopencm3/stm32/f0/syscfg.h +++ b/include/libopencm3/stm32/f0/syscfg.h @@ -6,7 +6,10 @@ * * @version 1.0.0 * - * @date 11 July 2013 + * @author @htmlonly © @endhtmlonly 2013 + * Frantisek Burian + * + * @date 13 January 2014 * * LGPL License Terms @ref lgpl_license */ @@ -31,6 +34,7 @@ #ifndef LIBOPENCM3_SYSCFG_H #define LIBOPENCM3_SYSCFG_H +/**@{*/ #include #include @@ -104,5 +108,6 @@ BEGIN_DECLS END_DECLS +/**@}*/ #endif diff --git a/include/libopencm3/stm32/f0/tsc.h b/include/libopencm3/stm32/f0/tsc.h index 5127a27b..189cb81f 100644 --- a/include/libopencm3/stm32/f0/tsc.h +++ b/include/libopencm3/stm32/f0/tsc.h @@ -31,6 +31,7 @@ #ifndef LIBOPENCM3_TSC_H #define LIBOPENCM3_TSC_H +/**@{*/ #include #include @@ -156,5 +157,6 @@ BEGIN_DECLS END_DECLS +/**@}*/ #endif diff --git a/include/libopencm3/stm32/f1/exti.h b/include/libopencm3/stm32/f1/exti.h index 5d730eed..8f1ec090 100644 --- a/include/libopencm3/stm32/f1/exti.h +++ b/include/libopencm3/stm32/f1/exti.h @@ -1,3 +1,19 @@ +/** @defgroup exti_defines EXTI Defines + * + * @brief Defined Constants and Types for the STM32F1xx External Interrupts + * + * + * @ingroup STM32F1xx_defines + * + * @author @htmlonly © @endhtmlonly 2013 + * Piotr Esden-Tempski + * + * @version 1.0.0 + * + * @date 14 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f1/rcc.h b/include/libopencm3/stm32/f1/rcc.h index da4f959a..940f2193 100644 --- a/include/libopencm3/stm32/f1/rcc.h +++ b/include/libopencm3/stm32/f1/rcc.h @@ -1,20 +1,21 @@ -/** @defgroup STM32F1xx_rcc_defines RCC Defines - -@brief libopencm3 STM32F1xx Reset and Clock Control - -@ingroup STM32F1xx_defines - -@version 1.0.0 - -@author @htmlonly © @endhtmlonly 2009 -Federico Ruiz-Ugalde \ -@author @htmlonly © @endhtmlonly 2009 -Uwe Hermann - -@date 18 August 2012 - -LGPL License Terms @ref lgpl_license - */ +/** @defgroup rcc_defines RCC Defines + * + * @brief Defined Constants and Types for the STM32F1xx Reset and Clock + * Control + * + * @ingroup STM32F1xx_defines + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2009 + * Federico Ruiz-Ugalde \ + * @author @htmlonly © @endhtmlonly 2009 + * Uwe Hermann + * + * @date 18 August 2012 + * + * LGPL License Terms @ref lgpl_license + * */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f1/rtc.h b/include/libopencm3/stm32/f1/rtc.h index 85fc3907..713d5817 100644 --- a/include/libopencm3/stm32/f1/rtc.h +++ b/include/libopencm3/stm32/f1/rtc.h @@ -1,17 +1,17 @@ /** @defgroup rtc_defines RTC Defines - -@brief Defined Constants and Types for the STM32F1xx Real Time Clock - -@ingroup STM32F1xx_defines - -@author @htmlonly © @endhtmlonly 2010 Uwe Hermann - -@version 1.0.0 - -@date 4 March 2013 - -LGPL License Terms @ref lgpl_license - */ + * + * @brief Defined Constants and Types for the STM32F1xx Real Time Clock + * + * @ingroup STM32F1xx_defines + * + * @author @htmlonly © @endhtmlonly 2010 Uwe Hermann + * + * @version 1.0.0 + * + * @date 4 March 2013 + * + * LGPL License Terms @ref lgpl_license + * */ /* * This file is part of the libopencm3 project. * @@ -38,6 +38,7 @@ LGPL License Terms @ref lgpl_license #ifndef LIBOPENCM3_RTC_H #define LIBOPENCM3_RTC_H +/**@{*/ #include #include @@ -166,5 +167,6 @@ void rtc_awake_from_standby(void); void rtc_auto_awake(enum rcc_osc clock_source, uint32_t prescale_val); END_DECLS +/**@}*/ #endif diff --git a/include/libopencm3/stm32/f2/exti.h b/include/libopencm3/stm32/f2/exti.h index 538e3cc1..f2b2f3fb 100644 --- a/include/libopencm3/stm32/f2/exti.h +++ b/include/libopencm3/stm32/f2/exti.h @@ -1,3 +1,19 @@ +/** @defgroup exti_defines EXTI Defines + * + * @brief Defined Constants and Types for the STM32F2xx External Interrupts + * + * + * @ingroup STM32F2xx_defines + * + * @author @htmlonly © @endhtmlonly 2013 + * Piotr Esden-Tempski + * + * @version 1.0.0 + * + * @date 14 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f2/rcc.h b/include/libopencm3/stm32/f2/rcc.h index e1f45462..79e37301 100644 --- a/include/libopencm3/stm32/f2/rcc.h +++ b/include/libopencm3/stm32/f2/rcc.h @@ -1,3 +1,23 @@ +/** @defgroup rcc_defines RCC Defines + * + * @brief Defined Constants and Types for the STM32F2xx Reset and Clock + * Control + * + * @ingroup STM32F2xx_defines + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2009 + * Federico Ruiz-Ugalde \ + * @author @htmlonly © @endhtmlonly 2009 + * Uwe Hermann + * @author @htmlonly © @endhtmlonly 2011 + * Fergus Noble + * + * @date 18 August 2012 + * + * LGPL License Terms @ref lgpl_license + * */ /* * This file is part of the libopencm3 project. * @@ -18,6 +38,7 @@ * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ #ifndef LIBOPENCM3_RCC_H #define LIBOPENCM3_RCC_H @@ -734,3 +755,5 @@ void rcc_backupdomain_reset(void); END_DECLS #endif +/**@}*/ + diff --git a/include/libopencm3/stm32/f2/syscfg.h b/include/libopencm3/stm32/f2/syscfg.h index aef85f3a..7216f7c3 100644 --- a/include/libopencm3/stm32/f2/syscfg.h +++ b/include/libopencm3/stm32/f2/syscfg.h @@ -1,3 +1,19 @@ +/** @defgroup syscfg_defines SYSCFG Defines + * + * @ingroup STM32F2xx_defines + * + * @brief Defined Constants and Types for the STM32F2xx Sysconfig + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2013 + * Frantisek Burian + * + * @date 13 January 2014 + * + * LGPL License Terms @ref lgpl_license + * */ + /* * This file is part of the libopencm3 project. * @@ -16,6 +32,7 @@ * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ #ifndef LIBOPENCM3_SYSCFG_H #define LIBOPENCM3_SYSCFG_H @@ -24,3 +41,5 @@ #include #endif +/**@}*/ + diff --git a/include/libopencm3/stm32/f3/exti.h b/include/libopencm3/stm32/f3/exti.h index f9148853..4cd5888e 100644 --- a/include/libopencm3/stm32/f3/exti.h +++ b/include/libopencm3/stm32/f3/exti.h @@ -5,9 +5,12 @@ * * @ingroup STM32F3xx_defines * + * @author @htmlonly © @endhtmlonly 2013 + * Piotr Esden-Tempski + * * @version 1.0.0 * - * @date 11 July 2013 + * @date 14 January 2014 * * LGPL License Terms @ref lgpl_license */ @@ -32,6 +35,7 @@ #ifndef LIBOPENCM3_EXTI_H #define LIBOPENCM3_EXTI_H +/**@{*/ #include #include @@ -43,5 +47,6 @@ #define EXTI_FTSR2 MMIO32(EXTI_BASE + 0x24) #define EXTI_SWIER2 MMIO32(EXTI_BASE + 0x28) #define EXTI_PR2 MMIO32(EXTI_BASE + 0x2C) +/**@}*/ #endif diff --git a/include/libopencm3/stm32/f3/pwr.h b/include/libopencm3/stm32/f3/pwr.h index 7694c25e..5b5b7d4c 100644 --- a/include/libopencm3/stm32/f3/pwr.h +++ b/include/libopencm3/stm32/f3/pwr.h @@ -4,6 +4,13 @@ * * @ingroup STM32F3xx_defines * + * @author @htmlonly © @endhtmlonly 2011 + * Stephen Caudle + * @author @htmlonly © @endhtmlonly 2013 + * Fernando Cortes + * @author @htmlonly © @endhtmlonly 2013 + * Guillermo Rivera + * * @version 1.0.0 * * @date 11 July 2013 diff --git a/include/libopencm3/stm32/f3/rcc.h b/include/libopencm3/stm32/f3/rcc.h index b3616fbc..9b2a4a67 100644 --- a/include/libopencm3/stm32/f3/rcc.h +++ b/include/libopencm3/stm32/f3/rcc.h @@ -1,10 +1,23 @@ /** @defgroup rcc_defines RCC Defines * * @brief Defined Constants and Types for the STM32F3xx Reset and Clock - * control + * Control * * @ingroup STM32F3xx_defines * + * @author @htmlonly © @endhtmlonly 2009 + * Federico Ruiz-Ugalde \ + * @author @htmlonly © @endhtmlonly 2009 + * Uwe Hermann + * @author @htmlonly © @endhtmlonly 2011 + * Fergus Noble + * @author @htmlonly © @endhtmlonly 2011 + * Stephen Caudle + * @author @htmlonly © @endhtmlonly 2013 + * Fernando Cortes + * @author @htmlonly © @endhtmlonly 2013 + * Guillermo Rivera + * * @version 1.0.0 * * @date 11 July 2013 diff --git a/include/libopencm3/stm32/f3/rtc.h b/include/libopencm3/stm32/f3/rtc.h new file mode 100644 index 00000000..3945b623 --- /dev/null +++ b/include/libopencm3/stm32/f3/rtc.h @@ -0,0 +1,43 @@ +/** @defgroup rtc_defines RTC Defines + * + * @brief Defined Constants and Types for the STM32F3xx Real Time Clock + * + * @ingroup STM32F3xx_defines + * + * @author @htmlonly © @endhtmlonly 2014 + * Ken Sarkies + * + * @version 1.0.0 + * + * @date 13 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ +/* + * This file is part of the libopencm3 project. + * + * Copyright (C) 2014 Ken Sarkies + * + * This library is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this library. If not, see . + */ + +#ifndef LIBOPENCM3_RTC_F3_H +#define LIBOPENCM3_RTC_F3_H +/**@{*/ + +#include +#include +/**@}*/ + +#endif diff --git a/include/libopencm3/stm32/f3/syscfg.h b/include/libopencm3/stm32/f3/syscfg.h index aef85f3a..d559206b 100644 --- a/include/libopencm3/stm32/f3/syscfg.h +++ b/include/libopencm3/stm32/f3/syscfg.h @@ -1,3 +1,19 @@ +/** @defgroup syscfg_defines SYSCFG Defines + * + * @ingroup STM32F3xx_defines + * + * @brief Defined Constants and Types for the STM32F3xx Sysconfig + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2013 + * Frantisek Burian + * + * @date 13 January 2014 + * + * LGPL License Terms @ref lgpl_license + * */ + /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f4/exti.h b/include/libopencm3/stm32/f4/exti.h index 538e3cc1..33e979c0 100644 --- a/include/libopencm3/stm32/f4/exti.h +++ b/include/libopencm3/stm32/f4/exti.h @@ -1,3 +1,19 @@ +/** @defgroup exti_defines EXTI Defines + * + * @brief Defined Constants and Types for the STM32F4xx External Interrupts + * + * + * @ingroup STM32F4xx_defines + * + * @author @htmlonly © @endhtmlonly 2013 + * Piotr Esden-Tempski + * + * @version 1.0.0 + * + * @date 14 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f4/rcc.h b/include/libopencm3/stm32/f4/rcc.h index 38d9f12f..861d9fed 100644 --- a/include/libopencm3/stm32/f4/rcc.h +++ b/include/libopencm3/stm32/f4/rcc.h @@ -1,3 +1,25 @@ +/** @defgroup rcc_defines RCC Defines + * + * @brief Defined Constants and Types for the STM32F4xx Reset and Clock + * Control + * + * @ingroup STM32F4xx_defines + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2009 + * Federico Ruiz-Ugalde \ + * @author @htmlonly © @endhtmlonly 2009 + * Uwe Hermann + * @author @htmlonly © @endhtmlonly 2011 + * Fergus Noble + * @author @htmlonly © @endhtmlonly 2011 + * Stephen Caudle + * + * @date 18 August 2012 + * + * LGPL License Terms @ref lgpl_license + * */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f4/syscfg.h b/include/libopencm3/stm32/f4/syscfg.h index aef85f3a..2f8cef29 100644 --- a/include/libopencm3/stm32/f4/syscfg.h +++ b/include/libopencm3/stm32/f4/syscfg.h @@ -1,3 +1,19 @@ +/** @defgroup syscfg_defines SYSCFG Defines + * + * @ingroup STM32F4xx_defines + * + * @brief Defined Constants and Types for the STM32F4xx Sysconfig + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2013 + * Frantisek Burian + * + * @date 13 January 2014 + * + * LGPL License Terms @ref lgpl_license + * */ + /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/l1/dma.h b/include/libopencm3/stm32/l1/dma.h index c66bc34b..342d7868 100644 --- a/include/libopencm3/stm32/l1/dma.h +++ b/include/libopencm3/stm32/l1/dma.h @@ -1,20 +1,20 @@ -/** @defgroup STM32L1xx_dma_defines DMA Defines - -@ingroup STM32L1xx_defines - -@brief Defined Constants and Types for the STM32L1xx DMA Controller - -@version 1.0.0 - -@author @htmlonly © @endhtmlonly 2011 -Fergus Noble -@author @htmlonly © @endhtmlonly 2012 -Ken Sarkies - -@date 18 October 2012 - -LGPL License Terms @ref lgpl_license - */ +/** @defgroup dma_defines DMA Defines + * + * @ingroup STM32L1xx_defines + * + * @brief Defined Constants and Types for the STM32L1xx DMA Controller + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2011 + * Fergus Noble + * @author @htmlonly © @endhtmlonly 2012 + * Ken Sarkies + * + * @date 18 October 2012 + * + * LGPL License Terms @ref lgpl_license + * */ /* * This file is part of the libopencm3 project. diff --git a/include/libopencm3/stm32/l1/exti.h b/include/libopencm3/stm32/l1/exti.h index 538e3cc1..21bdd4e3 100644 --- a/include/libopencm3/stm32/l1/exti.h +++ b/include/libopencm3/stm32/l1/exti.h @@ -1,3 +1,19 @@ +/** @defgroup exti_defines EXTI Defines + * + * @brief Defined Constants and Types for the STM32L1xx External Interrupts + * + * + * @ingroup STM32L1xx_defines + * + * @author @htmlonly © @endhtmlonly 2013 + * Piotr Esden-Tempski + * + * @version 1.0.0 + * + * @date 14 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/l1/rcc.h b/include/libopencm3/stm32/l1/rcc.h index 49017d43..ee794d5c 100644 --- a/include/libopencm3/stm32/l1/rcc.h +++ b/include/libopencm3/stm32/l1/rcc.h @@ -1,22 +1,23 @@ -/** @defgroup STM32L1xx_rcc_defines RCC Defines - -@ingroup STM32L1xx_defines - -@brief libopencm3 STM32L1xx Reset and Clock Control - -@version 1.0.0 - -@author @htmlonly © @endhtmlonly 2009 -Federico Ruiz-Ugalde \ -@author @htmlonly © @endhtmlonly 2009 -Uwe Hermann -@author @htmlonly © @endhtmlonly 2012 -Karl Palsson - -@date 11 November 2012 - -LGPL License Terms @ref lgpl_license - */ +/** @defgroup rcc_defines RCC Defines + * + * @ingroup STM32L1xx_defines + * + * @brief Defined Constants and Types for the STM32L1xx Reset and Clock + * Control + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2009 + * Federico Ruiz-Ugalde \ + * @author @htmlonly © @endhtmlonly 2009 + * Uwe Hermann + * @author @htmlonly © @endhtmlonly 2012 + * Karl Palsson + * + * @date 11 November 2012 + * + * LGPL License Terms @ref lgpl_license + * */ /* * This file is part of the libopencm3 project. diff --git a/include/libopencm3/stm32/l1/syscfg.h b/include/libopencm3/stm32/l1/syscfg.h index aef85f3a..c7e48ad1 100644 --- a/include/libopencm3/stm32/l1/syscfg.h +++ b/include/libopencm3/stm32/l1/syscfg.h @@ -1,3 +1,19 @@ +/** @defgroup syscfg_defines SYSCFG Defines + * + * @ingroup STM32L1xx_defines + * + * @brief Defined Constants and Types for the STM32L1xx Sysconfig + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2013 + * Frantisek Burian + * + * @date 13 January 2014 + * + * LGPL License Terms @ref lgpl_license + * */ + /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/common/exti_common_all.c b/lib/stm32/common/exti_common_all.c index 4e06a91a..f8f9be78 100644 --- a/lib/stm32/common/exti_common_all.c +++ b/lib/stm32/common/exti_common_all.c @@ -20,6 +20,8 @@ * This provides the code for the "next gen" EXTI block provided in F2/F4/L1 * devices. (differences only in the source selection) */ +/**@{*/ + #include #include @@ -149,3 +151,5 @@ void exti_select_source(uint32_t exti, uint32_t gpioport) #endif }; } +/**@}*/ + diff --git a/lib/stm32/common/flash_common_f234.c b/lib/stm32/common/flash_common_f234.c index 4c2546bb..6ad69f61 100644 --- a/lib/stm32/common/flash_common_f234.c +++ b/lib/stm32/common/flash_common_f234.c @@ -21,6 +21,7 @@ * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ /**@{*/ diff --git a/lib/stm32/common/flash_common_f24.c b/lib/stm32/common/flash_common_f24.c index 7577786d..1e9da9a1 100644 --- a/lib/stm32/common/flash_common_f24.c +++ b/lib/stm32/common/flash_common_f24.c @@ -21,6 +21,7 @@ * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ /**@{*/ diff --git a/lib/stm32/common/hash_common_f24.c b/lib/stm32/common/hash_common_f24.c index 3207fe78..24d489c1 100644 --- a/lib/stm32/common/hash_common_f24.c +++ b/lib/stm32/common/hash_common_f24.c @@ -1,13 +1,13 @@ /** @addtogroup hash_file - -@author @htmlonly © @endhtmlonly 2013 -Mikhail Avkhimenia - -This library supports the HASH processor in the STM32F2 and STM32F4 -series of ARM Cortex Microcontrollers by ST Microelectronics. - -LGPL License Terms @ref lgpl_license - */ + * + * @author @htmlonly © @endhtmlonly 2013 + * Mikhail Avkhimenia + * + * This library supports the HASH processor in the STM32F2 and STM32F4 + * series of ARM Cortex Microcontrollers by ST Microelectronics. + * + * LGPL License Terms @ref lgpl_license + * */ /* * This file is part of the libopencm3 project. @@ -159,3 +159,5 @@ void hash_get_result(uint32_t *data) data[4] = HASH_HR[4]; } } +/**@}*/ + diff --git a/lib/stm32/common/rcc_common_all.c b/lib/stm32/common/rcc_common_all.c index 797ee0f7..0e7f866f 100644 --- a/lib/stm32/common/rcc_common_all.c +++ b/lib/stm32/common/rcc_common_all.c @@ -17,6 +17,7 @@ * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ #include @@ -181,6 +182,7 @@ void rcc_periph_reset_release(enum rcc_periph_rst rst) { _RCC_REG(rst) &= ~_RCC_BIT(rst); } +/**@}*/ #undef _RCC_REG #undef _RCC_BIT diff --git a/lib/stm32/f0/comparator.c b/lib/stm32/f0/comparator.c index 17fcab8f..51bd0f2f 100644 --- a/lib/stm32/f0/comparator.c +++ b/lib/stm32/f0/comparator.c @@ -27,6 +27,7 @@ * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ #include @@ -59,3 +60,5 @@ void comp_select_speed(uint8_t id, uint32_t speed) { COMP_CSR(id) = (COMP_CSR(id) & ~COMP_CSR_SPEED) | speed; } +/**@}*/ + diff --git a/lib/stm32/f0/pwr.c b/lib/stm32/f0/pwr.c index 52d323eb..8a3ffd2e 100644 --- a/lib/stm32/f0/pwr.c +++ b/lib/stm32/f0/pwr.c @@ -1,4 +1,4 @@ -/** @defgroup pwr-file PWR +/** @defgroup pwr_file PWR * * @ingroup STM32F0xx * diff --git a/lib/stm32/f1/pwr.c b/lib/stm32/f1/pwr.c index 082612a8..167f920d 100644 --- a/lib/stm32/f1/pwr.c +++ b/lib/stm32/f1/pwr.c @@ -1,21 +1,21 @@ -/** @defgroup pwr-file PWR - -@ingroup STM32F1xx - -@brief libopencm3 STM32F1xx Power Control - -@version 1.0.0 - -@author @htmlonly © @endhtmlonly 2012 -Ken Sarkies - -@date 18 August 2012 - -This library supports the power control system for the -STM32F1 series of ARM Cortex Microcontrollers by ST Microelectronics. - -LGPL License Terms @ref lgpl_license -*/ +/** @defgroup pwr_file PWR + * + * @ingroup STM32F1xx + * + * @brief libopencm3 STM32F1xx Power Control + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2012 + * Ken Sarkies + * + * @date 18 August 2012 + * + * This library supports the power control system for the + * STM32F1 series of ARM Cortex Microcontrollers by ST Microelectronics. + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/f1/rtc.c b/lib/stm32/f1/rtc.c index 71b5006f..b2d7b83f 100644 --- a/lib/stm32/f1/rtc.c +++ b/lib/stm32/f1/rtc.c @@ -1,18 +1,18 @@ /** @defgroup rtc_file RTC - -@ingroup STM32F1xx - -@brief libopencm3 STM32F1xx RTC - -@author @htmlonly © @endhtmlonly 2010 Uwe Hermann -@author @htmlonly © @endhtmlonly 2010 Lord James - -@version 1.0.0 - -@date 4 March 2013 - -LGPL License Terms @ref lgpl_license -*/ + * + * @ingroup STM32F1xx + * + * @brief libopencm3 STM32F1xx RTC + * + * @author @htmlonly © @endhtmlonly 2010 Uwe Hermann + * @author @htmlonly © @endhtmlonly 2010 Lord James + * + * @version 1.0.0 + * + * @date 4 March 2013 + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. @@ -33,6 +33,8 @@ LGPL License Terms @ref lgpl_license * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ + #include #include @@ -299,3 +301,5 @@ void rtc_auto_awake(enum rcc_osc clock_source, uint32_t prescale_val) rtc_set_prescale_val(prescale_val); } } +/**@}*/ + diff --git a/lib/stm32/f2/crypto.c b/lib/stm32/f2/crypto.c new file mode 100644 index 00000000..bc8b83be --- /dev/null +++ b/lib/stm32/f2/crypto.c @@ -0,0 +1,33 @@ +/** @defgroup crypto_file CRYPTO + * + * @ingroup STM32F2xx + * + * @brief libopencm3 STM32F2xx Cryptographic controller + * + * @version 1.0.0 + * + * @date 14 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ + +/* + * This file is part of the libopencm3 project. + * + * This library is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this library. If not, see . + */ + +#include +#include + diff --git a/lib/stm32/f2/hash.c b/lib/stm32/f2/hash.c new file mode 100644 index 00000000..5454acbe --- /dev/null +++ b/lib/stm32/f2/hash.c @@ -0,0 +1,33 @@ +/** @defgroup hash_file HASH + * + * @ingroup STM32F2xx + * + * @brief libopencm3 STM32F2xx Hash Processor + * + * @version 1.0.0 + * + * @date 14 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ + +/* + * This file is part of the libopencm3 project. + * + * This library is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this library. If not, see . + */ + +#include +#include + diff --git a/lib/stm32/f2/i2c.c b/lib/stm32/f2/i2c.c index df0fcff1..ea0c99da 100644 --- a/lib/stm32/f2/i2c.c +++ b/lib/stm32/f2/i2c.c @@ -1,15 +1,15 @@ /** @defgroup i2c_file I2C - -@ingroup STM32F2xx - -@brief libopencm3 STM32F2xx I2C - -@version 1.0.0 - -@date 15 October 2012 - -LGPL License Terms @ref lgpl_license -*/ + * + * @ingroup STM32F2xx + * + * @brief libopencm3 STM32F2xx I2C + * + * @version 1.0.0 + * + * @date 15 October 2012 + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. @@ -29,5 +29,5 @@ LGPL License Terms @ref lgpl_license */ #include -#include +#include diff --git a/lib/stm32/f2/pwr.c b/lib/stm32/f2/pwr.c new file mode 100644 index 00000000..0e5641eb --- /dev/null +++ b/lib/stm32/f2/pwr.c @@ -0,0 +1,39 @@ +/** @defgroup pwr_file PWR + * + * @ingroup STM32F2xx + * + * @brief libopencm3 STM32F2xx Power Control + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2014 + * Ken Sarkies + * + * @date 13 January 2014 + * + * This library supports the power control system for the + * STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics. + * + * LGPL License Terms @ref lgpl_license + */ +/* + * This file is part of the libopencm3 project. + * + * Copyright (C) 2014 Ken Sarkies + * + * This library is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this library. If not, see . + */ + +#include + diff --git a/lib/stm32/f2/rcc.c b/lib/stm32/f2/rcc.c index 14b2f970..d150dfc6 100644 --- a/lib/stm32/f2/rcc.c +++ b/lib/stm32/f2/rcc.c @@ -4,7 +4,7 @@ * * @section rcc_f2_api_ex Reset and Clock Control API. * - * @brief libopencm3 STM32F4xx Reset and Clock Control + * @brief libopencm3 STM32F2xx Reset and Clock Control * * @author @htmlonly © @endhtmlonly 2013 Frantisek Burian * diff --git a/lib/stm32/f3/flash.c b/lib/stm32/f3/flash.c index 58687161..d157aca4 100644 --- a/lib/stm32/f3/flash.c +++ b/lib/stm32/f3/flash.c @@ -41,6 +41,7 @@ * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ /**@{*/ diff --git a/lib/stm32/f3/pwr.c b/lib/stm32/f3/pwr.c index f9a2aede..3c1a84bd 100644 --- a/lib/stm32/f3/pwr.c +++ b/lib/stm32/f3/pwr.c @@ -2,7 +2,12 @@ * * @ingroup STM32F3xx * - * @brief libopencm3 STM32F3xx Power control + * @brief libopencm3 STM32F3xx Power Control + * + * @author @htmlonly © @endhtmlonly 2014 + * Ken Sarkies + * + * @date 13 January 2014 * * @version 1.0.0 * @@ -14,6 +19,8 @@ /* * This file is part of the libopencm3 project. * + * Copyright (C) 2014 Ken Sarkies + * * This library is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or diff --git a/lib/stm32/f3/rcc.c b/lib/stm32/f3/rcc.c index 5bd3caae..ff2c2937 100644 --- a/lib/stm32/f3/rcc.c +++ b/lib/stm32/f3/rcc.c @@ -32,6 +32,7 @@ * You should have received a copy of the GNU Lesser General Public License * along with this library. If not, see . */ +/**@{*/ #include #include @@ -460,3 +461,5 @@ void rcc_usb_prescale_1(void) { RCC_CFGR |= RCC_CFGR_USBPRES; } +/**@}*/ + diff --git a/lib/stm32/f3/rtc.c b/lib/stm32/f3/rtc.c new file mode 100644 index 00000000..f332765a --- /dev/null +++ b/lib/stm32/f3/rtc.c @@ -0,0 +1,38 @@ +/** @defgroup rtc_file RTC + * + * @ingroup STM32F3xx + * + * @brief libopencm3 STM32F3xx Real Time Clock + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2014 + * Ken Sarkies + * + * @date 13 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ + +/* + * This file is part of the libopencm3 project. + * + * Copyright (C) 2014 Ken Sarkies + * + * This library is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this library. If not, see . + */ + +#include + + diff --git a/lib/stm32/f4/hash.c b/lib/stm32/f4/hash.c new file mode 100644 index 00000000..0c4b9fc9 --- /dev/null +++ b/lib/stm32/f4/hash.c @@ -0,0 +1,33 @@ +/** @defgroup hash_file HASH + * + * @ingroup STM32F4xx + * + * @brief libopencm3 STM32F4xx Hash Processor + * + * @version 1.0.0 + * + * @date 13 January 2014 + * + * LGPL License Terms @ref lgpl_license + */ + +/* + * This file is part of the libopencm3 project. + * + * This library is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this library. If not, see . + */ + +#include +#include + diff --git a/lib/stm32/f4/pwr.c b/lib/stm32/f4/pwr.c index 07acada0..9b9e579d 100644 --- a/lib/stm32/f4/pwr.c +++ b/lib/stm32/f4/pwr.c @@ -1,20 +1,20 @@ -/** @defgroup pwr-file PWR - -@ingroup STM32F4xx - -@brief libopencm3 STM32F4xx Power Control - -@version 1.0.0 - -@author @htmlonly © @endhtmlonly 2011 Stephen Caudle - -@date 4 March 2013 - -This library supports the power control system for the -STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics. - -LGPL License Terms @ref lgpl_license -*/ +/** @defgroup pwr_file PWR + * + * @ingroup STM32F4xx + * + * @brief libopencm3 STM32F4xx Power Control + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2011 Stephen Caudle + * + * @date 4 March 2013 + * + * This library supports the power control system for the + * STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics. + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/l1/pwr.c b/lib/stm32/l1/pwr.c index f36dbb8b..64210d58 100644 --- a/lib/stm32/l1/pwr.c +++ b/lib/stm32/l1/pwr.c @@ -1,20 +1,20 @@ -/** @defgroup pwr-file PWR - -@ingroup STM32L1xx - -@brief libopencm3 STM32L1xx Power Control - -@version 1.0.0 - -@author @htmlonly © @endhtmlonly 2012 Karl Palsson - -@date 4 March 2013 - -This library supports the power control system for the -STM32L1 series of ARM Cortex Microcontrollers by ST Microelectronics. - -LGPL License Terms @ref lgpl_license -*/ +/** @defgroup pwr_file PWR + * + * @ingroup STM32L1xx + * + * @brief libopencm3 STM32L1xx Power Control + * + * @version 1.0.0 + * + * @author @htmlonly © @endhtmlonly 2012 Karl Palsson + * + * @date 4 March 2013 + * + * This library supports the power control system for the + * STM32L1 series of ARM Cortex Microcontrollers by ST Microelectronics. + * + * LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. *