/**
@page UART_Printf UART Printf example
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file UART/UART_Printf/readme.txt
* @author MCD Application Team
* @brief Description of the UART Printf example.
******************************************************************************
* @attention
*
* Copyright (c) 2017 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
@endverbatim
@par Example Description
This example shows how to re-route the C library printf function to the UART.
The UART outputs a message on the HyperTerminal.
LED4 is ON when there is an error occurrence.
The USART 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.
@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, full-duplex
@par Directory contents
- UART/UART_Printf/Inc/stm32f4xx_hal_conf.h HAL configuration file
- UART/UART_Printf/Inc/stm32f4xx_it.h IT interrupt handlers header file
- UART/UART_Printf/Inc/main.h Header for main.c module
- UART/UART_Printf/Src/stm32f4xx_it.c Interrupt handlers
- UART/UART_Printf/Src/main.c Main program
- UART/UART_Printf/Src/stm32f4xx_hal_msp.c HAL MSP module
- UART/UART_Printf/Src/system_stm32f4xx.c STM32F4xx system source file
@par Hardware and Software environment
- This example runs on STM32F413xx devices.
- This example has been tested with STM32F413H-DISCOVERY board and can be
easily tailored to any other supported device and development board.
- STM32F413H-DISCOVERY Set-up
- Connect ST-Link cable to the PC USB port to display data on the HyperTerminal.
A virtual COM port will then appear in the HyperTerminal.
- Hyperterminal configuration:
- Data 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
*/