diff --git a/drivers/watchdog/CMakeLists.txt b/drivers/watchdog/CMakeLists.txt index d683d949366..9aa8d29e6bd 100644 --- a/drivers/watchdog/CMakeLists.txt +++ b/drivers/watchdog/CMakeLists.txt @@ -2,6 +2,7 @@ zephyr_sources_ifdef(CONFIG_WDT_QMSI wdt_qmsi.c) zephyr_sources_ifdef(CONFIG_IWDG_STM32 wdt_iwdg_stm32.c) +zephyr_sources_ifdef(CONFIG_WWDG_STM32 wdt_wwdg_stm32.c) zephyr_sources_ifdef(CONFIG_WDOG_CMSDK_APB wdt_cmsdk_apb.c) zephyr_sources_ifdef(CONFIG_WDT_SAM wdt_sam.c) zephyr_sources_ifdef(CONFIG_WDT_ESP32 wdt_esp32.c) diff --git a/drivers/watchdog/Kconfig.stm32 b/drivers/watchdog/Kconfig.stm32 index 48ac80ba698..1b3c2c8b4cf 100644 --- a/drivers/watchdog/Kconfig.stm32 +++ b/drivers/watchdog/Kconfig.stm32 @@ -2,6 +2,7 @@ # # Copyright (c) 2016 Open-RnD Sp. z o.o. # Copyright (c) 2017 RnDity Sp. z o.o. +# Copyright (c) 2019 Centaur Analytics, Inc # # SPDX-License-Identifier: Apache-2.0 # @@ -30,3 +31,10 @@ config IWDG_STM32_TIMEOUT help Set timeout value for IWDG in microseconds. The min timeout supported is 0.1ms, the max timeout is 26214.4ms. + +config WWDG_STM32 + bool "System Window Watchdog (WWDG) Driver for STM32 family of MCUs" + depends on SOC_FAMILY_STM32 + select HAS_DTS_WDT + help + Enable WWDG driver for STM32 line of MCUs diff --git a/drivers/watchdog/wdt_wwdg_stm32.c b/drivers/watchdog/wdt_wwdg_stm32.c new file mode 100644 index 00000000000..7252a6dd9f5 --- /dev/null +++ b/drivers/watchdog/wdt_wwdg_stm32.c @@ -0,0 +1,272 @@ +/* + * Copyright (c) 2019 Centaur Analytics, Inc + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#include +#include +#include +#include +#include +#include + +#include "wdt_wwdg_stm32.h" + +#define WWDG_INTERNAL_DIVIDER 4096U +#define WWDG_RESET_LIMIT WWDG_COUNTER_MIN +#define WWDG_COUNTER_MIN 0x40 +#define WWDG_COUNTER_MAX 0x7f + +/* The timeout of the WWDG in milliseconds is calculated by the below formula: + * + * t_WWDG = 1000 * ((counter & 0x3F) + 1) / f_WWDG (ms) + * + * where: + * - t_WWDG: WWDG timeout + * - counter: a value in [0x40, 0x7F] representing the cycles before timeout. + * Giving the counter a value below 0x40, will result in an + * immediate system reset. A reset is produced when the counter + * rolls over from 0x40 to 0x3F. + * - f_WWDG: the frequency of the WWDG clock. This can be calculated by the + * below formula: + * f_WWDG = f_PCLK / (4096 * prescaler) (Hz) + * where: + * - f_PCLK: the clock frequency of the system + * - 4096: the constant internal divider + * - prescaler: the programmable divider with valid values of 1, 2, 4 or 8 + * + * The minimum timeout is calculated with: + * - counter = 0x40 + * - prescaler = 1 + * The maximim timeout is calculated with: + * - counter = 0x7F + * - prescaler = 8 + * + * E.g. for f_PCLK = 2MHz + * t_WWDG_min = 1000 * ((0x40 & 0x3F) + 1) / (2000000 / (4096 * 1)) + * = 2.048 ms + * t_WWDG_max = 1000 * ((0x7F & 0x3F) + 1) / (2000000 / (4096 * 8)) + * = 1048.576 ms + */ + +#define ABS_DIFF_UINT(a, b) ((a) > (b) ? (a) - (b) : (b) - (a)) +#define WWDG_TIMEOUT_ERROR_MARGIN (100 * USEC_PER_MSEC) +#define IS_WWDG_TIMEOUT(__TIMEOUT_GOLDEN__, __TIMEOUT__) \ + (ABS_DIFF_UINT(__TIMEOUT_GOLDEN__, __TIMEOUT__) < \ + WWDG_TIMEOUT_ERROR_MARGIN) + +static void wwdg_stm32_irq_config(struct device *dev); + +static u32_t wwdg_stm32_get_pclk(struct device *dev) +{ + struct device *clk = device_get_binding(STM32_CLOCK_CONTROL_NAME); + const struct wwdg_stm32_config *cfg = WWDG_STM32_CFG(dev); + u32_t pclk_rate; + + __ASSERT_NO_MSG(clk); + + clock_control_get_rate(clk, (clock_control_subsys_t *) &cfg->pclken, + &pclk_rate); + + return pclk_rate; +} + +/** + * @brief Calculates the timeout in microseconds. + * + * @param dev Pointer to device structure. + * @param prescaler The prescaler value. + * @param counter The counter value. + * @return The timeout calculated in microseconds. + */ +static u32_t wwdg_stm32_get_timeout(struct device *dev, u32_t prescaler, + u32_t counter) +{ + u32_t divider = WWDG_INTERNAL_DIVIDER * (1 << (prescaler >> 7)); + float f_wwdg = wwdg_stm32_get_pclk(dev) / divider; + + return USEC_PER_SEC * (((counter & 0x3F) + 1) / f_wwdg); +} + +/** + * @brief Calculates prescaler & counter values. + * + * @param dev Pointer to device structure. + * @param timeout Timeout value in microseconds. + * @param prescaler Pointer to prescaler value. + * @param counter Pointer to counter value. + */ +static void wwdg_stm32_convert_timeout(struct device *dev, u32_t timeout, + u32_t *prescaler, + u32_t *counter) +{ + u32_t clock_freq = wwdg_stm32_get_pclk(dev); + u8_t divider = 0U; + u8_t shift = 3U; + + /* Convert timeout to seconds. */ + float timeout_s = (float)timeout / USEC_PER_SEC; + float wwdg_freq; + + *prescaler = 0; + *counter = 0; + + for (divider = 8; divider >= 1; divider >>= 1) { + wwdg_freq = ((float)clock_freq) / WWDG_INTERNAL_DIVIDER / divider; + /* +1 to ceil the result, which may lose from truncation */ + *counter = (u32_t)(timeout_s * wwdg_freq + 1) - 1; + *counter |= WWDG_RESET_LIMIT; + *prescaler = shift << 7; + + if (*counter <= WWDG_COUNTER_MAX) { + break; + } + + shift--; + } +} + +static int wwdg_stm32_setup(struct device *dev, u8_t options) +{ + WWDG_TypeDef *wwdg = WWDG_STM32_STRUCT(dev); + + /* Deactivate running when debugger is attached. */ + if (options & WDT_OPT_PAUSE_HALTED_BY_DBG) { +#if defined(CONFIG_SOC_SERIES_STM32F0X) + LL_APB1_GRP2_EnableClock(LL_APB1_GRP2_PERIPH_DBGMCU); +#elif defined(CONFIG_SOC_SERIES_STM32L0X) + LL_APB2_GRP1_EnableClock(LL_APB2_GRP1_PERIPH_DBGMCU); +#endif + LL_DBGMCU_APB1_GRP1_FreezePeriph(LL_DBGMCU_APB1_GRP1_WWDG_STOP); + } + + if (options & WDT_OPT_PAUSE_IN_SLEEP) { + return -ENOTSUP; + } + + /* Enable the WWDG */ + LL_WWDG_Enable(wwdg); + + return 0; +} + +static int wwdg_stm32_disable(struct device *dev) +{ + /* watchdog cannot be stopped once started unless SOC gets a reset */ + ARG_UNUSED(dev); + + return -EPERM; +} + +static int wwdg_stm32_install_timeout(struct device *dev, + const struct wdt_timeout_cfg *config) +{ + struct wwdg_stm32_data *data = WWDG_STM32_DATA(dev); + WWDG_TypeDef *wwdg = WWDG_STM32_STRUCT(dev); + u32_t timeout = config->window.max * USEC_PER_MSEC; + u32_t calculated_timeout; + u32_t prescaler = 0U; + u32_t counter = 0U; + + if (config->callback != NULL) { + data->callback = config->callback; + } + + wwdg_stm32_convert_timeout(dev, timeout, &prescaler, &counter); + + calculated_timeout = wwdg_stm32_get_timeout(dev, prescaler, counter); + if (!(IS_WWDG_PRESCALER(prescaler) && IS_WWDG_COUNTER(counter) && + IS_WWDG_TIMEOUT(timeout, calculated_timeout))) { + /* One of the parameters provided is invalid */ + return -EINVAL; + } + + data->counter = counter; + + /* Configure WWDG */ + /* Set the programmable prescaler */ + LL_WWDG_SetPrescaler(wwdg, prescaler); + + /* Set window the same as the counter to be able to feed the WWDG almost + * immediately + */ + LL_WWDG_SetWindow(wwdg, counter); + LL_WWDG_SetCounter(wwdg, counter); + + return 0; +} + +static int wwdg_stm32_feed(struct device *dev, int channel_id) +{ + WWDG_TypeDef *wwdg = WWDG_STM32_STRUCT(dev); + struct wwdg_stm32_data *data = WWDG_STM32_DATA(dev); + + ARG_UNUSED(channel_id); + LL_WWDG_SetCounter(wwdg, data->counter); + + return 0; +} + +void wwdg_stm32_isr(void *arg) +{ + struct device *const dev = (struct device *)arg; + struct wwdg_stm32_data *data = WWDG_STM32_DATA(dev); + WWDG_TypeDef *wwdg = WWDG_STM32_STRUCT(dev); + + if (LL_WWDG_IsEnabledIT_EWKUP(wwdg)) { + if (LL_WWDG_IsActiveFlag_EWKUP(wwdg)) { + LL_WWDG_ClearFlag_EWKUP(wwdg); + data->callback(dev, 0); + } + } +} + +static const struct wdt_driver_api wwdg_stm32_api = { + .setup = wwdg_stm32_setup, + .disable = wwdg_stm32_disable, + .install_timeout = wwdg_stm32_install_timeout, + .feed = wwdg_stm32_feed, +}; + +static int wwdg_stm32_init(struct device *dev) +{ + struct device *clk = device_get_binding(STM32_CLOCK_CONTROL_NAME); + const struct wwdg_stm32_config *cfg = WWDG_STM32_CFG(dev); + + __ASSERT_NO_MSG(clk); + + clock_control_on(clk, (clock_control_subsys_t *) &cfg->pclken); + + wwdg_stm32_irq_config(dev); + + return 0; +} + +static struct wwdg_stm32_data wwdg_stm32_dev_data = { + .counter = WWDG_RESET_LIMIT, + .callback = NULL +}; + +static struct wwdg_stm32_config wwdg_stm32_dev_config = { + .pclken = { + .enr = DT_WWDT_0_CLOCK_BITS, + .bus = DT_WWDT_0_CLOCK_BUS + }, + .Instance = (WWDG_TypeDef *)DT_WWDT_0_BASE_ADDRESS, +}; + +DEVICE_AND_API_INIT(wwdg_stm32, DT_WWDT_0_NAME, + wwdg_stm32_init, &wwdg_stm32_dev_data, &wwdg_stm32_dev_config, + POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEVICE, + &wwdg_stm32_api); + +static void wwdg_stm32_irq_config(struct device *dev) +{ + WWDG_TypeDef *wwdg = WWDG_STM32_STRUCT(dev); + + IRQ_CONNECT(DT_WWDT_0_IRQ, DT_WWDT_0_IRQ_PRI, + wwdg_stm32_isr, DEVICE_GET(wwdg_stm32), 0); + irq_enable(DT_WWDT_0_IRQ); + LL_WWDG_EnableIT_EWKUP(wwdg); +} diff --git a/drivers/watchdog/wdt_wwdg_stm32.h b/drivers/watchdog/wdt_wwdg_stm32.h new file mode 100644 index 00000000000..0826ede9a0e --- /dev/null +++ b/drivers/watchdog/wdt_wwdg_stm32.h @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2019 Centaur Analytics, Inc + * + * SPDX-License-Identifier: Apache-2.0 + */ + +#ifndef ZEPHYR_DRIVERS_WATCHDOG_WWDG_STM32_H_ +#define ZEPHYR_DRIVERS_WATCHDOG_WWDG_STM32_H_ + +#include +#include +#include + +/** + * @brief Driver for System Window Watchdog (WWDG) for STM32 MCUs + * + * The driver targets all STM32 SoCs. For details please refer to + * an appropriate reference manual and look for chapter called: + * + * System window watchdog (WWDG) + * + */ + +/* driver configuration */ +struct wwdg_stm32_config { + struct stm32_pclken pclken; + WWDG_TypeDef *Instance; +}; + +/* driver data */ +struct wwdg_stm32_data { + /* WWDG reset counter */ + u8_t counter; + + /* WWDG user defined callback on EWI */ + wdt_callback_t callback; +}; + +#define WWDG_STM32_CFG(dev) \ + ((const struct wwdg_stm32_config *const)(dev)->config->config_info) + +#define WWDG_STM32_DATA(dev) \ + ((struct wwdg_stm32_data *const)(dev)->driver_data) + +#define WWDG_STM32_STRUCT(dev) \ + ((WWDG_TypeDef *)(WWDG_STM32_CFG(dev))->Instance) + +#endif /* ZEPHYR_DRIVERS_WATCHDOG_WWDG_STM32_H_ */ diff --git a/soc/arm/st_stm32/common/Kconfig.defconfig.series b/soc/arm/st_stm32/common/Kconfig.defconfig.series index 6349e2c16d3..41f057b8c7f 100644 --- a/soc/arm/st_stm32/common/Kconfig.defconfig.series +++ b/soc/arm/st_stm32/common/Kconfig.defconfig.series @@ -44,6 +44,9 @@ if WATCHDOG config IWDG_STM32 default y +config WWDG_STM32 + default n + endif # WATCHDOG if PWM diff --git a/soc/arm/st_stm32/stm32f0/soc.h b/soc/arm/st_stm32/stm32f0/soc.h index 9e838d1ceb4..b0e3be5346d 100644 --- a/soc/arm/st_stm32/stm32f0/soc.h +++ b/soc/arm/st_stm32/stm32f0/soc.h @@ -47,6 +47,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #ifdef CONFIG_I2C_STM32_V2 #include #endif diff --git a/soc/arm/st_stm32/stm32f1/soc.h b/soc/arm/st_stm32/stm32f1/soc.h index 5a69f5f1c0e..f192986ca01 100644 --- a/soc/arm/st_stm32/stm32f1/soc.h +++ b/soc/arm/st_stm32/stm32f1/soc.h @@ -55,6 +55,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #ifdef CONFIG_GPIO_STM32 #include #endif diff --git a/soc/arm/st_stm32/stm32f2/soc.h b/soc/arm/st_stm32/stm32f2/soc.h index f2fdfa4f044..fe3157e8895 100644 --- a/soc/arm/st_stm32/stm32f2/soc.h +++ b/soc/arm/st_stm32/stm32f2/soc.h @@ -50,6 +50,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #ifdef CONFIG_ADC_STM32 #include #endif diff --git a/soc/arm/st_stm32/stm32f3/soc.h b/soc/arm/st_stm32/stm32f3/soc.h index eb0202cd3a6..0f2c6efd63b 100644 --- a/soc/arm/st_stm32/stm32f3/soc.h +++ b/soc/arm/st_stm32/stm32f3/soc.h @@ -56,6 +56,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #if defined(CONFIG_RTC_STM32) || defined(CONFIG_COUNTER_RTC_STM32) #include #include diff --git a/soc/arm/st_stm32/stm32f4/soc.h b/soc/arm/st_stm32/stm32f4/soc.h index 5f00892031d..23ee51f31d8 100644 --- a/soc/arm/st_stm32/stm32f4/soc.h +++ b/soc/arm/st_stm32/stm32f4/soc.h @@ -59,6 +59,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #if defined(CONFIG_RTC_STM32) || defined(CONFIG_COUNTER_RTC_STM32) #include #include diff --git a/soc/arm/st_stm32/stm32f7/soc.h b/soc/arm/st_stm32/stm32f7/soc.h index 2c33c4e1b07..94cfe8d0b92 100644 --- a/soc/arm/st_stm32/stm32f7/soc.h +++ b/soc/arm/st_stm32/stm32f7/soc.h @@ -68,6 +68,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #ifdef CONFIG_ADC_STM32 #include #endif diff --git a/soc/arm/st_stm32/stm32g0/soc.h b/soc/arm/st_stm32/stm32g0/soc.h index f3b23f5caf1..35b32be94d5 100644 --- a/soc/arm/st_stm32/stm32g0/soc.h +++ b/soc/arm/st_stm32/stm32g0/soc.h @@ -44,6 +44,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #ifdef CONFIG_SERIAL_HAS_DRIVER #include #endif diff --git a/soc/arm/st_stm32/stm32h7/soc.h b/soc/arm/st_stm32/stm32h7/soc.h index e8407df0f3b..3bda6ecc21d 100644 --- a/soc/arm/st_stm32/stm32h7/soc.h +++ b/soc/arm/st_stm32/stm32h7/soc.h @@ -52,6 +52,10 @@ #include #endif /* CONFIG_GPIO_STM32 */ +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #ifdef CONFIG_SERIAL_HAS_DRIVER #include #endif /* CONFIG_SERIAL_HAS_DRIVER */ diff --git a/soc/arm/st_stm32/stm32l0/soc.h b/soc/arm/st_stm32/stm32l0/soc.h index 4fbbdb3cb84..8b91da72ec3 100644 --- a/soc/arm/st_stm32/stm32l0/soc.h +++ b/soc/arm/st_stm32/stm32l0/soc.h @@ -60,6 +60,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #ifdef CONFIG_ADC_STM32 #include #endif diff --git a/soc/arm/st_stm32/stm32l1/soc.h b/soc/arm/st_stm32/stm32l1/soc.h index 70ebde39ec0..19e0962019b 100644 --- a/soc/arm/st_stm32/stm32l1/soc.h +++ b/soc/arm/st_stm32/stm32l1/soc.h @@ -51,6 +51,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #endif /* !_ASMLANGUAGE */ #endif /* _STM32L1_SOC_H_ */ diff --git a/soc/arm/st_stm32/stm32l4/soc.h b/soc/arm/st_stm32/stm32l4/soc.h index 12b10cec60e..ae7535f2f99 100644 --- a/soc/arm/st_stm32/stm32l4/soc.h +++ b/soc/arm/st_stm32/stm32l4/soc.h @@ -64,6 +64,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #ifdef CONFIG_ENTROPY_STM32_RNG #include #endif diff --git a/soc/arm/st_stm32/stm32mp1/soc.h b/soc/arm/st_stm32/stm32mp1/soc.h index 392e010a148..582e37f9f0d 100644 --- a/soc/arm/st_stm32/stm32mp1/soc.h +++ b/soc/arm/st_stm32/stm32mp1/soc.h @@ -58,6 +58,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #endif /* !_ASMLANGUAGE */ #endif /* _STM32MP1SOC_H_ */ diff --git a/soc/arm/st_stm32/stm32wb/soc.h b/soc/arm/st_stm32/stm32wb/soc.h index 928f363cc9a..26c4fa4464a 100644 --- a/soc/arm/st_stm32/stm32wb/soc.h +++ b/soc/arm/st_stm32/stm32wb/soc.h @@ -65,6 +65,10 @@ #include #endif +#ifdef CONFIG_WWDG_STM32 +#include +#endif + #endif /* !_ASMLANGUAGE */ #endif /* _STM32WBX_SOC_H_ */