forked from Imagelibrary/rtems
arm_lm3s69xx: improve doxygen
Add doxygen to the header files in the arm/lm3s69xx/include directory.
This commit is contained in:
@@ -1,3 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* @ingroup arm_lm3s69xx
|
||||||
|
*
|
||||||
|
* @brief Global BSP Definitions
|
||||||
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright (c) 2011-2012 Sebastian Huber. All rights reserved.
|
* Copyright (c) 2011-2012 Sebastian Huber. All rights reserved.
|
||||||
*
|
*
|
||||||
@@ -36,3 +44,11 @@
|
|||||||
#endif /* ASM */
|
#endif /* ASM */
|
||||||
|
|
||||||
#endif /* LIBBSP_ARM_LM3S69XX_BSP_H */
|
#endif /* LIBBSP_ARM_LM3S69XX_BSP_H */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup arm_lm3s69xx LM3S69XX Support
|
||||||
|
*
|
||||||
|
* @ingroup bsp_arm
|
||||||
|
*
|
||||||
|
* @brief LM3S69XX Support Package
|
||||||
|
*/
|
||||||
|
|||||||
@@ -1,3 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* @ingroup lm3s69xx_io
|
||||||
|
*
|
||||||
|
* @brief IO definitions.
|
||||||
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
||||||
*
|
*
|
||||||
@@ -11,6 +19,14 @@
|
|||||||
#include <bspopts.h>
|
#include <bspopts.h>
|
||||||
#include <stdbool.h>
|
#include <stdbool.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup lm3s69xx_io IO Support
|
||||||
|
*
|
||||||
|
* @ingroup arm_lm3s69xx
|
||||||
|
*
|
||||||
|
* @brief IO support.
|
||||||
|
*/
|
||||||
|
|
||||||
typedef enum {
|
typedef enum {
|
||||||
LM3S69XX_GPIO_DIRECTION_INPUT,
|
LM3S69XX_GPIO_DIRECTION_INPUT,
|
||||||
LM3S69XX_GPIO_DIRECTION_OUTPUT
|
LM3S69XX_GPIO_DIRECTION_OUTPUT
|
||||||
|
|||||||
@@ -1,3 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* @ingroup lm3s69xx_interrupt
|
||||||
|
*
|
||||||
|
* @brief Interrupt definitions.
|
||||||
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
||||||
*
|
*
|
||||||
@@ -24,6 +32,14 @@
|
|||||||
#include <rtems/irq-extension.h>
|
#include <rtems/irq-extension.h>
|
||||||
#include <bspopts.h>
|
#include <bspopts.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup lm3s69xx_interrupt Interrupt Support
|
||||||
|
*
|
||||||
|
* @ingroup arm_lm3s69xx
|
||||||
|
*
|
||||||
|
* @brief Interrupt support.
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* ASM */
|
#endif /* ASM */
|
||||||
|
|
||||||
#define LM3S69XX_IRQ_GPIO_PORT_A 0
|
#define LM3S69XX_IRQ_GPIO_PORT_A 0
|
||||||
|
|||||||
@@ -1,3 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* @ingroup lm3s69xx_reg
|
||||||
|
*
|
||||||
|
* @brief Register definitions.
|
||||||
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
||||||
*
|
*
|
||||||
@@ -19,6 +27,14 @@
|
|||||||
#include <bspopts.h>
|
#include <bspopts.h>
|
||||||
#include <bsp/utility.h>
|
#include <bsp/utility.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup lm3s69xx_reg Register Definitions
|
||||||
|
*
|
||||||
|
* @ingroup arm_lm3s69xx
|
||||||
|
*
|
||||||
|
* @brief Register Definitions
|
||||||
|
*/
|
||||||
|
|
||||||
#define LM3S69XX_SYSCON_BASE 0x400fe000
|
#define LM3S69XX_SYSCON_BASE 0x400fe000
|
||||||
|
|
||||||
#define LM3S69XX_UART_0_BASE 0x4000c000
|
#define LM3S69XX_UART_0_BASE 0x4000c000
|
||||||
|
|||||||
@@ -1,3 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* @ingroup lm3s69xx_ssi
|
||||||
|
*
|
||||||
|
* @brief SSI support.
|
||||||
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
||||||
*
|
*
|
||||||
@@ -10,6 +18,14 @@
|
|||||||
#include <rtems/libi2c.h>
|
#include <rtems/libi2c.h>
|
||||||
#include <bspopts.h>
|
#include <bspopts.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup lm3s69xx_ssi SSI Support
|
||||||
|
*
|
||||||
|
* @ingroup arm_lm3s69xx
|
||||||
|
*
|
||||||
|
* @brief SSI Support
|
||||||
|
*/
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -1,3 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* @ingroup lm3s69xx_syscon
|
||||||
|
*
|
||||||
|
* @brief Syscon support.
|
||||||
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
* Copyright <20> 2013 Eugeniy Meshcheryakov <eugen@debian.org>
|
||||||
*
|
*
|
||||||
@@ -9,6 +17,14 @@
|
|||||||
#define LIBBSP_ARM_LM3S69XX_SYSCON_H
|
#define LIBBSP_ARM_LM3S69XX_SYSCON_H
|
||||||
#include <stdbool.h>
|
#include <stdbool.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup lm3s69xx_syscon Syscon Support
|
||||||
|
*
|
||||||
|
* @ingroup arm_lm3s69xx
|
||||||
|
*
|
||||||
|
* @brief Syscon Support
|
||||||
|
*/
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -1,3 +1,11 @@
|
|||||||
|
/**
|
||||||
|
* @file
|
||||||
|
*
|
||||||
|
* @ingroup lm3s69xx_uart
|
||||||
|
*
|
||||||
|
* brief UART support.
|
||||||
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
|
* Copyright (c) 2011 Sebastian Huber. All rights reserved.
|
||||||
*
|
*
|
||||||
@@ -17,6 +25,14 @@
|
|||||||
|
|
||||||
#include <libchip/serial.h>
|
#include <libchip/serial.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* defgroup lm3s69xx_uart UART Support
|
||||||
|
*
|
||||||
|
* @ingroup arm_lm3s69xx
|
||||||
|
*
|
||||||
|
* @brief UART support.
|
||||||
|
*/
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif /* __cplusplus */
|
#endif /* __cplusplus */
|
||||||
|
|||||||
Reference in New Issue
Block a user