Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_MOTE_L152RC/stm32l1xx_hal_iwdg.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
112:6f327212ef96 
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 112:6f327212ef96 1 /**
Kojto 112:6f327212ef96 2 ******************************************************************************
Kojto 112:6f327212ef96 3 * @file stm32l1xx_hal_iwdg.h
Kojto 112:6f327212ef96 4 * @author MCD Application Team
Kojto 112:6f327212ef96 5 * @version V1.0.0
Kojto 112:6f327212ef96 6 * @date 5-September-2014
Kojto 112:6f327212ef96 7 * @brief Header file of IWDG HAL module.
Kojto 112:6f327212ef96 8 ******************************************************************************
Kojto 112:6f327212ef96 9 * @attention
Kojto 112:6f327212ef96 10 *
Kojto 112:6f327212ef96 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
Kojto 112:6f327212ef96 12 *
Kojto 112:6f327212ef96 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 112:6f327212ef96 14 * are permitted provided that the following conditions are met:
Kojto 112:6f327212ef96 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 112:6f327212ef96 16 * this list of conditions and the following disclaimer.
Kojto 112:6f327212ef96 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 112:6f327212ef96 18 * this list of conditions and the following disclaimer in the documentation
Kojto 112:6f327212ef96 19 * and/or other materials provided with the distribution.
Kojto 112:6f327212ef96 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 112:6f327212ef96 21 * may be used to endorse or promote products derived from this software
Kojto 112:6f327212ef96 22 * without specific prior written permission.
Kojto 112:6f327212ef96 23 *
Kojto 112:6f327212ef96 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 112:6f327212ef96 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 112:6f327212ef96 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 112:6f327212ef96 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 112:6f327212ef96 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 112:6f327212ef96 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 112:6f327212ef96 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 112:6f327212ef96 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 112:6f327212ef96 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 112:6f327212ef96 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 112:6f327212ef96 34 *
Kojto 112:6f327212ef96 35 ******************************************************************************
Kojto 112:6f327212ef96 36 */
Kojto 112:6f327212ef96 37
Kojto 112:6f327212ef96 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 112:6f327212ef96 39 #ifndef __STM32L1xx_HAL_IWDG_H
Kojto 112:6f327212ef96 40 #define __STM32L1xx_HAL_IWDG_H
Kojto 112:6f327212ef96 41
Kojto 112:6f327212ef96 42 #ifdef __cplusplus
Kojto 112:6f327212ef96 43 extern "C" {
Kojto 112:6f327212ef96 44 #endif
Kojto 112:6f327212ef96 45
Kojto 112:6f327212ef96 46 /* Includes ------------------------------------------------------------------*/
Kojto 112:6f327212ef96 47 #include "stm32l1xx_hal_def.h"
Kojto 112:6f327212ef96 48
Kojto 112:6f327212ef96 49 /** @addtogroup STM32L1xx_HAL_Driver
Kojto 112:6f327212ef96 50 * @{
Kojto 112:6f327212ef96 51 */
Kojto 112:6f327212ef96 52
Kojto 112:6f327212ef96 53 /** @addtogroup IWDG
Kojto 112:6f327212ef96 54 * @{
Kojto 112:6f327212ef96 55 */
Kojto 112:6f327212ef96 56
Kojto 112:6f327212ef96 57 /* Exported types ------------------------------------------------------------*/
Kojto 112:6f327212ef96 58
Kojto 112:6f327212ef96 59 /** @defgroup IWDG_Exported_Types IWDG Exported Types
Kojto 112:6f327212ef96 60 * @{
Kojto 112:6f327212ef96 61 */
Kojto 112:6f327212ef96 62
Kojto 112:6f327212ef96 63 /**
Kojto 112:6f327212ef96 64 * @brief IWDG HAL State Structure definition
Kojto 112:6f327212ef96 65 */
Kojto 112:6f327212ef96 66 typedef enum
Kojto 112:6f327212ef96 67 {
Kojto 112:6f327212ef96 68 HAL_IWDG_STATE_RESET = 0x00, /*!< IWDG not yet initialized or disabled */
Kojto 112:6f327212ef96 69 HAL_IWDG_STATE_READY = 0x01, /*!< IWDG initialized and ready for use */
Kojto 112:6f327212ef96 70 HAL_IWDG_STATE_BUSY = 0x02, /*!< IWDG internal process is ongoing */
Kojto 112:6f327212ef96 71 HAL_IWDG_STATE_TIMEOUT = 0x03, /*!< IWDG timeout state */
Kojto 112:6f327212ef96 72 HAL_IWDG_STATE_ERROR = 0x04 /*!< IWDG error state */
Kojto 112:6f327212ef96 73
Kojto 112:6f327212ef96 74 }HAL_IWDG_StateTypeDef;
Kojto 112:6f327212ef96 75
Kojto 112:6f327212ef96 76 /**
Kojto 112:6f327212ef96 77 * @brief IWDG Init structure definition
Kojto 112:6f327212ef96 78 */
Kojto 112:6f327212ef96 79 typedef struct
Kojto 112:6f327212ef96 80 {
Kojto 112:6f327212ef96 81 uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
Kojto 112:6f327212ef96 82 This parameter can be a value of @ref IWDG_Prescaler */
Kojto 112:6f327212ef96 83
Kojto 112:6f327212ef96 84 uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
Kojto 112:6f327212ef96 85 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
Kojto 112:6f327212ef96 86
Kojto 112:6f327212ef96 87 }IWDG_InitTypeDef;
Kojto 112:6f327212ef96 88
Kojto 112:6f327212ef96 89 /**
Kojto 112:6f327212ef96 90 * @brief IWDG Handle Structure definition
Kojto 112:6f327212ef96 91 */
Kojto 112:6f327212ef96 92 typedef struct
Kojto 112:6f327212ef96 93 {
Kojto 112:6f327212ef96 94 IWDG_TypeDef *Instance; /*!< Register base address */
Kojto 112:6f327212ef96 95
Kojto 112:6f327212ef96 96 IWDG_InitTypeDef Init; /*!< IWDG required parameters */
Kojto 112:6f327212ef96 97
Kojto 112:6f327212ef96 98 HAL_LockTypeDef Lock; /*!< IWDG Locking object */
Kojto 112:6f327212ef96 99
Kojto 112:6f327212ef96 100 __IO HAL_IWDG_StateTypeDef State; /*!< IWDG communication state */
Kojto 112:6f327212ef96 101
Kojto 112:6f327212ef96 102 }IWDG_HandleTypeDef;
Kojto 112:6f327212ef96 103
Kojto 112:6f327212ef96 104 /**
Kojto 112:6f327212ef96 105 * @}
Kojto 112:6f327212ef96 106 */
Kojto 112:6f327212ef96 107
Kojto 112:6f327212ef96 108 /* Exported constants --------------------------------------------------------*/
Kojto 112:6f327212ef96 109
Kojto 112:6f327212ef96 110 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
Kojto 112:6f327212ef96 111 * @{
Kojto 112:6f327212ef96 112 */
Kojto 112:6f327212ef96 113
Kojto 112:6f327212ef96 114 /** @defgroup IWDG_Registers_BitMask IWDG_Registers_BitMask
Kojto 112:6f327212ef96 115 * @brief IWDG registers bit mask
Kojto 112:6f327212ef96 116 * @{
Kojto 112:6f327212ef96 117 */
Kojto 112:6f327212ef96 118 /* --- KR Register ---*/
Kojto 112:6f327212ef96 119 /* KR register bit mask */
Kojto 112:6f327212ef96 120 #define KR_KEY_RELOAD ((uint32_t)0xAAAA) /*!< IWDG Reload Counter Enable */
Kojto 112:6f327212ef96 121 #define KR_KEY_ENABLE ((uint32_t)0xCCCC) /*!< IWDG Peripheral Enable */
Kojto 112:6f327212ef96 122 #define KR_KEY_EWA ((uint32_t)0x5555) /*!< IWDG KR Write Access Enable */
Kojto 112:6f327212ef96 123 #define KR_KEY_DWA ((uint32_t)0x0000) /*!< IWDG KR Write Access Disable */
Kojto 112:6f327212ef96 124
Kojto 112:6f327212ef96 125 #define IS_IWDG_KR(__KR__) (((__KR__) == KR_KEY_RELOAD) || \
Kojto 112:6f327212ef96 126 ((__KR__) == KR_KEY_ENABLE))|| \
Kojto 112:6f327212ef96 127 ((__KR__) == KR_KEY_EWA)) || \
Kojto 112:6f327212ef96 128 ((__KR__) == KR_KEY_DWA))
Kojto 112:6f327212ef96 129 /**
Kojto 112:6f327212ef96 130 * @}
Kojto 112:6f327212ef96 131 */
Kojto 112:6f327212ef96 132
Kojto 112:6f327212ef96 133 /** @defgroup IWDG_Flag_definition IWDG_Flag_definition
Kojto 112:6f327212ef96 134 * @{
Kojto 112:6f327212ef96 135 */
Kojto 112:6f327212ef96 136 #define IWDG_FLAG_PVU ((uint32_t)IWDG_SR_PVU) /*!< Watchdog counter prescaler value update Flag */
Kojto 112:6f327212ef96 137 #define IWDG_FLAG_RVU ((uint32_t)IWDG_SR_RVU) /*!< Watchdog counter reload value update Flag */
Kojto 112:6f327212ef96 138
Kojto 112:6f327212ef96 139 /**
Kojto 112:6f327212ef96 140 * @}
Kojto 112:6f327212ef96 141 */
Kojto 112:6f327212ef96 142
Kojto 112:6f327212ef96 143 /** @defgroup IWDG_Prescaler IWDG_Prescaler
Kojto 112:6f327212ef96 144 * @{
Kojto 112:6f327212ef96 145 */
Kojto 112:6f327212ef96 146 #define IWDG_PRESCALER_4 ((uint8_t)0x00) /*!< IWDG prescaler set to 4 */
Kojto 112:6f327212ef96 147 #define IWDG_PRESCALER_8 ((uint8_t)(IWDG_PR_PR_0)) /*!< IWDG prescaler set to 8 */
Kojto 112:6f327212ef96 148 #define IWDG_PRESCALER_16 ((uint8_t)(IWDG_PR_PR_1)) /*!< IWDG prescaler set to 16 */
Kojto 112:6f327212ef96 149 #define IWDG_PRESCALER_32 ((uint8_t)(IWDG_PR_PR_1 | IWDG_PR_PR_0)) /*!< IWDG prescaler set to 32 */
Kojto 112:6f327212ef96 150 #define IWDG_PRESCALER_64 ((uint8_t)(IWDG_PR_PR_2)) /*!< IWDG prescaler set to 64 */
Kojto 112:6f327212ef96 151 #define IWDG_PRESCALER_128 ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_0)) /*!< IWDG prescaler set to 128 */
Kojto 112:6f327212ef96 152 #define IWDG_PRESCALER_256 ((uint8_t)(IWDG_PR_PR_2 | IWDG_PR_PR_1)) /*!< IWDG prescaler set to 256 */
Kojto 112:6f327212ef96 153
Kojto 112:6f327212ef96 154 #define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
Kojto 112:6f327212ef96 155 ((__PRESCALER__) == IWDG_PRESCALER_8) || \
Kojto 112:6f327212ef96 156 ((__PRESCALER__) == IWDG_PRESCALER_16) || \
Kojto 112:6f327212ef96 157 ((__PRESCALER__) == IWDG_PRESCALER_32) || \
Kojto 112:6f327212ef96 158 ((__PRESCALER__) == IWDG_PRESCALER_64) || \
Kojto 112:6f327212ef96 159 ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
Kojto 112:6f327212ef96 160 ((__PRESCALER__) == IWDG_PRESCALER_256))
Kojto 112:6f327212ef96 161
Kojto 112:6f327212ef96 162 /**
Kojto 112:6f327212ef96 163 * @}
Kojto 112:6f327212ef96 164 */
Kojto 112:6f327212ef96 165
Kojto 112:6f327212ef96 166 /** @defgroup IWDG_Reload_Value IWDG_Reload_Value
Kojto 112:6f327212ef96 167 * @{
Kojto 112:6f327212ef96 168 */
Kojto 112:6f327212ef96 169 #define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= 0xFFF)
Kojto 112:6f327212ef96 170
Kojto 112:6f327212ef96 171 /**
Kojto 112:6f327212ef96 172 * @}
Kojto 112:6f327212ef96 173 */
Kojto 112:6f327212ef96 174
Kojto 112:6f327212ef96 175 /**
Kojto 112:6f327212ef96 176 * @}
Kojto 112:6f327212ef96 177 */
Kojto 112:6f327212ef96 178
Kojto 112:6f327212ef96 179 /* Exported macros -----------------------------------------------------------*/
Kojto 112:6f327212ef96 180
Kojto 112:6f327212ef96 181 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
Kojto 112:6f327212ef96 182 * @{
Kojto 112:6f327212ef96 183 */
Kojto 112:6f327212ef96 184
Kojto 112:6f327212ef96 185 /** @brief Reset IWDG handle state
Kojto 112:6f327212ef96 186 * @param __HANDLE__: IWDG handle.
Kojto 112:6f327212ef96 187 * @retval None
Kojto 112:6f327212ef96 188 */
Kojto 112:6f327212ef96 189 #define __HAL_IWDG_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IWDG_STATE_RESET)
Kojto 112:6f327212ef96 190
Kojto 112:6f327212ef96 191 /**
Kojto 112:6f327212ef96 192 * @brief Enables the IWDG peripheral.
Kojto 112:6f327212ef96 193 * @param __HANDLE__: IWDG handle
Kojto 112:6f327212ef96 194 * @retval None
Kojto 112:6f327212ef96 195 */
Kojto 112:6f327212ef96 196 #define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, KR_KEY_ENABLE)
Kojto 112:6f327212ef96 197
Kojto 112:6f327212ef96 198 /**
Kojto 112:6f327212ef96 199 * @brief Reloads IWDG counter with value defined in the reload register
Kojto 112:6f327212ef96 200 * (write access to IWDG_PR and IWDG_RLR registers disabled).
Kojto 112:6f327212ef96 201 * @param __HANDLE__: IWDG handle
Kojto 112:6f327212ef96 202 * @retval None
Kojto 112:6f327212ef96 203 */
Kojto 112:6f327212ef96 204 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, KR_KEY_RELOAD)
Kojto 112:6f327212ef96 205
Kojto 112:6f327212ef96 206 /**
Kojto 112:6f327212ef96 207 * @brief Enables write access to IWDG_PR and IWDG_RLR registers.
Kojto 112:6f327212ef96 208 * @param __HANDLE__: IWDG handle
Kojto 112:6f327212ef96 209 * @retval None
Kojto 112:6f327212ef96 210 */
Kojto 112:6f327212ef96 211 #define __HAL_IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, KR_KEY_EWA)
Kojto 112:6f327212ef96 212
Kojto 112:6f327212ef96 213 /**
Kojto 112:6f327212ef96 214 * @brief Disables write access to IWDG_PR and IWDG_RLR registers.
Kojto 112:6f327212ef96 215 * @param __HANDLE__: IWDG handle
Kojto 112:6f327212ef96 216 * @retval None
Kojto 112:6f327212ef96 217 */
Kojto 112:6f327212ef96 218 #define __HAL_IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, KR_KEY_DWA)
Kojto 112:6f327212ef96 219
Kojto 112:6f327212ef96 220 /**
Kojto 112:6f327212ef96 221 * @brief Gets the selected IWDG's flag status.
Kojto 112:6f327212ef96 222 * @param __HANDLE__: IWDG handle
Kojto 112:6f327212ef96 223 * @param __FLAG__: specifies the flag to check.
Kojto 112:6f327212ef96 224 * This parameter can be one of the following values:
Kojto 112:6f327212ef96 225 * @arg IWDG_FLAG_PVU: Watchdog counter reload value update flag
Kojto 112:6f327212ef96 226 * @arg IWDG_FLAG_RVU: Watchdog counter prescaler value flag
Kojto 112:6f327212ef96 227 * @retval The new state of __FLAG__ (TRUE or FALSE).
Kojto 112:6f327212ef96 228 */
Kojto 112:6f327212ef96 229 #define __HAL_IWDG_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
Kojto 112:6f327212ef96 230
Kojto 112:6f327212ef96 231 /**
Kojto 112:6f327212ef96 232 * @}
Kojto 112:6f327212ef96 233 */
Kojto 112:6f327212ef96 234
Kojto 112:6f327212ef96 235 /* Exported functions --------------------------------------------------------*/
Kojto 112:6f327212ef96 236
Kojto 112:6f327212ef96 237 /** @addtogroup IWDG_Exported_Functions
Kojto 112:6f327212ef96 238 * @{
Kojto 112:6f327212ef96 239 */
Kojto 112:6f327212ef96 240
Kojto 112:6f327212ef96 241 /** @addtogroup IWDG_Exported_Functions_Group1
Kojto 112:6f327212ef96 242 * @{
Kojto 112:6f327212ef96 243 */
Kojto 112:6f327212ef96 244 /* Initialization/de-initialization functions ********************************/
Kojto 112:6f327212ef96 245 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
Kojto 112:6f327212ef96 246 void HAL_IWDG_MspInit(IWDG_HandleTypeDef *hiwdg);
Kojto 112:6f327212ef96 247
Kojto 112:6f327212ef96 248 /**
Kojto 112:6f327212ef96 249 * @}
Kojto 112:6f327212ef96 250 */
Kojto 112:6f327212ef96 251
Kojto 112:6f327212ef96 252 /** @addtogroup IWDG_Exported_Functions_Group2
Kojto 112:6f327212ef96 253 * @{
Kojto 112:6f327212ef96 254 */
Kojto 112:6f327212ef96 255 /* I/O operation functions ****************************************************/
Kojto 112:6f327212ef96 256 HAL_StatusTypeDef HAL_IWDG_Start(IWDG_HandleTypeDef *hiwdg);
Kojto 112:6f327212ef96 257 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
Kojto 112:6f327212ef96 258
Kojto 112:6f327212ef96 259 /**
Kojto 112:6f327212ef96 260 * @}
Kojto 112:6f327212ef96 261 */
Kojto 112:6f327212ef96 262
Kojto 112:6f327212ef96 263 /** @addtogroup IWDG_Exported_Functions_Group3
Kojto 112:6f327212ef96 264 * @{
Kojto 112:6f327212ef96 265 */
Kojto 112:6f327212ef96 266 /* Peripheral State functions ************************************************/
Kojto 112:6f327212ef96 267 HAL_IWDG_StateTypeDef HAL_IWDG_GetState(IWDG_HandleTypeDef *hiwdg);
Kojto 112:6f327212ef96 268
Kojto 112:6f327212ef96 269 /**
Kojto 112:6f327212ef96 270 * @}
Kojto 112:6f327212ef96 271 */
Kojto 112:6f327212ef96 272
Kojto 112:6f327212ef96 273 /**
Kojto 112:6f327212ef96 274 * @}
Kojto 112:6f327212ef96 275 */
Kojto 112:6f327212ef96 276
Kojto 112:6f327212ef96 277 /**
Kojto 112:6f327212ef96 278 * @}
Kojto 112:6f327212ef96 279 */
Kojto 112:6f327212ef96 280
Kojto 112:6f327212ef96 281 /**
Kojto 112:6f327212ef96 282 * @}
Kojto 112:6f327212ef96 283 */
Kojto 112:6f327212ef96 284
Kojto 112:6f327212ef96 285 #ifdef __cplusplus
Kojto 112:6f327212ef96 286 }
Kojto 112:6f327212ef96 287 #endif
Kojto 112:6f327212ef96 288
Kojto 112:6f327212ef96 289 #endif /* __STM32L1xx_HAL_IWDG_H */
Kojto 112:6f327212ef96 290
Kojto 112:6f327212ef96 291 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/