jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases 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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/Makefile
View File

@ -5,11 +5,14 @@
doc: html latex
html: cm3 stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 top
html: cm3 usb stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 top
cm3:
cd cm3/; doxygen
usb:
cd usb/; doxygen
lm3s:
cd lm3s/; doxygen
@ -96,5 +99,5 @@ efm32tg.pdf:
clean:
@rm -rf html/ */html/ */latex/ *.pdf */*.tag
.PHONY: doc html cm3 lm3s lm4f lpc13 lpc17 lpc43 stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg top latex
.PHONY: doc html cm3 usb lm3s lm4f lpc13 lpc17 lpc43 stm32l1 stm32f1 stm32f2 stm32f4 efm32g efm32gg efm32lg efm32tg top latex

1
doc/efm32g/DoxygenLayout_efm32g.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/efm32gg/DoxygenLayout_efm32gg.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/efm32lg/DoxygenLayout_efm32lg.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/efm32tg/DoxygenLayout_efm32tg.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/lm3s/DoxygenLayout_lm3s.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/lm4f/DoxygenLayout_lm4f.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/lpc13xx/DoxygenLayout_lpc13xx.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/lpc17xx/DoxygenLayout_lpc17xx.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/lpc43xx/DoxygenLayout_lpc43xx.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

1
doc/stm32f1/DoxygenLayout_stm32f1.xml
View File

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

1
doc/stm32f2/DoxygenLayout_stm32f2.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" intro=""/>
<tab type="user" visible="yes" url="../../stm32f1/html/modules.html" title="STM32F1" intro=""/>
<tab type="modules" visible="yes" title="STM32F2" intro=""/>
<tab type="user" visible="yes" url="../../stm32f4/html/modules.html" title="STM32F4" intro=""/>

1
doc/stm32f4/DoxygenLayout_stm32f4.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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="modules" visible="yes" title="STM32F4" intro=""/>

1
doc/stm32l1/DoxygenLayout_stm32l1.xml
View File

@ -5,6 +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="../../usb/html/modules.html" title="Generic USB" 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=""/>

4
include/libopencm3/lm3s/doc-lm3s.h
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

19
include/libopencm3/lm3s/gpio.h
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

19
include/libopencm3/lm3s/systemcontrol.h
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

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

18
include/libopencm3/lpc13xx/gpio.h
View File

@ -1,3 +1,17 @@
/** @defgroup gpio_defines GPIO Defines
@brief <b>Defined Constants and Types for the LPC13xx General Purpose I/O</b>
@ingroup LPC13xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,6 +31,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#ifndef LPC13XX_GPIO_H
#define LPC13XX_GPIO_H
@ -103,4 +119,6 @@ void gpio_set(u32 gpioport, u16 gpios);
END_DECLS
/**@}*/
#endif

12
include/libopencm3/lpc17xx/doc-lpc17xx.h
View File

@ -1,16 +1,16 @@
/** @mainpage libopencm3 LPC13xx
/** @mainpage libopencm3 LPC17xx
@version 1.0.0
@date 14 September 2012
API documentation for NXP Semiconductors LPC13xx Cortex M3 series.
API documentation for NXP Semiconductors LPC17xx Cortex M3 series.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup LPC13xx LPC13xx
Libraries for NXP Semiconductors LPC13xx series.
/** @defgroup LPC17xx LPC17xx
Libraries for NXP Semiconductors LPC17xx series.
@version 1.0.0
@ -19,9 +19,9 @@ Libraries for NXP Semiconductors LPC13xx series.
LGPL License Terms @ref lgpl_license
*/
/** @defgroup LPC13xx_defines LPC13xx Defines
/** @defgroup LPC17xx_defines LPC17xx Defines
@brief Defined Constants and Types for the LPC13xx series
@brief Defined Constants and Types for the LPC17xx series
@version 1.0.0

18
include/libopencm3/lpc17xx/gpio.h
View File

@ -1,3 +1,17 @@
/** @defgroup gpio_defines GPIO Defines
@brief <b>Defined Constants and Types for the LPC17xx General Purpose I/O</b>
@ingroup LPC17xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC17XX_GPIO_H
#define LPC17XX_GPIO_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc17xx/memorymap.h>
@ -139,4 +155,6 @@ void gpio_clear(u32 gpioport, u32 gpios);
END_DECLS
/**@}*/
#endif

18
include/libopencm3/lpc43xx/adc.h
View File

@ -1,3 +1,17 @@
/** @defgroup adc_defines ADC Defines
@brief <b>Defined Constants and Types for the LPC43xx A/D Converter</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_ADC_H
#define LPC43XX_ADC_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -92,4 +108,6 @@
#define ADC0_STAT ADC_STAT(ADC0)
#define ADC1_STAT ADC_STAT(ADC1)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/atimer.h
View File

@ -1,3 +1,17 @@
/** @defgroup atimer_defines Alarm Timer Defines
@brief <b>Defined Constants and Types for the LPC43xx Alarm Timer</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_ATIMER_H
#define LPC43XX_ATIMER_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -49,4 +65,6 @@
/* Set register */
#define ATIMER_SET_STAT MMIO32(ATIMER_BASE + 0xFEC)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/ccu.h
View File

@ -1,3 +1,17 @@
/** @defgroup ccu_defines Clock Control Unit Defines
@brief <b>Defined Constants and Types for the LPC43xx Clock Control Unit</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_CCU_H
#define LPC43XX_CCU_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -381,4 +397,6 @@
/* CLK_SDIO status register (for SD/MMC) */
#define CCU2_CLK_SDIO_STAT MMIO32(CCU2_BASE + 0x804)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/cgu.h
View File

@ -1,3 +1,17 @@
/** @defgroup cgu_defines Clock Generation Unit Defines
@brief <b>Defined Constants and Types for the LPC43xx Clock Generation Unit</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_CGU_H
#define CGU_LPC43XX_CGU_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -236,4 +252,6 @@
#define CGU_SRC_IDIVD 0x0F
#define CGU_SRC_IDIVE 0x10
/**@}*/
#endif

18
include/libopencm3/lpc43xx/creg.h
View File

@ -1,3 +1,17 @@
/** @defgroup creg_defines Configuration Registers Defines
@brief <b>Defined Constants and Types for the LPC43xx Configuration Registers</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_CREG_H
#define LPC43XX_CREG_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -73,4 +89,6 @@
/* ARM Cortex-M0 memory mapping */
#define CREG_M0APPMEMMAP MMIO32(CREG_BASE + 0x404)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/eventrouter.h
View File

@ -1,3 +1,17 @@
/** @defgroup eventrouter_defines Event Router Defines
@brief <b>Defined Constants and Types for the LPC43xx Event Router</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_EVENTROUTER_H
#define LPC43XX_EVENTROUTER_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -49,4 +65,6 @@
/* Set event status register */
#define EVENTROUTER_SET_STAT MMIO32(EVENTROUTER_BASE + 0xFEC)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/gima.h
View File

@ -1,3 +1,17 @@
/** @defgroup gima_defines Global Input Multiplexer Array Defines
@brief <b>Defined Constants and Types for the LPC43xx Global Input Multiplexer Array</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_GIMA_H
#define LPC43XX_GIMA_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -115,4 +131,6 @@
/* ADC start1 input multiplexer (GIMA output 29) */
#define GIMA_ADCSTART1_IN MMIO32(GIMA_BASE + 0x074)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/gpdma.h
View File

@ -1,3 +1,17 @@
/** @defgroup gpdma_defines General Purpose DMA Defines
@brief <b>Defined Constants and Types for the LPC43xx General Purpose DMA</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_GPDMA_H
#define LPC43XX_GPDMA_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -140,4 +156,6 @@
#define GPDMA_C6CONFIG GPDMA_CONFIG(GPDMA_CHANNEL6)
#define GPDMA_C7CONFIG GPDMA_CONFIG(GPDMA_CHANNEL7)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/gpio.h
View File

@ -1,3 +1,17 @@
/** @defgroup gpio_defines General Purpose I/O Defines
@brief <b>Defined Constants and Types for the LPC43xx General Purpose I/O</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -21,6 +35,8 @@
#ifndef LPC43XX_GPIO_H
#define LPC43XX_GPIO_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -161,4 +177,6 @@ void gpio_toggle(u32 gpioport, u32 gpios);
END_DECLS
/**@}*/
#endif

18
include/libopencm3/lpc43xx/i2c.h
View File

@ -1,3 +1,17 @@
/** @defgroup i2c_defines I2C Defines
@brief <b>Defined Constants and Types for the LPC43xx I2C</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_I2C_H
#define LPC43XX_I2C_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -143,4 +159,6 @@ void i2c0_stop(void);
END_DECLS
/**@}*/
#endif

18
include/libopencm3/lpc43xx/i2s.h
View File

@ -1,3 +1,17 @@
/** @defgroup i2s_defines I2S Defines
@brief <b>Defined Constants and Types for the LPC43xx I2S</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_I2S_H
#define LPC43XX_I2S_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -102,4 +118,6 @@
#define I2S0_RXMODE I2S_RXMODE(I2S0)
#define I2S1_RXMODE I2S_RXMODE(I2S1)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/rgu.h
View File

@ -1,3 +1,17 @@
/** @defgroup rgu_defines Reset Generation Unit Defines
@brief <b>Defined Constants and Types for the LPC43xx Reset Generation Unit</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_RGU_H
#define LPC43XX_RGU_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -241,4 +257,6 @@
/* Reserved */
#define RESET_EXT_STAT63 MMIO32(RGU_BASE + 0x4FC)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/ritimer.h
View File

@ -1,3 +1,17 @@
/** @defgroup ritimer_defines Repetitive Interrupt Timer Defines
@brief <b>Defined Constants and Types for the LPC43xx Repetitive Interrupt Timer</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_RITIMER_H
#define LPC43XX_RITIMER_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -37,4 +53,6 @@
/* 32-bit counter */
#define RITIMER_COUNTER MMIO32(RITIMER_BASE + 0x00C)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/scu.h
View File

@ -1,3 +1,17 @@
/** @defgroup scu_defines System Control Unit Defines
@brief <b>Defined Constants and Types for the LPC43xx System Control Unit</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -21,6 +35,8 @@
#ifndef LPC43XX_SCU_H
#define LPC43XX_SCU_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -731,4 +747,6 @@ void scu_pinmux(scu_grp_pin_t group_pin, u32 scu_conf);
END_DECLS
/**@}*/
#endif

18
include/libopencm3/lpc43xx/sdio.h
View File

@ -1,3 +1,17 @@
/** @defgroup sdio_defines SDIO
@brief <b>Defined Constants and Types for the LPC43xx SDIO</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_SDIO_H
#define LPC43XX_SDIO_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -130,4 +146,6 @@
/* Data FIFO read/write */
#define SDIO_DATA MMIO32(SDIO_BASE + 0x100)
/**@}*/
#endif

32
include/libopencm3/lpc43xx/sgpio.h
View File

@ -1,3 +1,31 @@
/** @defgroup sgpio_defines Serial General Purpose I/O
@brief <b>Defined Constants and Types for the LPC43xx Serial General Purpose I/O</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/** @defgroup sdio_defines SDIO
@brief <b>Defined Constants and Types for the LPC43xx SDIO</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -21,6 +49,8 @@
#ifndef LPC43XX_SGPIO_H
#define LPC43XX_SGPIO_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -295,4 +325,6 @@
/* Input bit match interrupt set status */
#define SGPIO_SET_STATUS_3 MMIO32(SGPIO_PORT_BASE + 0xF74)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/ssp.h
View File

@ -1,3 +1,17 @@
/** @defgroup ssp_defines Synchronous Serial Port
@brief <b>Defined Constants and Types for the LPC43xx Synchronous Serial Port</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_SSP_H
#define LPC43XX_SSP_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -182,4 +198,6 @@ void ssp_write(ssp_num_t ssp_num, u16 data);
END_DECLS
/**@}*/
#endif

18
include/libopencm3/lpc43xx/timer.h
View File

@ -1,3 +1,17 @@
/** @defgroup timer_defines Timer
@brief <b>Defined Constants and Types for the LPC43xx timer</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_TIMER_H
#define LPC43XX_TIMER_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -153,4 +169,6 @@
#define TIMER2_CTCR TIMER_CTCR(TIMER2)
#define TIMER3_CTCR TIMER_CTCR(TIMER3)
/**@}*/
#endif

18
include/libopencm3/lpc43xx/wwdt.h
View File

@ -1,3 +1,17 @@
/** @defgroup wwdt_defines Windowed Watchdog Timer
@brief <b>Defined Constants and Types for the LPC43xx Windowed Watchdog Timer</b>
@ingroup LPC43xx_defines
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
@date 10 March 2013
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -20,6 +34,8 @@
#ifndef LPC43XX_WWDT_H
#define LPC43XX_WWDT_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/lpc43xx/memorymap.h>
@ -43,4 +59,6 @@
/* Watchdog timer window register */
#define WWDT_WINDOW MMIO32(WWDT_BASE + 0x018)
/**@}*/
#endif

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

@ -31,6 +31,8 @@ specific memorymap.h header before including this header file.*/
#ifndef LIBOPENCM3_CRC_COMMON_ALL_H
#define LIBOPENCM3_CRC_COMMON_ALL_H
/**@{*/
#include <libopencm3/cm3/common.h>
/* --- CRC registers ------------------------------------------------------- */
@ -89,6 +91,8 @@ u32 crc_calculate_block(u32 *datap, int size);
END_DECLS
/**@}*/
#endif
#else
#warning "crc_common_all.h should not be included explicitly, only via crc.h"

20
lib/lm3s/gpio.c
View File

@ -1,3 +1,18 @@
/** @defgroup gpio_file General Purpose I/O
@brief <b>LM3S General Purpose I/O</b>
@ingroup LM3Sxx
@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.
*
@ -17,6 +32,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/lm3s/gpio.h>
void gpio_set(u32 gpioport, u8 gpios)
@ -29,3 +46,6 @@ void gpio_clear(u32 gpioport, u8 gpios)
{
GPIO_DATA(gpioport)[gpios] = 0;
}
/**@}*/

20
lib/lm4f/gpio.c
View File

@ -1,3 +1,18 @@
/** @defgroup gpio_file General Purpose I/O
@brief <b>LM4F General Purpose I/O</b>
@ingroup LM4Fxx
@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.
*
@ -17,6 +32,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/lm4f/gpio.h>
void gpio_set(u32 gpioport, u8 gpios)
@ -29,3 +46,6 @@ void gpio_clear(u32 gpioport, u8 gpios)
{
GPIO_DATA(gpioport)[gpios] = 0;
}
/**@}*/

4
lib/lm4f/rcc.c
View File

@ -21,7 +21,7 @@
/**
* @defgroup rcc_file RCC
*
* @ingroup LM4F
* @ingroup LM4Fxx
*
@author @htmlonly &copy; @endhtmlonly 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
@ -79,6 +79,7 @@
/**
* @defgroup rcc_low_level Low-level clock control API
@ingroup rcc_file
* @{
*/
/**
@ -342,6 +343,7 @@ void rcc_wait_for_pll_ready(void)
/**
* @defgroup rcc_high_level High-level clock control API
@ingroup rcc_file
* @{
*/

17
lib/lpc13xx/gpio.c
View File

@ -1,3 +1,15 @@
/** @defgroup gpio_file GPIO
@ingroup LPC13xx
@brief <b>libopencm3 LPC13xx General Purpose I/O</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,9 +29,14 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/lpc13xx/gpio.h>
void gpio_set(u32 gpioport, u16 gpios)
{
GPIO_DATA(gpioport) = gpios;
}
/**@}*/

18
lib/lpc17xx/gpio.c
View File

@ -1,3 +1,16 @@
/** @defgroup gpio_file GPIO
@ingroup LPC17xx
@brief <b>libopencm3 LPC17xx General Purpose I/O</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,6 +30,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/lpc17xx/gpio.h>
void gpio_set(u32 gpioport, u32 gpios)
@ -28,3 +43,6 @@ void gpio_clear(u32 gpioport, u32 gpios)
{
GPIO_CLR(gpioport) = gpios;
}
/**@}*/

20
lib/lpc43xx/gpio.c
View File

@ -1,3 +1,16 @@
/** @defgroup gpio_file GPIO
@ingroup LPC43xx
@brief <b>libopencm3 LPC43xx General Purpose I/O</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,6 +30,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/lpc43xx/gpio.h>
void gpio_set(u32 gpioport, u32 gpios)
@ -32,4 +47,7 @@ void gpio_clear(u32 gpioport, u32 gpios)
void gpio_toggle(u32 gpioport, u32 gpios)
{
GPIO_NOT(gpioport) = gpios;
}
}
/**@}*/

18
lib/lpc43xx/i2c.c
View File

@ -1,3 +1,16 @@
/** @defgroup i2c_file I2C
@ingroup LPC43xx
@brief <b>libopencm3 LPC43xx I2C</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Michael Ossmann <mike@ossmann.com>
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -22,6 +35,8 @@
* peripheral working.
*/
/**@{*/
#include <libopencm3/lpc43xx/i2c.h>
#include <libopencm3/lpc43xx/scu.h>
#include <libopencm3/lpc43xx/cgu.h>
@ -91,3 +106,6 @@ void i2c0_stop(void)
I2C0_CONSET = I2C_CONSET_STO;
I2C0_CONCLR = I2C_CONCLR_SIC;
}
/**@}*/

18
lib/lpc43xx/scu.c
View File

@ -1,3 +1,16 @@
/** @defgroup scu_file System Control Unit
@ingroup LPC43xx
@brief <b>libopencm3 LPC43xx System Control Unit</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Benjamin Vernoux <titanmkd@gmail.com>
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,6 +30,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/lpc43xx/scu.h>
/* For pin_conf_normal value see scu.h define SCU_CONF_XXX or Configuration for different I/O pins types */
@ -28,3 +43,6 @@ void scu_pinmux(scu_grp_pin_t group_pin, u32 scu_conf)
/* For other special SCU register USB1, I2C0, ADC0/1, DAC, EMC clock delay See scu.h */
/* For Pin interrupt select register see scu.h SCU_PINTSEL0 & SCU_PINTSEL1 */
/**@}*/

16
lib/lpc43xx/ssp.c
View File

@ -1,3 +1,16 @@
/** @defgroup ssp_file SSP
@ingroup LPC43xx
@brief <b>libopencm3 LPC43xx SSP</b>
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Benjamin Vernoux <titanmkd@gmail.com>
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,6 +30,8 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/lpc43xx/ssp.h>
#include <libopencm3/lpc43xx/cgu.h>
@ -160,4 +175,5 @@ void ssp_write(ssp_num_t ssp_num, u16 data)
*/
ssp_wait_until_not_busy(ssp_num);
}
/**@}*/