electronics
/
libopencm3
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix a number of top level doxygen issues. 

So that the navigation pane works correctly in browsers.
Some additional doc fixes put in where found (but many more still to go).
Added some dummy .c and .h files to bring the associated docs into line.
makefile changed to allow 'make html' as well as 'make doc' (the latter only does html anyway).
This commit is contained in:
Ken Sarkies 2014-01-14 22:58:48 +10:30 committed by Frantisek Burian
parent a54a12e1c9
commit 3c6e9fd56d
78 changed files with 792 additions and 304 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@ -86,7 +86,8 @@ install: lib
@printf " INSTALL scripts\n"
$(Q)$(INSTALL) -m 0644 scripts/*.scr $(SHAREDIR)
doc:
html doc:
$(Q)$(MAKE) -C doc html
clean: $(IRQ_DEFN_FILES:=.cleanhdr) $(LIB_DIRS:=.clean) $(EXAMPLE_DIRS:=.clean) doc.clean styleclean

11
doc/Doxyfile
View File

@ -19,14 +19,3 @@ LAYOUT_FILE = DoxygenLayout.xml
GENERATE_LATEX = NO
TAGFILES = ./cm3/cm3.tag=../cm3/html \
./stm32/stm32.tag=../stm32/html \
./stm32f1/stm32f1.tag=../stm32f1/html \
./stm32f4/stm32f4.tag=../stm32f4/html \
./lm3s/lm3s.tag=../lm3s/html \
./lm4f/lm4f.tag=../lm4f/html \
./lpc13xx/lpc13xx.tag=../lpc13xx/html \
./lpc17xx/lpc17xx.tag=../lpc17xx/html \
./lpc43xx/lpc43xx.tag=../lpc43xx/html

39
doc/HACKING
View File

@ -11,18 +11,7 @@ structure is important and should be maintained.
Each of the subdirectories has a configuration file, a layout file and
subdirectories for the documentation. Doxygen is intended to be run inside
these subdirectories. The Makefile will handle this in the appropriate
order. Tag files are generated and used by other doxygen runs to resolve links.
Tagfiles
--------
Tagfiles contain all information about the document, and are used to resolve
references in other documents. The groups defined in these external documents
are not shown when EXTERNAL_GROUPS = NO. The high level tagfiles must be
generated before any others so order is important.
As well as the processor families, a "cm3" subdirectory is used to generate
a tagfile to integrate the CM3 common core defines.
order.
Markup
------
@ -50,6 +39,32 @@ date and version number must be omitted as it will be included from the family
files. There must not be any reference to family groupings as these common files
will be incorporated into multiple family groups.
The common files should not be included in an application explicitly. Also the
doxygen preprocessor must be enabled to ensure that all macros and defines are
included. This means that common header files need to have a section at the top
of the file of the type (eg for gpio_common_f24.h):
/** @cond */
#ifdef LIBOPENCM3_GPIO_H
/** @endcond */
and at the end of the file:
/** @cond */
#else
#warning "gpio_common_f24.h should not be included explicitly, only via gpio.h"
#endif
/** @endcond */
This will stop the compiler preprocessor from including the common header file
unless the device family header file has also been included. The doxygen
conditional clauses are needed to stop the doxygen preprocessor seeing this
statement and so excluding processing of the common file contents.
/** @cond */
#if defined(LIBOPENCM3_GPIO_H) || defined(LIBOPENCM3_GPIO_COMMON_F24_H)
/** @endcond */
Each helper function must have a header with an @brief, and where appropriate
additional description, @parameter and @return elements. These latter must
describe the allowable parameter ranges preferably with reference to a suitable

1
doc/cm3/DoxygenLayout_cm3.xml
View File

@ -4,6 +4,7 @@
<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="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f0/html/modules.html" title="STM32F0" 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=""/>

4
doc/efm32g/Doxyfile
View File

@ -23,10 +23,8 @@ EXCLUDE =
LAYOUT_FILE = DoxygenLayout_efm32g.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
GENERATE_TAGFILE = efm32g.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

4
doc/efm32gg/Doxyfile
View File

@ -23,10 +23,8 @@ EXCLUDE =
LAYOUT_FILE = DoxygenLayout_efm32gg.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
GENERATE_TAGFILE = efm32gg.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

4
doc/efm32lg/Doxyfile
View File

@ -23,10 +23,8 @@ EXCLUDE =
LAYOUT_FILE = DoxygenLayout_efm32lg.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
GENERATE_TAGFILE = efm32lg.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

4
doc/efm32tg/Doxyfile
View File

@ -23,10 +23,8 @@ EXCLUDE =
LAYOUT_FILE = DoxygenLayout_efm32tg.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html \
GENERATE_TAGFILE = efm32tg.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

4
doc/lm3s/Doxyfile
View File

@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \
LAYOUT_FILE = DoxygenLayout_lm3s.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = lm3s.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

4
doc/lm4f/Doxyfile
View File

@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \
LAYOUT_FILE = DoxygenLayout_lm4f.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = lm4f.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

4
doc/lpc13xx/Doxyfile
View File

@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \
LAYOUT_FILE = DoxygenLayout_lpc13xx.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = lpc13xx.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

4
doc/lpc17xx/Doxyfile
View File

@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \
LAYOUT_FILE = DoxygenLayout_lpc17xx.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = lpc17xx.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

4
doc/lpc43xx/Doxyfile
View File

@ -21,10 +21,8 @@ INPUT = ../../include/libopencm3/license.dox \
LAYOUT_FILE = DoxygenLayout_lpc43xx.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = lpc43xx.tag
ENABLE_PREPROCESSING = NO
ENABLE_PREPROCESSING = YES

20
doc/stm32f0/Doxyfile
View File

@ -13,26 +13,26 @@
# Local settings
#---------------------------------------------------------------------------
WARN_LOGFILE = doxygen_stm32f0.log
WARN_LOGFILE = doxygen_stm32f0.log
INPUT = ../../include/libopencm3/license.dox \
INPUT = ../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/f0 \
../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/f0 \
INPUT += ../../lib/stm32/f0 \
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/f0/usb.h \
EXCLUDE = ../../include/libopencm3/stm32/f0/usb.h \
../../include/libopencm3/stm32/f0/usb_desc.h
EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
EXCLUDE_PATTERNS = *_common_*f24.h *_common_*f24.c \
*_common_*f234.h *_common_*f234.c \
*_common_*f124.h *_common_*f124.c
LAYOUT_FILE = DoxygenLayout_stm32f0.xml
LAYOUT_FILE = DoxygenLayout_stm32f0.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = stm32f0.tag
GENERATE_TAGFILE = stm32f0.tag
ENABLE_PREPROCESSING = YES
ENABLE_PREPROCESSING = YES

7
doc/stm32f1/Doxyfile
View File

@ -25,12 +25,13 @@ INPUT += ../../lib/stm32/f1 \
EXCLUDE = ../../include/libopencm3/stm32/f1/usb.h \
../../include/libopencm3/stm32/f1/usb_desc.h
EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
EXCLUDE_PATTERNS = *_common_*f24.h *_common_*f24.c \
*_common_*f234.h *_common_*f234.c \
*_common_*f024.h *_common_*f024.c \
*_common_*f03.h *_common_*f03.c
LAYOUT_FILE = DoxygenLayout_stm32f1.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = stm32f1.tag
ENABLE_PREPROCESSING = YES

8
doc/stm32f2/Doxyfile
View File

@ -22,14 +22,14 @@ INPUT = ../../include/libopencm3/license.dox \
INPUT += ../../lib/stm32/f2 \
../../lib/stm32/common
EXCLUDE =
EXCLUDE =
EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c
EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c \
*_common_*f013.h *_common_*f013.c \
*_common_*f03.h *_common_*f03.c
LAYOUT_FILE = DoxygenLayout_stm32f2.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = stm32f2.tag
ENABLE_PREPROCESSING = YES

8
doc/stm32f3/Doxyfile
View File

@ -22,15 +22,11 @@ INPUT += ../../lib/stm32/f3 \
EXCLUDE = ../../include/libopencm3/stm32/f3/usb.h \
../../include/libopencm3/stm32/f3/usb_desc.h
EXCLUDE_PATTERNS = *_common_f24.h *_common_f24.c
EXCLUDE_PATTERNS += *_common_f124.h *_common_f124.c
EXCLUDE_PATTERNS += *_common_l1f24.h *_common_l1f24.c
EXCLUDE_PATTERNS += *_common_bcd.h *_common_bcd.c
EXCLUDE_PATTERNS = *_common_*f*24.h *_common_*f*24.c \
*_common_bcd.h *_common_bcd.c
LAYOUT_FILE = DoxygenLayout_stm32f3.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = stm32f3.tag
ENABLE_PREPROCESSING = YES

8
doc/stm32f4/Doxyfile
View File

@ -22,14 +22,14 @@ INPUT = ../../include/libopencm3/license.dox \
INPUT += ../../lib/stm32/f4 \
../../lib/stm32/common
EXCLUDE =
EXCLUDE =
EXCLUDE_PATTERNS = *_common_f13.h *_common_f13.c
EXCLUDE_PATTERNS = *_common_f*3.h *_common_f*3.c \
*_common_*f013.h *_common_*f013.c \
*_common_*f03.h *_common_*f03.c
LAYOUT_FILE = DoxygenLayout_stm32f4.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
GENERATE_TAGFILE = stm32f4.tag
ENABLE_PREPROCESSING = YES

22
doc/stm32l1/Doxyfile
View File

@ -7,7 +7,7 @@
# Common Include File
#---------------------------------------------------------------------------
@INCLUDE = ../Doxyfile_common
@INCLUDE = ../Doxyfile_common
#---------------------------------------------------------------------------
# Local settings
@ -16,26 +16,28 @@
WARN_LOGFILE = doxygen_stm32l1.log
INPUT = ../../include/libopencm3/license.dox \
../../include/libopencm3/stm32/l1 \
../../include/libopencm3/stm32/common
../../include/libopencm3/stm32/l1 \
../../include/libopencm3/stm32/common
INPUT += ../../lib/stm32/l1 \
../../lib/stm32/common
../../lib/stm32/common
EXCLUDE = ../../include/libopencm3/stm32/common/gpio_common_f24.h \
../../include/libopencm3/stm32/common/timer_common_f24.h
../../include/libopencm3/stm32/common/timer_common_f24.h \
../../include/libopencm3/stm32/common/crypto_common_f24.h \
../../include/libopencm3/stm32/common/hash_common_f24.h
EXCLUDE += ../../lib/stm32/common/gpio_common_f24.c \
../../lib/stm32/common/timer_common_f24.c
../../lib/stm32/common/timer_common_f24.c \
../../lib/stm32/common/crypto_common_f24.c \
../../lib/stm32/common/hash_common_f24.c
EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_stm32l1.xml
TAGFILES = ../cm3/cm3.tag=../../cm3/html
LAYOUT_FILE = DoxygenLayout_stm32l1.xml
GENERATE_TAGFILE = stm32l1.tag
ENABLE_PREPROCESSING = YES
ENABLE_PREPROCESSING = YES

2
doc/usb/Doxyfile
View File

@ -24,8 +24,6 @@ EXCLUDE_PATTERNS =
LAYOUT_FILE = DoxygenLayout_usb.xml
TAGFILES =
GENERATE_TAGFILE = usb.tag
ENABLE_PREPROCESSING = NO

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

@ -1,3 +1,8 @@
/** @addtogroup exti_defines
*
* @author @htmlonly &copy; @endhtmlonly 2010
* Mark Butler <mbutler@physics.otago.ac.nz>
*/
/*
* This file is part of the libopencm3 project.
*
@ -22,6 +27,7 @@
/** @endcond */
#ifndef LIBOPENCM3_EXTI_COMMON_ALL_H
#define LIBOPENCM3_EXTI_COMMON_ALL_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/cm3/common.h>
@ -74,6 +80,7 @@ void exti_select_source(uint32_t exti, uint32_t gpioport);
uint32_t exti_get_flag_status(uint32_t exti);
END_DECLS
/**@}*/
#endif
/** @cond */

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

@ -1,3 +1,8 @@
/** @addtogroup exti_defines
*
* @author @htmlonly &copy; @endhtmlonly 2010
* Mark Butler <mbutler@physics.otago.ac.nz>
*/
/*
* This file is part of the libopencm3 project.
*
@ -22,6 +27,7 @@
/** @endcond */
#ifndef LIBOPENCM3_EXTI_COMMON_F24_H
#define LIBOPENCM3_EXTI_COMMON_F24_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/cm3/common.h>
@ -31,6 +37,7 @@
#define EXTI20 (1 << 20)
#define EXTI21 (1 << 21)
#define EXTI22 (1 << 22)
/**@}*/
#endif
/** @cond */

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

@ -1,12 +1,11 @@
/** @addtogroup gpio_defines
@author @htmlonly &copy; @endhtmlonly 2011
Fergus Noble <fergusnoble@gmail.com>
@author @htmlonly &copy; @endhtmlonly 2012
Ken Sarkies <ksarkies@internode.on.net>
*/
*
* @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.
*
@ -32,7 +31,7 @@ The order of header inclusion is important. gpio.h includes the device
specific memorymap.h header before including this header file.*/
/** @cond */
#if defined(LIBOPENCM3_GPIO_H) || defined(LIBOPENCM3_GPIO_COMMON_F24_H)
#if defined(LIBOPENCM3_GPIO_H)
/** @endcond */
#ifndef LIBOPENCM3_GPIO_COMMON_ALL_H
#define LIBOPENCM3_GPIO_COMMON_ALL_H

14
include/libopencm3/stm32/common/gpio_common_f234.h
View File

@ -1,11 +1,11 @@
/** @addtogroup gpio_defines
@author @htmlonly &copy; @endhtmlonly 2011
Fergus Noble <fergusnoble@gmail.com>
@author @htmlonly &copy; @endhtmlonly 2012
Ken Sarkies <ksarkies@internode.on.net>
*/
*
* @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.
*

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

@ -1,11 +1,11 @@
/** @addtogroup gpio_defines
@author @htmlonly &copy; @endhtmlonly 2011
Fergus Noble <fergusnoble@gmail.com>
@author @htmlonly &copy; @endhtmlonly 2012
Ken Sarkies <ksarkies@internode.on.net>
*/
*
* @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.
*
@ -103,6 +103,7 @@ specific memorymap.h header before including this header file.*/
#define GPIOH_AFRH GPIO_AFRH(GPIOH)
#define GPIOI_AFRH GPIO_AFRH(GPIOI)
/**@}*/
#endif
/** @cond */
#else

16
include/libopencm3/stm32/common/hash_common_f24.h
View File

@ -1,10 +1,9 @@
/** @addtogroup hash_defines
@author @htmlonly &copy; @endhtmlonly 2013
Mikhail Avkhimenia <mikhail@avkhimenia.net>
*/
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Mikhail Avkhimenia <mikhail@avkhimenia.net>
*
*/
/*
* This file is part of the libopencm3 project.
*
@ -26,7 +25,9 @@ Mikhail Avkhimenia <mikhail@avkhimenia.net>
/**@{*/
/** @cond */
#ifdef LIBOPENCM3_HASH_H
/** @endcond */
#ifndef LIBOPENCM3_HASH_COMMON_F24_H
#define LIBOPENCM3_HASH_COMMON_F24_H
@ -174,6 +175,9 @@ void hash_get_result(uint32_t *data);
END_DECLS
/**@}*/
#endif
/** @cond */
#else
#warning "hash_common_f24.h should not be included explicitly, only via hash.h"
#endif
/** @endcond */

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

@ -1,9 +1,8 @@
/** @addtogroup i2c_defines
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
*/
*
* @author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
*
*/
/*
* This file is part of the libopencm3 project.
*
@ -28,7 +27,7 @@ The order of header inclusion is important. i2c.h includes the device
specific memorymap.h header before including this header file.*/
/** @cond */
#if defined(LIBOPENCM3_I2C_H) || defined(LIBOPENCM3_I2C_COMMON_F24_H)
#if defined(LIBOPENCM3_I2C_H)
/** @endcond */
#ifndef LIBOPENCM3_I2C_COMMON_ALL_H
#define LIBOPENCM3_I2C_COMMON_ALL_H

13
include/libopencm3/stm32/common/rcc_common_all.h
View File

@ -1,4 +1,8 @@
/** @addtogroup rcc_defines
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Frantisek Burian <BuFran@seznam.cz>
*/
/*
* This file is part of the libopencm3 project.
*
@ -29,6 +33,7 @@
#ifndef LIBOPENCM3_RCC_COMMON_ALL_H
#define LIBOPENCM3_RCC_COMMON_ALL_H
/**@{*/
BEGIN_DECLS
@ -44,6 +49,12 @@ void rcc_periph_reset_hold(enum rcc_periph_rst rst);
void rcc_periph_reset_release(enum rcc_periph_rst rst);
END_DECLS
/**@}*/
#endif
/** @cond */
#else
#warning "rcc_common_all.h should not be included explicitly, only via rcc.h"
#endif
/** @endcond */

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

@ -1,9 +1,8 @@
/** @addtogroup spi_defines
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
*/
*
* @author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
*
*/
/*
* This file is part of the libopencm3 project.
*
@ -28,7 +27,7 @@ The order of header inclusion is important. spi.h includes the device
specific memorymap.h header before including this header file.*/
/** @cond */
#if defined(LIBOPENCM3_SPI_H) || defined(LIBOPENCM3_SPI_COMMON_F24_H)
#if defined(LIBOPENCM3_SPI_H)
/** @endcond */
#ifndef LIBOPENCM3_SPI_COMMON_ALL_H
#define LIBOPENCM3_SPI_COMMON_ALL_H

9
include/libopencm3/stm32/common/syscfg_common_l1f234.h
View File

@ -1,3 +1,9 @@
/** @addtogroup syscfg_defines
*
* @author @htmlonly &copy; @endhtmlonly 2011
* Fergus Noble <fergusnoble@gmail.com>
*
*/
/*
* This file is part of the libopencm3 project.
*
@ -27,7 +33,7 @@ specific memorymap.h header before including this header file.*/
#ifndef LIBOPENCM3_SYSCFG_COMMON_L1F234_H
#define LIBOPENCM3_SYSCFG_COMMON_L1F234_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
@ -47,6 +53,7 @@ specific memorymap.h header before including this header file.*/
#define SYSCFG_CMPCR MMIO32(SYSCFG_BASE + 0x20)
#endif
/**@}*/
/** @cond */
#else

11
include/libopencm3/stm32/common/timer_common_all.h
View File

@ -1,9 +1,8 @@
/** @addtogroup timer_defines
@author @htmlonly &copy; @endhtmlonly 2009 Piotr Esden-Tempski <piotr@esden.net>
*/
*
* @author @htmlonly &copy; @endhtmlonly 2009 Piotr Esden-Tempski <piotr@esden.net>
*
*/
/*
* This file is part of the libopencm3 project.
*
@ -30,7 +29,7 @@ The order of header inclusion is important. timer.h includes the device
specific memorymap.h header before including this header file.*/
/** @cond */
#if defined(LIBOPENCM3_TIMER_H) || defined(LIBOPENCM3_TIMER_COMMON_F24_H)
#if defined(LIBOPENCM3_TIMER_H)
/** @endcond */
#ifndef LIBOPENCM3_TIMER_COMMON_H
#define LIBOPENCM3_TIMER_COMMON_H

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

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

2
include/libopencm3/stm32/f0/cec.h
View File

@ -31,6 +31,7 @@
#ifndef LIBOPENCM3_CEC_H
#define LIBOPENCM3_CEC_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/stm32/memorymap.h>
@ -122,5 +123,6 @@
BEGIN_DECLS
END_DECLS
/**@}*/
#endif

2
include/libopencm3/stm32/f0/comparator.h
View File

@ -32,6 +32,7 @@
#ifndef LIBOPENCM3_COMP_H
#define LIBOPENCM3_COMP_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/stm32/memorymap.h>
@ -121,5 +122,6 @@ void comp_select_hyst(uint8_t id, uint32_t hyst);
void comp_select_speed(uint8_t id, uint32_t speed);
END_DECLS
/**@}*/
#endif

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

@ -32,6 +32,7 @@
#ifndef LIBOPENCM3_CRC_H
#define LIBOPENCM3_CRC_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/stm32/common/crc_common_all.h>
@ -67,5 +68,6 @@
BEGIN_DECLS
END_DECLS
/**@}*/
#endif

2
include/libopencm3/stm32/f0/exti.h
View File

@ -32,8 +32,10 @@
#ifndef LIBOPENCM3_EXTI_H
#define LIBOPENCM3_EXTI_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/stm32/common/exti_common_all.h>
/**@}*/
#endif

6
include/libopencm3/stm32/f0/rcc.h
View File

@ -1,9 +1,13 @@
/** @defgroup rcc_defines RCC Defines
*
* @brief <b>libopencm3 STM32F0xx Reset and Clock Control</b>
* @brief <b>Defined Constants and Types for the STM32F0xx Reset and Clock
Control</b>
*
* @ingroup STM32F0xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Frantisek Burian <BuFran@seznam.cz>
*
* @version 1.0.0
*
* @date 29 Jun 2013

7
include/libopencm3/stm32/f0/syscfg.h
View File

@ -6,7 +6,10 @@
*
* @version 1.0.0
*
* @date 11 July 2013
* @author @htmlonly &copy; @endhtmlonly 2013
* Frantisek Burian <BuFran@seznam.cz>
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
@ -31,6 +34,7 @@
#ifndef LIBOPENCM3_SYSCFG_H
#define LIBOPENCM3_SYSCFG_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/stm32/memorymap.h>
@ -104,5 +108,6 @@
BEGIN_DECLS
END_DECLS
/**@}*/
#endif

2
include/libopencm3/stm32/f0/tsc.h
View File

@ -31,6 +31,7 @@
#ifndef LIBOPENCM3_TSC_H
#define LIBOPENCM3_TSC_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/stm32/memorymap.h>
@ -156,5 +157,6 @@
BEGIN_DECLS
END_DECLS
/**@}*/
#endif

16
include/libopencm3/stm32/f1/exti.h
View File

@ -1,3 +1,19 @@
/** @defgroup exti_defines EXTI Defines
*
* @brief <b>Defined Constants and Types for the STM32F1xx External Interrupts
* </b>
*
* @ingroup STM32F1xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Piotr Esden-Tempski <piotr@esden.net>
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

35
include/libopencm3/stm32/f1/rcc.h
View File

@ -1,20 +1,21 @@
/** @defgroup STM32F1xx_rcc_defines RCC Defines
@brief <b>libopencm3 STM32F1xx Reset and Clock Control</b>
@ingroup STM32F1xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009
Federico Ruiz-Ugalde \<memeruiz at gmail dot com\>
@author @htmlonly &copy; @endhtmlonly 2009
Uwe Hermann <uwe@hermann-uwe.de>
@date 18 August 2012
LGPL License Terms @ref lgpl_license
*/
/** @defgroup rcc_defines RCC Defines
*
* @brief <b>Defined Constants and Types for the STM32F1xx Reset and Clock
* Control</b>
*
* @ingroup STM32F1xx_defines
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2009
* Federico Ruiz-Ugalde \<memeruiz at gmail dot com\>
* @author @htmlonly &copy; @endhtmlonly 2009
* Uwe Hermann <uwe@hermann-uwe.de>
*
* @date 18 August 2012
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.
*

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

@ -1,17 +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
*/
*
* @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.
*
@ -38,6 +38,7 @@ LGPL License Terms @ref lgpl_license
#ifndef LIBOPENCM3_RTC_H
#define LIBOPENCM3_RTC_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/cm3/common.h>
@ -166,5 +167,6 @@ void rtc_awake_from_standby(void);
void rtc_auto_awake(enum rcc_osc clock_source, uint32_t prescale_val);
END_DECLS
/**@}*/
#endif

16
include/libopencm3/stm32/f2/exti.h
View File

@ -1,3 +1,19 @@
/** @defgroup exti_defines EXTI Defines
*
* @brief <b>Defined Constants and Types for the STM32F2xx External Interrupts
* </b>
*
* @ingroup STM32F2xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Piotr Esden-Tempski <piotr@esden.net>
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

23
include/libopencm3/stm32/f2/rcc.h
View File

@ -1,3 +1,23 @@
/** @defgroup rcc_defines RCC Defines
*
* @brief <b>Defined Constants and Types for the STM32F2xx Reset and Clock
* Control</b>
*
* @ingroup STM32F2xx_defines
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2009
* Federico Ruiz-Ugalde \<memeruiz at gmail dot com\>
* @author @htmlonly &copy; @endhtmlonly 2009
* Uwe Hermann <uwe@hermann-uwe.de>
* @author @htmlonly &copy; @endhtmlonly 2011
* Fergus Noble <fergusnoble@gmail.com>
*
* @date 18 August 2012
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.
*
@ -18,6 +38,7 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#ifndef LIBOPENCM3_RCC_H
#define LIBOPENCM3_RCC_H
@ -734,3 +755,5 @@ void rcc_backupdomain_reset(void);
END_DECLS
#endif
/**@}*/

19
include/libopencm3/stm32/f2/syscfg.h
View File

@ -1,3 +1,19 @@
/** @defgroup syscfg_defines SYSCFG Defines
*
* @ingroup STM32F2xx_defines
*
* @brief Defined Constants and Types for the STM32F2xx Sysconfig
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Frantisek Burian <BuFran@seznam.cz>
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.
*
@ -16,6 +32,7 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#ifndef LIBOPENCM3_SYSCFG_H
#define LIBOPENCM3_SYSCFG_H
@ -24,3 +41,5 @@
#include <libopencm3/stm32/common/syscfg_common_l1f234.h>
#endif
/**@}*/

7
include/libopencm3/stm32/f3/exti.h
View File

@ -5,9 +5,12 @@
*
* @ingroup STM32F3xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Piotr Esden-Tempski <piotr@esden.net>
*
* @version 1.0.0
*
* @date 11 July 2013
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
@ -32,6 +35,7 @@
#ifndef LIBOPENCM3_EXTI_H
#define LIBOPENCM3_EXTI_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/stm32/common/exti_common_all.h>
@ -43,5 +47,6 @@
#define EXTI_FTSR2 MMIO32(EXTI_BASE + 0x24)
#define EXTI_SWIER2 MMIO32(EXTI_BASE + 0x28)
#define EXTI_PR2 MMIO32(EXTI_BASE + 0x2C)
/**@}*/
#endif

7
include/libopencm3/stm32/f3/pwr.h
View File

@ -4,6 +4,13 @@
*
* @ingroup STM32F3xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2011
* Stephen Caudle <scaudle@doceme.com>
* @author @htmlonly &copy; @endhtmlonly 2013
* Fernando Cortes <fernando.corcam@gmail.com>
* @author @htmlonly &copy; @endhtmlonly 2013
* Guillermo Rivera <memogrg@gmail.com>
*
* @version 1.0.0
*
* @date 11 July 2013

15
include/libopencm3/stm32/f3/rcc.h
View File

@ -1,10 +1,23 @@
/** @defgroup rcc_defines RCC Defines
*
* @brief <b>Defined Constants and Types for the STM32F3xx Reset and Clock
* control</b>
* Control</b>
*
* @ingroup STM32F3xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2009
* Federico Ruiz-Ugalde \<memeruiz at gmail dot com\>
* @author @htmlonly &copy; @endhtmlonly 2009
* Uwe Hermann <uwe@hermann-uwe.de>
* @author @htmlonly &copy; @endhtmlonly 2011
* Fergus Noble <fergusnoble@gmail.com>
* @author @htmlonly &copy; @endhtmlonly 2011
* Stephen Caudle <scaudle@doceme.com>
* @author @htmlonly &copy; @endhtmlonly 2013
* Fernando Cortes <fernando.corcam@gmail.com>
* @author @htmlonly &copy; @endhtmlonly 2013
* Guillermo Rivera <memogrg@gmail.com>
*
* @version 1.0.0
*
* @date 11 July 2013

43
include/libopencm3/stm32/f3/rtc.h Normal file
View File

@ -0,0 +1,43 @@
/** @defgroup rtc_defines RTC Defines
*
* @brief <b>Defined Constants and Types for the STM32F3xx Real Time Clock </b>
*
* @ingroup STM32F3xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2014
* Ken Sarkies <ksarkies@internode.on.net>
*
* @version 1.0.0
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_RTC_F3_H
#define LIBOPENCM3_RTC_F3_H
/**@{*/
#include <libopencm3/stm32/rtc.h>
#include <libopencm3/stm32/common/rtc_common_all.h>
/**@}*/
#endif

16
include/libopencm3/stm32/f3/syscfg.h
View File

@ -1,3 +1,19 @@
/** @defgroup syscfg_defines SYSCFG Defines
*
* @ingroup STM32F3xx_defines
*
* @brief Defined Constants and Types for the STM32F3xx Sysconfig
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Frantisek Burian <BuFran@seznam.cz>
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.
*

16
include/libopencm3/stm32/f4/exti.h
View File

@ -1,3 +1,19 @@
/** @defgroup exti_defines EXTI Defines
*
* @brief <b>Defined Constants and Types for the STM32F4xx External Interrupts
* </b>
*
* @ingroup STM32F4xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Piotr Esden-Tempski <piotr@esden.net>
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

22
include/libopencm3/stm32/f4/rcc.h
View File

@ -1,3 +1,25 @@
/** @defgroup rcc_defines RCC Defines
*
* @brief <b>Defined Constants and Types for the STM32F4xx Reset and Clock
* Control</b>
*
* @ingroup STM32F4xx_defines
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2009
* Federico Ruiz-Ugalde \<memeruiz at gmail dot com\>
* @author @htmlonly &copy; @endhtmlonly 2009
* Uwe Hermann <uwe@hermann-uwe.de>
* @author @htmlonly &copy; @endhtmlonly 2011
* Fergus Noble <fergusnoble@gmail.com>
* @author @htmlonly &copy; @endhtmlonly 2011
* Stephen Caudle <scaudle@doceme.com>
*
* @date 18 August 2012
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.
*

16
include/libopencm3/stm32/f4/syscfg.h
View File

@ -1,3 +1,19 @@
/** @defgroup syscfg_defines SYSCFG Defines
*
* @ingroup STM32F4xx_defines
*
* @brief Defined Constants and Types for the STM32F4xx Sysconfig
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Frantisek Burian <BuFran@seznam.cz>
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.
*

34
include/libopencm3/stm32/l1/dma.h
View File

@ -1,20 +1,20 @@
/** @defgroup STM32L1xx_dma_defines DMA Defines
@ingroup STM32L1xx_defines
@brief Defined Constants and Types for the STM32L1xx DMA Controller
@version 1.0.0
@author @htmlonly &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
*/
/** @defgroup dma_defines DMA Defines
*
* @ingroup STM32L1xx_defines
*
* @brief Defined Constants and Types for the STM32L1xx DMA Controller
*
* @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
* */
/*
* This file is part of the libopencm3 project.

16
include/libopencm3/stm32/l1/exti.h
View File

@ -1,3 +1,19 @@
/** @defgroup exti_defines EXTI Defines
*
* @brief <b>Defined Constants and Types for the STM32L1xx External Interrupts
* </b>
*
* @ingroup STM32L1xx_defines
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Piotr Esden-Tempski <piotr@esden.net>
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

39
include/libopencm3/stm32/l1/rcc.h
View File

@ -1,22 +1,23 @@
/** @defgroup STM32L1xx_rcc_defines RCC Defines
@ingroup STM32L1xx_defines
@brief <b>libopencm3 STM32L1xx Reset and Clock Control</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009
Federico Ruiz-Ugalde \<memeruiz at gmail dot com\>
@author @htmlonly &copy; @endhtmlonly 2009
Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012
Karl Palsson <karlp@tweak.net.au>
@date 11 November 2012
LGPL License Terms @ref lgpl_license
*/
/** @defgroup rcc_defines RCC Defines
*
* @ingroup STM32L1xx_defines
*
* @brief <b>Defined Constants and Types for the STM32L1xx Reset and Clock
* Control</b>
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2009
* Federico Ruiz-Ugalde \<memeruiz at gmail dot com\>
* @author @htmlonly &copy; @endhtmlonly 2009
* Uwe Hermann <uwe@hermann-uwe.de>
* @author @htmlonly &copy; @endhtmlonly 2012
* Karl Palsson <karlp@tweak.net.au>
*
* @date 11 November 2012
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.

16
include/libopencm3/stm32/l1/syscfg.h
View File

@ -1,3 +1,19 @@
/** @defgroup syscfg_defines SYSCFG Defines
*
* @ingroup STM32L1xx_defines
*
* @brief Defined Constants and Types for the STM32L1xx Sysconfig
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Frantisek Burian <BuFran@seznam.cz>
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.
*

4
lib/stm32/common/exti_common_all.c
View File

@ -20,6 +20,8 @@
* This provides the code for the "next gen" EXTI block provided in F2/F4/L1
* devices. (differences only in the source selection)
*/
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/stm32/exti.h>
@ -149,3 +151,5 @@ void exti_select_source(uint32_t exti, uint32_t gpioport)
#endif
};
}
/**@}*/

1
lib/stm32/common/flash_common_f234.c
View File

@ -21,6 +21,7 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
/**@{*/

1
lib/stm32/common/flash_common_f24.c
View File

@ -21,6 +21,7 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
/**@{*/

20
lib/stm32/common/hash_common_f24.c
View File

@ -1,13 +1,13 @@
/** @addtogroup hash_file
@author @htmlonly &copy; @endhtmlonly 2013
Mikhail Avkhimenia <mikhail@avkhimenia.net>
This library supports the HASH processor in the STM32F2 and STM32F4
series of ARM Cortex Microcontrollers by ST Microelectronics.
LGPL License Terms @ref lgpl_license
*/
*
* @author @htmlonly &copy; @endhtmlonly 2013
* Mikhail Avkhimenia <mikhail@avkhimenia.net>
*
* This library supports the HASH processor in the STM32F2 and STM32F4
* series of ARM Cortex Microcontrollers by ST Microelectronics.
*
* LGPL License Terms @ref lgpl_license
* */
/*
* This file is part of the libopencm3 project.
@ -159,3 +159,5 @@ void hash_get_result(uint32_t *data)
data[4] = HASH_HR[4];
}
}
/**@}*/

2
lib/stm32/common/rcc_common_all.c
View File

@ -17,6 +17,7 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/stm32/rcc.h>
@ -181,6 +182,7 @@ void rcc_periph_reset_release(enum rcc_periph_rst rst)
{
_RCC_REG(rst) &= ~_RCC_BIT(rst);
}
/**@}*/
#undef _RCC_REG
#undef _RCC_BIT

3
lib/stm32/f0/comparator.c
View File

@ -27,6 +27,7 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/stm32/comparator.h>
@ -59,3 +60,5 @@ void comp_select_speed(uint8_t id, uint32_t speed)
{
COMP_CSR(id) = (COMP_CSR(id) & ~COMP_CSR_SPEED) | speed;
}
/**@}*/

2
lib/stm32/f0/pwr.c
View File

@ -1,4 +1,4 @@
/** @defgroup pwr-file PWR
/** @defgroup pwr_file PWR
*
* @ingroup STM32F0xx
*

36
lib/stm32/f1/pwr.c
View File

@ -1,21 +1,21 @@
/** @defgroup pwr-file PWR
@ingroup STM32F1xx
@brief <b>libopencm3 STM32F1xx Power Control</b>
@version 1.0.0
@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
*/
/** @defgroup pwr_file PWR
*
* @ingroup STM32F1xx
*
* @brief <b>libopencm3 STM32F1xx Power Control</b>
*
* @version 1.0.0
*
* @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.
*

32
lib/stm32/f1/rtc.c
View File

@ -1,18 +1,18 @@
/** @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
*/
*
* @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.
@ -33,6 +33,8 @@ LGPL License Terms @ref lgpl_license
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/stm32/rcc.h>
#include <libopencm3/stm32/rtc.h>
@ -299,3 +301,5 @@ void rtc_auto_awake(enum rcc_osc clock_source, uint32_t prescale_val)
rtc_set_prescale_val(prescale_val);
}
}
/**@}*/

33
lib/stm32/f2/crypto.c Normal file
View File

@ -0,0 +1,33 @@
/** @defgroup crypto_file CRYPTO
*
* @ingroup STM32F2xx
*
* @brief <b>libopencm3 STM32F2xx Cryptographic controller</b>
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/crypto.h>
#include <libopencm3/stm32/common/crypto_common_all.h>

33
lib/stm32/f2/hash.c Normal file
View File

@ -0,0 +1,33 @@
/** @defgroup hash_file HASH
*
* @ingroup STM32F2xx
*
* @brief <b>libopencm3 STM32F2xx Hash Processor</b>
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/hash.h>
#include <libopencm3/stm32/common/hash_common_f24.h>

24
lib/stm32/f2/i2c.c
View File

@ -1,15 +1,15 @@
/** @defgroup i2c_file I2C
@ingroup STM32F2xx
@brief <b>libopencm3 STM32F2xx I2C</b>
@version 1.0.0
@date 15 October 2012
LGPL License Terms @ref lgpl_license
*/
*
* @ingroup STM32F2xx
*
* @brief <b>libopencm3 STM32F2xx I2C</b>
*
* @version 1.0.0
*
* @date 15 October 2012
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
@ -29,5 +29,5 @@ LGPL License Terms @ref lgpl_license
*/
#include <libopencm3/stm32/i2c.h>
#include <libopencm3/stm32/common/spi_common_all.h>
#include <libopencm3/stm32/common/i2c_common_all.h>

39
lib/stm32/f2/pwr.c Normal file
View File

@ -0,0 +1,39 @@
/** @defgroup pwr_file PWR
*
* @ingroup STM32F2xx
*
* @brief <b>libopencm3 STM32F2xx Power Control</b>
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2014
* Ken Sarkies <ksarkies@internode.on.net>
*
* @date 13 January 2014
*
* This library supports the power control system for the
* STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics.
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/pwr.h>

2
lib/stm32/f2/rcc.c
View File

@ -4,7 +4,7 @@
*
* @section rcc_f2_api_ex Reset and Clock Control API.
*
* @brief <b>libopencm3 STM32F4xx Reset and Clock Control</b>
* @brief <b>libopencm3 STM32F2xx Reset and Clock Control</b>
*
* @author @htmlonly &copy; @endhtmlonly 2013 Frantisek Burian <BuFran at seznam.cz>
*

1
lib/stm32/f3/flash.c
View File

@ -41,6 +41,7 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
/**@{*/

9
lib/stm32/f3/pwr.c
View File

@ -2,7 +2,12 @@
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx Power control</b>
* @brief <b>libopencm3 STM32F3xx Power Control</b>
*
* @author @htmlonly &copy; @endhtmlonly 2014
* Ken Sarkies <ksarkies@internode.on.net>
*
* @date 13 January 2014
*
* @version 1.0.0
*
@ -14,6 +19,8 @@
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or

3
lib/stm32/f3/rcc.c
View File

@ -32,6 +32,7 @@
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/cm3/assert.h>
#include <libopencm3/stm32/f3/rcc.h>
@ -460,3 +461,5 @@ void rcc_usb_prescale_1(void)
{
RCC_CFGR |= RCC_CFGR_USBPRES;
}
/**@}*/

38
lib/stm32/f3/rtc.c Normal file
View File

@ -0,0 +1,38 @@
/** @defgroup rtc_file RTC
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx Real Time Clock</b>
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2014
* Ken Sarkies <ksarkies@internode.on.net>
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/rtc.h>

33
lib/stm32/f4/hash.c Normal file
View File

@ -0,0 +1,33 @@
/** @defgroup hash_file HASH
*
* @ingroup STM32F4xx
*
* @brief <b>libopencm3 STM32F4xx Hash Processor</b>
*
* @version 1.0.0
*
* @date 13 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/hash.h>
#include <libopencm3/stm32/common/hash_common_f24.h>

34
lib/stm32/f4/pwr.c
View File

@ -1,20 +1,20 @@
/** @defgroup pwr-file PWR
@ingroup STM32F4xx
@brief <b>libopencm3 STM32F4xx Power Control</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
@date 4 March 2013
This library supports the power control system for the
STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup pwr_file PWR
*
* @ingroup STM32F4xx
*
* @brief <b>libopencm3 STM32F4xx Power Control</b>
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2011 Stephen Caudle <scaudle@doceme.com>
*
* @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.
*

34
lib/stm32/l1/pwr.c
View File

@ -1,20 +1,20 @@
/** @defgroup pwr-file PWR
@ingroup STM32L1xx
@brief <b>libopencm3 STM32L1xx Power Control</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
@date 4 March 2013
This library supports the power control system for the
STM32L1 series of ARM Cortex Microcontrollers by ST Microelectronics.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup pwr_file PWR
*
* @ingroup STM32L1xx
*
* @brief <b>libopencm3 STM32L1xx Power Control</b>
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
*
* @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.
*