EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Repair to documentation (most documented files)

Browse Source 
to remove errors, duplications and inconsistencies.
File lib/stm32/f1/pwr.c - all code removed as it duplicates that in common/pwr_common.c
Remaining changes do not affect code. Compiles OK.
TODO efm32 has no code so generates no modules
TODO F2 needs pwr.c
TODO L1 needs dma.h and dma.c
This commit is contained in:
Ken Sarkies
2013-03-07 11:14:06 +10:30
parent 31aa3b6f5a
commit e2022f5884
113 changed files with 457 additions and 403 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
include/libopencm3/efm32/efm32lg/doc-efm32lg.h Normal file
View File

@@ -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
*/

32
include/libopencm3/efm32/efm32tg/doc-efm32tg.h Normal file
View File

@@ -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
*/

8
include/libopencm3/stm32/common/crc_common_all.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup crc_defines */
/** @addtogroup crc_defines
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
*/
/*
* This file is part of the libopencm3 project.
@@ -19,7 +23,7 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/* 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

6
include/libopencm3/stm32/common/dac_common_all.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup dac_defines */
/** @addtogroup dac_defines
@author @htmlonly &copy; @endhtmlonly 2012 Felix Held <felix-libopencm3@felixheld.de>
*/
/*
* This file is part of the libopencm3 project.

8
include/libopencm3/stm32/common/dma_common_f13.h
View File

@@ -1,4 +1,10 @@
/** @addtogroup dma_defines */
/** @addtogroup dma_defines
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@author @htmlonly &copy; @endhtmlonly 2012 Piotr Esden-Tempski <piotr@esden.net>
*/
/*
* This file is part of the libopencm3 project.
*

7
include/libopencm3/stm32/common/dma_common_f24.h
View File

@@ -1,4 +1,9 @@
/** @addtogroup dma_defines */
/** @addtogroup dma_defines
@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
*/
/*
* This file is part of the libopencm3 project.
*

7
include/libopencm3/stm32/common/gpio_common_all.h
View File

@@ -1,4 +1,9 @@
/** @addtogroup gpio_defines */
/** @addtogroup gpio_defines
@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
*/
/*
* This file is part of the libopencm3 project.

7
include/libopencm3/stm32/common/gpio_common_f24.h
View File

@@ -1,4 +1,9 @@
/** @addtogroup gpio_defines */
/** @addtogroup gpio_defines
@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
*/
/*
* This file is part of the libopencm3 project.
*

6
include/libopencm3/stm32/common/i2c_common_all.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup i2c_defines */
/** @addtogroup i2c_defines
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
*/
/*
* This file is part of the libopencm3 project.

6
include/libopencm3/stm32/common/i2c_common_f24.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup i2c_defines */
/** @addtogroup i2c_defines
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
*/
/*
* This file is part of the libopencm3 project.

6
include/libopencm3/stm32/common/iwdg_common_all.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup iwdg_defines */
/** @addtogroup iwdg_defines
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
*/
/*
* This file is part of the libopencm3 project.
*

6
include/libopencm3/stm32/common/pwr_common_all.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup pwr_defines */
/** @addtogroup pwr_defines
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
*/
/*
* This file is part of the libopencm3 project.

6
include/libopencm3/stm32/common/rtc_common_bcd.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup rtc_defines */
/** @addtogroup rtc_defines
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
*/
/*
* This file is part of the libopencm3 project.
*

6
include/libopencm3/stm32/common/spi_common_all.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup spi_defines */
/** @addtogroup spi_defines
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
*/
/*
* This file is part of the libopencm3 project.

6
include/libopencm3/stm32/common/spi_common_f24.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup spi_defines */
/** @addtogroup spi_defines
@author @htmlonly &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
*/
/*
* This file is part of the libopencm3 project.
*

6
include/libopencm3/stm32/common/usart_common_all.h
View File

@@ -1,4 +1,8 @@
/** @addtogroup usart_defines */
/** @addtogroup usart_defines
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
*/
/*
* This file is part of the libopencm3 project.

7
include/libopencm3/stm32/common/usart_common_f24.h
View File

@@ -1,4 +1,9 @@
/** @addtogroup usart_defines */
/** @addtogroup usart_defines
@author @htmlonly &copy; @endhtmlonly 2011 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
*/
/*
* This file is part of the libopencm3 project.
*

29
include/libopencm3/stm32/doc-stm32f.h
View File

@@ -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
*/

2
include/libopencm3/stm32/f1/adc.h
View File

@@ -1,4 +1,4 @@
/** @defgroup STM32F1xx_adc_defines ADC Defines
/** @defgroup adc_defines ADC Defines
@brief <b>Defined Constants and Types for the STM32F1xx Analog to Digital Converters</b>

2
include/libopencm3/stm32/f1/crc.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f1/dac.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

5
include/libopencm3/stm32/f1/dma.h
View File

@@ -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 &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 30 November 2012
LGPL License Terms @ref lgpl_license

4
include/libopencm3/stm32/f1/gpio.h
View File

@@ -6,10 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Piotr Esden-Tempski <piotr@esden.net>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 1 July 2012
LGPL License Terms @ref lgpl_license

3
include/libopencm3/stm32/f1/i2c.h
View File

@@ -6,9 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 12 October 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f1/iwdg.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f1/pwr.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

14
include/libopencm3/stm32/f1/rtc.h
View File

@@ -1,3 +1,17 @@
/** @defgroup rtc_defines RTC Defines
@brief <b>Defined Constants and Types for the STM32F1xx Real Time Clock</b>
@ingroup STM32F1xx_defines
@author @htmlonly &copy; @endhtmlonly 2010 Uwe Hermann <uwe@hermann-uwe.de>
@version 1.0.0
@date 4 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

2
include/libopencm3/stm32/f1/spi.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f1/usart.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f2/crc.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f2/dac.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

5
include/libopencm3/stm32/f2/dma.h
View File

@@ -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 &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 18 October 2012
LGPL License Terms @ref lgpl_license

4
include/libopencm3/stm32/f2/gpio.h
View File

@@ -6,10 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Piotr Esden-Tempski <piotr@esden.net>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 1 July 2012
LGPL License Terms @ref lgpl_license

3
include/libopencm3/stm32/f2/i2c.h
View File

@@ -6,9 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 12 October 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f2/iwdg.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
LGPL License Terms @ref lgpl_license

13
include/libopencm3/stm32/f2/pwr.h
View File

@@ -1,3 +1,16 @@
/** @defgroup pwr_defines PWR Defines
@brief <b>Defined Constants and Types for the STM32F2xx PWR Control</b>
@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.
*

4
include/libopencm3/stm32/f2/rtc.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license
@@ -36,4 +34,4 @@ LGPL License Terms @ref lgpl_license
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/stm32/common/rtc_common_bcd.h>
#endif
#endif

2
include/libopencm3/stm32/f2/spi.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f2/usart.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f4/crc.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f4/dac.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

5
include/libopencm3/stm32/f4/dma.h
View File

@@ -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 &copy; @endhtmlonly 2011 Fergus Noble <fergusnoble@gmail.com>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 30 November 2012
LGPL License Terms @ref lgpl_license

4
include/libopencm3/stm32/f4/gpio.h
View File

@@ -6,10 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Piotr Esden-Tempski <piotr@esden.net>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 1 July 2012
LGPL License Terms @ref lgpl_license

3
include/libopencm3/stm32/f4/i2c.h
View File

@@ -6,9 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 12 October 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f4/iwdg.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f4/pwr.h
View File

@@ -8,6 +8,8 @@
@author @htmlonly &copy; @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
@date 4 March 2013
LGPL License Terms @ref lgpl_license
*/
/*

2
include/libopencm3/stm32/f4/rtc.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f4/spi.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/f4/usart.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/l1/crc.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/l1/dac.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

4
include/libopencm3/stm32/l1/gpio.h
View File

@@ -6,10 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Piotr Esden-Tempski <piotr@esden.net>
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
@date 1 July 2012
LGPL License Terms @ref lgpl_license

3
include/libopencm3/stm32/l1/i2c.h
View File

@@ -6,9 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 12 October 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/l1/iwdg.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
LGPL License Terms @ref lgpl_license

4
include/libopencm3/stm32/l1/rtc.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license
@@ -36,4 +34,4 @@ LGPL License Terms @ref lgpl_license
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/stm32/common/rtc_common_bcd.h>
#endif
#endif

2
include/libopencm3/stm32/l1/spi.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license

2
include/libopencm3/stm32/l1/usart.h
View File

@@ -6,8 +6,6 @@
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 5 December 2012
LGPL License Terms @ref lgpl_license