STM32F439xx HAL User Manual: stm32f4xx

This file contains all the functions prototypes for the HAL module driver. More...

#include "stm32f4xx_hal_conf.h"

Defines
#define	__HAL_DBGMCU_FREEZE_TIM2() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM2_STOP))
	Freeze/Unfreeze Peripherals in Debug mode.
#define	__HAL_DBGMCU_FREEZE_TIM3() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM3_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM4() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM4_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM5() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM5_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM6() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM6_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM7() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM7_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM12() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM12_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM13() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM13_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM14() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_TIM14_STOP))
#define	__HAL_DBGMCU_FREEZE_RTC() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_RTC_STOP))
#define	__HAL_DBGMCU_FREEZE_WWDG() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_WWDG_STOP))
#define	__HAL_DBGMCU_FREEZE_IWDG() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_IWDG_STOP))
#define	__HAL_DBGMCU_FREEZE_I2C1_TIMEOUT() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
#define	__HAL_DBGMCU_FREEZE_I2C2_TIMEOUT() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
#define	__HAL_DBGMCU_FREEZE_I2C3_TIMEOUT() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
#define	__HAL_DBGMCU_FREEZE_CAN1() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_CAN1_STOP))
#define	__HAL_DBGMCU_FREEZE_CAN2() (DBGMCU->APB1FZ \|= (DBGMCU_APB1_FZ_DBG_CAN2_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM1() (DBGMCU->APB2FZ \|= (DBGMCU_APB2_FZ_DBG_TIM1_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM8() (DBGMCU->APB2FZ \|= (DBGMCU_APB2_FZ_DBG_TIM8_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM9() (DBGMCU->APB2FZ \|= (DBGMCU_APB2_FZ_DBG_TIM9_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM10() (DBGMCU->APB2FZ \|= (DBGMCU_APB2_FZ_DBG_TIM10_STOP))
#define	__HAL_DBGMCU_FREEZE_TIM11() (DBGMCU->APB2FZ \|= (DBGMCU_APB2_FZ_DBG_TIM11_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM2() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM2_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM3() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM3_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM4() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM4_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM5() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM5_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM6() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM6_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM7() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM7_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM12() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM12_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM13() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM13_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM14() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_TIM14_STOP))
#define	__HAL_DBGMCU_UNFREEZE_RTC() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_RTC_STOP))
#define	__HAL_DBGMCU_UNFREEZE_WWDG() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_WWDG_STOP))
#define	__HAL_DBGMCU_UNFREEZE_IWDG() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_IWDG_STOP))
#define	__HAL_DBGMCU_UNFREEZE_I2C1_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C1_SMBUS_TIMEOUT))
#define	__HAL_DBGMCU_UNFREEZE_I2C2_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C2_SMBUS_TIMEOUT))
#define	__HAL_DBGMCU_UNFREEZE_I2C3_TIMEOUT() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_I2C3_SMBUS_TIMEOUT))
#define	__HAL_DBGMCU_UNFREEZE_CAN1() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN1_STOP))
#define	__HAL_DBGMCU_UNFREEZE_CAN2() (DBGMCU->APB1FZ &= ~(DBGMCU_APB1_FZ_DBG_CAN2_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM1() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM1_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM8() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM8_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM9() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM9_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM10() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM10_STOP))
#define	__HAL_DBGMCU_UNFREEZE_TIM11() (DBGMCU->APB2FZ &= ~(DBGMCU_APB2_FZ_DBG_TIM11_STOP))
#define	__HAL_SYSCFG_REMAPMEMORY_FLASH() (SYSCFG->MEMRMP &= ~(SYSCFG_MEMRMP_MEM_MODE))
	Main Flash memory mapped at 0x00000000.
#define	__HAL_SYSCFG_REMAPMEMORY_SYSTEMFLASH()
	System Flash memory mapped at 0x00000000.
#define	__HAL_SYSCFG_REMAPMEMORY_SRAM()
	Embedded SRAM mapped at 0x00000000.
#define	__HAL_SYSCFG_REMAPMEMORY_FMC()
	FMC Bank1 (NOR/PSRAM 1 and 2) mapped at 0x00000000.
#define	__HAL_SYSCFG_REMAPMEMORY_FMC_SDRAM()
	FMC/SDRAM Bank 1 and 2 mapped at 0x00000000.
#define	IS_TICKFREQ(FREQ)
Enumerations
enum	HAL_TickFreqTypeDef { HAL_TICK_FREQ_10HZ = 100U, HAL_TICK_FREQ_100HZ = 10U, HAL_TICK_FREQ_1KHZ = 1U, HAL_TICK_FREQ_DEFAULT = HAL_TICK_FREQ_1KHZ }
Functions
HAL_StatusTypeDef	HAL_Init (void)
	This function is used to initialize the HAL Library; it must be the first instruction to be executed in the main program (before to call any other HAL function), it performs the following: Configure the Flash prefetch, instruction and Data caches.
HAL_StatusTypeDef	HAL_DeInit (void)
	This function de-Initializes common part of the HAL and stops the systick.
__weak void	HAL_MspInit (void)
	Initialize the MSP.
__weak void	HAL_MspDeInit (void)
	DeInitializes the MSP.
__weak HAL_StatusTypeDef	HAL_InitTick (uint32_t TickPriority)
	This function configures the source of the time base.
__weak void	HAL_IncTick (void)
	This function is called to increment a global variable "uwTick" used as application time base.
__weak void	HAL_Delay (uint32_t Delay)
	This function provides minimum delay (in milliseconds) based on variable incremented.
__weak uint32_t	HAL_GetTick (void)
	Provides a tick value in millisecond.
uint32_t	HAL_GetTickPrio (void)
	This function returns a tick priority.
HAL_StatusTypeDef	HAL_SetTickFreq (HAL_TickFreqTypeDef Freq)
	Set new tick Freq.
HAL_TickFreqTypeDef	HAL_GetTickFreq (void)
	Return tick frequency.
__weak void	HAL_SuspendTick (void)
	Suspend Tick increment.
__weak void	HAL_ResumeTick (void)
	Resume Tick increment.
uint32_t	HAL_GetHalVersion (void)
	Returns the HAL revision.
uint32_t	HAL_GetREVID (void)
	Returns the device revision identifier.
uint32_t	HAL_GetDEVID (void)
	Returns the device identifier.
void	HAL_DBGMCU_EnableDBGSleepMode (void)
	Enable the Debug Module during SLEEP mode.
void	HAL_DBGMCU_DisableDBGSleepMode (void)
	Disable the Debug Module during SLEEP mode.
void	HAL_DBGMCU_EnableDBGStopMode (void)
	Enable the Debug Module during STOP mode.
void	HAL_DBGMCU_DisableDBGStopMode (void)
	Disable the Debug Module during STOP mode.
void	HAL_DBGMCU_EnableDBGStandbyMode (void)
	Enable the Debug Module during STANDBY mode.
void	HAL_DBGMCU_DisableDBGStandbyMode (void)
	Disable the Debug Module during STANDBY mode.
void	HAL_EnableCompensationCell (void)
	Enables the I/O Compensation Cell.
void	HAL_DisableCompensationCell (void)
	Power-down the I/O Compensation Cell.
void	HAL_GetUID (uint32_t *UID)
	Return the unique device identifier (UID based on 96 bits)
void	HAL_EnableMemorySwappingBank (void)
	Enables the Internal FLASH Bank Swapping.
void	HAL_DisableMemorySwappingBank (void)
	Disables the Internal FLASH Bank Swapping.

Detailed Description

This file contains all the functions prototypes for the HAL module driver.

Author:: MCD Application Team

Attention:

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.

Definition in file stm32f4xx_hal.h.

Defines

Enumerations

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics