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

Documentation structures added to place the non-STM32 families into the documentation tree.

Browse Source 
Actual documentation has not been added. Volunteers?
This commit is contained in:
Ken Sarkies
2013-03-10 23:28:21 +10:30
committed by Felix Ruess
parent 69902568d1
commit 1627cd60c3
54 changed files with 685 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/libopencm3/lm4f/doc-lm4f.h
View File

@@ -9,7 +9,7 @@ API documentation for TI Stellaris LM4F Cortex M4F series.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup LM4F LM4F
/** @defgroup LM4Fxx LM4F
Libraries for TI Stellaris LM4F series.
@version 1.0.0
@@ -19,7 +19,7 @@ Libraries for TI Stellaris LM4F series.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup LM4F_defines LM4F Defines
/** @defgroup LM4Fxx_defines LM4F Defines
@brief Defined Constants and Types for the LM4F series

20
include/libopencm3/lm4f/gpio.h
View File

@@ -1,3 +1,18 @@
/** @defgroup gpio_defines General Purpose I/O Defines
@brief <b>Defined Constants and Types for the LM4F General Purpose I/O</b>
@ingroup LM4Fxx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2011 Gareth McMullin <gareth@blacksphere.co.nz>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -20,6 +35,8 @@
#ifndef LM4F_GPIO_H
#define LM4F_GPIO_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lm4f/memorymap.h>
@@ -77,3 +94,6 @@ void gpio_clear(u32 gpioport, u8 gpios);
END_DECLS
#endif
/**@}*/

23
include/libopencm3/lm4f/nvic.h
View File

@@ -1,3 +1,18 @@
/** @defgroup nvic_defines Nested Vectored Interrupt Controller
@brief <b>Defined Constants and Types for the LM4F Nested Vectored Interrupt Controller</b>
@ingroup LM4Fxx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -20,15 +35,19 @@
#ifndef LIBOPENCM3_LM3S_NVIC_H
#define LIBOPENCM3_LM3S_NVIC_H
/**@{*/
#include <libopencm3/cm3/nvic.h>
/*
/** @ingroup nvic_defines
* The LM3S interrupt table applies to the LM4F as well.
* Some interrupt vectores marked as reserved in LM3S are used in LM4F, and some
* Some interrupt vectors marked as reserved in LM3S are used in LM4F, and some
* vectors in LM3S are marked reserved for LM4F. However, the common vectors are
* identical, and we can safely use the same interrupt table. Reserved vectors
* will never be triggered, so having them is perfectly safe.
*/
#include <libopencm3/lm3s/nvic.h>
/**@}*/
#endif /* LIBOPENCM3_LM3S_NVIC_H */

15
include/libopencm3/lm4f/rcc.h
View File

@@ -1,3 +1,18 @@
/** @defgroup rcc_defines Reset and Clock Control
@brief <b>Defined Constants and Types for the LM4F Reset and Clock Control</b>
@ingroup LM4Fxx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

18
include/libopencm3/lm4f/systemcontrol.h
View File

@@ -1,3 +1,17 @@
/** @defgroup systemcontrol_defines System Control
@brief <b>Defined Constants and Types for the LM4F System Control</b>
@ingroup LM4Fxx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -20,6 +34,8 @@
#ifndef LM4F_SYSTEMCONTROL_H
#define LM4F_SYSTEMCONTROL_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lm4f/memorymap.h>
@@ -720,6 +736,8 @@ void periph_clock_disable(clken_t periph);
END_DECLS
/**@}*/
#endif /* LM4F_SYSTEMCONTROL_H */