Mercurial > ~darius > hgwebdir.cgi > stm32temp

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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_DMA_Polling USART DMA Polling example
3
4 @verbatim
5 ******************** (C) COPYRIGHT 2011 STMicroelectronics *******************
6 * @file USART/DMA_Polling/readme.txt
7 * @author MCD Application Team
8 * @version V3.5.0
9 * @date 08-April-2011
10 * @brief Description of the USART DMA Polling example.
11 ******************************************************************************
12 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
13 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
14 * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
15 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
16 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
17 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
18 ******************************************************************************
19 @endverbatim
20
21 @par Example Description
22
23 This example provides a basic communication between USARTy and USARTz using DMA
24 capability. USARTy and USARTz can be USART1 and USART2 or USART2 and USART3,
25 depending on the STMicroelectronics EVAL board you are using.
26
27 First, the DMA transfers data from TxBuffer2 buffer to USARTz Transmit data
28 register, then this data is sent to USARTy. Data received by USARTy is transferred
29 by DMA and stored in RxBuffer1 then compared with the send ones and the result
30 of this comparison is stored in the "TransferStatus1" variable.
31
32 In the same time, the DMA transfers data from TxBuffer1 buffer to USARTy Transmit
33 data register, then this data is sent to USARTz. Data received by USARTz is
34 transferred by DMA and stored in RxBuffer2 then compared with the send ones and
35 the result of this comparison is stored in the "TransferStatus2" variable.
36
37 USARTy and USARTz configured as follow:
38 - BaudRate = 230400 baud
39 - Word Length = 8 Bits
40 - One Stop Bit
41 - No parity
42 - Hardware flow control disabled (RTS and CTS signals)
43 - Receive and transmit enabled
44
45 @par Directory contents
46
47 - USART/DMA_Polling/platform_config.h Evaluation board specific configuration file
48 - USART/DMA_Polling/stm32f10x_conf.h Library Configuration file
49 - USART/DMA_Polling/stm32f10x_it.h Interrupt handlers header file
50 - USART/DMA_Polling/stm32f10x_it.c Interrupt handlers
51 - USART/DMA_Polling/main.c Main program
52 - USART/DMA_Polling/system_stm32f10x.c STM32F10x system source file
53
54 @par Hardware and Software environment
55
56 - This example runs on STM32F10x Connectivity line, High-Density, High-Density
57 Value line, Medium-Density, XL-Density, Medium-Density Value line, Low-Density
58 and Low-Density Value line Devices.
59
60 - This example has been tested with STMicroelectronics STM32100E-EVAL (High-Density
61 Value line), STM32100B-EVAL (Medium-Density Value line), STM3210C-EVAL (Connectivity line),
62 STM3210E-EVAL (High-Density and XL-Density) and STM3210B-EVAL (Medium-Density)
63 evaluation boards and can be easily tailored to any other supported device
64 and development board.
65 To select the STMicroelectronics evaluation board used to run the example,
66 uncomment the corresponding line in USART/DMA_Polling/platform_config.h file
67
68 - STM32100E-EVAL Set-up
69 - Connect a null-modem female/female RS232 cable between CN10 (USART1) and
70 CN5 (USART2).
71 @note Make sure that jumper JP5 is not open.
72
73 - STM32100B-EVAL Set-up
74 - Connect a null-modem female/female RS232 cable between CN10 (USART1) and
75 CN9 (USART2).
76 @note In this case USART2 Tx and Rx pins are remapped by software on PD.05
77 and PD.06 respectively.
78
79 - STM3210C-EVAL Set-up
80 - Connect USART2 Tx pin (PD.05) to USART3 Rx pin (PC.11)
81 - Connect USART2 Rx pin (PD.06) to USART3 Tx pin (PC.10)
82 @note In this case USART3 Tx and Rx pins are remapped by software.
83 Make sure that jumpers JP19 and JP18 are open.
84
85 - STM3210E-EVAL Set-up
86 - Connect a null-modem female/female RS232 cable between CN12 (USART1) and
87 CN8 (USART2).
88
89 - STM3210B-EVAL Set-up
90 - Connect a null-modem female/female RS232 cable between CN6 (USART1) and
91 CN5 (USART2).
92 - In this case USART2 Tx and Rx pins are remapped by software on PD.05
93 and PD.06 respectively.
94
95 @par How to use it ?
96
97 In order to make the program work, you must do the following :
98 - Copy all source files from this example folder to the template folder under
99 Project\STM32F10x_StdPeriph_Template
100 - Open your preferred toolchain
101 - Rebuild all files and load your image into target memory
102 - Run the example
103
104 @note
105 - Low-density Value line devices are STM32F100xx microcontrollers where the
106 Flash memory density ranges between 16 and 32 Kbytes.
107 - Low-density devices are STM32F101xx, STM32F102xx and STM32F103xx
108 microcontrollers where the Flash memory density ranges between 16 and 32 Kbytes.
109 - Medium-density Value line devices are STM32F100xx microcontrollers where
110 the Flash memory density ranges between 64 and 128 Kbytes.
111 - Medium-density devices are STM32F101xx, STM32F102xx and STM32F103xx
112 microcontrollers where the Flash memory density ranges between 64 and 128 Kbytes.
113 - High-density Value line devices are STM32F100xx microcontrollers where
114 the Flash memory density ranges between 256 and 512 Kbytes.
115 - High-density devices are STM32F101xx and STM32F103xx microcontrollers where
116 the Flash memory density ranges between 256 and 512 Kbytes.
117 - XL-density devices are STM32F101xx and STM32F103xx microcontrollers where
118 the Flash memory density ranges between 512 and 1024 Kbytes.
119 - Connectivity line devices are STM32F105xx and STM32F107xx microcontrollers.
120
121 * <h3><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h3>
122 */