diff options
author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-19 15:00:45 -0400 |
---|---|---|
committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-19 18:45:45 -0400 |
commit | 58fb7e2e586acc0263c1a228290327d18fdd184b (patch) | |
tree | a13e12438c2a9c7065c716739678da74092c4b0b /libmaple/iwdg.h | |
parent | 44394fd34d98e356557c80da2e60b789870a4eeb (diff) | |
download | librambutan-58fb7e2e586acc0263c1a228290327d18fdd184b.tar.gz librambutan-58fb7e2e586acc0263c1a228290327d18fdd184b.zip |
iwdg: Doxygen comments
Diffstat (limited to 'libmaple/iwdg.h')
-rw-r--r-- | libmaple/iwdg.h | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/libmaple/iwdg.h b/libmaple/iwdg.h index 551bb12..7845578 100644 --- a/libmaple/iwdg.h +++ b/libmaple/iwdg.h @@ -58,6 +58,7 @@ typedef struct iwdg_reg_map { __io uint32 SR; /**< Status register */ } iwdg_reg_map; +/** Independent watchdog base pointer */ #define IWDG_BASE ((struct iwdg_reg_map*)0x40003000) /* @@ -88,15 +89,19 @@ typedef struct iwdg_reg_map { #define IWDG_SR_RVU BIT(IWDG_SR_RVU_BIT) #define IWDG_SR_PVU BIT(IWDG_SR_PVU_BIT) -/** Independent watchdog prescalers */ +/** + * @brief Independent watchdog prescalers. + * + * These divide the 40 kHz IWDG clock. + */ typedef enum iwdg_prescaler { - IWDG_PRE_4 = IWDG_PR_DIV_4, - IWDG_PRE_8 = IWDG_PR_DIV_8, - IWDG_PRE_16 = IWDG_PR_DIV_16, - IWDG_PRE_32 = IWDG_PR_DIV_32, - IWDG_PRE_64 = IWDG_PR_DIV_64, - IWDG_PRE_128 = IWDG_PR_DIV_128, - IWDG_PRE_256 = IWDG_PR_DIV_256 + IWDG_PRE_4 = IWDG_PR_DIV_4, /**< Divide by 4 */ + IWDG_PRE_8 = IWDG_PR_DIV_8, /**< Divide by 8 */ + IWDG_PRE_16 = IWDG_PR_DIV_16, /**< Divide by 16 */ + IWDG_PRE_32 = IWDG_PR_DIV_32, /**< Divide by 32 */ + IWDG_PRE_64 = IWDG_PR_DIV_64, /**< Divide by 64 */ + IWDG_PRE_128 = IWDG_PR_DIV_128, /**< Divide by 128 */ + IWDG_PRE_256 = IWDG_PR_DIV_256 /**< Divide by 256 */ } iwdg_prescaler; void iwdg_init(iwdg_prescaler prescaler, uint16 reload); |