path: root/source/Core/BSP/Miniware/Vendor/STM32F1xx_HAL_Driver/Inc/stm32f1xx_hal.h

/**
 ******************************************************************************
 * @file    stm32f1xx_hal.h
 * @author  MCD Application Team
 * @brief   This file contains all the functions prototypes for the HAL
 *          module driver.
 ******************************************************************************
 * @attention
 *
 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright notice,
 *      this list of conditions and the following disclaimer in the documentation
 *      and/or other materials provided with the distribution.
 *   3. Neither the name of STMicroelectronics nor the names of its contributors
 *      may be used to endorse or promote products derived from this software
 *      without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************
 */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __STM32F1xx_HAL_H
#define __STM32F1xx_HAL_H

#ifdef __cplusplus
extern "C" {
#endif

/* Includes ------------------------------------------------------------------*/
#include "stm32f1xx_hal_conf.h"

/** @addtogroup STM32F1xx_HAL_Driver
 * @{
 */

/** @addtogroup HAL
 * @{
 */

/* Exported constants --------------------------------------------------------*/

/** @defgroup HAL_Exported_Constants HAL Exported Constants
 * @{
 */

/** @defgroup HAL_TICK_FREQ Tick Frequency
 * @{
 */
typedef enum { HAL_TICK_FREQ_10HZ = 100U, HAL_TICK_FREQ_100HZ = 10U, HAL_TICK_FREQ_1KHZ = 1U, HAL_TICK_FREQ_DEFAULT = HAL_TICK_FREQ_1KHZ } HAL_TickFreqTypeDef;
/**
 * @}
 */
/* Exported types ------------------------------------------------------------*/
extern uint32_t            uwTickPrio;
extern HAL_TickFreqTypeDef uwTickFreq;

/**
 * @}
 */
/* Exported macro ------------------------------------------------------------*/
/** @defgroup HAL_Exported_Macros HAL Exported Macros
 * @{
 */

/** @defgroup DBGMCU_Freeze_Unfreeze Freeze Unfreeze Peripherals in Debug mode
 * @brief   Freeze/Unfreeze Peripherals in Debug mode
 * Note: On devices STM32F10xx8 and STM32F10xxB,
 *                  STM32F101xC/D/E and STM32F103xC/D/E,
 *                  STM32F101xF/G and STM32F103xF/G
 *                  STM32F10xx4 and STM32F10xx6
 *       Debug registers DBGMCU_IDCODE and DBGMCU_CR are accessible only in
 *       debug mode (not accessible by the user software in normal mode).
 *       Refer to errata sheet of these devices for more details.
 * @{
 */

/* Peripherals on APB1 */
/**
 * @brief  TIM2 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM2()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM2_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM2() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM2_STOP)

/**
 * @brief  TIM3 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM3()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM3_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM3() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM3_STOP)

#if defined(DBGMCU_CR_DBG_TIM4_STOP)
/**
 * @brief  TIM4 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM4()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM4_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM4() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM4_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM5_STOP)
/**
 * @brief  TIM5 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM5()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM5_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM5() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM5_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM6_STOP)
/**
 * @brief  TIM6 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM6()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM6_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM6() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM6_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM7_STOP)
/**
 * @brief  TIM7 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM7()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM7_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM7() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM7_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM12_STOP)
/**
 * @brief  TIM12 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM12()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM12_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM12() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM12_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM13_STOP)
/**
 * @brief  TIM13 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM13()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM13_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM13() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM13_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM14_STOP)
/**
 * @brief  TIM14 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM14()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM14_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM14() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM14_STOP)
#endif

/**
 * @brief  WWDG Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_WWDG()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_WWDG_STOP)
#define __HAL_DBGMCU_UNFREEZE_WWDG() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_WWDG_STOP)

/**
 * @brief  IWDG Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_IWDG()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_IWDG_STOP)
#define __HAL_DBGMCU_UNFREEZE_IWDG() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_IWDG_STOP)

/**
 * @brief  I2C1 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_I2C1_TIMEOUT()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_I2C1_SMBUS_TIMEOUT)
#define __HAL_DBGMCU_UNFREEZE_I2C1_TIMEOUT() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_I2C1_SMBUS_TIMEOUT)

#if defined(DBGMCU_CR_DBG_I2C2_SMBUS_TIMEOUT)
/**
 * @brief  I2C2 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_I2C2_TIMEOUT()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_I2C2_SMBUS_TIMEOUT)
#define __HAL_DBGMCU_UNFREEZE_I2C2_TIMEOUT() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_I2C2_SMBUS_TIMEOUT)
#endif

#if defined(DBGMCU_CR_DBG_CAN1_STOP)
/**
 * @brief  CAN1 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_CAN1()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_CAN1_STOP)
#define __HAL_DBGMCU_UNFREEZE_CAN1() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_CAN1_STOP)
#endif

#if defined(DBGMCU_CR_DBG_CAN2_STOP)
/**
 * @brief  CAN2 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_CAN2()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_CAN2_STOP)
#define __HAL_DBGMCU_UNFREEZE_CAN2() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_CAN2_STOP)
#endif

/* Peripherals on APB2 */
#if defined(DBGMCU_CR_DBG_TIM1_STOP)
/**
 * @brief  TIM1 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM1()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM1_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM1() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM1_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM8_STOP)
/**
 * @brief  TIM8 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM8()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM8_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM8() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM8_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM9_STOP)
/**
 * @brief  TIM9 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM9()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM9_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM9() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM9_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM10_STOP)
/**
 * @brief  TIM10 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM10()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM10_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM10() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM10_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM11_STOP)
/**
 * @brief  TIM11 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM11()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM11_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM11() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM11_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM15_STOP)
/**
 * @brief  TIM15 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM15()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM15_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM15() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM15_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM16_STOP)
/**
 * @brief  TIM16 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM16()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM16_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM16() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM16_STOP)
#endif

#if defined(DBGMCU_CR_DBG_TIM17_STOP)
/**
 * @brief  TIM17 Peripherals Debug mode
 */
#define __HAL_DBGMCU_FREEZE_TIM17()   SET_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM17_STOP)
#define __HAL_DBGMCU_UNFREEZE_TIM17() CLEAR_BIT(DBGMCU->CR, DBGMCU_CR_DBG_TIM17_STOP)
#endif

/**
 * @}
 */

/** @defgroup HAL_Private_Macros HAL Private Macros
 * @{
 */
#define IS_TICKFREQ(FREQ) (((FREQ) == HAL_TICK_FREQ_10HZ) || ((FREQ) == HAL_TICK_FREQ_100HZ) || ((FREQ) == HAL_TICK_FREQ_1KHZ))
/**
 * @}
 */

/* Exported functions --------------------------------------------------------*/
/** @addtogroup HAL_Exported_Functions
 * @{
 */
/** @addtogroup HAL_Exported_Functions_Group1
 * @{
 */
/* Initialization and de-initialization functions  ******************************/
HAL_StatusTypeDef HAL_Init(void);
HAL_StatusTypeDef HAL_DeInit(void);
void              HAL_MspInit(void);
void              HAL_MspDeInit(void);
HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority);
/**
 * @}
 */

/** @addtogroup HAL_Exported_Functions_Group2
 * @{
 */
/* Peripheral Control functions  ************************************************/
void                HAL_IncTick(void);
void                HAL_Delay(uint32_t Delay);
uint32_t            HAL_GetTick(void);
uint32_t            HAL_GetTickPrio(void);
HAL_StatusTypeDef   HAL_SetTickFreq(HAL_TickFreqTypeDef Freq);
HAL_TickFreqTypeDef HAL_GetTickFreq(void);
void                HAL_SuspendTick(void);
void                HAL_ResumeTick(void);
uint32_t            HAL_GetHalVersion(void);
uint32_t            HAL_GetREVID(void);
uint32_t            HAL_GetDEVID(void);
void                HAL_DBGMCU_EnableDBGSleepMode(void);
void                HAL_DBGMCU_DisableDBGSleepMode(void);
void                HAL_DBGMCU_EnableDBGStopMode(void);
void                HAL_DBGMCU_DisableDBGStopMode(void);
void                HAL_DBGMCU_EnableDBGStandbyMode(void);
void                HAL_DBGMCU_DisableDBGStandbyMode(void);
void                HAL_GetUID(uint32_t *UID);
/**
 * @}
 */

/**
 * @}
 */
/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/** @defgroup HAL_Private_Variables HAL Private Variables
 * @{
 */
/**
 * @}
 */
/* Private constants ---------------------------------------------------------*/
/** @defgroup HAL_Private_Constants HAL Private Constants
 * @{
 */
/**
 * @}
 */
/* Private macros ------------------------------------------------------------*/
/* Private functions ---------------------------------------------------------*/
/**
 * @}
 */

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif /* __STM32F1xx_HAL_H */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/