RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

cpu/cc2538: doxgen fixes

Browse Source 
- added missing documentation
- repaired doxygen groups
This commit is contained in:
Hauke Petersen 2016-01-26 22:48:12 +01:00
parent 9d6ff3d218
commit e1df626a9b
9 changed files with 178 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cpu/cc2538/doc.txt
View File

@ -1,10 +1,11 @@
/**
* @defgroup cpu_cc2538 Texas Instruments CC2538
* @defgroup cpu_cc2538 TI CC2538
* @ingroup cpu
* @brief Texas Instruments CC2538 Cortex-M3 MCU specific code
*/
/**
* @defgroup cpu_cc2538_definitions Texas Instruments CC2538 Definitions
* @defgroup cpu_cc2538_regs TI CC2538 CMSIS-style Headers
* @ingroup cpu_cc2538
* @brief CMSIS-style register definitions for the TI CC2538
*/

2
cpu/cc2538/include/cc2538.h
View File

@ -7,7 +7,7 @@
*/
/**
* @ingroup cpu_cc2538_definitions
* @ingroup cpu_cc2538_regs
* @{
*
* @file

20
cpu/cc2538/include/cc2538_gpio.h
View File

@ -7,7 +7,8 @@
*/
/**
* @addtogroup cpu_cc2538
* @defgroup cpu_cc2538_gpio CC2538 General-Purpose I/O
* @ingroup cpu_cc2538_regs
* @{
*
* @file
@ -17,7 +18,6 @@
*
* @author Ian Martin <ian@locicontrols.com>
*
* @defgroup cc2538-gpio CC2538 General-Purpose I/O
* @{
*/
@ -216,14 +216,14 @@ typedef struct {
* @brief IOC port component registers
*/
typedef struct {
cc2538_reg_t PA_SEL[8];
cc2538_reg_t PB_SEL[8];
cc2538_reg_t PC_SEL[8];
cc2538_reg_t PD_SEL[8];
cc2538_reg_t PA_OVER[8];
cc2538_reg_t PB_OVER[8];
cc2538_reg_t PC_OVER[8];
cc2538_reg_t PD_OVER[8];
cc2538_reg_t PA_SEL[8]; /**< Port A SEL register */
cc2538_reg_t PB_SEL[8]; /**< Port B SEL register */
cc2538_reg_t PC_SEL[8]; /**< Port C SEL register */
cc2538_reg_t PD_SEL[8]; /**< Port D SEL register */
cc2538_reg_t PA_OVER[8]; /**< Port A OVER register */
cc2538_reg_t PB_OVER[8]; /**< Port B OVER register */
cc2538_reg_t PC_OVER[8]; /**< Port C OVER register */
cc2538_reg_t PD_OVER[8]; /**< Port D OVER register */
} cc2538_ioc_t;
/**

14
cpu/cc2538/include/cc2538_gptimer.h
View File

@ -7,7 +7,8 @@
*/
/**
* @addtogroup cpu_cc2538
* @defgroup cpu_cc2538_gptimer CC2538 General Purpose Timer
* @ingroup cpu_cc2538_regs
* @{
*
* @file
@ -48,6 +49,9 @@ enum {
typedef struct {
cc2538_reg_t CFG; /**< GPTIMER Configuration */
/**
* @brief Timer A
*/
union {
cc2538_reg_t TAMR; /**< GPTIMER Timer A mode */
struct {
@ -66,6 +70,9 @@ typedef struct {
} TAMRbits;
} cc2538_gptimer_tamr;
/**
* @brief Timer B
*/
union {
cc2538_reg_t TBMR; /**< GPTIMER Timer B mode */
struct {
@ -84,6 +91,9 @@ typedef struct {
} TBMRbits;
} cc2538_gptimer_tbmr;
/**
* @brief Timer Control
*/
union {
cc2538_reg_t CTL; /**< GPTIMER Control */
struct {
@ -127,7 +137,7 @@ typedef struct {
cc2538_reg_t TBPS; /**< GPTIMER Timer B Prescale Snapshot */
cc2538_reg_t TAPV; /**< GPTIMER Timer A Prescale Value */
cc2538_reg_t TBPV; /**< GPTIMER Timer B Prescale Value */
cc2538_reg_t RESERVED[981];
cc2538_reg_t RESERVED[981]; /**< Reserved */
cc2538_reg_t PP; /**< GPTIMER Peripheral Properties */
} cc2538_gptimer_t;

29
cpu/cc2538/include/cc2538_ioc.h
View File

@ -7,23 +7,21 @@
*/
/**
* @defgroup cpu_cc2538_ioc CC2538 I/O Control
* @ingroup cpu_cc2538_regs
* @{
*
* @file
* @brief CC2538 I/O Control driver
*
* Header file with declarations for the I/O Control module
*
* @author Ian Martin <ian@locicontrols.com>
*
* @addtogroup cpu_cc2538
* @{
*
* @defgroup cc2538-ioc CC2538 I/O Control
*
* Header file with declarations for the I/O Control module
* @{
*/
#ifndef IOC_H_
#define IOC_H_
#ifndef CC2538_IOC_H_
#define CC2538_IOC_H_
#include <stdint.h>
@ -33,8 +31,13 @@
extern "C" {
#endif
/**
* @name Port control register addresses
* @{
*/
#define IOC_PXX_SEL ( (cc2538_reg_t*)0x400d4000 )
#define IOC_PXX_OVER ( (cc2538_reg_t*)0x400d4080 )
/** @} */
/** @name Peripheral Signal Select Values (for IOC_Pxx_SEL registers)
* @{
@ -64,7 +67,8 @@ enum {
};
/** @} */
/** @name Values for IOC_PXX_OVER
/**
* @name Values for IOC_PXX_OVER
* @{
*/
#define IOC_OVERRIDE_OE 0x00000008 /**< Output Enable */
@ -78,8 +82,5 @@ enum {
} /* end extern "C" */
#endif
#endif /* IOC_H_ */
/** @} */
/** @} */
#endif /* CC2538_IOC_H_ */
/** @} */

13
cpu/cc2538/include/cc2538_rfcore.h
View File

@ -7,6 +7,8 @@
*/
/**
* @defgroup cpu_cc2538_rfcore CC2538 RF core interface
* @ingroup cpu_cc2538_regs
* @{
*
* @file
@ -14,11 +16,6 @@
*
* @author Ian Martin <ian@locicontrols.com>
*
* @addtogroup cpu_cc2538
* @{
*
* @defgroup cc2538-rfcore CC2538 RF core interface
* @{
*/
#ifndef CC2538_RFCORE_H
@ -83,6 +80,9 @@ typedef struct {
cc2538_reg_t XREG_CCACTRL1; /**< RF Other CCA Options */
cc2538_reg_t XREG_RSSI; /**< RF RSSI status register */
/**
* @brief RSSI status register
*/
union {
cc2538_reg_t XREG_RSSISTAT; /**< RF RSSI valid status register */
struct {
@ -105,6 +105,9 @@ typedef struct {
cc2538_reg_t XREG_RFERRM; /**< RF error interrupt mask */
cc2538_reg_t RESERVED3; /**< Reserved bytes */
/**
* @brief RF random data register
*/
union {
cc2538_reg_t XREG_RFRND; /**< RF Random data */
struct {

7
cpu/cc2538/include/cc2538_soc_adc.h
View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup cpu_cc2538
* @defgroup cpu_cc2538_adc CC2538 ADC
* @ingroup cpu_cc2538_regs
* @{
*
* @file
@ -29,6 +30,10 @@ extern "C" {
* @brief SOC ADC component registers
*/
typedef struct {
/**
* @brief ADC control register
*/
union {
cc2538_reg_t ADCCON1; /**< ADC Control Register 1 */
struct {

19
cpu/cc2538/include/cc2538_sys_ctrl.h
View File

@ -7,7 +7,8 @@
*/
/**
* @ingroup cpu_cc2538
* @defgroup cpu_cc2538_sysctrl CC2538 System Control
* @ingroup cpu_cc2538_regs
* @{
*
* @file
@ -29,6 +30,10 @@ extern "C" {
* @brief System Control component registers
*/
typedef struct {
/**
* @brief Clock control register
*/
union {
cc2538_reg_t CLOCK_CTRL; /**< Clock control register */
struct {
@ -47,6 +52,9 @@ typedef struct {
} CLOCK_CTRLbits;
} cc2538_sys_ctrl_clk_ctrl;
/**
* @brief Clock status register
*/
union {
cc2538_reg_t CLOCK_STA; /**< Clock status register */
struct {
@ -77,6 +85,9 @@ typedef struct {
cc2538_reg_t DCGCSSI; /**< Module clocks for SSI[1:0] when the CPU is in PM0 */
cc2538_reg_t SRSSI; /**< Reset for SSI[1:0]. */
/**
* @brief UART module clock register - active mode
*/
union {
cc2538_reg_t RCGCUART; /**< Module clocks for UART[1:0] when the CPU is in active (run) mode */
struct {
@ -86,6 +97,9 @@ typedef struct {
} RCGCUARTbits;
} cc2538_sys_ctrl_unnamed1;
/**
* @brief UART module clock register - sleep mode
*/
union {
cc2538_reg_t SCGCUART; /**< Module clocks for UART[1:0] when the CPU is in sleep mode */
struct {
@ -95,6 +109,9 @@ typedef struct {
} SCGCUARTbits;
} cc2538_sys_ctrl_unnamed2;
/**
* @brief UART module clock register - PM0 mode
*/
union {
cc2538_reg_t DCGCUART; /**< Module clocks for UART[1:0] when the CPU is in PM0 */
struct {

24
cpu/cc2538/include/cc2538_uart.h
View File

@ -7,7 +7,8 @@
*/
/**
* @addtogroup cpu_cc2538
* @defgroup cpu_cc2538_uart CC2538 UART
* @ingroup cpu_cc2538_regs
* @{
*
* @file
@ -31,6 +32,9 @@ extern "C" {
typedef struct {
cc2538_reg_t DR; /**< UART Data Register */
/**
* @brief Status register
*/
union {
cc2538_reg_t RSR; /**< UART receive status and error clear */
cc2538_reg_t ECR; /**< UART receive status and error clear */
@ -38,6 +42,9 @@ typedef struct {
cc2538_reg_t RESERVED1[4]; /**< Reserved addresses */
/**
* @brief Flag register
*/
union {
cc2538_reg_t FR; /**< UART Flag Register */
struct {
@ -57,6 +64,9 @@ typedef struct {
cc2538_reg_t IBRD; /**< UART Integer Baud-Rate Divisor */
cc2538_reg_t FBRD; /**< UART Fractional Baud-Rate Divisor */
/**
* @brief Line control register
*/
union {
cc2538_reg_t LCRH; /**< UART Line Control Register */
struct {
@ -71,6 +81,9 @@ typedef struct {
} LCRHbits;
} cc2538_uart_lcrh;
/**
* @brief Control register
*/
union {
cc2538_reg_t CTL; /**< UART Control */
struct {
@ -91,6 +104,9 @@ typedef struct {
} CTLbits;
} cc2538_uart_ctl;
/**
* @brief Interrupt FIFO level select register
*/
union {
cc2538_reg_t IFLS; /**< UART interrupt FIFO Level Select */
struct {
@ -100,6 +116,9 @@ typedef struct {
} IFLSbits;
} cc2538_uart_ifls;
/**
* @brief Interrupt mask register
*/
union {
cc2538_reg_t IM; /**< UART Interrupt Mask */
struct {
@ -122,6 +141,9 @@ typedef struct {
cc2538_reg_t RIS; /**< UART Raw Interrupt Status */
/**
* @brief Masked interrupt status register
*/
union {
cc2538_reg_t MIS; /**< UART Masked Interrupt Status */
struct {