summaryrefslogtreecommitdiffstats
path: root/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h
diff options
context:
space:
mode:
authorThomas Doerfler <Thomas.Doerfler@embedded-brains.de>2009-09-18 08:05:40 +0000
committerThomas Doerfler <Thomas.Doerfler@embedded-brains.de>2009-09-18 08:05:40 +0000
commitba938b8d7d7d8dde2899e9428b752339d32190c2 (patch)
tree8a3ee64e121e1025dafd32ef72e8807f663d2778 /c/src/lib/libbsp/arm/lpc24xx/include/bsp.h
parentpreinstall.am: Regenerate. (diff)
downloadrtems-ba938b8d7d7d8dde2899e9428b752339d32190c2.tar.bz2
Changes throughout.
Diffstat (limited to '')
-rw-r--r--c/src/lib/libbsp/arm/lpc24xx/include/bsp.h48
1 files changed, 41 insertions, 7 deletions
diff --git a/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h b/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h
index bb156b01aa..e1f06b2ee3 100644
--- a/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h
+++ b/c/src/lib/libbsp/arm/lpc24xx/include/bsp.h
@@ -3,7 +3,7 @@
*
* @ingroup lpc24xx
*
- * @brief Global BSP variables and functions.
+ * @brief Global BSP definitions.
*/
/*
@@ -35,25 +35,59 @@ extern "C" {
#ifndef ASM
-/* Network driver configuration */
-
struct rtems_bsdnet_ifconfig;
+/**
+ * @defgroup lpc24xx LPC24XX Support
+ *
+ * @ingroup bsp_kit
+ *
+ * @brief LPC24XX support package.
+ *
+ * @{
+ */
+
+/**
+ * @brief Network driver attach and detach function.
+ */
int lpc24xx_eth_attach_detach(
struct rtems_bsdnet_ifconfig *config,
int attaching
);
+/**
+ * @brief Standard network driver attach and detach function.
+ */
#define RTEMS_BSP_NETWORK_DRIVER_ATTACH lpc24xx_eth_attach_detach
+/**
+ * @brief Standard network driver name.
+ */
#define RTEMS_BSP_NETWORK_DRIVER_NAME "eth0"
-/*
- * BSP specific idle thread
+/**
+ * @brief Optimized idle task.
+ *
+ * This idle task sets the power mode to idle. This causes the processor clock
+ * to be stopped, while on-chip peripherals remain active. Any enabled
+ * interrupt from a peripheral or an external interrupt source will cause the
+ * processor to resume execution.
+ *
+ * To enable the idle task use the following in the system configuration:
+ *
+ * @code
+ * #include <bsp.h>
+ *
+ * #define CONFIGURE_INIT
+ *
+ * #define CONFIGURE_IDLE_TASK_BODY lpc24xx_idle
+ *
+ * #include <confdefs.h>
+ * @endcode
*/
-void *bsp_idle_thread( uint32_t ignored);
+void *lpc24xx_idle(uintptr_t ignored);
-#define BSP_IDLE_TASK_BODY bsp_idle_thread
+/** @} */
#endif /* ASM */