lib/main/STM32F1/Drivers/STM32F1xx_HAL_Driver/Inc/stm32f1xx_hal.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f1xx_hal.h
   4   * @author  MCD Application Team
   5   * @version V1.1.1
   6   * @date    12-May-2017
   7   * @brief   This file contains all the functions prototypes for the HAL
   8   *          module driver.
   9   ******************************************************************************
  10   * @attention
  11   *
  12   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  13   *
  14   * Redistribution and use in source and binary forms, with or without modification,
  15   * are permitted provided that the following conditions are met:
  16   *   1. Redistributions of source code must retain the above copyright notice,
  17   *      this list of conditions and the following disclaimer.
  18   *   2. Redistributions in binary form must reproduce the above copyright notice,
  19   *      this list of conditions and the following disclaimer in the documentation
  20   *      and/or other materials provided with the distribution.
  21   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  22   *      may be used to endorse or promote products derived from this software
  23   *      without specific prior written permission.
  24   *
  25   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  28   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  29   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  31   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  33   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35   *
  36   ******************************************************************************
  37   */
  38
  39 /* Define to prevent recursive inclusion -------------------------------------*/
  40 #ifndef __STM32F1xx_HAL_H
  41 #define __STM32F1xx_HAL_H
  42
  43 #ifdef __cplusplus
  44  extern "C" {
  45 #endif
  46
  47 /* Includes ------------------------------------------------------------------*/
  48 #include "stm32f1xx_hal_conf.h"
  49
  50 /** @addtogroup STM32F1xx_HAL_Driver
  51   * @{
  52   */
  53
  54 /** @addtogroup HAL
  55   * @{
  56   */
  57
  58 /* Exported types ------------------------------------------------------------*/
  59 /* Exported constants --------------------------------------------------------*/
  60
  61 /* Exported macro ------------------------------------------------------------*/
  62 /** @defgroup HAL_Exported_Macros HAL Exported Macros
  63   * @{
  64   */
  65
  66 /** @defgroup DBGMCU_Freeze_Unfreeze Freeze Unfreeze Peripherals in Debug mode
  67   * @brief   Freeze/Unfreeze Peripherals in Debug mode
  68   * Note: On devices STM32F10xx8 and STM32F10xxB,
  69   *                  STM32F101xC/D/E and STM32F103xC/D/E,
  70   *                  STM32F101xF/G and STM32F103xF/G
  71   *                  STM32F10xx4 and STM32F10xx6
  72   *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
  73   *       debug mode (not accessible by the user software in normal mode).
  74   *       Refer to errata sheet of these devices for more details.
  75   * @{
  76   */
  77
  78 /* Peripherals on APB1 */
  79 /**
  80   * @brief  TIM2 Peripherals Debug mode
  81   */
  82 #define __HAL_DBGMCU_FREEZE_TIM2()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM2_STOP)
  83 #define __HAL_DBGMCU_UNFREEZE_TIM2()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM2_STOP)
  84
  85 /**
  86   * @brief  TIM3 Peripherals Debug mode
  87   */
  88 #define __HAL_DBGMCU_FREEZE_TIM3()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM3_STOP)
  89 #define __HAL_DBGMCU_UNFREEZE_TIM3()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM3_STOP)
  90
  91 #if defined (DBGMCU_CR_DBG_TIM4_STOP)
  92 /**
  93   * @brief  TIM4 Peripherals Debug mode
  94   */
  95 #define __HAL_DBGMCU_FREEZE_TIM4()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM4_STOP)
  96 #define __HAL_DBGMCU_UNFREEZE_TIM4()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM4_STOP)
  97 #endif
  98
  99 #if defined (DBGMCU_CR_DBG_TIM5_STOP)
 100 /**
 101   * @brief  TIM5 Peripherals Debug mode
 102   */
 103 #define __HAL_DBGMCU_FREEZE_TIM5()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM5_STOP)
 104 #define __HAL_DBGMCU_UNFREEZE_TIM5()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM5_STOP)
 105 #endif
 106
 107 #if defined (DBGMCU_CR_DBG_TIM6_STOP)
 108 /**
 109   * @brief  TIM6 Peripherals Debug mode
 110   */
 111 #define __HAL_DBGMCU_FREEZE_TIM6()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM6_STOP)
 112 #define __HAL_DBGMCU_UNFREEZE_TIM6()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM6_STOP)
 113 #endif
 114
 115 #if defined (DBGMCU_CR_DBG_TIM7_STOP)
 116 /**
 117   * @brief  TIM7 Peripherals Debug mode
 118   */
 119 #define __HAL_DBGMCU_FREEZE_TIM7()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM7_STOP)
 120 #define __HAL_DBGMCU_UNFREEZE_TIM7()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM7_STOP)
 121 #endif
 122
 123 #if defined (DBGMCU_CR_DBG_TIM12_STOP)
 124 /**
 125   * @brief  TIM12 Peripherals Debug mode
 126   */
 127 #define __HAL_DBGMCU_FREEZE_TIM12()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM12_STOP)
 128 #define __HAL_DBGMCU_UNFREEZE_TIM12()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM12_STOP)
 129 #endif
 130
 131 #if defined (DBGMCU_CR_DBG_TIM13_STOP)
 132 /**
 133   * @brief  TIM13 Peripherals Debug mode
 134   */
 135 #define __HAL_DBGMCU_FREEZE_TIM13()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM13_STOP)
 136 #define __HAL_DBGMCU_UNFREEZE_TIM13()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM13_STOP)
 137 #endif
 138
 139 #if defined (DBGMCU_CR_DBG_TIM14_STOP)
 140 /**
 141   * @brief  TIM14 Peripherals Debug mode
 142   */
 143 #define __HAL_DBGMCU_FREEZE_TIM14()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM14_STOP)
 144 #define __HAL_DBGMCU_UNFREEZE_TIM14()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM14_STOP)
 145 #endif
 146
 147 /**
 148   * @brief  WWDG Peripherals Debug mode
 149   */
 150 #define __HAL_DBGMCU_FREEZE_WWDG()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_WWDG_STOP)
 151 #define __HAL_DBGMCU_UNFREEZE_WWDG()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_WWDG_STOP)
 152
 153 /**
 154   * @brief  IWDG Peripherals Debug mode
 155   */
 156 #define __HAL_DBGMCU_FREEZE_IWDG()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_IWDG_STOP)
 157 #define __HAL_DBGMCU_UNFREEZE_IWDG()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_IWDG_STOP)
 158
 159 /**
 160   * @brief  I2C1 Peripherals Debug mode
 161   */
 162 #define __HAL_DBGMCU_FREEZE_I2C1_TIMEOUT()    SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_I2C1_SMBUS_TIMEOUT)
 163 #define __HAL_DBGMCU_UNFREEZE_I2C1_TIMEOUT()  CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_I2C1_SMBUS_TIMEOUT)
 164
 165 #if defined (DBGMCU_CR_DBG_I2C2_SMBUS_TIMEOUT)
 166 /**
 167   * @brief  I2C2 Peripherals Debug mode
 168   */
 169 #define __HAL_DBGMCU_FREEZE_I2C2_TIMEOUT()    SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_I2C2_SMBUS_TIMEOUT)
 170 #define __HAL_DBGMCU_UNFREEZE_I2C2_TIMEOUT()  CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_I2C2_SMBUS_TIMEOUT)
 171 #endif
 172
 173 #if defined (DBGMCU_CR_DBG_CAN1_STOP)
 174 /**
 175   * @brief  CAN1 Peripherals Debug mode
 176   */
 177 #define __HAL_DBGMCU_FREEZE_CAN1()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_CAN1_STOP)
 178 #define __HAL_DBGMCU_UNFREEZE_CAN1()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_CAN1_STOP)
 179 #endif
 180
 181 #if defined (DBGMCU_CR_DBG_CAN2_STOP)
 182 /**
 183   * @brief  CAN2 Peripherals Debug mode
 184   */
 185 #define __HAL_DBGMCU_FREEZE_CAN2()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_CAN2_STOP)
 186 #define __HAL_DBGMCU_UNFREEZE_CAN2()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_CAN2_STOP)
 187 #endif
 188
 189 /* Peripherals on APB2 */
 190 #if defined (DBGMCU_CR_DBG_TIM1_STOP)
 191 /**
 192   * @brief  TIM1 Peripherals Debug mode
 193   */
 194 #define __HAL_DBGMCU_FREEZE_TIM1()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM1_STOP)
 195 #define __HAL_DBGMCU_UNFREEZE_TIM1()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM1_STOP)
 196 #endif
 197
 198 #if defined (DBGMCU_CR_DBG_TIM8_STOP)
 199 /**
 200   * @brief  TIM8 Peripherals Debug mode
 201   */
 202 #define __HAL_DBGMCU_FREEZE_TIM8()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM8_STOP)
 203 #define __HAL_DBGMCU_UNFREEZE_TIM8()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM8_STOP)
 204 #endif
 205
 206 #if defined (DBGMCU_CR_DBG_TIM9_STOP)
 207 /**
 208   * @brief  TIM9 Peripherals Debug mode
 209   */
 210 #define __HAL_DBGMCU_FREEZE_TIM9()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM9_STOP)
 211 #define __HAL_DBGMCU_UNFREEZE_TIM9()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM9_STOP)
 212 #endif
 213
 214 #if defined (DBGMCU_CR_DBG_TIM10_STOP)
 215 /**
 216   * @brief  TIM10 Peripherals Debug mode
 217   */
 218 #define __HAL_DBGMCU_FREEZE_TIM10()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM10_STOP)
 219 #define __HAL_DBGMCU_UNFREEZE_TIM10()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM10_STOP)
 220 #endif
 221
 222 #if defined (DBGMCU_CR_DBG_TIM11_STOP)
 223 /**
 224   * @brief  TIM11 Peripherals Debug mode
 225   */
 226 #define __HAL_DBGMCU_FREEZE_TIM11()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM11_STOP)
 227 #define __HAL_DBGMCU_UNFREEZE_TIM11()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM11_STOP)
 228 #endif
 229
 230
 231 #if defined (DBGMCU_CR_DBG_TIM15_STOP)
 232 /**
 233   * @brief  TIM15 Peripherals Debug mode
 234   */
 235 #define __HAL_DBGMCU_FREEZE_TIM15()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM15_STOP)
 236 #define __HAL_DBGMCU_UNFREEZE_TIM15()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM15_STOP)
 237 #endif
 238
 239 #if defined (DBGMCU_CR_DBG_TIM16_STOP)
 240 /**
 241   * @brief  TIM16 Peripherals Debug mode
 242   */
 243 #define __HAL_DBGMCU_FREEZE_TIM16()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM16_STOP)
 244 #define __HAL_DBGMCU_UNFREEZE_TIM16()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM16_STOP)
 245 #endif
 246
 247 #if defined (DBGMCU_CR_DBG_TIM17_STOP)
 248 /**
 249   * @brief  TIM17 Peripherals Debug mode
 250   */
 251 #define __HAL_DBGMCU_FREEZE_TIM17()            SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM17_STOP)
 252 #define __HAL_DBGMCU_UNFREEZE_TIM17()          CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM17_STOP)
 253 #endif
 254
 255 /**
 256   * @}
 257   */
 258
 259 /**
 260   * @}
 261   */
 262
 263 /* Exported functions --------------------------------------------------------*/
 264 /** @addtogroup HAL_Exported_Functions
 265   * @{
 266   */
 267 /** @addtogroup HAL_Exported_Functions_Group1
 268   * @{
 269   */
 270 /* Initialization and de-initialization functions  ******************************/
 271 HAL_StatusTypeDef HAL_Init(void);
 272 HAL_StatusTypeDef HAL_DeInit(void);
 273 void HAL_MspInit(void);
 274 void HAL_MspDeInit(void);
 275 HAL_StatusTypeDef HAL_InitTick (uint32_t TickPriority);
 276 /**
 277   * @}
 278   */
 279
 280 /** @addtogroup HAL_Exported_Functions_Group2
 281   * @{
 282   */
 283 /* Peripheral Control functions  ************************************************/
 284 void HAL_IncTick(void);
 285 void HAL_Delay(__IO uint32_t Delay);
 286 uint32_t HAL_GetTick(void);
 287 void HAL_SuspendTick(void);
 288 void HAL_ResumeTick(void);
 289 uint32_t HAL_GetHalVersion(void);
 290 uint32_t HAL_GetREVID(void);
 291 uint32_t HAL_GetDEVID(void);
 292 void HAL_DBGMCU_EnableDBGSleepMode(void);
 293 void HAL_DBGMCU_DisableDBGSleepMode(void);
 294 void HAL_DBGMCU_EnableDBGStopMode(void);
 295 void HAL_DBGMCU_DisableDBGStopMode(void);
 296 void HAL_DBGMCU_EnableDBGStandbyMode(void);
 297 void HAL_DBGMCU_DisableDBGStandbyMode(void);
 298 void HAL_GetUID(uint32_t *UID);
 299 /**
 300   * @}
 301   */
 302
 303 /**
 304   * @}
 305   */
 306 /* Private types -------------------------------------------------------------*/
 307 /* Private variables ---------------------------------------------------------*/
 308 /** @defgroup HAL_Private_Variables HAL Private Variables
 309   * @{
 310   */
 311 /**
 312   * @}
 313   */
 314 /* Private constants ---------------------------------------------------------*/
 315 /** @defgroup HAL_Private_Constants HAL Private Constants
 316   * @{
 317   */
 318 /**
 319   * @}
 320   */
 321 /* Private macros ------------------------------------------------------------*/
 322 /* Private functions ---------------------------------------------------------*/
 323 /**
 324   * @}
 325   */
 326
 327 /**
 328   * @}
 329   */
 330
 331 #ifdef __cplusplus
 332 }
 333 #endif
 334
 335 #endif /* __STM32F1xx_HAL_H */
 336
 337 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/