Skip to content

Commit 7ea8c7f

Browse files
Merge pull request #7486 from smlng/enh/docu/cc26x0/timer
docu: enhance timer config docu for cc26x0
2 parents 5c4000c + 09bc23b commit 7ea8c7f

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

boards/cc2650stk/include/periph_conf.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ extern "C" {
3535

3636
/**
3737
* @name Timer configuration
38+
*
39+
* General purpose timers (GPT[0-3]) are configured consecutively and in order
40+
* (without gaps) starting from GPT0, i.e. if multiple timers are enabled.
41+
*
3842
* @{
3943
*/
4044
static const timer_conf_t timer_config[] = {

cpu/cc26x0/include/periph_cpu.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,20 @@ typedef enum {
5757
GPIO_RISING = IOCFG_EDGEDET_RISING,
5858
GPIO_BOTH = IOCFG_EDGEDET_BOTH
5959
} gpio_flank_t;
60-
#endif /* ndef DOXYGEN */
6160

6261
/**
6362
* @brief Configuration of low-level general purpose timers
6463
*
65-
* @note Timers *must* be configured consecutively and in order (without gaps)
66-
* starting from GPT0, specifically if multiple timers are enabled.
64+
* General purpose timers (GPT[0-3]) are configured consecutively and in order
65+
* (without gaps) starting from GPT0, i.e. if multiple timers are enabled.
6766
*/
6867
typedef struct {
6968
uint8_t cfg; /**< timer config [16,32 Bit] */
7069
uint8_t chn; /**< number of channels [1,2] */
7170
} timer_conf_t;
7271

72+
#endif /* ifndef DOXYGEN */
73+
7374
#ifdef __cplusplus
7475
}
7576
#endif

0 commit comments

Comments
 (0)