STM32F769IDiscovery  1.00
uDANTE Audio Networking with STM32F7 DISCO board
Data Structures | Macros | Enumerations | Functions
stm32f7xx_hal_usart.h File Reference

Header file of USART HAL module. More...

#include "stm32f7xx_hal_def.h"
#include "stm32f7xx_hal_usart_ex.h"

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...
 

Macros

#define HAL_USART_ERROR_NONE   ((uint32_t)0x00000000U)
 
#define HAL_USART_ERROR_PE   ((uint32_t)0x00000001U)
 
#define HAL_USART_ERROR_NE   ((uint32_t)0x00000002U)
 
#define HAL_USART_ERROR_FE   ((uint32_t)0x00000004U)
 
#define HAL_USART_ERROR_ORE   ((uint32_t)0x00000008U)
 
#define HAL_USART_ERROR_DMA   ((uint32_t)0x00000010U)
 
#define USART_STOPBITS_1   ((uint32_t)0x0000U)
 
#define USART_STOPBITS_2   ((uint32_t)USART_CR2_STOP_1)
 
#define USART_STOPBITS_1_5   ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
 
#define USART_PARITY_NONE   ((uint32_t)0x0000U)
 
#define USART_PARITY_EVEN   ((uint32_t)USART_CR1_PCE)
 
#define USART_PARITY_ODD   ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
 
#define USART_MODE_RX   ((uint32_t)USART_CR1_RE)
 
#define USART_MODE_TX   ((uint32_t)USART_CR1_TE)
 
#define USART_MODE_TX_RX   ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
 
#define USART_OVERSAMPLING_16   ((uint32_t)0x0000U)
 
#define USART_OVERSAMPLING_8   ((uint32_t)USART_CR1_OVER8)
 
#define USART_CLOCK_DISABLE   ((uint32_t)0x0000U)
 
#define USART_CLOCK_ENABLE   ((uint32_t)USART_CR2_CLKEN)
 
#define USART_POLARITY_LOW   ((uint32_t)0x0000U)
 
#define USART_POLARITY_HIGH   ((uint32_t)USART_CR2_CPOL)
 
#define USART_PHASE_1EDGE   ((uint32_t)0x0000U)
 
#define USART_PHASE_2EDGE   ((uint32_t)USART_CR2_CPHA)
 
#define USART_LASTBIT_DISABLE   ((uint32_t)0x0000U)
 
#define USART_LASTBIT_ENABLE   ((uint32_t)USART_CR2_LBCL)
 
#define USART_RXDATA_FLUSH_REQUEST   ((uint32_t)USART_RQR_RXFRQ)
 
#define USART_TXDATA_FLUSH_REQUEST   ((uint32_t)USART_RQR_TXFRQ)
 
#define USART_FLAG_REACK   ((uint32_t)0x00400000U)
 
#define USART_FLAG_TEACK   ((uint32_t)0x00200000U)
 
#define USART_FLAG_BUSY   ((uint32_t)0x00010000U)
 
#define USART_FLAG_CTS   ((uint32_t)0x00000400U)
 
#define USART_FLAG_CTSIF   ((uint32_t)0x00000200U)
 
#define USART_FLAG_LBDF   ((uint32_t)0x00000100U)
 
#define USART_FLAG_TXE   ((uint32_t)0x00000080U)
 
#define USART_FLAG_TC   ((uint32_t)0x00000040U)
 
#define USART_FLAG_RXNE   ((uint32_t)0x00000020U)
 
#define USART_FLAG_IDLE   ((uint32_t)0x00000010U)
 
#define USART_FLAG_ORE   ((uint32_t)0x00000008U)
 
#define USART_FLAG_NE   ((uint32_t)0x00000004U)
 
#define USART_FLAG_FE   ((uint32_t)0x00000002U)
 
#define USART_FLAG_PE   ((uint32_t)0x00000001U)
 
#define USART_IT_PE   ((uint16_t)0x0028U)
 
#define USART_IT_TXE   ((uint16_t)0x0727U)
 
#define USART_IT_TC   ((uint16_t)0x0626U)
 
#define USART_IT_RXNE   ((uint16_t)0x0525U)
 
#define USART_IT_IDLE   ((uint16_t)0x0424U)
 
#define USART_IT_ERR   ((uint16_t)0x0060U)
 
#define USART_IT_ORE   ((uint16_t)0x0300U)
 
#define USART_IT_NE   ((uint16_t)0x0200U)
 
#define USART_IT_FE   ((uint16_t)0x0100U)
 
#define USART_CLEAR_PEF   USART_ICR_PECF
 
#define USART_CLEAR_FEF   USART_ICR_FECF
 
#define USART_CLEAR_NEF   USART_ICR_NCF
 
#define USART_CLEAR_OREF   USART_ICR_ORECF
 
#define USART_CLEAR_IDLEF   USART_ICR_IDLECF
 
#define USART_CLEAR_TCF   USART_ICR_TCCF
 
#define USART_CLEAR_CTSF   USART_ICR_CTSCF
 
#define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_USART_STATE_RESET)
 Reset USART handle state. More...
 
#define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
 Checks whether the specified USART flag is set or not. More...
 
#define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enables the specified USART interrupt. More...
 
#define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disables the specified USART interrupt. More...
 
#define __HAL_USART_GET_IT(__HANDLE__, __IT__)   ((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__IT__)>> 0x08)))
 Checks whether the specified USART interrupt has occurred or not. More...
 
#define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __IT__)
 Checks whether the specified USART interrupt source is enabled. More...
 
#define __HAL_USART_CLEAR_IT(__HANDLE__, __IT_CLEAR__)   ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
 Clears the specified USART ISR flag, in setting the proper ICR register flag. More...
 
#define __HAL_USART_SEND_REQ(__HANDLE__, __REQ__)   ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
 Set a specific USART request flag. More...
 
#define __HAL_USART_ENABLE(__HANDLE__)    ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
 Enable USART. More...
 
#define __HAL_USART_DISABLE(__HANDLE__)    ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
 Disable USART. More...
 
#define USART_IT_MASK   ((uint16_t)0x001FU)
 USART interruptions flag mask. More...
 
#define USART_GETCLOCKSOURCE(__HANDLE__, __CLOCKSOURCE__)
 Reports the USART clock source. More...
 
#define IS_USART_STOPBITS(__STOPBITS__)
 
#define IS_USART_PARITY(__PARITY__)
 
#define IS_USART_MODE(__MODE__)   ((((__MODE__) & (uint32_t)0xFFFFFFF3U) == 0x00U) && ((__MODE__) != (uint32_t)0x00U))
 
#define IS_USART_OVERSAMPLING(__SAMPLING__)
 
#define IS_USART_CLOCK(__CLOCK__)
 
#define IS_USART_POLARITY(__CPOL__)   (((__CPOL__) == USART_POLARITY_LOW) || ((__CPOL__) == USART_POLARITY_HIGH))
 
#define IS_USART_PHASE(__CPHA__)   (((__CPHA__) == USART_PHASE_1EDGE) || ((__CPHA__) == USART_PHASE_2EDGE))
 
#define IS_USART_LASTBIT(__LASTBIT__)
 
#define IS_USART_REQUEST_PARAMETER(__PARAM__)
 
#define IS_USART_BAUDRATE(__BAUDRATE__)   ((__BAUDRATE__) < 9000001)
 

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...
 

Functions

HAL_StatusTypeDef HAL_USART_Init (USART_HandleTypeDef *husart)
 
HAL_StatusTypeDef HAL_USART_DeInit (USART_HandleTypeDef *husart)
 
void HAL_USART_MspInit (USART_HandleTypeDef *husart)
 
void HAL_USART_MspDeInit (USART_HandleTypeDef *husart)
 
HAL_StatusTypeDef HAL_USART_CheckIdleState (USART_HandleTypeDef *husart)
 
HAL_StatusTypeDef HAL_USART_Transmit (USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout)
 
HAL_StatusTypeDef HAL_USART_Receive (USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
 
HAL_StatusTypeDef HAL_USART_TransmitReceive (USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout)
 
HAL_StatusTypeDef HAL_USART_Transmit_IT (USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size)
 
HAL_StatusTypeDef HAL_USART_Receive_IT (USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size)
 
HAL_StatusTypeDef HAL_USART_TransmitReceive_IT (USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
 
HAL_StatusTypeDef HAL_USART_Transmit_DMA (USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size)
 
HAL_StatusTypeDef HAL_USART_Receive_DMA (USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size)
 
HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA (USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size)
 
HAL_StatusTypeDef HAL_USART_DMAPause (USART_HandleTypeDef *husart)
 
HAL_StatusTypeDef HAL_USART_DMAResume (USART_HandleTypeDef *husart)
 
HAL_StatusTypeDef HAL_USART_DMAStop (USART_HandleTypeDef *husart)
 
void HAL_USART_IRQHandler (USART_HandleTypeDef *husart)
 
void HAL_USART_TxHalfCpltCallback (USART_HandleTypeDef *husart)
 
void HAL_USART_TxCpltCallback (USART_HandleTypeDef *husart)
 
void HAL_USART_RxCpltCallback (USART_HandleTypeDef *husart)
 
void HAL_USART_RxHalfCpltCallback (USART_HandleTypeDef *husart)
 
void HAL_USART_TxRxCpltCallback (USART_HandleTypeDef *husart)
 
void HAL_USART_ErrorCallback (USART_HandleTypeDef *husart)
 
HAL_USART_StateTypeDef HAL_USART_GetState (USART_HandleTypeDef *husart)
 
uint32_t HAL_USART_GetError (USART_HandleTypeDef *husart)
 

Detailed Description

Header file of USART HAL module.

Author
MCD Application Team
Version
V1.1.0
Date
22-April-2016
Attention

© COPYRIGHT(c) 2016 STMicroelectronics

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 stm32f7xx_hal_usart.h.