STM32F103xB HAL User Manual: stm32f1xx_hal

USART HAL module driver. This file provides firmware functions to manage the following functionalities of the Universal Synchronous/Asynchronous Receiver Transmitter Peripheral (USART). + Initialization and de-initialization functions + IO operation functions + Peripheral Control functions. More...

#include "stm32f1xx_hal.h"

Go to the source code of this file.

Defines
#define	DUMMY_DATA 0xFFFFU
#define	USART_TIMEOUT_VALUE 22000U
Functions
void	USART_InitCallbacksToDefault (USART_HandleTypeDef *husart)
	Initialize the callbacks to their default values.
static void	USART_EndTxTransfer (USART_HandleTypeDef *husart)
	End ongoing Tx transfer on USART peripheral (following error detection or Transmit completion).
static void	USART_EndRxTransfer (USART_HandleTypeDef *husart)
	End ongoing Rx transfer on USART peripheral (following error detection or Reception completion).
static HAL_StatusTypeDef	USART_Transmit_IT (USART_HandleTypeDef *husart)
	Simplex Send an amount of data in non-blocking mode.
static HAL_StatusTypeDef	USART_EndTransmit_IT (USART_HandleTypeDef *husart)
	Wraps up transmission in non blocking mode.
static HAL_StatusTypeDef	USART_Receive_IT (USART_HandleTypeDef *husart)
	Simplex Receive an amount of data in non-blocking mode.
static HAL_StatusTypeDef	USART_TransmitReceive_IT (USART_HandleTypeDef *husart)
	Full-Duplex Send receive an amount of data in full-duplex mode (non-blocking).
static void	USART_SetConfig (USART_HandleTypeDef *husart)
	Configures the USART peripheral.
static void	USART_DMATransmitCplt (DMA_HandleTypeDef *hdma)
	DMA USART transmit process complete callback.
static void	USART_DMATxHalfCplt (DMA_HandleTypeDef *hdma)
	DMA USART transmit process half complete callback.
static void	USART_DMAReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA USART receive process complete callback.
static void	USART_DMARxHalfCplt (DMA_HandleTypeDef *hdma)
	DMA USART receive process half complete callback.
static void	USART_DMAError (DMA_HandleTypeDef *hdma)
	DMA USART communication error callback.
static void	USART_DMAAbortOnError (DMA_HandleTypeDef *hdma)
	DMA USART communication abort callback, when initiated by HAL services on Error (To be called at end of DMA Abort procedure following error occurrence).
static void	USART_DMATxAbortCallback (DMA_HandleTypeDef *hdma)
	DMA USART Tx communication abort callback, when initiated by user (To be called at end of DMA Tx Abort procedure following user abort request).
static void	USART_DMARxAbortCallback (DMA_HandleTypeDef *hdma)
	DMA USART Rx communication abort callback, when initiated by user (To be called at end of DMA Rx Abort procedure following user abort request).
static HAL_StatusTypeDef	USART_WaitOnFlagUntilTimeout (USART_HandleTypeDef *husart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
	This function handles USART Communication Timeout.
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.
HAL_StatusTypeDef	HAL_USART_DeInit (USART_HandleTypeDef *husart)
	DeInitializes the USART peripheral.
__weak void	HAL_USART_MspInit (USART_HandleTypeDef *husart)
	USART MSP Init.
__weak void	HAL_USART_MspDeInit (USART_HandleTypeDef *husart)
	USART MSP DeInit.
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.
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.
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.
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.
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 full-duplex mode (blocking mode).
HAL_StatusTypeDef	HAL_USART_Transmit_IT (USART_HandleTypeDef husart, uint8_t pTxData, uint16_t Size)
	Simplex Send an amount of data in non-blocking mode.
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.
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 full-duplex mode (non-blocking).
HAL_StatusTypeDef	HAL_USART_Transmit_DMA (USART_HandleTypeDef husart, uint8_t pTxData, uint16_t Size)
	Simplex Send an amount of data in DMA mode.
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.
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 DMA mode.
HAL_StatusTypeDef	HAL_USART_DMAPause (USART_HandleTypeDef *husart)
	Pauses the DMA Transfer.
HAL_StatusTypeDef	HAL_USART_DMAResume (USART_HandleTypeDef *husart)
	Resumes the DMA Transfer.
HAL_StatusTypeDef	HAL_USART_DMAStop (USART_HandleTypeDef *husart)
	Stops the DMA Transfer.
HAL_StatusTypeDef	HAL_USART_Abort (USART_HandleTypeDef *husart)
	Abort ongoing transfer (blocking mode).
HAL_StatusTypeDef	HAL_USART_Abort_IT (USART_HandleTypeDef *husart)
	Abort ongoing transfer (Interrupt mode).
void	HAL_USART_IRQHandler (USART_HandleTypeDef *husart)
	This function handles USART interrupt request.
__weak void	HAL_USART_TxCpltCallback (USART_HandleTypeDef *husart)
	Tx Transfer completed callbacks.
__weak void	HAL_USART_TxHalfCpltCallback (USART_HandleTypeDef *husart)
	Tx Half Transfer completed callbacks.
__weak void	HAL_USART_RxCpltCallback (USART_HandleTypeDef *husart)
	Rx Transfer completed callbacks.
__weak void	HAL_USART_RxHalfCpltCallback (USART_HandleTypeDef *husart)
	Rx Half Transfer completed callbacks.
__weak void	HAL_USART_TxRxCpltCallback (USART_HandleTypeDef *husart)
	Tx/Rx Transfers completed callback for the non-blocking process.
__weak void	HAL_USART_ErrorCallback (USART_HandleTypeDef *husart)
	USART error callbacks.
__weak void	HAL_USART_AbortCpltCallback (USART_HandleTypeDef *husart)
	USART Abort Complete callback.
HAL_USART_StateTypeDef	HAL_USART_GetState (USART_HandleTypeDef *husart)
	Returns the USART state.
uint32_t	HAL_USART_GetError (USART_HandleTypeDef *husart)
	Return the USART error code.

Detailed Description

Author:

MCD Application Team

  ==============================================================================
                        ##### How to use this driver #####
  ==============================================================================
  [..]
    The USART HAL driver can be used as follows:

    (#) Declare a USART_HandleTypeDef handle structure (eg. USART_HandleTypeDef husart).
    (#) Initialize the USART low level resources by implementing the HAL_USART_MspInit() API:
        (##) Enable the USARTx interface clock.
        (##) USART pins configuration:
             (+++) Enable the clock for the USART GPIOs.
             (+++) Configure the USART pins as alternate function pull-up.
        (##) NVIC configuration if you need to use interrupt process (HAL_USART_Transmit_IT(),
             HAL_USART_Receive_IT() and HAL_USART_TransmitReceive_IT() APIs):
             (+++) Configure the USARTx interrupt priority.
             (+++) Enable the NVIC USART IRQ handle.
        (##) DMA Configuration if you need to use DMA process (HAL_USART_Transmit_DMA()
             HAL_USART_Receive_DMA() and HAL_USART_TransmitReceive_DMA() APIs):
             (+++) Declare a DMA handle structure for the Tx/Rx channel.
             (+++) Enable the DMAx interface clock.
             (+++) Configure the declared DMA handle structure with the required Tx/Rx parameters.
             (+++) Configure the DMA Tx/Rx channel.
             (+++) Associate the initialized DMA handle to the USART DMA Tx/Rx handle.
             (+++) Configure the priority and enable the NVIC for the transfer complete interrupt on the DMA Tx/Rx channel.
             (+++) Configure the USARTx interrupt priority and enable the NVIC USART IRQ handle
                   (used for last byte sending completion detection in DMA non circular mode)

    (#) Program the Baud Rate, Word Length, Stop Bit, Parity, Hardware
        flow control and Mode(Receiver/Transmitter) in the husart Init structure.

    (#) Initialize the USART registers by calling the HAL_USART_Init() API:
        (++) These APIs configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
             by calling the customized HAL_USART_MspInit(&husart) API.

        -@@- The specific USART interrupts (Transmission complete interrupt,
             RXNE interrupt and Error Interrupts) will be managed using the macros
             __HAL_USART_ENABLE_IT() and __HAL_USART_DISABLE_IT() inside the transmit and receive process.

    (#) Three operation modes are available within this driver :

     *** Polling mode IO operation ***
     =================================
     [..]
       (+) Send an amount of data in blocking mode using HAL_USART_Transmit()
       (+) Receive an amount of data in blocking mode using HAL_USART_Receive()

     *** Interrupt mode IO operation ***
     ===================================
     [..]
       (+) Send an amount of data in non blocking mode using HAL_USART_Transmit_IT()
       (+) At transmission end of transfer HAL_USART_TxHalfCpltCallback is executed and user can
            add his own code by customization of function pointer HAL_USART_TxCpltCallback
       (+) Receive an amount of data in non blocking mode using HAL_USART_Receive_IT()
       (+) At reception end of transfer HAL_USART_RxCpltCallback is executed and user can
            add his own code by customization of function pointer HAL_USART_RxCpltCallback
       (+) In case of transfer Error, HAL_USART_ErrorCallback() function is executed and user can
            add his own code by customization of function pointer HAL_USART_ErrorCallback

     *** DMA mode IO operation ***
     ==============================
     [..]
       (+) Send an amount of data in non blocking mode (DMA) using HAL_USART_Transmit_DMA()
       (+) At transmission end of half transfer HAL_USART_TxHalfCpltCallback is executed and user can
            add his own code by customization of function pointer HAL_USART_TxHalfCpltCallback
       (+) At transmission end of transfer HAL_USART_TxCpltCallback is executed and user can
            add his own code by customization of function pointer HAL_USART_TxCpltCallback
       (+) Receive an amount of data in non blocking mode (DMA) using HAL_USART_Receive_DMA()
       (+) At reception end of half transfer HAL_USART_RxHalfCpltCallback is executed and user can
            add his own code by customization of function pointer HAL_USART_RxHalfCpltCallback
       (+) At reception end of transfer HAL_USART_RxCpltCallback is executed and user can
            add his own code by customization of function pointer HAL_USART_RxCpltCallback
       (+) In case of transfer Error, HAL_USART_ErrorCallback() function is executed and user can
            add his own code by customization of function pointer HAL_USART_ErrorCallback
       (+) Pause the DMA Transfer using HAL_USART_DMAPause()
       (+) Resume the DMA Transfer using HAL_USART_DMAResume()
       (+) Stop the DMA Transfer using HAL_USART_DMAStop()

     *** USART HAL driver macros list ***
     =============================================
     [..]
       Below the list of most used macros in USART HAL driver.

       (+) __HAL_USART_ENABLE: Enable the USART peripheral
       (+) __HAL_USART_DISABLE: Disable the USART peripheral
       (+) __HAL_USART_GET_FLAG : Check whether the specified USART flag is set or not
       (+) __HAL_USART_CLEAR_FLAG : Clear the specified USART pending flag
       (+) __HAL_USART_ENABLE_IT: Enable the specified USART interrupt
       (+) __HAL_USART_DISABLE_IT: Disable the specified USART interrupt

     [..]
       (@) You can refer to the USART HAL driver header file for more useful macros

    ##### Callback registration #####
    ==================================

    [..]
    The compilation define USE_HAL_USART_REGISTER_CALLBACKS when set to 1
    allows the user to configure dynamically the driver callbacks.

    [..]
    Use Function @ref HAL_USART_RegisterCallback() to register a user callback.
    Function @ref HAL_USART_RegisterCallback() allows to register following callbacks:
    (+) TxHalfCpltCallback        : Tx Half Complete Callback.
    (+) TxCpltCallback            : Tx Complete Callback.
    (+) RxHalfCpltCallback        : Rx Half Complete Callback.
    (+) RxCpltCallback            : Rx Complete Callback.
    (+) TxRxCpltCallback          : Tx Rx Complete Callback.
    (+) ErrorCallback             : Error Callback.
    (+) AbortCpltCallback         : Abort Complete Callback.
    (+) MspInitCallback           : USART MspInit.
    (+) MspDeInitCallback         : USART MspDeInit.
    This function takes as parameters the HAL peripheral handle, the Callback ID
    and a pointer to the user callback function.

    [..]
    Use function @ref HAL_USART_UnRegisterCallback() to reset a callback to the default
    weak (surcharged) function.
    @ref HAL_USART_UnRegisterCallback() takes as parameters the HAL peripheral handle,
    and the Callback ID.
    This function allows to reset following callbacks:
    (+) TxHalfCpltCallback        : Tx Half Complete Callback.
    (+) TxCpltCallback            : Tx Complete Callback.
    (+) RxHalfCpltCallback        : Rx Half Complete Callback.
    (+) RxCpltCallback            : Rx Complete Callback.
    (+) TxRxCpltCallback          : Tx Rx Complete Callback.
    (+) ErrorCallback             : Error Callback.
    (+) AbortCpltCallback         : Abort Complete Callback.
    (+) MspInitCallback           : USART MspInit.
    (+) MspDeInitCallback         : USART MspDeInit.

    [..]
    By default, after the @ref HAL_USART_Init() and when the state is HAL_USART_STATE_RESET
    all callbacks are set to the corresponding weak (surcharged) functions:
    examples @ref HAL_USART_TxCpltCallback(), @ref HAL_USART_RxHalfCpltCallback().
    Exception done for MspInit and MspDeInit functions that are respectively
    reset to the legacy weak (surcharged) functions in the @ref HAL_USART_Init()
    and @ref HAL_USART_DeInit() only when these callbacks are null (not registered beforehand).
    If not, MspInit or MspDeInit are not null, the @ref HAL_USART_Init() and @ref HAL_USART_DeInit()
    keep and use the user MspInit/MspDeInit callbacks (registered beforehand).

    [..]
    Callbacks can be registered/unregistered in HAL_USART_STATE_READY state only.
    Exception done MspInit/MspDeInit that can be registered/unregistered
    in HAL_USART_STATE_READY or HAL_USART_STATE_RESET state, thus registered (user)
    MspInit/DeInit callbacks can be used during the Init/DeInit.
    In that case first register the MspInit/MspDeInit user callbacks
    using @ref HAL_USART_RegisterCallback() before calling @ref HAL_USART_DeInit()
    or @ref HAL_USART_Init() function.

    [..]
    When The compilation define USE_HAL_USART_REGISTER_CALLBACKS is set to 0 or
    not defined, the callback registration feature is not available
    and weak (surcharged) callbacks are used.

[..] (@) Additional remark: If the parity is enabled, then the MSB bit of the data written in the data register is transmitted but is changed by the parity bit. Depending on the frame length defined by the M bit (8-bits or 9-bits), the possible USART frame formats are as listed in the following table: +-------------------------------------------------------------+ | M bit | PCE bit | USART frame | |---------------------|---------------------------------------| | 0 | 0 | | SB | 8 bit data | STB | | |---------|-----------|---------------------------------------| | 0 | 1 | | SB | 7 bit data | PB | STB | | |---------|-----------|---------------------------------------| | 1 | 0 | | SB | 9 bit data | STB | | |---------|-----------|---------------------------------------| | 1 | 1 | | SB | 8 bit data | PB | STB | | +-------------------------------------------------------------+

Attention:

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

Defines

Functions

Detailed Description

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