tinySA/os/hal/ports/STM32/LLD/xWDGv1/wdg_lld.h

181 lines
5.3 KiB
C

/*
ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file wdg_lld.h
* @brief WDG Driver subsystem low level driver header.
*
* @addtogroup WDG
* @{
*/
#ifndef _WDG_LLD_H_
#define _WDG_LLD_H_
#if HAL_USE_WDG || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/**
* @name RLR register definitions
* @{
*/
#define STM32_IWDG_RL_MASK (0x00000FFF << 0)
#define STM32_IWDG_RL(n) ((n) << 0)
/** @} */
/**
* @name PR register definitions
* @{
*/
#define STM32_IWDG_PR_MASK (7 << 0)
#define STM32_IWDG_PR_4 0U
#define STM32_IWDG_PR_8 1U
#define STM32_IWDG_PR_16 2U
#define STM32_IWDG_PR_32 3U
#define STM32_IWDG_PR_64 4U
#define STM32_IWDG_PR_128 5U
#define STM32_IWDG_PR_256 6U
/** @} */
/**
* @name WINR register definitions
* @{
*/
#define STM32_IWDG_WIN_MASK (0x00000FFF << 0)
#define STM32_IWDG_WIN(n) ((n) << 0)
#define STM32_IWDG_WIN_DISABLED STM32_IWDG_WIN(0x00000FFF)
/** @} */
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/**
* @brief IWDG driver enable switch.
* @details If set to @p TRUE the support for IWDG is included.
* @note The default is @p FALSE.
*/
#if !defined(STM32_WDG_USE_IWDG) || defined(__DOXYGEN__)
#define STM32_WDG_USE_IWDG FALSE
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if STM32_WDG_USE_IWDG && !STM32_HAS_IWDG
#error "IWDG not present in the selected device"
#endif
#if !STM32_WDG_USE_IWDG
#error "WDG driver activated but no xWDG peripheral assigned"
#endif
#if !defined(STM32_LSI_ENABLED)
#error "STM32_LSI_ENABLED not defined"
#endif
#if (STM32_WDG_USE_IWDG == TRUE) && (STM32_LSI_ENABLED == FALSE)
#error "IWDG requires LSI clock"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a structure representing an WDG driver.
*/
typedef struct WDGDriver WDGDriver;
/**
* @brief Driver configuration structure.
* @note It could be empty on some architectures.
*/
typedef struct {
/**
* @brief Configuration of the IWDG_PR register.
* @details See the STM32 reference manual for details.
*/
uint32_t pr;
/**
* @brief Configuration of the IWDG_RLR register.
* @details See the STM32 reference manual for details.
*/
uint32_t rlr;
/**
* @brief Configuration of the IWDG_WINR register.
* @details See the STM32 reference manual for details.
*/
uint32_t winr;
} WDGConfig;
/**
* @brief Structure representing an WDG driver.
*/
struct WDGDriver {
/**
* @brief Driver state.
*/
wdgstate_t state;
/**
* @brief Current configuration data.
*/
const WDGConfig *config;
/* End of the mandatory fields.*/
/**
* @brief Pointer to the IWDG registers block.
*/
IWDG_TypeDef *wdg;
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#if STM32_WDG_USE_IWDG && !defined(__DOXYGEN__)
extern WDGDriver WDGD1;
#endif
#ifdef __cplusplus
extern "C" {
#endif
void wdg_lld_init(void);
void wdg_lld_start(WDGDriver *wdgp);
void wdg_lld_stop(WDGDriver *wdgp);
void wdg_lld_reset(WDGDriver *wdgp);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_WDG */
#endif /* _WDG_LLD_H_ */
/** @} */