diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index a6026520..c1a7744f 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -8,16 +8,16 @@ - + - - - - + + + + diff --git a/doc/HACKING b/doc/HACKING index 07fb872a..48636765 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -28,23 +28,32 @@ Markup ------ Each family has been given a group name that will allow subgrouping of API -functions and defines in the documentation. +functions and defines in the documentation. -The header and source files for each family must have a heading section -in which an @defgroup defines the group names. For a peripheral xxx the -header will have a group name xxx_defines and the source file will have -xxx_file. This will allow the group to appear separately. An @ingroup must -be provided to place the group as a subgroup of the appropriate family -grouping. Note that @file is not used. +The header and source files for each peripheral in each family must have a +heading section in which an @defgroup defines the group name for the particular +peripheral. This group name will be the same across all families as each one +is documented deparately. Thus for a peripheral xxx the header will have a +group name xxx_defines and the source file will have xxx_file. This will allow +the group to appear separately. An @ingroup must be provided to place the group +as a subgroup of the appropriate family grouping. Note that @file is not used. -Common header and source files must have an @addgroup to include its -documentation into the appropriate peripheral group. These must not have any -reference to family groupings to allow them to be incorporated into multiple -family groups. +The heading section must include the version number and date and authors names +plus a license reference. Any documentation specific to the family can be +included here. If there are common files included then their documentation will +appear in a separate section. -Each function must have a header with an @brief, and where appropriate -@parameter and @return elements. These must describe the allowable parameter -ranges preferably with reference to a suitable define. +Common header and source files that are included into a number of families must +have an @addgroup to include its documentation into the appropriate peripheral +group. These headings may include authors and any specific descriptions but the +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. + +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 +define in the corresponding header file. The Doxyfile for a family must include input files from the header and source subdirectories, as well as all needed common files. The common files can be diff --git a/doc/cm3/DoxygenLayout_cm3.xml b/doc/cm3/DoxygenLayout_cm3.xml index 66ed9f33..1206a190 100644 --- a/doc/cm3/DoxygenLayout_cm3.xml +++ b/doc/cm3/DoxygenLayout_cm3.xml @@ -4,7 +4,6 @@ - diff --git a/doc/stm32f2/Doxyfile b/doc/stm32f2/Doxyfile index bc0348e7..cfe5dd50 100644 --- a/doc/stm32f2/Doxyfile +++ b/doc/stm32f2/Doxyfile @@ -24,7 +24,7 @@ INPUT += ../../lib/stm32/f2 \ EXCLUDE = -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c LAYOUT_FILE = DoxygenLayout_stm32f2.xml diff --git a/doc/stm32f4/Doxyfile b/doc/stm32f4/Doxyfile index eee41e9c..c5016f4e 100644 --- a/doc/stm32f4/Doxyfile +++ b/doc/stm32f4/Doxyfile @@ -24,6 +24,8 @@ INPUT += ../../lib/stm32/f4 \ EXCLUDE = +EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c + LAYOUT_FILE = DoxygenLayout_stm32f4.xml TAGFILES = ../cm3/cm3.tag=../../cm3/html diff --git a/doc/stm32l1/DoxygenLayout_stm32l1.xml b/doc/stm32l1/DoxygenLayout_stm32l1.xml index 86ee511a..28837e11 100644 --- a/doc/stm32l1/DoxygenLayout_stm32l1.xml +++ b/doc/stm32l1/DoxygenLayout_stm32l1.xml @@ -5,7 +5,7 @@ - + diff --git a/include/libopencm3/efm32/efm32lg/doc-efm32lg.h b/include/libopencm3/efm32/efm32lg/doc-efm32lg.h new file mode 100644 index 00000000..cea52e5d --- /dev/null +++ b/include/libopencm3/efm32/efm32lg/doc-efm32lg.h @@ -0,0 +1,32 @@ +/** @mainpage libopencm3 EFM32 Leopard Gecko + +@version 1.0.0 + +@date 4 March 2013 + +API documentation for Energy Micro EFM32 Leopard Gecko Cortex M3 series. + +LGPL License Terms @ref lgpl_license +*/ + +/** @defgroup EFM32LG EFM32 LeopardGecko +Libraries for Energy Micro EFM32 Leopard Gecko series. + +@version 1.0.0 + +@date 4 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + +/** @defgroup EFM32LG_defines EFM32 Leopard Gecko Defines + +@brief Defined Constants and Types for the Energy Micro EFM32 Leopard Gecko series + +@version 1.0.0 + +@date 4 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + diff --git a/include/libopencm3/efm32/efm32tg/doc-efm32tg.h b/include/libopencm3/efm32/efm32tg/doc-efm32tg.h new file mode 100644 index 00000000..799048cd --- /dev/null +++ b/include/libopencm3/efm32/efm32tg/doc-efm32tg.h @@ -0,0 +1,32 @@ +/** @mainpage libopencm3 EFM32 Tiny Gecko + +@version 1.0.0 + +@date 4 March 2013 + +API documentation for Energy Micro EFM32 Tiny Gecko Cortex M3 series. + +LGPL License Terms @ref lgpl_license +*/ + +/** @defgroup EFM32TG EFM32 TinyGecko +Libraries for Energy Micro EFM32 Tiny Gecko series. + +@version 1.0.0 + +@date 4 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + +/** @defgroup EFM32TG_defines EFM32 Tiny Gecko Defines + +@brief Defined Constants and Types for the Energy Micro EFM32 Tiny Gecko series + +@version 1.0.0 + +@date 4 March 2013 + +LGPL License Terms @ref lgpl_license +*/ + diff --git a/include/libopencm3/stm32/common/crc_common_all.h b/include/libopencm3/stm32/common/crc_common_all.h index 892f41bd..209f19bf 100644 --- a/include/libopencm3/stm32/common/crc_common_all.h +++ b/include/libopencm3/stm32/common/crc_common_all.h @@ -1,4 +1,8 @@ -/** @addtogroup crc_defines */ +/** @addtogroup crc_defines + +@author @htmlonly © @endhtmlonly 2010 Thomas Otto + +*/ /* * This file is part of the libopencm3 project. @@ -19,7 +23,7 @@ * along with this library. If not, see . */ -/* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA SPI.H */ +/* THIS FILE SHOULD NOT BE INCLUDED DIRECTLY, BUT ONLY VIA CRC.H */ #ifndef LIBOPENCM3_CRC_COMMON_ALL_H #define LIBOPENCM3_CRC_COMMON_ALL_H diff --git a/include/libopencm3/stm32/common/dac_common_all.h b/include/libopencm3/stm32/common/dac_common_all.h index c843c55c..94bf01bb 100644 --- a/include/libopencm3/stm32/common/dac_common_all.h +++ b/include/libopencm3/stm32/common/dac_common_all.h @@ -1,4 +1,8 @@ -/** @addtogroup dac_defines */ +/** @addtogroup dac_defines + +@author @htmlonly © @endhtmlonly 2012 Felix Held + +*/ /* * This file is part of the libopencm3 project. diff --git a/include/libopencm3/stm32/common/dma_common_f13.h b/include/libopencm3/stm32/common/dma_common_f13.h index 964bdf1a..68ade004 100644 --- a/include/libopencm3/stm32/common/dma_common_f13.h +++ b/include/libopencm3/stm32/common/dma_common_f13.h @@ -1,4 +1,10 @@ -/** @addtogroup dma_defines */ +/** @addtogroup dma_defines + +@author @htmlonly © @endhtmlonly 2010 Thomas Otto +@author @htmlonly © @endhtmlonly 2012 Piotr Esden-Tempski + +*/ + /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/common/dma_common_f24.h b/include/libopencm3/stm32/common/dma_common_f24.h index e7c5a160..ecf9fcfc 100644 --- a/include/libopencm3/stm32/common/dma_common_f24.h +++ b/include/libopencm3/stm32/common/dma_common_f24.h @@ -1,4 +1,9 @@ -/** @addtogroup dma_defines */ +/** @addtogroup dma_defines + +@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_all.h b/include/libopencm3/stm32/common/gpio_common_all.h index 9b05fde4..4d03db09 100644 --- a/include/libopencm3/stm32/common/gpio_common_all.h +++ b/include/libopencm3/stm32/common/gpio_common_all.h @@ -1,4 +1,9 @@ -/** @addtogroup gpio_defines */ +/** @addtogroup gpio_defines + +@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 f8bd4fb2..2ce0167e 100644 --- a/include/libopencm3/stm32/common/gpio_common_f24.h +++ b/include/libopencm3/stm32/common/gpio_common_f24.h @@ -1,4 +1,9 @@ -/** @addtogroup gpio_defines */ +/** @addtogroup gpio_defines + +@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/i2c_common_all.h b/include/libopencm3/stm32/common/i2c_common_all.h index d5cc490d..7f6d447e 100644 --- a/include/libopencm3/stm32/common/i2c_common_all.h +++ b/include/libopencm3/stm32/common/i2c_common_all.h @@ -1,4 +1,8 @@ -/** @addtogroup i2c_defines */ +/** @addtogroup i2c_defines + +@author @htmlonly © @endhtmlonly 2010 Thomas Otto + +*/ /* * This file is part of the libopencm3 project. diff --git a/include/libopencm3/stm32/common/i2c_common_f24.h b/include/libopencm3/stm32/common/i2c_common_f24.h index 22a57337..c267bd85 100644 --- a/include/libopencm3/stm32/common/i2c_common_f24.h +++ b/include/libopencm3/stm32/common/i2c_common_f24.h @@ -1,4 +1,8 @@ -/** @addtogroup i2c_defines */ +/** @addtogroup i2c_defines + +@author @htmlonly © @endhtmlonly 2012 Ken Sarkies + +*/ /* * This file is part of the libopencm3 project. diff --git a/include/libopencm3/stm32/common/iwdg_common_all.h b/include/libopencm3/stm32/common/iwdg_common_all.h index ea2ad16d..b75e4d14 100644 --- a/include/libopencm3/stm32/common/iwdg_common_all.h +++ b/include/libopencm3/stm32/common/iwdg_common_all.h @@ -1,4 +1,8 @@ -/** @addtogroup iwdg_defines */ +/** @addtogroup iwdg_defines + +@author @htmlonly © @endhtmlonly 2010 Thomas Otto + +*/ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/common/pwr_common_all.h b/include/libopencm3/stm32/common/pwr_common_all.h index cc9fd229..a6b38d88 100644 --- a/include/libopencm3/stm32/common/pwr_common_all.h +++ b/include/libopencm3/stm32/common/pwr_common_all.h @@ -1,4 +1,8 @@ -/** @addtogroup pwr_defines */ +/** @addtogroup pwr_defines + +@author @htmlonly © @endhtmlonly 2010 Thomas Otto + +*/ /* * This file is part of the libopencm3 project. diff --git a/include/libopencm3/stm32/common/rtc_common_bcd.h b/include/libopencm3/stm32/common/rtc_common_bcd.h index 69a46f5c..41afe3f5 100644 --- a/include/libopencm3/stm32/common/rtc_common_bcd.h +++ b/include/libopencm3/stm32/common/rtc_common_bcd.h @@ -1,4 +1,8 @@ -/** @addtogroup rtc_defines */ +/** @addtogroup rtc_defines + +@author @htmlonly © @endhtmlonly 2012 Karl Palsson + +*/ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/common/spi_common_all.h b/include/libopencm3/stm32/common/spi_common_all.h index 976d679a..a337c371 100644 --- a/include/libopencm3/stm32/common/spi_common_all.h +++ b/include/libopencm3/stm32/common/spi_common_all.h @@ -1,4 +1,8 @@ -/** @addtogroup spi_defines */ +/** @addtogroup spi_defines + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann + +*/ /* * This file is part of the libopencm3 project. diff --git a/include/libopencm3/stm32/common/spi_common_f24.h b/include/libopencm3/stm32/common/spi_common_f24.h index 6b3764e3..0a5873dd 100644 --- a/include/libopencm3/stm32/common/spi_common_f24.h +++ b/include/libopencm3/stm32/common/spi_common_f24.h @@ -1,4 +1,8 @@ -/** @addtogroup spi_defines */ +/** @addtogroup spi_defines + +@author @htmlonly © @endhtmlonly 2011 Fergus Noble + +*/ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/common/usart_common_all.h b/include/libopencm3/stm32/common/usart_common_all.h index 553ba285..b7ab394a 100644 --- a/include/libopencm3/stm32/common/usart_common_all.h +++ b/include/libopencm3/stm32/common/usart_common_all.h @@ -1,4 +1,8 @@ -/** @addtogroup usart_defines */ +/** @addtogroup usart_defines + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann + +*/ /* * This file is part of the libopencm3 project. diff --git a/include/libopencm3/stm32/common/usart_common_f24.h b/include/libopencm3/stm32/common/usart_common_f24.h index 089a0c27..301eceb7 100644 --- a/include/libopencm3/stm32/common/usart_common_f24.h +++ b/include/libopencm3/stm32/common/usart_common_f24.h @@ -1,4 +1,9 @@ -/** @addtogroup usart_defines */ +/** @addtogroup usart_defines + +@author @htmlonly © @endhtmlonly 2011 Uwe Hermann +@author @htmlonly © @endhtmlonly 2011 Stephen Caudle + +*/ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/doc-stm32f.h b/include/libopencm3/stm32/doc-stm32f.h deleted file mode 100644 index 7b0a1a31..00000000 --- a/include/libopencm3/stm32/doc-stm32f.h +++ /dev/null @@ -1,29 +0,0 @@ -/** @mainpage libopencm3 STM32 Common - -@version 1.0.0 - -@date 7 September 2012 - -API documentation for common files for ST Microelectronics STM32 Cortex M3 series. - -LGPL License Terms @ref lgpl_license -*/ - -/** @defgroup STM32F_defines STM32F Common Defines - -@brief Defined Constants and Types for the STM32F series - -LGPL License Terms @ref lgpl_license - */ - -/** @defgroup STM32F_files STM32F Common Files - -@brief Common Files for ST Microelectronics STM32F series. - -@version 1.0.0 - -@date 7 September 2012 - -LGPL License Terms @ref lgpl_license -*/ - diff --git a/include/libopencm3/stm32/f1/adc.h b/include/libopencm3/stm32/f1/adc.h index a382be28..1121bb16 100644 --- a/include/libopencm3/stm32/f1/adc.h +++ b/include/libopencm3/stm32/f1/adc.h @@ -1,4 +1,4 @@ -/** @defgroup STM32F1xx_adc_defines ADC Defines +/** @defgroup adc_defines ADC Defines @brief Defined Constants and Types for the STM32F1xx Analog to Digital Converters diff --git a/include/libopencm3/stm32/f1/crc.h b/include/libopencm3/stm32/f1/crc.h index c3b99395..f31d4dec 100644 --- a/include/libopencm3/stm32/f1/crc.h +++ b/include/libopencm3/stm32/f1/crc.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - @date 18 August 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f1/dac.h b/include/libopencm3/stm32/f1/dac.h index 1e6ecfa3..e68618b8 100644 --- a/include/libopencm3/stm32/f1/dac.h +++ b/include/libopencm3/stm32/f1/dac.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f1/dma.h b/include/libopencm3/stm32/f1/dma.h index e0c55a60..bdffa52a 100644 --- a/include/libopencm3/stm32/f1/dma.h +++ b/include/libopencm3/stm32/f1/dma.h @@ -1,4 +1,4 @@ -/** @defgroup STM32F1xx_dma_defines DMA Defines +/** @defgroup dma_defines DMA Defines @ingroup STM32F1xx_defines @@ -6,9 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 30 November 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f1/gpio.h b/include/libopencm3/stm32/f1/gpio.h index 1e97b734..fb6690c2 100644 --- a/include/libopencm3/stm32/f1/gpio.h +++ b/include/libopencm3/stm32/f1/gpio.h @@ -6,10 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2009 Uwe Hermann -@author @htmlonly © @endhtmlonly 2012 Piotr Esden-Tempski -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 1 July 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f1/i2c.h b/include/libopencm3/stm32/f1/i2c.h index 44d906a4..8c6ab521 100644 --- a/include/libopencm3/stm32/f1/i2c.h +++ b/include/libopencm3/stm32/f1/i2c.h @@ -6,9 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 12 October 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f1/iwdg.h b/include/libopencm3/stm32/f1/iwdg.h index c8a1e855..5a42f08b 100644 --- a/include/libopencm3/stm32/f1/iwdg.h +++ b/include/libopencm3/stm32/f1/iwdg.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - @date 18 August 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f1/pwr.h b/include/libopencm3/stm32/f1/pwr.h index 2875492f..1cabca3f 100644 --- a/include/libopencm3/stm32/f1/pwr.h +++ b/include/libopencm3/stm32/f1/pwr.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f1/rtc.h b/include/libopencm3/stm32/f1/rtc.h index a8a89666..4070919c 100644 --- a/include/libopencm3/stm32/f1/rtc.h +++ b/include/libopencm3/stm32/f1/rtc.h @@ -1,3 +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 + */ /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f1/spi.h b/include/libopencm3/stm32/f1/spi.h index eb434a15..d2fe7c26 100644 --- a/include/libopencm3/stm32/f1/spi.h +++ b/include/libopencm3/stm32/f1/spi.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f1/usart.h b/include/libopencm3/stm32/f1/usart.h index 24a8137b..f18d2559 100644 --- a/include/libopencm3/stm32/f1/usart.h +++ b/include/libopencm3/stm32/f1/usart.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f2/crc.h b/include/libopencm3/stm32/f2/crc.h index bf2d9fe0..425eb615 100644 --- a/include/libopencm3/stm32/f2/crc.h +++ b/include/libopencm3/stm32/f2/crc.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - @date 18 August 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f2/dac.h b/include/libopencm3/stm32/f2/dac.h index f6e16e7b..326706c0 100644 --- a/include/libopencm3/stm32/f2/dac.h +++ b/include/libopencm3/stm32/f2/dac.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f2/dma.h b/include/libopencm3/stm32/f2/dma.h index 0eb952c4..5396bde1 100644 --- a/include/libopencm3/stm32/f2/dma.h +++ b/include/libopencm3/stm32/f2/dma.h @@ -1,4 +1,4 @@ -/** @defgroup STM32F2xx_dma_defines DMA Defines +/** @defgroup dma_defines DMA Defines @ingroup STM32F2xx_defines @@ -6,9 +6,6 @@ @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 diff --git a/include/libopencm3/stm32/f2/gpio.h b/include/libopencm3/stm32/f2/gpio.h index 099fb380..f9f000a3 100644 --- a/include/libopencm3/stm32/f2/gpio.h +++ b/include/libopencm3/stm32/f2/gpio.h @@ -6,10 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2009 Uwe Hermann -@author @htmlonly © @endhtmlonly 2012 Piotr Esden-Tempski -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 1 July 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f2/i2c.h b/include/libopencm3/stm32/f2/i2c.h index 3dc16528..7cc4bc81 100644 --- a/include/libopencm3/stm32/f2/i2c.h +++ b/include/libopencm3/stm32/f2/i2c.h @@ -6,9 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 12 October 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f2/iwdg.h b/include/libopencm3/stm32/f2/iwdg.h index d15f9a90..d25398fc 100644 --- a/include/libopencm3/stm32/f2/iwdg.h +++ b/include/libopencm3/stm32/f2/iwdg.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - @date 18 August 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f2/pwr.h b/include/libopencm3/stm32/f2/pwr.h index 7db223d2..7c765056 100644 --- a/include/libopencm3/stm32/f2/pwr.h +++ b/include/libopencm3/stm32/f2/pwr.h @@ -1,3 +1,16 @@ +/** @defgroup pwr_defines PWR Defines + +@brief Defined Constants and Types for the STM32F2xx PWR Control + +@ingroup STM32F2xx_defines + +@version 1.0.0 + +@date 4 March 2013 + +LGPL License Terms @ref lgpl_license + */ + /* * This file is part of the libopencm3 project. * diff --git a/include/libopencm3/stm32/f2/rtc.h b/include/libopencm3/stm32/f2/rtc.h index ebc09360..e78043ce 100644 --- a/include/libopencm3/stm32/f2/rtc.h +++ b/include/libopencm3/stm32/f2/rtc.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license @@ -36,4 +34,4 @@ LGPL License Terms @ref lgpl_license #include #include -#endif \ No newline at end of file +#endif diff --git a/include/libopencm3/stm32/f2/spi.h b/include/libopencm3/stm32/f2/spi.h index c1a5f45c..2c434288 100644 --- a/include/libopencm3/stm32/f2/spi.h +++ b/include/libopencm3/stm32/f2/spi.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f2/usart.h b/include/libopencm3/stm32/f2/usart.h index 31314bcd..8a4b54c2 100644 --- a/include/libopencm3/stm32/f2/usart.h +++ b/include/libopencm3/stm32/f2/usart.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/crc.h b/include/libopencm3/stm32/f4/crc.h index 1c375fab..bab8a23b 100644 --- a/include/libopencm3/stm32/f4/crc.h +++ b/include/libopencm3/stm32/f4/crc.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - @date 18 August 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/dac.h b/include/libopencm3/stm32/f4/dac.h index 0961c30d..1634fd74 100644 --- a/include/libopencm3/stm32/f4/dac.h +++ b/include/libopencm3/stm32/f4/dac.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/dma.h b/include/libopencm3/stm32/f4/dma.h index a3e9db11..1b308de0 100644 --- a/include/libopencm3/stm32/f4/dma.h +++ b/include/libopencm3/stm32/f4/dma.h @@ -1,4 +1,4 @@ -/** @defgroup STM32F4xx_dma_defines DMA Defines +/** @defgroup dma_defines DMA Defines @ingroup STM32F4xx_defines @@ -6,9 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2011 Fergus Noble -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 30 November 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/gpio.h b/include/libopencm3/stm32/f4/gpio.h index 4eedc6ef..dae8b923 100644 --- a/include/libopencm3/stm32/f4/gpio.h +++ b/include/libopencm3/stm32/f4/gpio.h @@ -6,10 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2009 Uwe Hermann -@author @htmlonly © @endhtmlonly 2012 Piotr Esden-Tempski -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 1 July 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/i2c.h b/include/libopencm3/stm32/f4/i2c.h index e1a41cf4..4f61f402 100644 --- a/include/libopencm3/stm32/f4/i2c.h +++ b/include/libopencm3/stm32/f4/i2c.h @@ -6,9 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 12 October 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/iwdg.h b/include/libopencm3/stm32/f4/iwdg.h index d5baef40..d708fb52 100644 --- a/include/libopencm3/stm32/f4/iwdg.h +++ b/include/libopencm3/stm32/f4/iwdg.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - @date 18 August 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/pwr.h b/include/libopencm3/stm32/f4/pwr.h index c9b27fd5..e07d4d70 100644 --- a/include/libopencm3/stm32/f4/pwr.h +++ b/include/libopencm3/stm32/f4/pwr.h @@ -8,6 +8,8 @@ @author @htmlonly © @endhtmlonly 2011 Stephen Caudle +@date 4 March 2013 + LGPL License Terms @ref lgpl_license */ /* diff --git a/include/libopencm3/stm32/f4/rtc.h b/include/libopencm3/stm32/f4/rtc.h index 55b5b23a..752895ba 100644 --- a/include/libopencm3/stm32/f4/rtc.h +++ b/include/libopencm3/stm32/f4/rtc.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/spi.h b/include/libopencm3/stm32/f4/spi.h index 65892905..5e2c5648 100644 --- a/include/libopencm3/stm32/f4/spi.h +++ b/include/libopencm3/stm32/f4/spi.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/f4/usart.h b/include/libopencm3/stm32/f4/usart.h index 740f0a87..6669e6b9 100644 --- a/include/libopencm3/stm32/f4/usart.h +++ b/include/libopencm3/stm32/f4/usart.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/l1/crc.h b/include/libopencm3/stm32/l1/crc.h index 07370f29..80194538 100644 --- a/include/libopencm3/stm32/l1/crc.h +++ b/include/libopencm3/stm32/l1/crc.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - @date 18 August 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/l1/dac.h b/include/libopencm3/stm32/l1/dac.h index 7f7ea526..8a8854c3 100644 --- a/include/libopencm3/stm32/l1/dac.h +++ b/include/libopencm3/stm32/l1/dac.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/l1/gpio.h b/include/libopencm3/stm32/l1/gpio.h index 93850a28..c4ab65fd 100644 --- a/include/libopencm3/stm32/l1/gpio.h +++ b/include/libopencm3/stm32/l1/gpio.h @@ -6,10 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2009 Uwe Hermann -@author @htmlonly © @endhtmlonly 2012 Piotr Esden-Tempski -@author @htmlonly © @endhtmlonly 2012 Karl Palsson - @date 1 July 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/l1/i2c.h b/include/libopencm3/stm32/l1/i2c.h index 1fd419d4..c2fd3ab4 100644 --- a/include/libopencm3/stm32/l1/i2c.h +++ b/include/libopencm3/stm32/l1/i2c.h @@ -6,9 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 12 October 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/l1/iwdg.h b/include/libopencm3/stm32/l1/iwdg.h index 8ba6c446..54c11ebd 100644 --- a/include/libopencm3/stm32/l1/iwdg.h +++ b/include/libopencm3/stm32/l1/iwdg.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2010 Thomas Otto - @date 18 August 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/l1/rtc.h b/include/libopencm3/stm32/l1/rtc.h index d364fb52..95331d32 100644 --- a/include/libopencm3/stm32/l1/rtc.h +++ b/include/libopencm3/stm32/l1/rtc.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license @@ -36,4 +34,4 @@ LGPL License Terms @ref lgpl_license #include #include -#endif \ No newline at end of file +#endif diff --git a/include/libopencm3/stm32/l1/spi.h b/include/libopencm3/stm32/l1/spi.h index 04849561..92f96d6b 100644 --- a/include/libopencm3/stm32/l1/spi.h +++ b/include/libopencm3/stm32/l1/spi.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/include/libopencm3/stm32/l1/usart.h b/include/libopencm3/stm32/l1/usart.h index 5b67a5a0..75bb049d 100644 --- a/include/libopencm3/stm32/l1/usart.h +++ b/include/libopencm3/stm32/l1/usart.h @@ -6,8 +6,6 @@ @version 1.0.0 -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - @date 5 December 2012 LGPL License Terms @ref lgpl_license diff --git a/lib/lm4f/rcc.c b/lib/lm4f/rcc.c index 48eb2a26..26c6c394 100644 --- a/lib/lm4f/rcc.c +++ b/lib/lm4f/rcc.c @@ -23,6 +23,8 @@ * * @ingroup LM4F * +@author @htmlonly © @endhtmlonly 2012 Alexandru Gagniuc + * \brief libopencm3 LM4F Clock control API * * The LM$F clock API provides functionaliity for manipulating the system clock, diff --git a/lib/stm32/common/crc_common_all.c b/lib/stm32/common/crc_common_all.c index d65d1b71..14b35eb5 100644 --- a/lib/stm32/common/crc_common_all.c +++ b/lib/stm32/common/crc_common_all.c @@ -1,13 +1,9 @@ /** @addtogroup crc_file -@version 1.0.0 - @author @htmlonly © @endhtmlonly 2012 Karl Palsson -@date 15 October 2012 +*/ -LGPL License Terms @ref lgpl_license - */ /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/common/dac_common_all.c b/lib/stm32/common/dac_common_all.c index a6be233f..b20b9c33 100644 --- a/lib/stm32/common/dac_common_all.c +++ b/lib/stm32/common/dac_common_all.c @@ -1,10 +1,6 @@ /** @addtogroup dac_file -@version 1.0.0 - -@author @htmlonly © @endhtmlonly 2012 Ken Sarkies - -@date 18 August 2012 +@author @htmlonly © @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net This library supports the Digital to Analog Conversion System in the STM32F series of ARM Cortex Microcontrollers by ST Microelectronics. diff --git a/lib/stm32/common/dma_common_f13.c b/lib/stm32/common/dma_common_f13.c index 35b9da64..9ef5b45a 100644 --- a/lib/stm32/common/dma_common_f13.c +++ b/lib/stm32/common/dma_common_f13.c @@ -1,11 +1,7 @@ /** @addtogroup dma_file -@version 1.0.0 - @author @htmlonly © @endhtmlonly 2010 Thomas Otto -@date 18 August 2012 - This library supports the DMA Control System in the STM32 series of ARM Cortex Microcontrollers by ST Microelectronics. @@ -42,7 +38,7 @@ LGPL License Terms @ref lgpl_license /**@{*/ -#include +#include /*-----------------------------------------------------------------------------*/ /** @brief DMA Channel Reset diff --git a/lib/stm32/common/dma_common_f24.c b/lib/stm32/common/dma_common_f24.c index 504c30e9..aa20e392 100644 --- a/lib/stm32/common/dma_common_f24.c +++ b/lib/stm32/common/dma_common_f24.c @@ -1,11 +1,7 @@ /** @addtogroup dma_file -@version 1.0.0 - @author @htmlonly © @endhtmlonly 2012 Ken Sarkies -@date 30 November 2012 - This library supports the DMA Control System in the STM32F2 and STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics. @@ -22,8 +18,8 @@ Each stream has access to a 4 word deep FIFO and can use double buffering by means of two memory pointers. When using the FIFO it is possible to configure transfers to occur in indivisible bursts. -It is also possible to select a peripheral to control the flow of data rather -than the DMA controller. This limits the functionality but is udeful when the +It is also possible to select a peripheral instead of the DMA controller to +control the flow of data. This limits the functionality but is useful when the number of transfers is unknown. LGPL License Terms @ref lgpl_license @@ -49,7 +45,7 @@ LGPL License Terms @ref lgpl_license /**@{*/ -#include +#include /*-----------------------------------------------------------------------------*/ /** @brief DMA Stream Reset diff --git a/lib/stm32/common/gpio_common_all.c b/lib/stm32/common/gpio_common_all.c index d23e4155..ef662e4d 100644 --- a/lib/stm32/common/gpio_common_all.c +++ b/lib/stm32/common/gpio_common_all.c @@ -1,4 +1,8 @@ -/** @addtogroup gpio_file */ +/** @addtogroup gpio_file + +@author @htmlonly © @endhtmlonly 2009 Uwe Hermann + +*/ /* * This file is part of the libopencm3 project. diff --git a/lib/stm32/common/gpio_common_f24.c b/lib/stm32/common/gpio_common_f24.c index 5b296935..63c18c3f 100644 --- a/lib/stm32/common/gpio_common_f24.c +++ b/lib/stm32/common/gpio_common_f24.c @@ -1,12 +1,8 @@ /** @addtogroup gpio_file -@version 1.0.0 - @author @htmlonly © @endhtmlonly 2009 Uwe Hermann @author @htmlonly © @endhtmlonly 2012 Ken Sarkies -@date 18 August 2012 - Each I/O port has 16 individually configurable bits. Many I/O pins share GPIO functionality with a number of alternate functions and must be configured to the alternate function mode if these are to be accessed. A feature is available to @@ -50,7 +46,6 @@ Example 2: Digital input on port C12 with pullup reg16 = gpio_port_read(GPIOC); @endcode -LGPL License Terms @ref lgpl_license */ /* * This file is part of the libopencm3 project. diff --git a/lib/stm32/common/i2c_common_all.c b/lib/stm32/common/i2c_common_all.c index 28ae199e..337fe9d1 100644 --- a/lib/stm32/common/i2c_common_all.c +++ b/lib/stm32/common/i2c_common_all.c @@ -1,12 +1,8 @@ /** @addtogroup i2c_file -@version 1.0.0 - @author @htmlonly © @endhtmlonly 2010 Thomas Otto @author @htmlonly © @endhtmlonly 2012 Ken Sarkies -@date 15 October 2012 - Devices can have up to two I2C peripherals. The peripherals support SMBus and PMBus variants. @@ -17,8 +13,7 @@ a multimaster contention is lost or a stop condition is generated. @todo all sorts of lovely stuff like DMA, Interrupts, SMBus variant, Status register access, Error conditions -LGPL License Terms @ref lgpl_license - */ +*/ /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/common/iwdg_common_all.c b/lib/stm32/common/iwdg_common_all.c index d3d93646..792adfe4 100644 --- a/lib/stm32/common/iwdg_common_all.c +++ b/lib/stm32/common/iwdg_common_all.c @@ -1,11 +1,7 @@ /** @addtogroup iwdg_file -@version 1.0.0 - @author @htmlonly © @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net -@date 18 August 2012 - This library supports the Independent Watchdog Timer System in the STM32F1xx series of ARM Cortex Microcontrollers by ST Microelectronics. @@ -20,8 +16,7 @@ relevant bit is not set, the IWDG timer must be enabled by software. @note: Tested: CPU STM32F103RET6, Board ET-ARM Stamp STM32 -LGPL License Terms @ref lgpl_license - */ +*/ /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/common/pwr_common_all.c b/lib/stm32/common/pwr_common_all.c index 451ed1cf..a4556648 100644 --- a/lib/stm32/common/pwr_common_all.c +++ b/lib/stm32/common/pwr_common_all.c @@ -1,19 +1,7 @@ -/** @defgroup STM32F1xx-pwr-file PWR - -@ingroup STM32F1xx - -@brief libopencm3 STM32F1xx Power Control - -@version 1.0.0 +/** @addtogroup pwr-file PWR @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/common/rtc_common_bcd.c b/lib/stm32/common/rtc_common_bcd.c index cddfe9bc..ff61a481 100644 --- a/lib/stm32/common/rtc_common_bcd.c +++ b/lib/stm32/common/rtc_common_bcd.c @@ -1,4 +1,8 @@ -/** @addtogroup rtc_file */ +/** @addtogroup rtc_file + +@author @htmlonly © @endhtmlonly 2012 Karl Palsson + +*/ /* * This file is part of the libopencm3 project. diff --git a/lib/stm32/common/spi_common_all.c b/lib/stm32/common/spi_common_all.c index 184654e8..2431d443 100644 --- a/lib/stm32/common/spi_common_all.c +++ b/lib/stm32/common/spi_common_all.c @@ -1,12 +1,8 @@ /** @addtogroup spi_file -@version 1.0.0 - @author @htmlonly © @endhtmlonly 2009 Uwe Hermann @author @htmlonly © @endhtmlonly 2012 Ken Sarkies -@date 15 October 2012 - Devices can have up to three SPI peripherals. The common 4-wire full-duplex mode of operation is supported, along with 3-wire variants using unidirectional communication modes or half-duplex bidirectional communication. A variety of @@ -32,8 +28,8 @@ LSB first. @todo need additional functions to aid ISRs in retrieving status -LGPL License Terms @ref lgpl_license - */ +*/ + /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/common/usart_common_all.c b/lib/stm32/common/usart_common_all.c index 0c3d3024..b550ba4d 100644 --- a/lib/stm32/common/usart_common_all.c +++ b/lib/stm32/common/usart_common_all.c @@ -1,18 +1,14 @@ /** @addtogroup usart_file -@version 1.0.0 - @author @htmlonly © @endhtmlonly 2009 Uwe Hermann -@date 30 August 2012 - This library supports the USART/UART in the STM32F series of ARM Cortex Microcontrollers by ST Microelectronics. Devices can have up to 3 USARTs and 2 UARTs. -LGPL License Terms @ref lgpl_license - */ +*/ + /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/f1/crc.c b/lib/stm32/f1/crc.c index 505fb798..8c880522 100644 --- a/lib/stm32/f1/crc.c +++ b/lib/stm32/f1/crc.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F1xx CRC +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f1/dac.c b/lib/stm32/f1/dac.c index 90dc029e..d0a23721 100644 --- a/lib/stm32/f1/dac.c +++ b/lib/stm32/f1/dac.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F1xx DAC +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f1/dma.c b/lib/stm32/f1/dma.c index f22baef4..31565083 100644 --- a/lib/stm32/f1/dma.c +++ b/lib/stm32/f1/dma.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F1xx DMA +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f1/i2c.c b/lib/stm32/f1/i2c.c index 2d86bf32..1f7e7a5a 100644 --- a/lib/stm32/f1/i2c.c +++ b/lib/stm32/f1/i2c.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F1xx I2C +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f1/iwdg.c b/lib/stm32/f1/iwdg.c index 85cf18c7..f44a9e47 100644 --- a/lib/stm32/f1/iwdg.c +++ b/lib/stm32/f1/iwdg.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F1xx Independent Watchdog Timer +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f1/pwr.c b/lib/stm32/f1/pwr.c index 451ed1cf..8e59bab1 100644 --- a/lib/stm32/f1/pwr.c +++ b/lib/stm32/f1/pwr.c @@ -1,4 +1,4 @@ -/** @defgroup STM32F1xx-pwr-file PWR +/** @defgroup pwr-file PWR @ingroup STM32F1xx @@ -38,180 +38,5 @@ LGPL License Terms @ref lgpl_license #include -/*---------------------------------------------------------------------------*/ -/** @brief Disable Backup Domain Write Protection. - -This allows backup domain registers to be changed. These registers are write -protected after a reset. -*/ - -void pwr_disable_backup_domain_write_protect(void) -{ - PWR_CR |= PWR_CR_DBP; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Re-enable Backup Domain Write Protection. - -This protects backup domain registers from inadvertent change. -*/ - -void pwr_enable_backup_domain_write_protect(void) -{ - PWR_CR &= ~PWR_CR_DBP; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Enable Power Voltage Detector. - -This provides voltage level threshold detection. The result of detection is -provided in the power voltage detector output flag (see @ref pwr_voltage_high) -or by setting the EXTI16 interrupt (see datasheet for configuration details). - -@param[in] pvd_level u32. Taken from @ref pwr_pls. -*/ - -void pwr_enable_power_voltage_detect(u32 pvd_level) -{ - PWR_CR &= ~PWR_CR_PLS_MASK; - PWR_CR |= (PWR_CR_PVDE | pvd_level); -} - -/*---------------------------------------------------------------------------*/ -/** @brief Disable Power Voltage Detector. - -*/ - -void pwr_disable_power_voltage_detect(void) -{ - PWR_CR &= ~PWR_CR_PVDE; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Clear the Standby Flag. - -This is set when the processor returns from a standby mode. -*/ - -void pwr_clear_standby_flag(void) -{ - PWR_CR |= PWR_CR_CSBF; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Clear the Wakeup Flag. - -This is set when the processor receives a wakeup signal. -*/ - -void pwr_clear_wakeup_flag(void) -{ - PWR_CR |= PWR_CR_CWUF; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Set Standby Mode in Deep Sleep. - -*/ - -void pwr_set_standby_mode(void) -{ - PWR_CR |= PWR_CR_PDDS; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Set Stop Mode in Deep Sleep. - -*/ - -void pwr_set_stop_mode(void) -{ - PWR_CR &= ~PWR_CR_PDDS; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Voltage Regulator On in Stop Mode. - -*/ - -void pwr_voltage_regulator_on_in_stop(void) -{ - PWR_CR &= ~PWR_CR_LPDS; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Voltage Regulator Low Power in Stop Mode. - -*/ - -void pwr_voltage_regulator_low_power_in_stop(void) -{ - PWR_CR |= PWR_CR_LPDS; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Enable Wakeup Pin. - -The wakeup pin is used for waking the processor from standby mode. -*/ - -void pwr_enable_wakeup_pin(void) -{ - PWR_CSR |= PWR_CSR_EWUP; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Release Wakeup Pin. - -The wakeup pin is used for general purpose I/O. -*/ - -void pwr_disable_wakeup_pin(void) -{ - PWR_CSR &= ~PWR_CSR_EWUP; -} - -/*---------------------------------------------------------------------------*/ -/** @brief Get Voltage Detector Output. - -The voltage detector threshold must be set when the power voltage detector is -enabled, see @ref pwr_enable_power_voltage_detect. - -@returns boolean: TRUE if the power voltage is above the preset voltage -threshold. -*/ - -bool pwr_voltage_high(void) -{ - return (PWR_CSR & PWR_CSR_PVDO); -} - -/*---------------------------------------------------------------------------*/ -/** @brief Get Standby Flag. - -The standby flag is set when the processor returns from a standby state. It is -cleared by software (see @ref pwr_clear_standby_flag). - -@returns boolean: TRUE if the processor was in standby state. -*/ - -bool pwr_get_standby_flag(void) -{ - return (PWR_CSR & PWR_CSR_SBF); -} - -/*---------------------------------------------------------------------------*/ -/** @brief Get Wakeup Flag. - -The wakeup flag is set when a wakeup event has been received. It is -cleared by software (see @ref pwr_clear_wakeup_flag). - -@returns boolean: TRUE if a wakeup event was received. -*/ - -bool pwr_get_wakeup_flag(void) -{ - return (PWR_CSR & PWR_CSR_WUF); -} /**@}*/ diff --git a/lib/stm32/f1/rtc.c b/lib/stm32/f1/rtc.c index cfc5f5b6..24b19ce3 100644 --- a/lib/stm32/f1/rtc.c +++ b/lib/stm32/f1/rtc.c @@ -1,3 +1,19 @@ +/** @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 +*/ + /* * This file is part of the libopencm3 project. * @@ -18,8 +34,8 @@ * along with this library. If not, see . */ -#include -#include +#include +#include #include void rtc_awake_from_off(osc_t clock_source) diff --git a/lib/stm32/f1/spi.c b/lib/stm32/f1/spi.c index 3be5c230..f3f36e32 100644 --- a/lib/stm32/f1/spi.c +++ b/lib/stm32/f1/spi.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F1xx SPI +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f1/usart.c b/lib/stm32/f1/usart.c index ecf2b06d..13e20b24 100644 --- a/lib/stm32/f1/usart.c +++ b/lib/stm32/f1/usart.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F1xx USART +@version 1.0.0 + +@date 30 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/crc.c b/lib/stm32/f2/crc.c index 5437f7c5..df352d12 100644 --- a/lib/stm32/f2/crc.c +++ b/lib/stm32/f2/crc.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx CRC +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/dac.c b/lib/stm32/f2/dac.c index 5d207032..ce9165b4 100644 --- a/lib/stm32/f2/dac.c +++ b/lib/stm32/f2/dac.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx DAC +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/dma.c b/lib/stm32/f2/dma.c index 8e8f7022..c9374ff1 100644 --- a/lib/stm32/f2/dma.c +++ b/lib/stm32/f2/dma.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx DMA +@version 1.0.0 + +@date 30 November 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/gpio.c b/lib/stm32/f2/gpio.c index a2dfc88a..370f59ba 100644 --- a/lib/stm32/f2/gpio.c +++ b/lib/stm32/f2/gpio.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx General Purpose I/O +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/i2c.c b/lib/stm32/f2/i2c.c index f20a8404..df0fcff1 100644 --- a/lib/stm32/f2/i2c.c +++ b/lib/stm32/f2/i2c.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx I2C +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/iwdg.c b/lib/stm32/f2/iwdg.c index 0440d883..80a223dc 100644 --- a/lib/stm32/f2/iwdg.c +++ b/lib/stm32/f2/iwdg.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx Independent Watchdog Timer +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/rtc.c b/lib/stm32/f2/rtc.c index 461d0b1a..310fe434 100644 --- a/lib/stm32/f2/rtc.c +++ b/lib/stm32/f2/rtc.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx RTC +@version 1.0.0 + +@date 4 March 2013 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/spi.c b/lib/stm32/f2/spi.c index bc4a4eef..ce157a5d 100644 --- a/lib/stm32/f2/spi.c +++ b/lib/stm32/f2/spi.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx SPI +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f2/usart.c b/lib/stm32/f2/usart.c index 225b706a..09c09002 100644 --- a/lib/stm32/f2/usart.c +++ b/lib/stm32/f2/usart.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F2xx USART +@version 1.0.0 + +@date 30 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/crc.c b/lib/stm32/f4/crc.c index 90e67822..1814fccc 100644 --- a/lib/stm32/f4/crc.c +++ b/lib/stm32/f4/crc.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx CRC +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/dac.c b/lib/stm32/f4/dac.c index 4776c413..19eaa4be 100644 --- a/lib/stm32/f4/dac.c +++ b/lib/stm32/f4/dac.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx DAC +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/dma.c b/lib/stm32/f4/dma.c index c9f5db68..75271a12 100644 --- a/lib/stm32/f4/dma.c +++ b/lib/stm32/f4/dma.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx DMA +@version 1.0.0 + +@date 30 November 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/gpio.c b/lib/stm32/f4/gpio.c index 96a6f450..db42e8da 100644 --- a/lib/stm32/f4/gpio.c +++ b/lib/stm32/f4/gpio.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx General Purpose I/O +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/i2c.c b/lib/stm32/f4/i2c.c index 3250faa3..ac6f1176 100644 --- a/lib/stm32/f4/i2c.c +++ b/lib/stm32/f4/i2c.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx I2C +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/iwdg.c b/lib/stm32/f4/iwdg.c index 9332fc4f..67985d6b 100644 --- a/lib/stm32/f4/iwdg.c +++ b/lib/stm32/f4/iwdg.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx Independent Watchdog Timer +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/pwr.c b/lib/stm32/f4/pwr.c index 7be34f42..e4921925 100644 --- a/lib/stm32/f4/pwr.c +++ b/lib/stm32/f4/pwr.c @@ -1,3 +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 +*/ /* * This file is part of the libopencm3 project. * @@ -17,7 +34,7 @@ * along with this library. If not, see . */ -#include +#include void pwr_set_vos_scale(vos_scale_t scale) { diff --git a/lib/stm32/f4/rtc.c b/lib/stm32/f4/rtc.c index 7e1b5ffe..77f56318 100644 --- a/lib/stm32/f4/rtc.c +++ b/lib/stm32/f4/rtc.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx RTC +@version 1.0.0 + +@date 4 March 2013 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/spi.c b/lib/stm32/f4/spi.c index 40f55016..050d8234 100644 --- a/lib/stm32/f4/spi.c +++ b/lib/stm32/f4/spi.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx SPI +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/f4/usart.c b/lib/stm32/f4/usart.c index e0f7be8d..201ff5d2 100644 --- a/lib/stm32/f4/usart.c +++ b/lib/stm32/f4/usart.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32F4xx USART +@version 1.0.0 + +@date 30 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/l1/crc.c b/lib/stm32/l1/crc.c index 7d513419..b85ecd59 100644 --- a/lib/stm32/l1/crc.c +++ b/lib/stm32/l1/crc.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32L1xx CRC +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/l1/dac.c b/lib/stm32/l1/dac.c index 534f9f10..b20457ca 100644 --- a/lib/stm32/l1/dac.c +++ b/lib/stm32/l1/dac.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32L1xx DAC +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/l1/gpio.c b/lib/stm32/l1/gpio.c index 7fc2012b..fd42ba87 100644 --- a/lib/stm32/l1/gpio.c +++ b/lib/stm32/l1/gpio.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32L1xx General Purpose I/O +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/l1/i2c.c b/lib/stm32/l1/i2c.c index 7a6fe848..00e9fa90 100644 --- a/lib/stm32/l1/i2c.c +++ b/lib/stm32/l1/i2c.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32L1xx I2C +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/l1/iwdg.c b/lib/stm32/l1/iwdg.c index 05ddf04e..b0b9593f 100644 --- a/lib/stm32/l1/iwdg.c +++ b/lib/stm32/l1/iwdg.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32L1xx Independent Watchdog Timer +@version 1.0.0 + +@date 18 August 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/l1/pwr.c b/lib/stm32/l1/pwr.c index 85418515..e7128998 100644 --- a/lib/stm32/l1/pwr.c +++ b/lib/stm32/l1/pwr.c @@ -1,3 +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 +*/ /* * This file is part of the libopencm3 project. * diff --git a/lib/stm32/l1/rtc.c b/lib/stm32/l1/rtc.c index bc7f87ff..1afd5973 100644 --- a/lib/stm32/l1/rtc.c +++ b/lib/stm32/l1/rtc.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32L1xx RTC +@version 1.0.0 + +@date 4 March 2013 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/l1/spi.c b/lib/stm32/l1/spi.c index 30c44dd3..c6887dcc 100644 --- a/lib/stm32/l1/spi.c +++ b/lib/stm32/l1/spi.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32L1xx SPI +@version 1.0.0 + +@date 15 October 2012 + +LGPL License Terms @ref lgpl_license */ /* diff --git a/lib/stm32/l1/usart.c b/lib/stm32/l1/usart.c index 67fd6746..3dc55c2c 100644 --- a/lib/stm32/l1/usart.c +++ b/lib/stm32/l1/usart.c @@ -4,6 +4,11 @@ @brief libopencm3 STM32L1xx USART +@version 1.0.0 + +@date 30 August 2012 + +LGPL License Terms @ref lgpl_license */ /*