diff --git a/doc/Makefile b/doc/Makefile index ee6b2bb3..51d0605d 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -5,11 +5,14 @@ doc: html latex -html: cm3 stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 top +html: cm3 usb stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 top cm3: cd cm3/; doxygen +usb: + cd usb/; doxygen + lm3s: cd lm3s/; doxygen @@ -96,5 +99,5 @@ efm32tg.pdf: clean: @rm -rf html/ */html/ */latex/ *.pdf */*.tag -.PHONY: doc html cm3 lm3s lm4f lpc13 lpc17 lpc43 stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg top latex +.PHONY: doc html cm3 usb lm3s lm4f lpc13 lpc17 lpc43 stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg top latex diff --git a/doc/efm32g/DoxygenLayout_efm32g.xml b/doc/efm32g/DoxygenLayout_efm32g.xml index 1ec60aaf..7740639f 100644 --- a/doc/efm32g/DoxygenLayout_efm32g.xml +++ b/doc/efm32g/DoxygenLayout_efm32g.xml @@ -5,6 +5,7 @@ + diff --git a/doc/efm32gg/DoxygenLayout_efm32gg.xml b/doc/efm32gg/DoxygenLayout_efm32gg.xml index 89b43a40..6f2006cc 100644 --- a/doc/efm32gg/DoxygenLayout_efm32gg.xml +++ b/doc/efm32gg/DoxygenLayout_efm32gg.xml @@ -5,6 +5,7 @@ + diff --git a/doc/efm32lg/DoxygenLayout_efm32lg.xml b/doc/efm32lg/DoxygenLayout_efm32lg.xml index d1e29749..f2afb39b 100644 --- a/doc/efm32lg/DoxygenLayout_efm32lg.xml +++ b/doc/efm32lg/DoxygenLayout_efm32lg.xml @@ -5,6 +5,7 @@ + diff --git a/doc/efm32tg/DoxygenLayout_efm32tg.xml b/doc/efm32tg/DoxygenLayout_efm32tg.xml index 63811df6..f3b6d944 100644 --- a/doc/efm32tg/DoxygenLayout_efm32tg.xml +++ b/doc/efm32tg/DoxygenLayout_efm32tg.xml @@ -5,6 +5,7 @@ + diff --git a/doc/lm3s/DoxygenLayout_lm3s.xml b/doc/lm3s/DoxygenLayout_lm3s.xml index 1077ee5b..c8678aa6 100644 --- a/doc/lm3s/DoxygenLayout_lm3s.xml +++ b/doc/lm3s/DoxygenLayout_lm3s.xml @@ -5,6 +5,7 @@ + diff --git a/doc/lm4f/DoxygenLayout_lm4f.xml b/doc/lm4f/DoxygenLayout_lm4f.xml index 43e51f62..27ab5e09 100644 --- a/doc/lm4f/DoxygenLayout_lm4f.xml +++ b/doc/lm4f/DoxygenLayout_lm4f.xml @@ -5,6 +5,7 @@ + diff --git a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml index 370eb9f9..1fdccea3 100644 --- a/doc/lpc13xx/DoxygenLayout_lpc13xx.xml +++ b/doc/lpc13xx/DoxygenLayout_lpc13xx.xml @@ -5,6 +5,7 @@ + diff --git a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml index 098edea3..e3fd4c67 100644 --- a/doc/lpc17xx/DoxygenLayout_lpc17xx.xml +++ b/doc/lpc17xx/DoxygenLayout_lpc17xx.xml @@ -5,6 +5,7 @@ + diff --git a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml index e8320791..806ddaec 100644 --- a/doc/lpc43xx/DoxygenLayout_lpc43xx.xml +++ b/doc/lpc43xx/DoxygenLayout_lpc43xx.xml @@ -5,6 +5,7 @@ + diff --git a/doc/stm32f1/DoxygenLayout_stm32f1.xml b/doc/stm32f1/DoxygenLayout_stm32f1.xml index 3e435b3a..8e19d27f 100644 --- a/doc/stm32f1/DoxygenLayout_stm32f1.xml +++ b/doc/stm32f1/DoxygenLayout_stm32f1.xml @@ -5,6 +5,7 @@ + diff --git a/doc/stm32f2/DoxygenLayout_stm32f2.xml b/doc/stm32f2/DoxygenLayout_stm32f2.xml index b7d810a9..e21cab23 100644 --- a/doc/stm32f2/DoxygenLayout_stm32f2.xml +++ b/doc/stm32f2/DoxygenLayout_stm32f2.xml @@ -5,6 +5,7 @@ + diff --git a/doc/stm32f4/DoxygenLayout_stm32f4.xml b/doc/stm32f4/DoxygenLayout_stm32f4.xml index ce247bf2..7d48f630 100644 --- a/doc/stm32f4/DoxygenLayout_stm32f4.xml +++ b/doc/stm32f4/DoxygenLayout_stm32f4.xml @@ -5,6 +5,7 @@ + diff --git a/doc/stm32l1/DoxygenLayout_stm32l1.xml b/doc/stm32l1/DoxygenLayout_stm32l1.xml index 28837e11..62090c57 100644 --- a/doc/stm32l1/DoxygenLayout_stm32l1.xml +++ b/doc/stm32l1/DoxygenLayout_stm32l1.xml @@ -5,6 +5,7 @@ + diff --git a/include/libopencm3/lm3s/doc-lm3s.h b/include/libopencm3/lm3s/doc-lm3s.h index 2503a7b0..1a4ecb80 100644 --- a/include/libopencm3/lm3s/doc-lm3s.h +++ b/include/libopencm3/lm3s/doc-lm3s.h @@ -9,7 +9,7 @@ API documentation for TI Stellaris LM3S Cortex M3 series. LGPL License Terms @ref lgpl_license */ -/** @defgroup LM3S LM3S +/** @defgroup LM3Sxx LM3S Libraries for TI Stellaris LM3S series. @version 1.0.0 @@ -19,7 +19,7 @@ Libraries for TI Stellaris LM3S series. LGPL License Terms @ref lgpl_license */ -/** @defgroup LM3S_defines LM3S Defines +/** @defgroup LM3Sxx_defines LM3S Defines @brief Defined Constants and Types for the LM3S series diff --git a/include/libopencm3/lm3s/gpio.h b/include/libopencm3/lm3s/gpio.h index 5296b74b..e261b6a0 100644 --- a/include/libopencm3/lm3s/gpio.h +++ b/include/libopencm3/lm3s/gpio.h @@ -1,3 +1,17 @@ +/** @defgroup gpio_defines General Purpose I/O Defines + +@brief Defined Constants and Types for the LM3S General Purpose I/O + +@ingroup LM3Sxx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2011 Gareth McMullin + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LM3S_GPIO_H #define LM3S_GPIO_H +/**@{*/ + #include #include @@ -76,4 +92,7 @@ void gpio_clear(u32 gpioport, u8 gpios); END_DECLS +/**@}*/ + #endif + diff --git a/include/libopencm3/lm3s/systemcontrol.h b/include/libopencm3/lm3s/systemcontrol.h index 32b0ba55..15e4d603 100644 --- a/include/libopencm3/lm3s/systemcontrol.h +++ b/include/libopencm3/lm3s/systemcontrol.h @@ -1,3 +1,18 @@ +/** @defgroup systemcontrol_defines System Control + +@brief Defined Constants and Types for the LM3S System Control + +@ingroup LM3Sxx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2011 Gareth McMullin + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -20,6 +35,8 @@ #ifndef LM3S_SYSTEMCONTROL_H #define LM3S_SYSTEMCONTROL_H +/**@{*/ + #include #define SYSTEMCONTROL_DID0 MMIO32(SYSTEMCONTROL_BASE + 0x000) @@ -57,5 +74,7 @@ #define SYSTEMCONTROL_DCGC2 MMIO32(SYSTEMCONTROL_BASE + 0x128) #define SYSTEMCONTROL_DSLPCLKCFG MMIO32(SYSTEMCONTROL_BASE + 0x144) +/**@}*/ + #endif diff --git a/include/libopencm3/lm4f/doc-lm4f.h b/include/libopencm3/lm4f/doc-lm4f.h index 130da54d..4877721e 100644 --- a/include/libopencm3/lm4f/doc-lm4f.h +++ b/include/libopencm3/lm4f/doc-lm4f.h @@ -9,7 +9,7 @@ API documentation for TI Stellaris LM4F Cortex M4F series. LGPL License Terms @ref lgpl_license */ -/** @defgroup LM4F LM4F +/** @defgroup LM4Fxx LM4F Libraries for TI Stellaris LM4F series. @version 1.0.0 @@ -19,7 +19,7 @@ Libraries for TI Stellaris LM4F series. LGPL License Terms @ref lgpl_license */ -/** @defgroup LM4F_defines LM4F Defines +/** @defgroup LM4Fxx_defines LM4F Defines @brief Defined Constants and Types for the LM4F series diff --git a/include/libopencm3/lm4f/gpio.h b/include/libopencm3/lm4f/gpio.h index 19987c7a..3cb0ee1a 100644 --- a/include/libopencm3/lm4f/gpio.h +++ b/include/libopencm3/lm4f/gpio.h @@ -1,3 +1,18 @@ +/** @defgroup gpio_defines General Purpose I/O Defines + +@brief Defined Constants and Types for the LM4F General Purpose I/O + +@ingroup LM4Fxx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2011 Gareth McMullin + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -20,6 +35,8 @@ #ifndef LM4F_GPIO_H #define LM4F_GPIO_H +/**@{*/ + #include #include @@ -77,3 +94,6 @@ void gpio_clear(u32 gpioport, u8 gpios); END_DECLS #endif + +/**@}*/ + diff --git a/include/libopencm3/lm4f/nvic.h b/include/libopencm3/lm4f/nvic.h index d29ea9cf..febb7a94 100644 --- a/include/libopencm3/lm4f/nvic.h +++ b/include/libopencm3/lm4f/nvic.h @@ -1,3 +1,18 @@ +/** @defgroup nvic_defines Nested Vectored Interrupt Controller + +@brief Defined Constants and Types for the LM4F Nested Vectored Interrupt Controller + +@ingroup LM4Fxx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Alexandru Gagniuc + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -20,15 +35,19 @@ #ifndef LIBOPENCM3_LM3S_NVIC_H #define LIBOPENCM3_LM3S_NVIC_H +/**@{*/ + #include -/* +/** @ingroup nvic_defines * The LM3S interrupt table applies to the LM4F as well. - * Some interrupt vectores marked as reserved in LM3S are used in LM4F, and some + * Some interrupt vectors marked as reserved in LM3S are used in LM4F, and some * vectors in LM3S are marked reserved for LM4F. However, the common vectors are * identical, and we can safely use the same interrupt table. Reserved vectors * will never be triggered, so having them is perfectly safe. */ #include +/**@}*/ + #endif /* LIBOPENCM3_LM3S_NVIC_H */ diff --git a/include/libopencm3/lm4f/rcc.h b/include/libopencm3/lm4f/rcc.h index 1c15f4b2..332358ed 100644 --- a/include/libopencm3/lm4f/rcc.h +++ b/include/libopencm3/lm4f/rcc.h @@ -1,3 +1,18 @@ +/** @defgroup rcc_defines Reset and Clock Control + +@brief Defined Constants and Types for the LM4F Reset and Clock Control + +@ingroup LM4Fxx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Alexandru Gagniuc + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/lm4f/systemcontrol.h b/include/libopencm3/lm4f/systemcontrol.h index 30fa1c98..44208a02 100644 --- a/include/libopencm3/lm4f/systemcontrol.h +++ b/include/libopencm3/lm4f/systemcontrol.h @@ -1,3 +1,17 @@ +/** @defgroup systemcontrol_defines System Control + +@brief Defined Constants and Types for the LM4F System Control + +@ingroup LM4Fxx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Alexandru Gagniuc + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LM4F_SYSTEMCONTROL_H #define LM4F_SYSTEMCONTROL_H +/**@{*/ + #include #include @@ -720,6 +736,8 @@ void periph_clock_disable(clken_t periph); END_DECLS +/**@}*/ + #endif /* LM4F_SYSTEMCONTROL_H */ diff --git a/include/libopencm3/lpc13xx/gpio.h b/include/libopencm3/lpc13xx/gpio.h index 4a71625f..ebaae407 100644 --- a/include/libopencm3/lpc13xx/gpio.h +++ b/include/libopencm3/lpc13xx/gpio.h @@ -1,3 +1,17 @@ +/** @defgroup gpio_defines GPIO Defines + +@brief Defined Constants and Types for the LPC13xx General Purpose I/O + +@ingroup LPC13xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -17,6 +31,8 @@ * along with this library. If not, see . */ +/**@{*/ + #ifndef LPC13XX_GPIO_H #define LPC13XX_GPIO_H @@ -103,4 +119,6 @@ void gpio_set(u32 gpioport, u16 gpios); END_DECLS +/**@}*/ + #endif diff --git a/include/libopencm3/lpc17xx/doc-lpc17xx.h b/include/libopencm3/lpc17xx/doc-lpc17xx.h index 5ed7cae9..4bc603de 100644 --- a/include/libopencm3/lpc17xx/doc-lpc17xx.h +++ b/include/libopencm3/lpc17xx/doc-lpc17xx.h @@ -1,16 +1,16 @@ -/** @mainpage libopencm3 LPC13xx +/** @mainpage libopencm3 LPC17xx @version 1.0.0 @date 14 September 2012 -API documentation for NXP Semiconductors LPC13xx Cortex M3 series. +API documentation for NXP Semiconductors LPC17xx Cortex M3 series. LGPL License Terms @ref lgpl_license */ -/** @defgroup LPC13xx LPC13xx -Libraries for NXP Semiconductors LPC13xx series. +/** @defgroup LPC17xx LPC17xx +Libraries for NXP Semiconductors LPC17xx series. @version 1.0.0 @@ -19,9 +19,9 @@ Libraries for NXP Semiconductors LPC13xx series. LGPL License Terms @ref lgpl_license */ -/** @defgroup LPC13xx_defines LPC13xx Defines +/** @defgroup LPC17xx_defines LPC17xx Defines -@brief Defined Constants and Types for the LPC13xx series +@brief Defined Constants and Types for the LPC17xx series @version 1.0.0 diff --git a/include/libopencm3/lpc17xx/gpio.h b/include/libopencm3/lpc17xx/gpio.h index f35516d2..852ad2a9 100644 --- a/include/libopencm3/lpc17xx/gpio.h +++ b/include/libopencm3/lpc17xx/gpio.h @@ -1,3 +1,17 @@ +/** @defgroup gpio_defines GPIO Defines + +@brief Defined Constants and Types for the LPC17xx General Purpose I/O + +@ingroup LPC17xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC17XX_GPIO_H #define LPC17XX_GPIO_H +/**@{*/ + #include #include @@ -139,4 +155,6 @@ void gpio_clear(u32 gpioport, u32 gpios); END_DECLS +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/adc.h b/include/libopencm3/lpc43xx/adc.h index ff51e782..c63c1e4c 100644 --- a/include/libopencm3/lpc43xx/adc.h +++ b/include/libopencm3/lpc43xx/adc.h @@ -1,3 +1,17 @@ +/** @defgroup adc_defines ADC Defines + +@brief Defined Constants and Types for the LPC43xx A/D Converter + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_ADC_H #define LPC43XX_ADC_H +/**@{*/ + #include #include @@ -92,4 +108,6 @@ #define ADC0_STAT ADC_STAT(ADC0) #define ADC1_STAT ADC_STAT(ADC1) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/atimer.h b/include/libopencm3/lpc43xx/atimer.h index 2a7655ff..cbb70d72 100644 --- a/include/libopencm3/lpc43xx/atimer.h +++ b/include/libopencm3/lpc43xx/atimer.h @@ -1,3 +1,17 @@ +/** @defgroup atimer_defines Alarm Timer Defines + +@brief Defined Constants and Types for the LPC43xx Alarm Timer + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_ATIMER_H #define LPC43XX_ATIMER_H +/**@{*/ + #include #include @@ -49,4 +65,6 @@ /* Set register */ #define ATIMER_SET_STAT MMIO32(ATIMER_BASE + 0xFEC) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/ccu.h b/include/libopencm3/lpc43xx/ccu.h index 068bd3d8..d3b1d500 100644 --- a/include/libopencm3/lpc43xx/ccu.h +++ b/include/libopencm3/lpc43xx/ccu.h @@ -1,3 +1,17 @@ +/** @defgroup ccu_defines Clock Control Unit Defines + +@brief Defined Constants and Types for the LPC43xx Clock Control Unit + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_CCU_H #define LPC43XX_CCU_H +/**@{*/ + #include #include @@ -381,4 +397,6 @@ /* CLK_SDIO status register (for SD/MMC) */ #define CCU2_CLK_SDIO_STAT MMIO32(CCU2_BASE + 0x804) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/cgu.h b/include/libopencm3/lpc43xx/cgu.h index c0ce8271..915150b2 100644 --- a/include/libopencm3/lpc43xx/cgu.h +++ b/include/libopencm3/lpc43xx/cgu.h @@ -1,3 +1,17 @@ +/** @defgroup cgu_defines Clock Generation Unit Defines + +@brief Defined Constants and Types for the LPC43xx Clock Generation Unit + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_CGU_H #define CGU_LPC43XX_CGU_H +/**@{*/ + #include #include @@ -236,4 +252,6 @@ #define CGU_SRC_IDIVD 0x0F #define CGU_SRC_IDIVE 0x10 +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/creg.h b/include/libopencm3/lpc43xx/creg.h index dafc8824..2213c6f9 100644 --- a/include/libopencm3/lpc43xx/creg.h +++ b/include/libopencm3/lpc43xx/creg.h @@ -1,3 +1,17 @@ +/** @defgroup creg_defines Configuration Registers Defines + +@brief Defined Constants and Types for the LPC43xx Configuration Registers + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_CREG_H #define LPC43XX_CREG_H +/**@{*/ + #include #include @@ -73,4 +89,6 @@ /* ARM Cortex-M0 memory mapping */ #define CREG_M0APPMEMMAP MMIO32(CREG_BASE + 0x404) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/eventrouter.h b/include/libopencm3/lpc43xx/eventrouter.h index d326988b..ef5ac694 100644 --- a/include/libopencm3/lpc43xx/eventrouter.h +++ b/include/libopencm3/lpc43xx/eventrouter.h @@ -1,3 +1,17 @@ +/** @defgroup eventrouter_defines Event Router Defines + +@brief Defined Constants and Types for the LPC43xx Event Router + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_EVENTROUTER_H #define LPC43XX_EVENTROUTER_H +/**@{*/ + #include #include @@ -49,4 +65,6 @@ /* Set event status register */ #define EVENTROUTER_SET_STAT MMIO32(EVENTROUTER_BASE + 0xFEC) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/gima.h b/include/libopencm3/lpc43xx/gima.h index ee14ecc0..c54df67c 100644 --- a/include/libopencm3/lpc43xx/gima.h +++ b/include/libopencm3/lpc43xx/gima.h @@ -1,3 +1,17 @@ +/** @defgroup gima_defines Global Input Multiplexer Array Defines + +@brief Defined Constants and Types for the LPC43xx Global Input Multiplexer Array + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_GIMA_H #define LPC43XX_GIMA_H +/**@{*/ + #include #include @@ -115,4 +131,6 @@ /* ADC start1 input multiplexer (GIMA output 29) */ #define GIMA_ADCSTART1_IN MMIO32(GIMA_BASE + 0x074) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/gpdma.h b/include/libopencm3/lpc43xx/gpdma.h index 064ccd77..7c91c6d4 100644 --- a/include/libopencm3/lpc43xx/gpdma.h +++ b/include/libopencm3/lpc43xx/gpdma.h @@ -1,3 +1,17 @@ +/** @defgroup gpdma_defines General Purpose DMA Defines + +@brief Defined Constants and Types for the LPC43xx General Purpose DMA + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_GPDMA_H #define LPC43XX_GPDMA_H +/**@{*/ + #include #include @@ -140,4 +156,6 @@ #define GPDMA_C6CONFIG GPDMA_CONFIG(GPDMA_CHANNEL6) #define GPDMA_C7CONFIG GPDMA_CONFIG(GPDMA_CHANNEL7) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/gpio.h b/include/libopencm3/lpc43xx/gpio.h index daa21fd3..397d7e5a 100644 --- a/include/libopencm3/lpc43xx/gpio.h +++ b/include/libopencm3/lpc43xx/gpio.h @@ -1,3 +1,17 @@ +/** @defgroup gpio_defines General Purpose I/O Defines + +@brief Defined Constants and Types for the LPC43xx General Purpose I/O + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -21,6 +35,8 @@ #ifndef LPC43XX_GPIO_H #define LPC43XX_GPIO_H +/**@{*/ + #include #include @@ -161,4 +177,6 @@ void gpio_toggle(u32 gpioport, u32 gpios); END_DECLS +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/i2c.h b/include/libopencm3/lpc43xx/i2c.h index 29e797e5..09a0e1fc 100644 --- a/include/libopencm3/lpc43xx/i2c.h +++ b/include/libopencm3/lpc43xx/i2c.h @@ -1,3 +1,17 @@ +/** @defgroup i2c_defines I2C Defines + +@brief Defined Constants and Types for the LPC43xx I2C + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_I2C_H #define LPC43XX_I2C_H +/**@{*/ + #include #include @@ -143,4 +159,6 @@ void i2c0_stop(void); END_DECLS +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/i2s.h b/include/libopencm3/lpc43xx/i2s.h index 8c9c5dba..52f5c740 100644 --- a/include/libopencm3/lpc43xx/i2s.h +++ b/include/libopencm3/lpc43xx/i2s.h @@ -1,3 +1,17 @@ +/** @defgroup i2s_defines I2S Defines + +@brief Defined Constants and Types for the LPC43xx I2S + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_I2S_H #define LPC43XX_I2S_H +/**@{*/ + #include #include @@ -102,4 +118,6 @@ #define I2S0_RXMODE I2S_RXMODE(I2S0) #define I2S1_RXMODE I2S_RXMODE(I2S1) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/rgu.h b/include/libopencm3/lpc43xx/rgu.h index 777158bb..4952ec1b 100644 --- a/include/libopencm3/lpc43xx/rgu.h +++ b/include/libopencm3/lpc43xx/rgu.h @@ -1,3 +1,17 @@ +/** @defgroup rgu_defines Reset Generation Unit Defines + +@brief Defined Constants and Types for the LPC43xx Reset Generation Unit + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_RGU_H #define LPC43XX_RGU_H +/**@{*/ + #include #include @@ -241,4 +257,6 @@ /* Reserved */ #define RESET_EXT_STAT63 MMIO32(RGU_BASE + 0x4FC) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/ritimer.h b/include/libopencm3/lpc43xx/ritimer.h index d231a41c..e7308787 100644 --- a/include/libopencm3/lpc43xx/ritimer.h +++ b/include/libopencm3/lpc43xx/ritimer.h @@ -1,3 +1,17 @@ +/** @defgroup ritimer_defines Repetitive Interrupt Timer Defines + +@brief Defined Constants and Types for the LPC43xx Repetitive Interrupt Timer + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_RITIMER_H #define LPC43XX_RITIMER_H +/**@{*/ + #include #include @@ -37,4 +53,6 @@ /* 32-bit counter */ #define RITIMER_COUNTER MMIO32(RITIMER_BASE + 0x00C) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/scu.h b/include/libopencm3/lpc43xx/scu.h index c1b9fc24..755fd8df 100644 --- a/include/libopencm3/lpc43xx/scu.h +++ b/include/libopencm3/lpc43xx/scu.h @@ -1,3 +1,17 @@ +/** @defgroup scu_defines System Control Unit Defines + +@brief Defined Constants and Types for the LPC43xx System Control Unit + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -21,6 +35,8 @@ #ifndef LPC43XX_SCU_H #define LPC43XX_SCU_H +/**@{*/ + #include #include @@ -731,4 +747,6 @@ void scu_pinmux(scu_grp_pin_t group_pin, u32 scu_conf); END_DECLS +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/sdio.h b/include/libopencm3/lpc43xx/sdio.h index 3310aa95..164dda47 100644 --- a/include/libopencm3/lpc43xx/sdio.h +++ b/include/libopencm3/lpc43xx/sdio.h @@ -1,3 +1,17 @@ +/** @defgroup sdio_defines SDIO + +@brief Defined Constants and Types for the LPC43xx SDIO + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_SDIO_H #define LPC43XX_SDIO_H +/**@{*/ + #include #include @@ -130,4 +146,6 @@ /* Data FIFO read/write */ #define SDIO_DATA MMIO32(SDIO_BASE + 0x100) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/sgpio.h b/include/libopencm3/lpc43xx/sgpio.h index 226551ee..686108af 100644 --- a/include/libopencm3/lpc43xx/sgpio.h +++ b/include/libopencm3/lpc43xx/sgpio.h @@ -1,3 +1,31 @@ +/** @defgroup sgpio_defines Serial General Purpose I/O + +@brief Defined Constants and Types for the LPC43xx Serial General Purpose I/O + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ +/** @defgroup sdio_defines SDIO + +@brief Defined Constants and Types for the LPC43xx SDIO + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -21,6 +49,8 @@ #ifndef LPC43XX_SGPIO_H #define LPC43XX_SGPIO_H +/**@{*/ + #include #include @@ -295,4 +325,6 @@ /* Input bit match interrupt set status */ #define SGPIO_SET_STATUS_3 MMIO32(SGPIO_PORT_BASE + 0xF74) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/ssp.h b/include/libopencm3/lpc43xx/ssp.h index b3d95db1..64e048c6 100644 --- a/include/libopencm3/lpc43xx/ssp.h +++ b/include/libopencm3/lpc43xx/ssp.h @@ -1,3 +1,17 @@ +/** @defgroup ssp_defines Synchronous Serial Port + +@brief Defined Constants and Types for the LPC43xx Synchronous Serial Port + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_SSP_H #define LPC43XX_SSP_H +/**@{*/ + #include #include @@ -182,4 +198,6 @@ void ssp_write(ssp_num_t ssp_num, u16 data); END_DECLS +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/timer.h b/include/libopencm3/lpc43xx/timer.h index 1064b06f..82329bc3 100644 --- a/include/libopencm3/lpc43xx/timer.h +++ b/include/libopencm3/lpc43xx/timer.h @@ -1,3 +1,17 @@ +/** @defgroup timer_defines Timer + +@brief Defined Constants and Types for the LPC43xx timer + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_TIMER_H #define LPC43XX_TIMER_H +/**@{*/ + #include #include @@ -153,4 +169,6 @@ #define TIMER2_CTCR TIMER_CTCR(TIMER2) #define TIMER3_CTCR TIMER_CTCR(TIMER3) +/**@}*/ + #endif diff --git a/include/libopencm3/lpc43xx/wwdt.h b/include/libopencm3/lpc43xx/wwdt.h index b4e63bf5..a6c0123c 100644 --- a/include/libopencm3/lpc43xx/wwdt.h +++ b/include/libopencm3/lpc43xx/wwdt.h @@ -1,3 +1,17 @@ +/** @defgroup wwdt_defines Windowed Watchdog Timer + +@brief Defined Constants and Types for the LPC43xx Windowed Watchdog Timer + +@ingroup LPC43xx_defines + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license + */ /* * This file is part of the libopencm3 project. * @@ -20,6 +34,8 @@ #ifndef LPC43XX_WWDT_H #define LPC43XX_WWDT_H +/**@{*/ + #include #include @@ -43,4 +59,6 @@ /* Watchdog timer window register */ #define WWDT_WINDOW MMIO32(WWDT_BASE + 0x018) +/**@}*/ + #endif diff --git a/include/libopencm3/stm32/common/crc_common_all.h b/include/libopencm3/stm32/common/crc_common_all.h index ad87c667..38383555 100644 --- a/include/libopencm3/stm32/common/crc_common_all.h +++ b/include/libopencm3/stm32/common/crc_common_all.h @@ -31,6 +31,8 @@ specific memorymap.h header before including this header file.*/ #ifndef LIBOPENCM3_CRC_COMMON_ALL_H #define LIBOPENCM3_CRC_COMMON_ALL_H +/**@{*/ + #include /* --- CRC registers ------------------------------------------------------- */ @@ -89,6 +91,8 @@ u32 crc_calculate_block(u32 *datap, int size); END_DECLS +/**@}*/ + #endif #else #warning "crc_common_all.h should not be included explicitly, only via crc.h" diff --git a/lib/lm3s/gpio.c b/lib/lm3s/gpio.c index a92c96ef..3d91c443 100644 --- a/lib/lm3s/gpio.c +++ b/lib/lm3s/gpio.c @@ -1,3 +1,18 @@ +/** @defgroup gpio_file General Purpose I/O + +@brief LM3S General Purpose I/O + +@ingroup LM3Sxx + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2011 Gareth McMullin + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -17,6 +32,8 @@ * along with this library. If not, see . */ +/**@{*/ + #include void gpio_set(u32 gpioport, u8 gpios) @@ -29,3 +46,6 @@ void gpio_clear(u32 gpioport, u8 gpios) { GPIO_DATA(gpioport)[gpios] = 0; } + +/**@}*/ + diff --git a/lib/lm4f/gpio.c b/lib/lm4f/gpio.c index 2d50116a..95a86ef6 100644 --- a/lib/lm4f/gpio.c +++ b/lib/lm4f/gpio.c @@ -1,3 +1,18 @@ +/** @defgroup gpio_file General Purpose I/O + +@brief LM4F General Purpose I/O + +@ingroup LM4Fxx + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2011 Gareth McMullin + +@date 10 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -17,6 +32,8 @@ * along with this library. If not, see . */ +/**@{*/ + #include void gpio_set(u32 gpioport, u8 gpios) @@ -29,3 +46,6 @@ void gpio_clear(u32 gpioport, u8 gpios) { GPIO_DATA(gpioport)[gpios] = 0; } + +/**@}*/ + diff --git a/lib/lm4f/rcc.c b/lib/lm4f/rcc.c index 26c6c394..29f281ce 100644 --- a/lib/lm4f/rcc.c +++ b/lib/lm4f/rcc.c @@ -21,7 +21,7 @@ /** * @defgroup rcc_file RCC * - * @ingroup LM4F + * @ingroup LM4Fxx * @author @htmlonly © @endhtmlonly 2012 Alexandru Gagniuc @@ -79,6 +79,7 @@ /** * @defgroup rcc_low_level Low-level clock control API +@ingroup rcc_file * @{ */ /** @@ -342,6 +343,7 @@ void rcc_wait_for_pll_ready(void) /** * @defgroup rcc_high_level High-level clock control API +@ingroup rcc_file * @{ */ diff --git a/lib/lpc13xx/gpio.c b/lib/lpc13xx/gpio.c index be4874c3..fba5b9b4 100644 --- a/lib/lpc13xx/gpio.c +++ b/lib/lpc13xx/gpio.c @@ -1,3 +1,15 @@ +/** @defgroup gpio_file GPIO + +@ingroup LPC13xx + +@brief libopencm3 LPC13xx General Purpose I/O + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann + +LGPL License Terms @ref lgpl_license +*/ /* * This file is part of the libopencm3 project. * @@ -17,9 +29,14 @@ * along with this library. If not, see . */ +/**@{*/ + #include void gpio_set(u32 gpioport, u16 gpios) { GPIO_DATA(gpioport) = gpios; } + +/**@}*/ + diff --git a/lib/lpc17xx/gpio.c b/lib/lpc17xx/gpio.c index 6c44081c..0a56d27e 100644 --- a/lib/lpc17xx/gpio.c +++ b/lib/lpc17xx/gpio.c @@ -1,3 +1,16 @@ +/** @defgroup gpio_file GPIO + +@ingroup LPC17xx + +@brief libopencm3 LPC17xx General Purpose I/O + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -17,6 +30,8 @@ * along with this library. If not, see . */ +/**@{*/ + #include void gpio_set(u32 gpioport, u32 gpios) @@ -28,3 +43,6 @@ void gpio_clear(u32 gpioport, u32 gpios) { GPIO_CLR(gpioport) = gpios; } + +/**@}*/ + diff --git a/lib/lpc43xx/gpio.c b/lib/lpc43xx/gpio.c index 1256fd03..cbce8964 100644 --- a/lib/lpc43xx/gpio.c +++ b/lib/lpc43xx/gpio.c @@ -1,3 +1,16 @@ +/** @defgroup gpio_file GPIO + +@ingroup LPC43xx + +@brief libopencm3 LPC43xx General Purpose I/O + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -17,6 +30,8 @@ * along with this library. If not, see . */ +/**@{*/ + #include void gpio_set(u32 gpioport, u32 gpios) @@ -32,4 +47,7 @@ void gpio_clear(u32 gpioport, u32 gpios) void gpio_toggle(u32 gpioport, u32 gpios) { GPIO_NOT(gpioport) = gpios; -} \ No newline at end of file +} + +/**@}*/ + diff --git a/lib/lpc43xx/i2c.c b/lib/lpc43xx/i2c.c index f006615e..b401afb1 100644 --- a/lib/lpc43xx/i2c.c +++ b/lib/lpc43xx/i2c.c @@ -1,3 +1,16 @@ +/** @defgroup i2c_file I2C + +@ingroup LPC43xx + +@brief libopencm3 LPC43xx I2C + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Michael Ossmann + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -22,6 +35,8 @@ * peripheral working. */ +/**@{*/ + #include #include #include @@ -91,3 +106,6 @@ void i2c0_stop(void) I2C0_CONSET = I2C_CONSET_STO; I2C0_CONCLR = I2C_CONCLR_SIC; } + +/**@}*/ + diff --git a/lib/lpc43xx/scu.c b/lib/lpc43xx/scu.c index addf5e2c..f3d7dcd1 100644 --- a/lib/lpc43xx/scu.c +++ b/lib/lpc43xx/scu.c @@ -1,3 +1,16 @@ +/** @defgroup scu_file System Control Unit + +@ingroup LPC43xx + +@brief libopencm3 LPC43xx System Control Unit + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Benjamin Vernoux + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -17,6 +30,8 @@ * along with this library. If not, see . */ +/**@{*/ + #include /* For pin_conf_normal value see scu.h define SCU_CONF_XXX or Configuration for different I/O pins types */ @@ -28,3 +43,6 @@ void scu_pinmux(scu_grp_pin_t group_pin, u32 scu_conf) /* For other special SCU register USB1, I2C0, ADC0/1, DAC, EMC clock delay See scu.h */ /* For Pin interrupt select register see scu.h SCU_PINTSEL0 & SCU_PINTSEL1 */ + +/**@}*/ + diff --git a/lib/lpc43xx/ssp.c b/lib/lpc43xx/ssp.c index d2b8ff1f..4a1ffb50 100644 --- a/lib/lpc43xx/ssp.c +++ b/lib/lpc43xx/ssp.c @@ -1,3 +1,16 @@ +/** @defgroup ssp_file SSP + +@ingroup LPC43xx + +@brief libopencm3 LPC43xx SSP + +@version 1.0.0 + +@author @htmlonly © @endhtmlonly 2012 Benjamin Vernoux + +LGPL License Terms @ref lgpl_license +*/ + /* * This file is part of the libopencm3 project. * @@ -17,6 +30,8 @@ * along with this library. If not, see . */ +/**@{*/ + #include #include @@ -160,4 +175,5 @@ void ssp_write(ssp_num_t ssp_num, u16 data) */ ssp_wait_until_not_busy(ssp_num); } +/**@}*/