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,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;
}
}
/**@}*/

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;
}
/**@}*/

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

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);
}
/**@}*/