EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

swm050: wdt: doxygen polish

Browse Source
This commit is contained in:
Karl Palsson
2019-11-28 11:43:01 +00:00
parent 47b59e2df4
commit da0c6a6724
3 changed files with 70 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/libopencm3/swm050/sysctl.h
View File

@@ -34,8 +34,8 @@
/** @defgroup sysctl_bit_defs SYSCTL register bit definitions /** @defgroup sysctl_bit_defs SYSCTL register bit definitions
@{*/ @{*/
#define SYSCTL_SYS_CFG_2_SLEEP (1 << 4) #define SYSCTL_SYS_CFG_2_SLEEP (1 << 4)
#define SYSCTL_SYS_CFG_1_TIMERSE0 (1 << 6)
#define SYSCTL_SYS_CFG_1_TIMERSE1 (1 << 17) #define SYSCTL_SYS_CFG_1_TIMERSE1 (1 << 17)
#define SYSCTL_SYS_CFG_1_TIMERSE0 (1 << 6)
#define SYSCTL_SYS_CFG_1_WDT (1 << 4) #define SYSCTL_SYS_CFG_1_WDT (1 << 4)
/**@}*/ /**@}*/

4
include/libopencm3/swm050/wdt.h
View File

@@ -35,9 +35,9 @@
/** @defgroup wdt_modes Watchdog mode /** @defgroup wdt_modes Watchdog mode
@{*/ @{*/
enum wdt_modes { enum wdt_modes {
/* On timeout, reset the system */ /** On timeout, reset the system */
WDT_MODE_RESET, WDT_MODE_RESET,
/* On timeout, generate an interrupt. If another timeout occurs without /** On timeout, generate an interrupt. If another timeout (time2) occurs without
the interrupt being cleared, reset the system. */ the interrupt being cleared, reset the system. */
WDT_MODE_INT WDT_MODE_INT
}; };

124
lib/swm050/wdt.c
View File

@@ -27,14 +27,13 @@
#include <libopencm3/swm050/wdt.h> #include <libopencm3/swm050/wdt.h>
#include <libopencm3/swm050/sysctl.h> #include <libopencm3/swm050/sysctl.h>
/*---------------------------------------------------------------------------*/ /**
/** Sets up the WDT before the call to wdt_enable(). * Sets up the WDT before the call to @ref wdt_enable().
* This only prepares the watchdog, it will not start counting until
@param mode passed to wdt_mode() * it is enabled.
* @param mode passed to @ref wdt_mode()
@param time1 passed to wdt_set_time() * @param time1 passed to @ref wdt_set_time()
* @param time2 passed to @ref wdt_set_time()
@param time2 passed to wdt_set_time()
*/ */
void wdt_setup(enum wdt_modes mode, uint8_t time1, uint8_t time2) void wdt_setup(enum wdt_modes mode, uint8_t time1, uint8_t time2)
{ {
@@ -43,13 +42,15 @@ void wdt_setup(enum wdt_modes mode, uint8_t time1, uint8_t time2)
wdt_mode(mode); wdt_mode(mode);
wdt_reset(); wdt_reset();
} }
/*---------------------------------------------------------------------------*/
/** Enables the WDT.
If WDT_MODE_INT is used, the interrupt should also be enabled /**
using the NVIC before enabling the WDT. * Enables the WDT.
* This actually starts the watchdog, you should have already selected
@param en enable * modes and set timeouts.
* If @ref WDT_MODE_INT is used, the interrupt should also be enabled
* using the NVIC before enabling the WDT.
* @sa wdt_setup
* @param en enable
*/ */
void wdt_enable(bool en) void wdt_enable(bool en)
{ {
@@ -60,10 +61,9 @@ void wdt_enable(bool en)
} }
} }
/*---------------------------------------------------------------------------*/ /**
/** Sets the WDT's mode of operation. * Sets the WDT's mode of operation.
* @param mode The mode of operation @ref wdt_modes
@param mode The mode of operation @ref wdt_modes
*/ */
void wdt_mode(enum wdt_modes mode) void wdt_mode(enum wdt_modes mode)
{ {
@@ -74,33 +74,29 @@ void wdt_mode(enum wdt_modes mode)
} }
} }
/*---------------------------------------------------------------------------*/ /**
/** Restarts the WDT's counter. * Reset the WDT's counter.
* The "feed the dog" operation. Must be called periodically to avoid a
The "feed the dog" operation. Must be called periodically to avoid a timeout. * timeout. Calling this also clears any WDT interrupts.
Calling this also clears any WDT interrupts.
*/ */
void wdt_reset(void) void wdt_reset(void)
{ {
WDT_CRR = 0x76; WDT_CRR = 0x76;
} }
/*---------------------------------------------------------------------------*/ /**
/** Gets the WDT's interrupt status. * Gets the WDT's interrupt status.
* @note Only useful with @ref WDT_MODE_INT
Only useful in WDT_MODE_INT. * @return The WDT's interrupt status. True if an interrupt has not been cleared.
@return The WDT's interrupt status. True if an interrupt has not been cleared.
*/ */
bool wdt_int_status(void) bool wdt_int_status(void)
{ {
return WDT_STAT & 0x1; return WDT_STAT & 0x1;
} }
/*---------------------------------------------------------------------------*/ /**
/** Clears the WDT's interrupt. * Clears the WDT's interrupt.
* @note Only useful with @ref WDT_MODE_INT
Only useful in WDT_MODE_INT.
*/ */
void wdt_clear_int(void) void wdt_clear_int(void)
{ {
@@ -110,10 +106,11 @@ void wdt_clear_int(void)
(void)dummy; (void)dummy;
} }
/*---------------------------------------------------------------------------*/ /**
/** Enables the WDT's clock. * Enables the WDT's clock.
* This only enables the clock to the peripheral.
@param en True to enable, false to disable * @sa wdt_setup
* @param en True to enable, false to disable
*/ */
void wdt_clock_enable(bool en) void wdt_clock_enable(bool en)
{ {
@@ -124,41 +121,36 @@ void wdt_clock_enable(bool en)
} }
} }
/*---------------------------------------------------------------------------*/ /**
/** Gets the current WDT counter value. * Gets the current WDT counter value.
* The vendor-supplied documentation for the @ref WDT_CCVR register appears to be
The vendor-supplied documentation for the WDT_CCVR register appears to be * incorrect, and does not seem to be 1 bit wide, which would make no sense.
incorrect, and does not seem to be 1 bit wide, which would make no sense. * @return The current WDT counter value
@return The current WDT counter value
*/ */
uint32_t wdt_get_value(void) uint32_t wdt_get_value(void)
{ {
return WDT_CCVR; return WDT_CCVR;
} }
/*---------------------------------------------------------------------------*/ /**
/** Sets the WDT's initial counter values. * Sets the WDT's initial counter values.
* Both time1 and time2 follow the equation 2^(8 + i), where i is a value from
Both time1 and time2 follow the equation 2^(8 + i), where i is a value from * 0 to 15, and where the result is in clock cycles.
0 to 15, and where the result is in clock cycles. * For example:
* time1 = 15
For example: * 2^(8 + time1) / 18Mhz = 0.466s
time1 = 15 * The majority of the vendor-supplied documentation appears to be completely
2^(8 + time1) / 18Mhz = 0.466s * incorrect about the equation used for these counters.
*
The majority of the vendor-supplied documentation appears to be completely * Only the least significant 4 bits are used for both values, eg 0 to 15.
incorrect about the equation used for these counters. *
* @param time1 The timer value used in both modes. In @ref WDT_MODE_RESET, this
@param time1 The timer value used in both modes. In WDT_MODE_RESET, this value * value counts down to 0 and resets the system. In @ref WDT_MODE_INT, this value
counts down to 0 and resets the system. In WDT_MODE_INT, this value counts down * counts down to 0, generates a WDT interrupt, loads time2 into the counter,
to 0, generates a WDT interrupt, loads time2 into the counter, and counts down. * and counts down.
Only the 4 least significant bits of this value are used, e.g. 0 to 15. * @param time2 The timer value used after time1 in mode @ref WDT_MODE_INT. If
* this counts down to 0, and the WDT interrupt has not been cleared, the
@param time2 The timer value used after time1 in mode WDT_MODE_INT. If this * system resets. This has no use in mode @ref WDT_MODE_RESET.
counts down to 0, and the WDT interrupt has not been cleared, the system resets.
This has no use in mode WDT_MODE_RESET.
Only the 4 least significant bits of this value are used, e.g. 0 to 15.
*/ */
void wdt_set_time(uint8_t time1, uint8_t time2) void wdt_set_time(uint8_t time1, uint8_t time2)
{ {