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

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

View File

@@ -9,7 +9,7 @@ API documentation for TI Stellaris LM3S Cortex M3 series.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup LM3S LM3S
/** @defgroup LM3Sxx LM3S
Libraries for TI Stellaris LM3S series.
@version 1.0.0
@@ -19,7 +19,7 @@ Libraries for TI Stellaris LM3S series.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup LM3S_defines LM3S Defines
/** @defgroup LM3Sxx_defines LM3S Defines
@brief Defined Constants and Types for the LM3S series

View File

@@ -1,3 +1,17 @@
/** @defgroup gpio_defines General Purpose I/O Defines
@brief <b>Defined Constants and Types for the LM3S General Purpose I/O</b>
@ingroup LM3Sxx_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 +34,8 @@
#ifndef LM3S_GPIO_H
#define LM3S_GPIO_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lm3s/memorymap.h>
@@ -76,4 +92,7 @@ void gpio_clear(u32 gpioport, u8 gpios);
END_DECLS
/**@}*/
#endif

View File

@@ -1,3 +1,18 @@
/** @defgroup systemcontrol_defines System Control
@brief <b>Defined Constants and Types for the LM3S System Control</b>
@ingroup LM3Sxx_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 LM3S_SYSTEMCONTROL_H
#define LM3S_SYSTEMCONTROL_H
/**@{*/
#include <libopencm3/cm3/common.h>
#define SYSTEMCONTROL_DID0 MMIO32(SYSTEMCONTROL_BASE + 0x000)
@@ -57,5 +74,7 @@
#define SYSTEMCONTROL_DCGC2 MMIO32(SYSTEMCONTROL_BASE + 0x128)
#define SYSTEMCONTROL_DSLPCLKCFG MMIO32(SYSTEMCONTROL_BASE + 0x144)
/**@}*/
#endif