Repair to documentation (most documented files)

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

View File

@ -8,16 +8,16 @@
<tab type="user" visible="yes" url="../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="user" visible="yes" url="../../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../stm32l1/html/modules.html" title="STM32L1" intro=""/>
<tab type="user" visible="yes" url="../lm3s/html/modules.html" title="LM3S" intro=""/>
<tab type="user" visible="yes" url="../lm4f/html/modules.html" title="LM4F" intro=""/>
<tab type="user" visible="yes" url="../lpc13xx/html/modules.html" title="LPC13" intro=""/>
<tab type="user" visible="yes" url="../lpc17xx/html/modules.html" title="LPC17" intro=""/>
<tab type="user" visible="yes" url="../lpc43xx/html/modules.html" title="LPC43" intro=""/>
<tab type="user" visible="yes" url="../../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
<tab type="user" visible="yes" url="../../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
<tab type="user" visible="yes" url="../../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
<tab type="user" visible="yes" url="../../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
<tab type="user" visible="yes" url="../emf32g/html/modules.html" title="EMF32 Gecko" intro=""/>
<tab type="user" visible="yes" url="../emf32gg/html/modules.html" title="EMF32 Giant Gecko" intro=""/>
<tab type="user" visible="yes" url="../emf32lg/html/modules.html" title="EMF32 Leopard Gecko" intro=""/>
<tab type="user" visible="yes" url="../emf32tg/html/modules.html" title="EMF32 Tiny Gecko" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespaces" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>

View File

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

View File

@ -4,7 +4,6 @@
<tab type="mainpage" visible="yes" title="libopencm3"/>
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="modules" visible="yes" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../stm32/html/modules.html" title="STM32" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

View File

@ -24,7 +24,7 @@ INPUT += ../../lib/stm32/f2 \
EXCLUDE =
EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c
LAYOUT_FILE = DoxygenLayout_stm32f2.xml

View File

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

View File

@ -5,7 +5,7 @@
<tab type="pages" visible="yes" title="General Information" intro=""/>
<tab type="user" visible="yes" url="../../html/index.html" title="Back to Top" intro=""/>
<tab type="user" visible="yes" url="../../cm3/html/modules.html" title="CM3 Core" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="user" visible="yes" url="../../stm32f2/html/modules.html" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>
<tab type="modules" visible="yes" title="STM32L1" intro=""/>

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

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

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

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.

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.
*

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.
*

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.

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.
*

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.

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.

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.
*

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.

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.
*

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.

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.
*

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.

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.
*

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

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>

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

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

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

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

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

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

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

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.
*

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

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

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

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

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

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

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

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

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.
*

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

View File

@ -23,6 +23,8 @@
*
* @ingroup LM4F
*
@author @htmlonly &copy; @endhtmlonly 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
* \brief <b>libopencm3 LM4F Clock control API</b>
*
* The LM$F clock API provides functionaliity for manipulating the system clock,

View File

@ -1,13 +1,9 @@
/** @addtogroup crc_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@remake.is>
@date 15 October 2012
*/
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

View File

@ -1,10 +1,6 @@
/** @addtogroup dac_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies
@date 18 August 2012
@author @htmlonly &copy; @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.

View File

@ -1,11 +1,7 @@
/** @addtogroup dma_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@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 <libopencm3/stm32/f1/dma.h>
#include <libopencm3/stm32/dma.h>
/*-----------------------------------------------------------------------------*/
/** @brief DMA Channel Reset

View File

@ -1,11 +1,7 @@
/** @addtogroup dma_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@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 <libopencm3/stm32/f4/dma.h>
#include <libopencm3/stm32/dma.h>
/*-----------------------------------------------------------------------------*/
/** @brief DMA Stream Reset

View File

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

View File

@ -1,12 +1,8 @@
/** @addtogroup gpio_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@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.

View File

@ -1,12 +1,8 @@
/** @addtogroup i2c_file
@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 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.
*

View File

@ -1,11 +1,7 @@
/** @addtogroup iwdg_file
@version 1.0.0
@author @htmlonly &copy; @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.
*

View File

@ -1,19 +1,7 @@
/** @defgroup STM32F1xx-pwr-file PWR
@ingroup STM32F1xx
@brief <b>libopencm3 STM32F1xx Power Control</b>
@version 1.0.0
/** @addtogroup pwr-file PWR
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@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.

View File

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

View File

@ -1,12 +1,8 @@
/** @addtogroup spi_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@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.
*

View File

@ -1,18 +1,14 @@
/** @addtogroup usart_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@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.
*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx CRC</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx DAC</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx DMA</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx I2C</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx Independent Watchdog Timer</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -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 <libopencm3/stm32/pwr.h>
/*---------------------------------------------------------------------------*/
/** @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);
}
/**@}*/

View File

@ -1,3 +1,19 @@
/** @defgroup rtc_file RTC
@ingroup STM32F1xx
@brief <b>libopencm3 STM32F1xx RTC</b>
@author @htmlonly &copy; @endhtmlonly 2010 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2010 Lord James <lordjames@y7mail.com>
@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 <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/f1/rcc.h>
#include <libopencm3/stm32/f1/rtc.h>
#include <libopencm3/stm32/rcc.h>
#include <libopencm3/stm32/rtc.h>
#include <libopencm3/stm32/pwr.h>
void rtc_awake_from_off(osc_t clock_source)

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx SPI</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F1xx USART</b>
@version 1.0.0
@date 30 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx CRC</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx DAC</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx DMA</b>
@version 1.0.0
@date 30 November 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx General Purpose I/O</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx I2C</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx Independent Watchdog Timer</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx RTC</b>
@version 1.0.0
@date 4 March 2013
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx SPI</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F2xx USART</b>
@version 1.0.0
@date 30 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx CRC</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx DAC</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx DMA</b>
@version 1.0.0
@date 30 November 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx General Purpose I/O</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx I2C</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
/*

View File

@ -4,6 +4,11 @@
@brief <b>libopencm3 STM32F4xx Independent Watchdog Timer</b>
@version 1.0.0
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/*

Some files were not shown because too many files have changed in this diff Show More