comparison libs/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/USART/HyperTerminal_HwFlowControl/readme.txt @ 0:c59513fd84fb

Initial commit of STM32 test code.
author Daniel O'Connor <darius@dons.net.au>
date Mon, 03 Oct 2011 21:19:15 +1030
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:c59513fd84fb
1 /**
2 @page USART_HyperTerminal_HwFlowControl USART Hyperterminal Hardware Flow Control example
3
4 @verbatim
5 ******************** (C) COPYRIGHT 2011 STMicroelectronics *******************
6 * @file USART/HyperTerminal_HwFlowControl/readme.txt
7 * @author MCD Application Team
8 * @version V3.5.0
9 * @date 08-April-2011
10 * @brief Description of the USART Hyperterminal Hardware Flow Control
11 * example.
12 ******************************************************************************
13 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
14 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
15 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
16 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
17 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
18 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
19 ******************************************************************************
20 @endverbatim
21
22 @par Example Description
23
24 This example provides a description of how to use the USART with hardware flow
25 control and communicate with the Hyperterminal.
26 First, the USART2 sends the TxBuffer to the hyperterminal and still waiting for
27 a string from the hyperterminal that you must enter which must end by '\r'
28 character (keypad ENTER button). The communication will end if received data exceed
29 255 without sending the '\r' character. Each byte received is retransmitted to the
30 Hyperterminal.
31 The string that you have entered is stored in the RxBuffer array. The receive
32 buffer have a RxBufferSize bytes as maximum.
33
34 The USART2 is configured as follow:
35 - BaudRate = 115200 baud
36 - Word Length = 8 Bits
37 - One Stop Bit
38 - No parity
39 - Hardware flow control enabled (RTS and CTS signals)
40 - Receive and transmit enabled
41
42 @par Directory contents
43
44 - USART/HyperTerminal_HwFlowControl/platform_config.h Evaluation board specific configuration file
45 - USART/HyperTerminal_HwFlowControl/stm32f10x_conf.h Library Configuration file
46 - USART/HyperTerminal_HwFlowControl/stm32f10x_it.h Interrupt handlers header file
47 - USART/HyperTerminal_HwFlowControl/stm32f10x_it.c Interrupt handlers
48 - USART/HyperTerminal_HwFlowControl/main.c Main program
49 - USART/HyperTerminal_HwFlowControl/system_stm32f10x.c STM32F10x system source file
50
51 @par Hardware and Software environment
52
53 - This example runs on STM32F10x Connectivity line, High-Density, High-Density
54 Value line,Medium-Density, XL-Density, Medium-Density Value line, Low-Density
55 and Low-Density Value line Devices.
56
57 - This example has been tested with STMicroelectronics STM32100E-EVAL (High-Density
58 Value line), STM32100B-EVAL (Medium-Density Value line), STM3210E-EVAL
59 (High-Density and XL-Density) and STM3210B-EVAL (Medium-Density) evaluation
60 boards and can be easily tailored to any other supported device and development
61 board.
62 This example can't be tested with STM3210C-EVAL (Connectivity Line) evaluation board.
63 To select the STMicroelectronics evaluation board used to run the example,
64 uncomment the corresponding line in USART/HyperTerminal_HwFlowControl/platform_config.h file
65
66 - STM32100E-EVAL Set-up
67 - Connect a null-modem female/female RS232 cable between CN10 and PC serial
68 port.
69 @note Make sure the Jumper 5 (JP5) is not open.
70
71 - STM32100B-EVAL Set-up
72 - Connect a null-modem female/female RS232 cable between CN9 and PC serial
73 port.
74 @note In this case USART2 Tx, Rx, RTS and CTS pins are remapped by software
75 on PD.05, PD.06, PD.04 and PD.03 respectively.
76
77 - STM3210E-EVAL Set-up
78 - Connect a null-modem female/female RS232 cable between CN8 and PC serial
79 port.
80 @note Make sure the Jumper 4 (JP4) is in position 2<-->3.
81
82 - STM3210B-EVAL Set-up
83 - Connect a null-modem female/female RS232 cable between CN5 and PC serial
84 port.
85 @note In this case USART2 Tx, Rx, RTS and CTS pins are remapped by software
86 on PD.05, PD.06, PD.04 and PD.03 respectively.
87
88
89 - Hyperterminal configuration:
90 - Word Length = 8 Bits
91 - One Stop Bit
92 - No parity
93 - BaudRate = 115200 baud
94 - flow control: Hardware
95
96 @par How to use it ?
97
98 In order to make the program work, you must do the following :
99 - Copy all source files from this example folder to the template folder under
100 Project\STM32F10x_StdPeriph_Template
101 - Open your preferred toolchain
102 - Rebuild all files and load your image into target memory
103 - Run the example
104
105 @note
106 - Low-density Value line devices are STM32F100xx microcontrollers where the
107 Flash memory density ranges between 16 and 32 Kbytes.
108 - Low-density devices are STM32F101xx, STM32F102xx and STM32F103xx
109 microcontrollers where the Flash memory density ranges between 16 and 32 Kbytes.
110 - Medium-density Value line devices are STM32F100xx microcontrollers where
111 the Flash memory density ranges between 64 and 128 Kbytes.
112 - Medium-density devices are STM32F101xx, STM32F102xx and STM32F103xx
113 microcontrollers where the Flash memory density ranges between 64 and 128 Kbytes.
114 - High-density Value line devices are STM32F100xx microcontrollers where
115 the Flash memory density ranges between 256 and 512 Kbytes.
116 - High-density devices are STM32F101xx and STM32F103xx microcontrollers where
117 the Flash memory density ranges between 256 and 512 Kbytes.
118 - XL-density devices are STM32F101xx and STM32F103xx microcontrollers where
119 the Flash memory density ranges between 512 and 1024 Kbytes.
120 - Connectivity line devices are STM32F105xx and STM32F107xx microcontrollers.
121
122 * <h3><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h3>
123 */