Filippo Casamassima / mbed

my fork

Dependents:   Nucleo_blueNRG

Fork of mbed by mbed official

TARGET_NUCLEO_L152RE/stm32l1xx_hal_iwdg.h@97:4298809c7c9e, 2015-04-08 (annotated)

Committer:
filartrix
Date:
Wed Apr 08 14:12:53 2015 +0000
Revision:
97:4298809c7c9e
Parent:
90:cb3d968589d8 
First reale BlueNRG module for nucleo 401 board

Who changed what in which revision?

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