mirror of
https://github.com/STMicroelectronics/STM32CubeF4.git
synced 2025-04-30 13:48:52 +08:00
/**
@page UART_HyperTerminal_TxPolling_RxIT UART Hyperterminal Polling/IT example (HAL/LL mixed usage example)
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file UART/UART_HyperTerminal_TxPolling_RxIT/readme.txt
* @author MCD Application Team
* @brief Description of the UART HAL/LL mixed Hyperterminal example.
******************************************************************************
*
* 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.
*
******************************************************************************
@endverbatim
@par Example Description
This example describes how to use an UART to transmit data (transmit/receive)
between a board and an HyperTerminal PC application both in Polling and Interrupt
modes. This example provides a description of how to use USART peripheral through
the STM32F4xx UART HAL and LL API (LL API usage for performance improvement).
Board: NUCLEO-F411RE
Tx Pin: PA.02
Rx Pin: PA.03
_________________________
| ______________| _______________
| |USART2 | | HyperTerminal |
| | | | |
| | TX |______________________|RX |
| | | | |
| | | Virtual Com Port | |
| | | | |
| | RX |______________________|TX |
| | | | |
| |______________| |_______________|
| |
| |
| |
| |
|_STM32_Board_____________|
At the beginning of the main program the HAL_Init() function is called to reset
all the peripherals, initialize the Flash interface and the systick.
Then the SystemClock_Config() function is used to configure the system
clock (SYSCLK) to run at 100 MHz for STM32F4xx Devices.
The UART peripheral configuration is ensured by the HAL_UART_Init() function.
This later is calling the HAL_UART_MspInit()function which core is implementing
the configuration of the needed UART resources according to the used hardware.
You may update this function to change UART configuration.
Reception under IT on UART/Hyperterminal interface is then enabled using LL APIs.
Each 0.5 sec, a predefined Tx buffer is sent from MCU to PC reception of Data from Hyperterminal.
The Asynchronous communication aspect of the UART is clearly highlighted as the
data buffers transmission/reception to/from Hyperterminal are done simultaneously.
Transmit function which allow transmission of a predefined data buffer
in polling mode, is implemented using HAL UART API.
Receive function which allow the reception of Data from Hyperterminal in
IT mode, is implemented using LL USART API.
A double buffer is available for received data, allowing continuous reception.
Data received in Buffer A could be echoed on Tx, while buffer B is used for reception.
When buffer B is full, it is then echoed, while buffer A becomes active buffer for next reception, and so on.
For this example the TxBuffer is predefined and the RxBuffer size is limited to
10 data by the mean of the RXBUFFERSIZE define in the main.c file.
Received data will be stored in the RxBuffer buffer.
When Rx buffer is full, RX buffer is sent back to PC and led toggles.
The Asynchronous communication aspect of the UART is clearly highlighted as the
data buffers transmission/reception to/from Hyperterminal are done simultaneously.
STM32 Nucleo board's LEDs can be used to monitor the transfer status:
- LED2 toggles each time reception buffer is detected as full.
- LED2 stays ON when there is an error in transmission/reception process.
The UART is configured as follows:
- BaudRate = 9600 baud
- Word Length = 8 Bits (7 data bit + 1 parity bit)
- One Stop Bit
- Odd parity
- Hardware flow control disabled (RTS and CTS signals)
- Reception and transmission are enabled in the time
@note USARTx/UARTx instance used and associated resources can be updated in "main.h"
file depending hardware configuration used.
For example, current example is provided in a configuration based on Virtual Com Port use (USART2).
Another USART instance could be used, assuming corresponding TX and RX pins are properly wired
to PC Com port (updates to be done accordinlgy in main.h).
@note When the parity is enabled, the computed parity is inserted at the MSB
position of the transmitted data.
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
@note The application needs to ensure that the SysTick time base is always set to 1 millisecond
to have correct HAL operation.
@par Keywords
Connectivity, UART, Printf, Baud rate, RS-232, HyperTerminal, Polling, Transmission,
Reception, Asynchronous
@par Directory contents
- UART/UART_HyperTerminal_TxPolling_RxIT/Inc/stm32f4xx_hal_conf.h HAL configuration file
- UART/UART_HyperTerminal_TxPolling_RxIT/Inc/stm32f4xx_it.h IT interrupt handlers header file
- UART/UART_HyperTerminal_TxPolling_RxIT/Inc/main.h Main program header file
- UART/UART_HyperTerminal_TxPolling_RxIT/Src/stm32f4xx_it.c IT interrupt handlers
- UART/UART_HyperTerminal_TxPolling_RxIT/Src/main.c Main program
- UART/UART_HyperTerminal_TxPolling_RxIT/Src/stm32f4xx_hal_msp.c HAL MSP file
- UART/UART_HyperTerminal_TxPolling_RxIT/Src/system_stm32f4xx.c STM32F4xx system source file
@par Hardware and Software environment
- This example runs on STM32F411xx devices.
- This example has been tested with STMicroelectronics NUCLEO-F411RE board and can be
easily tailored to any other supported device and development board.
- NUCLEO-F411RE Set-up
Example is delivered for using Virtual Com port feature of STLINK for connection between NUCLEO-F411RE and PC,
Please ensure that USART communication between the target MCU and ST-LINK MCU is properly enabled
on HW board in order to support Virtual Com Port (Default HW SB configuration allows use of VCP)
GPIOs connected to USART2 TX/RX (PA.02 and PA.03) are automatically mapped
on RX and TX pins of PC UART Com port selected on PC side (please ensure VCP com port is selected).
- Launch serial communication SW on PC (as HyperTerminal or TeraTerm) with proper configuration
- Word Length = 7 Bits
- One Stop Bit
- Odd parity
- BaudRate = 9600 baud
- flow control: None
@par How to use it ?
In order to make the program work, you must do the following :
- Open your preferred toolchain
- Rebuild all files and load your image into target memory
- Run the example
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
*/