stm32f4xx_hal_usart.h File Reference

Header file of USART HAL module. More...

Go to the source code of this file.

Data Structures
struct	USART_InitTypeDef
	USART Init Structure definition. More...
struct	__USART_HandleTypeDef
	USART handle Structure definition. More...

Typedefs
typedef struct __USART_HandleTypeDef	USART_HandleTypeDef
	USART handle Structure definition.
typedef void(*	pUSART_CallbackTypeDef) (USART_HandleTypeDef *husart)
	HAL USART Callback pointer definition. More...

Enumerations
enum	HAL_USART_StateTypeDef {   HAL_USART_STATE_RESET = 0x00U , HAL_USART_STATE_READY = 0x01U , HAL_USART_STATE_BUSY = 0x02U , HAL_USART_STATE_BUSY_TX = 0x12U ,   HAL_USART_STATE_BUSY_RX = 0x22U , HAL_USART_STATE_BUSY_TX_RX = 0x32U , HAL_USART_STATE_TIMEOUT = 0x03U , HAL_USART_STATE_ERROR = 0x04U }
	HAL State structures definition. More...
enum	HAL_USART_CallbackIDTypeDef {   HAL_USART_TX_HALFCOMPLETE_CB_ID = 0x00U , HAL_USART_TX_COMPLETE_CB_ID = 0x01U , HAL_USART_RX_HALFCOMPLETE_CB_ID = 0x02U , HAL_USART_RX_COMPLETE_CB_ID = 0x03U ,   HAL_USART_TX_RX_COMPLETE_CB_ID = 0x04U , HAL_USART_ERROR_CB_ID = 0x05U , HAL_USART_ABORT_COMPLETE_CB_ID = 0x06U , HAL_USART_MSPINIT_CB_ID = 0x07U ,   HAL_USART_MSPDEINIT_CB_ID = 0x08U }
	HAL USART Callback ID enumeration definition. More...

Functions
HAL_StatusTypeDef	HAL_USART_Init (USART_HandleTypeDef *husart)
	Initialize the USART mode according to the specified parameters in the USART_InitTypeDef and initialize the associated handle. More...
HAL_StatusTypeDef	HAL_USART_DeInit (USART_HandleTypeDef *husart)
	DeInitializes the USART peripheral. More...
void	HAL_USART_MspInit (USART_HandleTypeDef *husart)
	USART MSP Init. More...
void	HAL_USART_MspDeInit (USART_HandleTypeDef *husart)
	USART MSP DeInit. More...
HAL_StatusTypeDef	HAL_USART_RegisterCallback (USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID, pUSART_CallbackTypeDef pCallback)
HAL_StatusTypeDef	HAL_USART_UnRegisterCallback (USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID)
	Unregister an USART Callback USART callaback is redirected to the weak predefined callback. More...
HAL_StatusTypeDef	HAL_USART_Transmit (USART_HandleTypeDef *husart, const uint8_t *pTxData, uint16_t Size, uint32_t Timeout)
	Simplex Send an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_USART_Receive (USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
	Full-Duplex Receive an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_USART_TransmitReceive (USART_HandleTypeDef *husart, const uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
	Full-Duplex Send and Receive an amount of data in full-duplex mode (blocking mode). More...
HAL_StatusTypeDef	HAL_USART_Transmit_IT (USART_HandleTypeDef *husart, const uint8_t *pTxData, uint16_t Size)
	Simplex Send an amount of data in non-blocking mode. More...
HAL_StatusTypeDef	HAL_USART_Receive_IT (USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size)
	Simplex Receive an amount of data in non-blocking mode. More...
HAL_StatusTypeDef	HAL_USART_TransmitReceive_IT (USART_HandleTypeDef *husart, const uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
	Full-Duplex Send and Receive an amount of data in full-duplex mode (non-blocking). More...
HAL_StatusTypeDef	HAL_USART_Transmit_DMA (USART_HandleTypeDef *husart, const uint8_t *pTxData, uint16_t Size)
	Simplex Send an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_USART_Receive_DMA (USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size)
	Full-Duplex Receive an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_USART_TransmitReceive_DMA (USART_HandleTypeDef *husart, const uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
	Full-Duplex Transmit Receive an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_USART_DMAPause (USART_HandleTypeDef *husart)
	Pauses the DMA Transfer. More...
HAL_StatusTypeDef	HAL_USART_DMAResume (USART_HandleTypeDef *husart)
	Resumes the DMA Transfer. More...
HAL_StatusTypeDef	HAL_USART_DMAStop (USART_HandleTypeDef *husart)
	Stops the DMA Transfer. More...
HAL_StatusTypeDef	HAL_USART_Abort (USART_HandleTypeDef *husart)
	Abort ongoing transfer (blocking mode). More...
HAL_StatusTypeDef	HAL_USART_Abort_IT (USART_HandleTypeDef *husart)
	Abort ongoing transfer (Interrupt mode). More...
void	HAL_USART_IRQHandler (USART_HandleTypeDef *husart)
	This function handles USART interrupt request. More...
void	HAL_USART_TxCpltCallback (USART_HandleTypeDef *husart)
	Tx Transfer completed callbacks. More...
void	HAL_USART_TxHalfCpltCallback (USART_HandleTypeDef *husart)
	Tx Half Transfer completed callbacks. More...
void	HAL_USART_RxCpltCallback (USART_HandleTypeDef *husart)
	Rx Transfer completed callbacks. More...
void	HAL_USART_RxHalfCpltCallback (USART_HandleTypeDef *husart)
	Rx Half Transfer completed callbacks. More...
void	HAL_USART_TxRxCpltCallback (USART_HandleTypeDef *husart)
	Tx/Rx Transfers completed callback for the non-blocking process. More...
void	HAL_USART_ErrorCallback (USART_HandleTypeDef *husart)
	USART error callbacks. More...
void	HAL_USART_AbortCpltCallback (USART_HandleTypeDef *husart)
	USART Abort Complete callback. More...
HAL_USART_StateTypeDef	HAL_USART_GetState (const USART_HandleTypeDef *husart)
	Returns the USART state. More...
uint32_t	HAL_USART_GetError (const USART_HandleTypeDef *husart)
	Return the USART error code. More...

Detailed Description

Header file of USART HAL module.

Author

MCD Application Team

Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Definition in file stm32f4xx_hal_usart.h.