stm32l4xx_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. More...
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 USART State structures definition. More...
enum	USART_ClockSourceTypeDef {   USART_CLOCKSOURCE_PCLK1 = 0x00U, USART_CLOCKSOURCE_PCLK2 = 0x01U, USART_CLOCKSOURCE_HSI = 0x02U, USART_CLOCKSOURCE_SYSCLK = 0x04U,   USART_CLOCKSOURCE_LSE = 0x08U, USART_CLOCKSOURCE_UNDEFINED = 0x10U }
	USART clock sources definitions. 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_RX_FIFO_FULL_CB_ID = 0x07U,   HAL_USART_TX_FIFO_EMPTY_CB_ID = 0x08U, HAL_USART_MSPINIT_CB_ID = 0x09U, HAL_USART_MSPDEINIT_CB_ID = 0x0AU }
	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)
	DeInitialize the USART peripheral. More...
void	HAL_USART_MspInit (USART_HandleTypeDef *husart)
	Initialize the USART MSP. More...
void	HAL_USART_MspDeInit (USART_HandleTypeDef *husart)
	DeInitialize the USART MSP. More...
HAL_StatusTypeDef	HAL_USART_RegisterCallback (USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID, pUSART_CallbackTypeDef pCallback)
	Register a User USART Callback To be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_USART_UnRegisterCallback (USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID)
	Unregister an UART Callback UART callaback is redirected to the weak predefined callback. More...
HAL_StatusTypeDef	HAL_USART_Transmit (USART_HandleTypeDef *husart, 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)
	Receive an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_USART_TransmitReceive (USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
	Full-Duplex Send and Receive an amount of data in blocking mode. More...
HAL_StatusTypeDef	HAL_USART_Transmit_IT (USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size)
	Send an amount of data in interrupt mode. More...
HAL_StatusTypeDef	HAL_USART_Receive_IT (USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size)
	Receive an amount of data in interrupt mode. More...
HAL_StatusTypeDef	HAL_USART_TransmitReceive_IT (USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
	Full-Duplex Send and Receive an amount of data in interrupt mode. More...
HAL_StatusTypeDef	HAL_USART_Transmit_DMA (USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size)
	Send an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_USART_Receive_DMA (USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size)
	Receive an amount of data in DMA mode. More...
HAL_StatusTypeDef	HAL_USART_TransmitReceive_DMA (USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
	Full-Duplex Transmit Receive an amount of data in non-blocking mode. More...
HAL_StatusTypeDef	HAL_USART_DMAPause (USART_HandleTypeDef *husart)
	Pause the DMA Transfer. More...
HAL_StatusTypeDef	HAL_USART_DMAResume (USART_HandleTypeDef *husart)
	Resume the DMA Transfer. More...
HAL_StatusTypeDef	HAL_USART_DMAStop (USART_HandleTypeDef *husart)
	Stop the DMA Transfer. More...
HAL_StatusTypeDef	HAL_USART_Abort (USART_HandleTypeDef *husart)
	Abort ongoing transfers (blocking mode). More...
HAL_StatusTypeDef	HAL_USART_Abort_IT (USART_HandleTypeDef *husart)
	Abort ongoing transfers (Interrupt mode). More...
void	HAL_USART_IRQHandler (USART_HandleTypeDef *husart)
	Handle USART interrupt request. More...
void	HAL_USART_TxHalfCpltCallback (USART_HandleTypeDef *husart)
	Tx Half Transfer completed callback. More...
void	HAL_USART_TxCpltCallback (USART_HandleTypeDef *husart)
	Tx Transfer completed callback. More...
void	HAL_USART_RxCpltCallback (USART_HandleTypeDef *husart)
	Rx Transfer completed callback. More...
void	HAL_USART_RxHalfCpltCallback (USART_HandleTypeDef *husart)
	Rx Half Transfer completed callback. 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 callback. More...
void	HAL_USART_AbortCpltCallback (USART_HandleTypeDef *husart)
	USART Abort Complete callback. More...
HAL_USART_StateTypeDef	HAL_USART_GetState (USART_HandleTypeDef *husart)
	Return the USART handle state. More...
uint32_t	HAL_USART_GetError (USART_HandleTypeDef *husart)
	Return the USART error code. More...

Detailed Description

Header file of USART HAL module.

Author

MCD Application Team

Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_usart.h.