mbed official / mbed

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

TARGET_NUCLEO_F446RE/stm32f4xx_hal_iwdg.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
110:165afa46840b 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 106:ba1f97679dad 1 /**
Kojto 106:ba1f97679dad 2 ******************************************************************************
Kojto 106:ba1f97679dad 3 * @file stm32f4xx_hal_iwdg.h
Kojto 106:ba1f97679dad 4 * @author MCD Application Team
Kojto 122:f9eeca106725 5 * @version V1.5.0
Kojto 122:f9eeca106725 6 * @date 06-May-2016
Kojto 106:ba1f97679dad 7 * @brief Header file of IWDG HAL module.
Kojto 106:ba1f97679dad 8 ******************************************************************************
Kojto 106:ba1f97679dad 9 * @attention
Kojto 106:ba1f97679dad 10 *
Kojto 122:f9eeca106725 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
Kojto 106:ba1f97679dad 12 *
Kojto 106:ba1f97679dad 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 106:ba1f97679dad 14 * are permitted provided that the following conditions are met:
Kojto 106:ba1f97679dad 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 106:ba1f97679dad 16 * this list of conditions and the following disclaimer.
Kojto 106:ba1f97679dad 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 106:ba1f97679dad 18 * this list of conditions and the following disclaimer in the documentation
Kojto 106:ba1f97679dad 19 * and/or other materials provided with the distribution.
Kojto 106:ba1f97679dad 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 106:ba1f97679dad 21 * may be used to endorse or promote products derived from this software
Kojto 106:ba1f97679dad 22 * without specific prior written permission.
Kojto 106:ba1f97679dad 23 *
Kojto 106:ba1f97679dad 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 106:ba1f97679dad 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 106:ba1f97679dad 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 106:ba1f97679dad 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 106:ba1f97679dad 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 106:ba1f97679dad 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 106:ba1f97679dad 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 106:ba1f97679dad 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 106:ba1f97679dad 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 106:ba1f97679dad 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 106:ba1f97679dad 34 *
Kojto 106:ba1f97679dad 35 ******************************************************************************
Kojto 122:f9eeca106725 36 */
Kojto 106:ba1f97679dad 37
Kojto 106:ba1f97679dad 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 106:ba1f97679dad 39 #ifndef __STM32F4xx_HAL_IWDG_H
Kojto 106:ba1f97679dad 40 #define __STM32F4xx_HAL_IWDG_H
Kojto 106:ba1f97679dad 41
Kojto 106:ba1f97679dad 42 #ifdef __cplusplus
Kojto 106:ba1f97679dad 43 extern "C" {
Kojto 106:ba1f97679dad 44 #endif
Kojto 106:ba1f97679dad 45
Kojto 106:ba1f97679dad 46 /* Includes ------------------------------------------------------------------*/
Kojto 106:ba1f97679dad 47 #include "stm32f4xx_hal_def.h"
Kojto 106:ba1f97679dad 48
Kojto 106:ba1f97679dad 49 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 106:ba1f97679dad 50 * @{
Kojto 106:ba1f97679dad 51 */
Kojto 106:ba1f97679dad 52
Kojto 106:ba1f97679dad 53 /** @addtogroup IWDG
Kojto 106:ba1f97679dad 54 * @{
Kojto 122:f9eeca106725 55 */
Kojto 106:ba1f97679dad 56
Kojto 106:ba1f97679dad 57 /* Exported types ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 58 /** @defgroup IWDG_Exported_Types IWDG Exported Types
Kojto 106:ba1f97679dad 59 * @{
Kojto 106:ba1f97679dad 60 */
Kojto 106:ba1f97679dad 61
Kojto 106:ba1f97679dad 62 /**
Kojto 122:f9eeca106725 63 * @brief IWDG Init structure definition
Kojto 122:f9eeca106725 64 */
Kojto 106:ba1f97679dad 65 typedef struct
Kojto 106:ba1f97679dad 66 {
Kojto 122:f9eeca106725 67 uint32_t Prescaler; /*!< Select the prescaler of the IWDG.
Kojto 106:ba1f97679dad 68 This parameter can be a value of @ref IWDG_Prescaler */
Kojto 122:f9eeca106725 69
Kojto 122:f9eeca106725 70 uint32_t Reload; /*!< Specifies the IWDG down-counter reload value.
Kojto 106:ba1f97679dad 71 This parameter must be a number between Min_Data = 0 and Max_Data = 0x0FFF */
Kojto 122:f9eeca106725 72
Kojto 122:f9eeca106725 73 } IWDG_InitTypeDef;
Kojto 106:ba1f97679dad 74
Kojto 122:f9eeca106725 75 /**
Kojto 122:f9eeca106725 76 * @brief IWDG Handle Structure definition
Kojto 122:f9eeca106725 77 */
Kojto 106:ba1f97679dad 78 typedef struct
Kojto 106:ba1f97679dad 79 {
Kojto 122:f9eeca106725 80 IWDG_TypeDef *Instance; /*!< Register base address */
Kojto 122:f9eeca106725 81
Kojto 106:ba1f97679dad 82 IWDG_InitTypeDef Init; /*!< IWDG required parameters */
Kojto 122:f9eeca106725 83
Kojto 106:ba1f97679dad 84 }IWDG_HandleTypeDef;
Kojto 106:ba1f97679dad 85
Kojto 106:ba1f97679dad 86 /**
Kojto 106:ba1f97679dad 87 * @}
Kojto 106:ba1f97679dad 88 */
Kojto 106:ba1f97679dad 89
Kojto 106:ba1f97679dad 90 /* Exported constants --------------------------------------------------------*/
Kojto 106:ba1f97679dad 91 /** @defgroup IWDG_Exported_Constants IWDG Exported Constants
Kojto 106:ba1f97679dad 92 * @{
Kojto 106:ba1f97679dad 93 */
Kojto 106:ba1f97679dad 94
Kojto 122:f9eeca106725 95 /** @defgroup IWDG_Prescaler IWDG Prescaler
Kojto 106:ba1f97679dad 96 * @{
Kojto 106:ba1f97679dad 97 */
Kojto 122:f9eeca106725 98 #define IWDG_PRESCALER_4 0x00000000U /*!< IWDG prescaler set to 4 */
Kojto 122:f9eeca106725 99 #define IWDG_PRESCALER_8 IWDG_PR_PR_0 /*!< IWDG prescaler set to 8 */
Kojto 122:f9eeca106725 100 #define IWDG_PRESCALER_16 IWDG_PR_PR_1 /*!< IWDG prescaler set to 16 */
Kojto 122:f9eeca106725 101 #define IWDG_PRESCALER_32 (IWDG_PR_PR_1 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 32 */
Kojto 122:f9eeca106725 102 #define IWDG_PRESCALER_64 IWDG_PR_PR_2 /*!< IWDG prescaler set to 64 */
Kojto 122:f9eeca106725 103 #define IWDG_PRESCALER_128 (IWDG_PR_PR_2 | IWDG_PR_PR_0) /*!< IWDG prescaler set to 128 */
Kojto 122:f9eeca106725 104 #define IWDG_PRESCALER_256 (IWDG_PR_PR_2 | IWDG_PR_PR_1) /*!< IWDG prescaler set to 256 */
Kojto 106:ba1f97679dad 105 /**
Kojto 106:ba1f97679dad 106 * @}
Kojto 106:ba1f97679dad 107 */
Kojto 106:ba1f97679dad 108
Kojto 106:ba1f97679dad 109 /**
Kojto 106:ba1f97679dad 110 * @}
Kojto 106:ba1f97679dad 111 */
Kojto 106:ba1f97679dad 112
Kojto 106:ba1f97679dad 113 /**
Kojto 106:ba1f97679dad 114 * @}
Kojto 106:ba1f97679dad 115 */
Kojto 106:ba1f97679dad 116
Kojto 106:ba1f97679dad 117 /* Exported macros -----------------------------------------------------------*/
Kojto 106:ba1f97679dad 118 /** @defgroup IWDG_Exported_Macros IWDG Exported Macros
Kojto 106:ba1f97679dad 119 * @{
Kojto 106:ba1f97679dad 120 */
Kojto 106:ba1f97679dad 121
Kojto 122:f9eeca106725 122 /**
Kojto 122:f9eeca106725 123 * @brief Enable the IWDG peripheral.
Kojto 122:f9eeca106725 124 * @param __HANDLE__ IWDG handle
Kojto 106:ba1f97679dad 125 * @retval None
Kojto 106:ba1f97679dad 126 */
Kojto 122:f9eeca106725 127 #define __HAL_IWDG_START(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_ENABLE)
Kojto 106:ba1f97679dad 128
Kojto 106:ba1f97679dad 129 /**
Kojto 122:f9eeca106725 130 * @brief Reload IWDG counter with value defined in the reload register
Kojto 122:f9eeca106725 131 * (write access to IWDG_PR & IWDG_RLR registers disabled).
Kojto 122:f9eeca106725 132 * @param __HANDLE__ IWDG handle
Kojto 122:f9eeca106725 133 * @retval None
Kojto 106:ba1f97679dad 134 */
Kojto 122:f9eeca106725 135 #define __HAL_IWDG_RELOAD_COUNTER(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_RELOAD)
Kojto 106:ba1f97679dad 136
Kojto 106:ba1f97679dad 137 /**
Kojto 106:ba1f97679dad 138 * @}
Kojto 106:ba1f97679dad 139 */
Kojto 106:ba1f97679dad 140
Kojto 122:f9eeca106725 141 /* Exported functions --------------------------------------------------------*/
Kojto 122:f9eeca106725 142 /** @defgroup IWDG_Exported_Functions IWDG Exported Functions
Kojto 106:ba1f97679dad 143 * @{
Kojto 106:ba1f97679dad 144 */
Kojto 122:f9eeca106725 145
Kojto 122:f9eeca106725 146 /** @defgroup IWDG_Exported_Functions_Group1 Initialization and Start functions
Kojto 122:f9eeca106725 147 * @{
Kojto 122:f9eeca106725 148 */
Kojto 122:f9eeca106725 149 /* Initialization/Start functions ********************************************/
Kojto 122:f9eeca106725 150 HAL_StatusTypeDef HAL_IWDG_Init(IWDG_HandleTypeDef *hiwdg);
Kojto 106:ba1f97679dad 151 /**
Kojto 106:ba1f97679dad 152 * @}
Kojto 106:ba1f97679dad 153 */
Kojto 106:ba1f97679dad 154
Kojto 122:f9eeca106725 155 /** @defgroup IWDG_Exported_Functions_Group2 IO operation functions
Kojto 106:ba1f97679dad 156 * @{
Kojto 106:ba1f97679dad 157 */
Kojto 122:f9eeca106725 158 /* I/O operation functions ****************************************************/
Kojto 122:f9eeca106725 159 HAL_StatusTypeDef HAL_IWDG_Refresh(IWDG_HandleTypeDef *hiwdg);
Kojto 106:ba1f97679dad 160 /**
Kojto 106:ba1f97679dad 161 * @}
Kojto 106:ba1f97679dad 162 */
Kojto 106:ba1f97679dad 163
Kojto 106:ba1f97679dad 164 /**
Kojto 106:ba1f97679dad 165 * @}
Kojto 122:f9eeca106725 166 */
Kojto 122:f9eeca106725 167
Kojto 122:f9eeca106725 168 /* Private constants ---------------------------------------------------------*/
Kojto 122:f9eeca106725 169 /** @defgroup IWDG_Private_Constants IWDG Private Constants
Kojto 122:f9eeca106725 170 * @{
Kojto 122:f9eeca106725 171 */
Kojto 106:ba1f97679dad 172
Kojto 122:f9eeca106725 173 /**
Kojto 122:f9eeca106725 174 * @brief IWDG Key Register BitMask
Kojto 122:f9eeca106725 175 */
Kojto 122:f9eeca106725 176 #define IWDG_KEY_RELOAD 0x0000AAAAU /*!< IWDG Reload Counter Enable */
Kojto 122:f9eeca106725 177 #define IWDG_KEY_ENABLE 0x0000CCCCU /*!< IWDG Peripheral Enable */
Kojto 122:f9eeca106725 178 #define IWDG_KEY_WRITE_ACCESS_ENABLE 0x00005555U /*!< IWDG KR Write Access Enable */
Kojto 122:f9eeca106725 179 #define IWDG_KEY_WRITE_ACCESS_DISABLE 0x00000000U /*!< IWDG KR Write Access Disable */
Kojto 122:f9eeca106725 180
Kojto 122:f9eeca106725 181 /**
Kojto 122:f9eeca106725 182 * @}
Kojto 122:f9eeca106725 183 */
Kojto 122:f9eeca106725 184
Kojto 122:f9eeca106725 185 /* Private macros ------------------------------------------------------------*/
Kojto 106:ba1f97679dad 186 /** @defgroup IWDG_Private_Macros IWDG Private Macros
Kojto 106:ba1f97679dad 187 * @{
Kojto 106:ba1f97679dad 188 */
Kojto 106:ba1f97679dad 189
Kojto 106:ba1f97679dad 190 /**
Kojto 122:f9eeca106725 191 * @brief Enable write access to IWDG_PR and IWDG_RLR registers.
Kojto 122:f9eeca106725 192 * @param __HANDLE__ IWDG handle
Kojto 106:ba1f97679dad 193 * @retval None
Kojto 106:ba1f97679dad 194 */
Kojto 122:f9eeca106725 195 #define IWDG_ENABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_ENABLE)
Kojto 106:ba1f97679dad 196
Kojto 106:ba1f97679dad 197 /**
Kojto 122:f9eeca106725 198 * @brief Disable write access to IWDG_PR and IWDG_RLR registers.
Kojto 122:f9eeca106725 199 * @param __HANDLE__ IWDG handle
Kojto 106:ba1f97679dad 200 * @retval None
Kojto 106:ba1f97679dad 201 */
Kojto 106:ba1f97679dad 202 #define IWDG_DISABLE_WRITE_ACCESS(__HANDLE__) WRITE_REG((__HANDLE__)->Instance->KR, IWDG_KEY_WRITE_ACCESS_DISABLE)
Kojto 106:ba1f97679dad 203
Kojto 122:f9eeca106725 204 /**
Kojto 122:f9eeca106725 205 * @brief Check IWDG prescaler value.
Kojto 122:f9eeca106725 206 * @param __PRESCALER__ IWDG prescaler value
Kojto 122:f9eeca106725 207 * @retval None
Kojto 122:f9eeca106725 208 */
Kojto 122:f9eeca106725 209 #define IS_IWDG_PRESCALER(__PRESCALER__) (((__PRESCALER__) == IWDG_PRESCALER_4) || \
Kojto 122:f9eeca106725 210 ((__PRESCALER__) == IWDG_PRESCALER_8) || \
Kojto 122:f9eeca106725 211 ((__PRESCALER__) == IWDG_PRESCALER_16) || \
Kojto 122:f9eeca106725 212 ((__PRESCALER__) == IWDG_PRESCALER_32) || \
Kojto 122:f9eeca106725 213 ((__PRESCALER__) == IWDG_PRESCALER_64) || \
Kojto 122:f9eeca106725 214 ((__PRESCALER__) == IWDG_PRESCALER_128)|| \
Kojto 122:f9eeca106725 215 ((__PRESCALER__) == IWDG_PRESCALER_256))
Kojto 106:ba1f97679dad 216
Kojto 122:f9eeca106725 217 /**
Kojto 122:f9eeca106725 218 * @brief Check IWDG reload value.
Kojto 122:f9eeca106725 219 * @param __RELOAD__ IWDG reload value
Kojto 122:f9eeca106725 220 * @retval None
Kojto 122:f9eeca106725 221 */
Kojto 122:f9eeca106725 222 #define IS_IWDG_RELOAD(__RELOAD__) ((__RELOAD__) <= IWDG_RLR_RL)
Kojto 106:ba1f97679dad 223
Kojto 106:ba1f97679dad 224 /**
Kojto 106:ba1f97679dad 225 * @}
Kojto 106:ba1f97679dad 226 */
Kojto 106:ba1f97679dad 227
Kojto 106:ba1f97679dad 228 /**
Kojto 106:ba1f97679dad 229 * @}
Kojto 106:ba1f97679dad 230 */
Kojto 106:ba1f97679dad 231
Kojto 106:ba1f97679dad 232 /**
Kojto 106:ba1f97679dad 233 * @}
Kojto 122:f9eeca106725 234 */
Kojto 106:ba1f97679dad 235
Kojto 122:f9eeca106725 236
Kojto 106:ba1f97679dad 237 #ifdef __cplusplus
Kojto 106:ba1f97679dad 238 }
Kojto 106:ba1f97679dad 239 #endif
Kojto 106:ba1f97679dad 240
Kojto 106:ba1f97679dad 241 #endif /* __STM32F4xx_HAL_IWDG_H */
Kojto 106:ba1f97679dad 242
Kojto 106:ba1f97679dad 243 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/