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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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