You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
485 lines
17 KiB
485 lines
17 KiB
/** |
|
****************************************************************************** |
|
* @file stm32f7xx_hal_uart_ex.c |
|
* @author MCD Application Team |
|
* @brief Extended UART HAL module driver. |
|
* This file provides firmware functions to manage the following extended |
|
* functionalities of the Universal Asynchronous Receiver Transmitter Peripheral (UART). |
|
* + Initialization and de-initialization functions |
|
* + Peripheral Control functions |
|
* |
|
* |
|
@verbatim |
|
============================================================================== |
|
##### UART peripheral extended features ##### |
|
============================================================================== |
|
|
|
(#) Declare a UART_HandleTypeDef handle structure. |
|
|
|
(#) For the UART RS485 Driver Enable mode, initialize the UART registers |
|
by calling the HAL_RS485Ex_Init() API. |
|
|
|
@endverbatim |
|
****************************************************************************** |
|
* @attention |
|
* |
|
* <h2><center>© Copyright (c) 2017 STMicroelectronics. |
|
* All rights reserved.</center></h2> |
|
* |
|
* 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 |
|
* |
|
****************************************************************************** |
|
*/ |
|
|
|
/* Includes ------------------------------------------------------------------*/ |
|
#include "stm32f7xx_hal.h" |
|
|
|
/** @addtogroup STM32F7xx_HAL_Driver |
|
* @{ |
|
*/ |
|
|
|
/** @defgroup UARTEx UARTEx |
|
* @brief UART Extended HAL module driver |
|
* @{ |
|
*/ |
|
|
|
#ifdef HAL_UART_MODULE_ENABLED |
|
|
|
/* Private typedef -----------------------------------------------------------*/ |
|
/* Private define ------------------------------------------------------------*/ |
|
|
|
/* Private macros ------------------------------------------------------------*/ |
|
/* Private variables ---------------------------------------------------------*/ |
|
/* Private function prototypes -----------------------------------------------*/ |
|
/** @defgroup UARTEx_Private_Functions UARTEx Private Functions |
|
* @{ |
|
*/ |
|
#if defined(USART_CR1_UESM) |
|
static void UARTEx_Wakeup_AddressConfig(UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection); |
|
#endif /* USART_CR1_UESM */ |
|
/** |
|
* @} |
|
*/ |
|
|
|
/* Exported functions --------------------------------------------------------*/ |
|
|
|
/** @defgroup UARTEx_Exported_Functions UARTEx Exported Functions |
|
* @{ |
|
*/ |
|
|
|
/** @defgroup UARTEx_Exported_Functions_Group1 Initialization and de-initialization functions |
|
* @brief Extended Initialization and Configuration Functions |
|
* |
|
@verbatim |
|
=============================================================================== |
|
##### Initialization and Configuration functions ##### |
|
=============================================================================== |
|
[..] |
|
This subsection provides a set of functions allowing to initialize the USARTx or the UARTy |
|
in asynchronous mode. |
|
(+) For the asynchronous mode the parameters below can be configured: |
|
(++) Baud Rate |
|
(++) Word Length |
|
(++) Stop Bit |
|
(++) Parity: 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. |
|
(++) Hardware flow control |
|
(++) Receiver/transmitter modes |
|
(++) Over Sampling Method |
|
(++) One-Bit Sampling Method |
|
(+) For the asynchronous mode, the following advanced features can be configured as well: |
|
(++) TX and/or RX pin level inversion |
|
(++) data logical level inversion |
|
(++) RX and TX pins swap |
|
(++) RX overrun detection disabling |
|
(++) DMA disabling on RX error |
|
(++) MSB first on communication line |
|
(++) auto Baud rate detection |
|
[..] |
|
The HAL_RS485Ex_Init() API follows the UART RS485 mode configuration |
|
procedures (details for the procedures are available in reference manual). |
|
|
|
@endverbatim |
|
|
|
Depending on the frame length defined by the M1 and M0 bits (7-bit, |
|
8-bit or 9-bit), the possible UART formats are listed in the |
|
following table. |
|
|
|
Table 1. UART frame format. |
|
+-----------------------------------------------------------------------+ |
|
| M1 bit | M0 bit | PCE bit | UART frame | |
|
|---------|---------|-----------|---------------------------------------| |
|
| 0 | 0 | 0 | | SB | 8 bit data | STB | | |
|
|---------|---------|-----------|---------------------------------------| |
|
| 0 | 0 | 1 | | SB | 7 bit data | PB | STB | | |
|
|---------|---------|-----------|---------------------------------------| |
|
| 0 | 1 | 0 | | SB | 9 bit data | STB | | |
|
|---------|---------|-----------|---------------------------------------| |
|
| 0 | 1 | 1 | | SB | 8 bit data | PB | STB | | |
|
|---------|---------|-----------|---------------------------------------| |
|
| 1 | 0 | 0 | | SB | 7 bit data | STB | | |
|
|---------|---------|-----------|---------------------------------------| |
|
| 1 | 0 | 1 | | SB | 6 bit data | PB | STB | | |
|
+-----------------------------------------------------------------------+ |
|
|
|
* @{ |
|
*/ |
|
|
|
/** |
|
* @brief Initialize the RS485 Driver enable feature according to the specified |
|
* parameters in the UART_InitTypeDef and creates the associated handle. |
|
* @param huart UART handle. |
|
* @param Polarity Select the driver enable polarity. |
|
* This parameter can be one of the following values: |
|
* @arg @ref UART_DE_POLARITY_HIGH DE signal is active high |
|
* @arg @ref UART_DE_POLARITY_LOW DE signal is active low |
|
* @param AssertionTime Driver Enable assertion time: |
|
* 5-bit value defining the time between the activation of the DE (Driver Enable) |
|
* signal and the beginning of the start bit. It is expressed in sample time |
|
* units (1/8 or 1/16 bit time, depending on the oversampling rate) |
|
* @param DeassertionTime Driver Enable deassertion time: |
|
* 5-bit value defining the time between the end of the last stop bit, in a |
|
* transmitted message, and the de-activation of the DE (Driver Enable) signal. |
|
* It is expressed in sample time units (1/8 or 1/16 bit time, depending on the |
|
* oversampling rate). |
|
* @retval HAL status |
|
*/ |
|
HAL_StatusTypeDef HAL_RS485Ex_Init(UART_HandleTypeDef *huart, uint32_t Polarity, uint32_t AssertionTime, |
|
uint32_t DeassertionTime) |
|
{ |
|
uint32_t temp; |
|
|
|
/* Check the UART handle allocation */ |
|
if (huart == NULL) |
|
{ |
|
return HAL_ERROR; |
|
} |
|
/* Check the Driver Enable UART instance */ |
|
assert_param(IS_UART_DRIVER_ENABLE_INSTANCE(huart->Instance)); |
|
|
|
/* Check the Driver Enable polarity */ |
|
assert_param(IS_UART_DE_POLARITY(Polarity)); |
|
|
|
/* Check the Driver Enable assertion time */ |
|
assert_param(IS_UART_ASSERTIONTIME(AssertionTime)); |
|
|
|
/* Check the Driver Enable deassertion time */ |
|
assert_param(IS_UART_DEASSERTIONTIME(DeassertionTime)); |
|
|
|
if (huart->gState == HAL_UART_STATE_RESET) |
|
{ |
|
/* Allocate lock resource and initialize it */ |
|
huart->Lock = HAL_UNLOCKED; |
|
|
|
#if (USE_HAL_UART_REGISTER_CALLBACKS == 1) |
|
UART_InitCallbacksToDefault(huart); |
|
|
|
if (huart->MspInitCallback == NULL) |
|
{ |
|
huart->MspInitCallback = HAL_UART_MspInit; |
|
} |
|
|
|
/* Init the low level hardware */ |
|
huart->MspInitCallback(huart); |
|
#else |
|
/* Init the low level hardware : GPIO, CLOCK, CORTEX */ |
|
HAL_UART_MspInit(huart); |
|
#endif /* (USE_HAL_UART_REGISTER_CALLBACKS) */ |
|
} |
|
|
|
huart->gState = HAL_UART_STATE_BUSY; |
|
|
|
/* Disable the Peripheral */ |
|
__HAL_UART_DISABLE(huart); |
|
|
|
/* Set the UART Communication parameters */ |
|
if (UART_SetConfig(huart) == HAL_ERROR) |
|
{ |
|
return HAL_ERROR; |
|
} |
|
|
|
if (huart->AdvancedInit.AdvFeatureInit != UART_ADVFEATURE_NO_INIT) |
|
{ |
|
UART_AdvFeatureConfig(huart); |
|
} |
|
|
|
/* Enable the Driver Enable mode by setting the DEM bit in the CR3 register */ |
|
SET_BIT(huart->Instance->CR3, USART_CR3_DEM); |
|
|
|
/* Set the Driver Enable polarity */ |
|
MODIFY_REG(huart->Instance->CR3, USART_CR3_DEP, Polarity); |
|
|
|
/* Set the Driver Enable assertion and deassertion times */ |
|
temp = (AssertionTime << UART_CR1_DEAT_ADDRESS_LSB_POS); |
|
temp |= (DeassertionTime << UART_CR1_DEDT_ADDRESS_LSB_POS); |
|
MODIFY_REG(huart->Instance->CR1, (USART_CR1_DEDT | USART_CR1_DEAT), temp); |
|
|
|
/* Enable the Peripheral */ |
|
__HAL_UART_ENABLE(huart); |
|
|
|
/* TEACK and/or REACK to check before moving huart->gState and huart->RxState to Ready */ |
|
return (UART_CheckIdleState(huart)); |
|
} |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
|
|
/** @defgroup UARTEx_Exported_Functions_Group3 Peripheral Control functions |
|
* @brief Extended Peripheral Control functions |
|
* |
|
@verbatim |
|
=============================================================================== |
|
##### Peripheral Control functions ##### |
|
=============================================================================== |
|
[..] This section provides the following functions: |
|
(+) HAL_UARTEx_EnableClockStopMode() API enables the UART clock (HSI or LSE only) during stop mode |
|
(+) HAL_UARTEx_DisableClockStopMode() API disables the above functionality |
|
(+) HAL_MultiProcessorEx_AddressLength_Set() API optionally sets the UART node address |
|
detection length to more than 4 bits for multiprocessor address mark wake up. |
|
#if defined(USART_CR1_UESM) |
|
(+) HAL_UARTEx_StopModeWakeUpSourceConfig() API defines the wake-up from stop mode |
|
trigger: address match, Start Bit detection or RXNE bit status. |
|
(+) HAL_UARTEx_EnableStopMode() API enables the UART to wake up the MCU from stop mode |
|
(+) HAL_UARTEx_DisableStopMode() API disables the above functionality |
|
#endif |
|
|
|
@endverbatim |
|
* @{ |
|
*/ |
|
|
|
#if defined(USART_CR3_UCESM) |
|
/** |
|
* @brief Keep UART Clock enabled when in Stop Mode. |
|
* @note When the USART clock source is configured to be LSE or HSI, it is possible to keep enabled |
|
* this clock during STOP mode by setting the UCESM bit in USART_CR3 control register. |
|
* @note When LPUART is used to wakeup from stop with LSE is selected as LPUART clock source, |
|
* and desired baud rate is 9600 baud, the bit UCESM bit in LPUART_CR3 control register must be set. |
|
* @param huart UART handle. |
|
* @retval HAL status |
|
*/ |
|
HAL_StatusTypeDef HAL_UARTEx_EnableClockStopMode(UART_HandleTypeDef *huart) |
|
{ |
|
/* Process Locked */ |
|
__HAL_LOCK(huart); |
|
|
|
/* Set UCESM bit */ |
|
SET_BIT(huart->Instance->CR3, USART_CR3_UCESM); |
|
|
|
/* Process Unlocked */ |
|
__HAL_UNLOCK(huart); |
|
|
|
return HAL_OK; |
|
} |
|
|
|
/** |
|
* @brief Disable UART Clock when in Stop Mode. |
|
* @param huart UART handle. |
|
* @retval HAL status |
|
*/ |
|
HAL_StatusTypeDef HAL_UARTEx_DisableClockStopMode(UART_HandleTypeDef *huart) |
|
{ |
|
/* Process Locked */ |
|
__HAL_LOCK(huart); |
|
|
|
/* Clear UCESM bit */ |
|
CLEAR_BIT(huart->Instance->CR3, USART_CR3_UCESM); |
|
|
|
/* Process Unlocked */ |
|
__HAL_UNLOCK(huart); |
|
|
|
return HAL_OK; |
|
} |
|
|
|
#endif /* USART_CR3_UCESM */ |
|
/** |
|
* @brief By default in multiprocessor mode, when the wake up method is set |
|
* to address mark, the UART handles only 4-bit long addresses detection; |
|
* this API allows to enable longer addresses detection (6-, 7- or 8-bit |
|
* long). |
|
* @note Addresses detection lengths are: 6-bit address detection in 7-bit data mode, |
|
* 7-bit address detection in 8-bit data mode, 8-bit address detection in 9-bit data mode. |
|
* @param huart UART handle. |
|
* @param AddressLength This parameter can be one of the following values: |
|
* @arg @ref UART_ADDRESS_DETECT_4B 4-bit long address |
|
* @arg @ref UART_ADDRESS_DETECT_7B 6-, 7- or 8-bit long address |
|
* @retval HAL status |
|
*/ |
|
HAL_StatusTypeDef HAL_MultiProcessorEx_AddressLength_Set(UART_HandleTypeDef *huart, uint32_t AddressLength) |
|
{ |
|
/* Check the UART handle allocation */ |
|
if (huart == NULL) |
|
{ |
|
return HAL_ERROR; |
|
} |
|
|
|
/* Check the address length parameter */ |
|
assert_param(IS_UART_ADDRESSLENGTH_DETECT(AddressLength)); |
|
|
|
huart->gState = HAL_UART_STATE_BUSY; |
|
|
|
/* Disable the Peripheral */ |
|
__HAL_UART_DISABLE(huart); |
|
|
|
/* Set the address length */ |
|
MODIFY_REG(huart->Instance->CR2, USART_CR2_ADDM7, AddressLength); |
|
|
|
/* Enable the Peripheral */ |
|
__HAL_UART_ENABLE(huart); |
|
|
|
/* TEACK and/or REACK to check before moving huart->gState to Ready */ |
|
return (UART_CheckIdleState(huart)); |
|
} |
|
|
|
#if defined(USART_CR1_UESM) |
|
/** |
|
* @brief Set Wakeup from Stop mode interrupt flag selection. |
|
* @note It is the application responsibility to enable the interrupt used as |
|
* usart_wkup interrupt source before entering low-power mode. |
|
* @param huart UART handle. |
|
* @param WakeUpSelection Address match, Start Bit detection or RXNE/RXFNE bit status. |
|
* This parameter can be one of the following values: |
|
* @arg @ref UART_WAKEUP_ON_ADDRESS |
|
* @arg @ref UART_WAKEUP_ON_STARTBIT |
|
* @arg @ref UART_WAKEUP_ON_READDATA_NONEMPTY |
|
* @retval HAL status |
|
*/ |
|
HAL_StatusTypeDef HAL_UARTEx_StopModeWakeUpSourceConfig(UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection) |
|
{ |
|
HAL_StatusTypeDef status = HAL_OK; |
|
uint32_t tickstart; |
|
|
|
/* check the wake-up from stop mode UART instance */ |
|
assert_param(IS_UART_WAKEUP_FROMSTOP_INSTANCE(huart->Instance)); |
|
/* check the wake-up selection parameter */ |
|
assert_param(IS_UART_WAKEUP_SELECTION(WakeUpSelection.WakeUpEvent)); |
|
|
|
/* Process Locked */ |
|
__HAL_LOCK(huart); |
|
|
|
huart->gState = HAL_UART_STATE_BUSY; |
|
|
|
/* Disable the Peripheral */ |
|
__HAL_UART_DISABLE(huart); |
|
|
|
/* Set the wake-up selection scheme */ |
|
MODIFY_REG(huart->Instance->CR3, USART_CR3_WUS, WakeUpSelection.WakeUpEvent); |
|
|
|
if (WakeUpSelection.WakeUpEvent == UART_WAKEUP_ON_ADDRESS) |
|
{ |
|
UARTEx_Wakeup_AddressConfig(huart, WakeUpSelection); |
|
} |
|
|
|
/* Enable the Peripheral */ |
|
__HAL_UART_ENABLE(huart); |
|
|
|
/* Init tickstart for timeout managment*/ |
|
tickstart = HAL_GetTick(); |
|
|
|
/* Wait until REACK flag is set */ |
|
if (UART_WaitOnFlagUntilTimeout(huart, USART_ISR_REACK, RESET, tickstart, HAL_UART_TIMEOUT_VALUE) != HAL_OK) |
|
{ |
|
status = HAL_TIMEOUT; |
|
} |
|
else |
|
{ |
|
/* Initialize the UART State */ |
|
huart->gState = HAL_UART_STATE_READY; |
|
} |
|
|
|
/* Process Unlocked */ |
|
__HAL_UNLOCK(huart); |
|
|
|
return status; |
|
} |
|
|
|
/** |
|
* @brief Enable UART Stop Mode. |
|
* @note The UART is able to wake up the MCU from Stop 1 mode as long as UART clock is HSI or LSE. |
|
* @param huart UART handle. |
|
* @retval HAL status |
|
*/ |
|
HAL_StatusTypeDef HAL_UARTEx_EnableStopMode(UART_HandleTypeDef *huart) |
|
{ |
|
/* Process Locked */ |
|
__HAL_LOCK(huart); |
|
|
|
/* Set UESM bit */ |
|
SET_BIT(huart->Instance->CR1, USART_CR1_UESM); |
|
|
|
/* Process Unlocked */ |
|
__HAL_UNLOCK(huart); |
|
|
|
return HAL_OK; |
|
} |
|
|
|
/** |
|
* @brief Disable UART Stop Mode. |
|
* @param huart UART handle. |
|
* @retval HAL status |
|
*/ |
|
HAL_StatusTypeDef HAL_UARTEx_DisableStopMode(UART_HandleTypeDef *huart) |
|
{ |
|
/* Process Locked */ |
|
__HAL_LOCK(huart); |
|
|
|
/* Clear UESM bit */ |
|
CLEAR_BIT(huart->Instance->CR1, USART_CR1_UESM); |
|
|
|
/* Process Unlocked */ |
|
__HAL_UNLOCK(huart); |
|
|
|
return HAL_OK; |
|
} |
|
|
|
#endif /* USART_CR1_UESM */ |
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** @addtogroup UARTEx_Private_Functions |
|
* @{ |
|
*/ |
|
#if defined(USART_CR1_UESM) |
|
|
|
/** |
|
* @brief Initialize the UART wake-up from stop mode parameters when triggered by address detection. |
|
* @param huart UART handle. |
|
* @param WakeUpSelection UART wake up from stop mode parameters. |
|
* @retval None |
|
*/ |
|
static void UARTEx_Wakeup_AddressConfig(UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection) |
|
{ |
|
assert_param(IS_UART_ADDRESSLENGTH_DETECT(WakeUpSelection.AddressLength)); |
|
|
|
/* Set the USART address length */ |
|
MODIFY_REG(huart->Instance->CR2, USART_CR2_ADDM7, WakeUpSelection.AddressLength); |
|
|
|
/* Set the USART address node */ |
|
MODIFY_REG(huart->Instance->CR2, USART_CR2_ADD, ((uint32_t)WakeUpSelection.Address << UART_CR2_ADDRESS_LSB_POS)); |
|
} |
|
#endif /* USART_CR1_UESM */ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
#endif /* HAL_UART_MODULE_ENABLED */ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/** |
|
* @} |
|
*/ |
|
|
|
/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
|
|