Mercurial > ~darius > hgwebdir.cgi > stm32temp
comparison libs/STM32F10x_StdPeriph_Lib_V3.5.0/Project/STM32F10x_StdPeriph_Examples/Lib_DEBUG/RunTime_Check/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 Lib_DEBUG_RunTime_Check Lib_DEBUG Run Time Checking example | |
3 | |
4 @verbatim | |
5 ******************** (C) COPYRIGHT 2011 STMicroelectronics ******************* | |
6 * @file Lib_DEBUG/RunTime_Check/readme.txt | |
7 * @author MCD Application Team | |
8 * @version V3.5.0 | |
9 * @date 08-April-2011 | |
10 * @brief Description of the Lib_DEBUG Run Time Checking 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 demonstrates how to declare a dynamic peripherals pointers used for | |
24 Debug mode. | |
25 | |
26 To use Debug mode you have to add the stm32f10x_ip_dbg.c file to your application. | |
27 This creates a pointer to the peripheral structure in SRAM. Debugging consequently | |
28 becomes easier and all register settings can be obtained by dumping a peripheral | |
29 variable. | |
30 | |
31 When the "USE_FULL_ASSERT" label is uncommented (in stm32f10x_conf.h file), | |
32 the assert_param macro is expanded and runtime checking is enabled in the firmware | |
33 library code. The runtime checking allows checking that all the library functions | |
34 input value lies within the parameter allowed values. | |
35 | |
36 The associated program simulates wrong parameter passed to library function and the | |
37 source of the error is printed on HyperTerminal (through USART). | |
38 | |
39 @note | |
40 The Debug mode increases the code size and reduces the code performance. For this | |
41 reason, it is recommended to used it only when debugging the application and to | |
42 remove it from the final application code. | |
43 | |
44 | |
45 @par Directory contents | |
46 | |
47 - Lib_DEBUG/RunTime_Check/stm32f10x_conf.h Library Configuration file | |
48 - Lib_DEBUG/RunTime_Check/stm32f10x_it.c Interrupt handlers | |
49 - Lib_DEBUG/RunTime_Check/stm32f10x_it.h Header for stm32f10x_it.c | |
50 - Lib_DEBUG/RunTime_Check/main.c Main program | |
51 - Lib_DEBUG/RunTime_Check/stm32f10x_ip_dbg.c Peripherals pointers initialization | |
52 - Lib_DEBUG/RunTime_Check/stm32f10x_ip_dbg.h Header for lib_dbg.c | |
53 - Lib_DEBUG/RunTime_Check/system_stm32f10x.c STM32F10x system source file | |
54 | |
55 @par Hardware and Software environment | |
56 | |
57 - This example runs on STM32F10x Connectivity line, High-Density, High-Density | |
58 Value line, Medium-Density, XL-Density, High-Density Value line, Medium-Density | |
59 Value line, Low-Density and Low-Density Value line Devices. | |
60 | |
61 - This example has been tested with STMicroelectronics STM32100E-EVAL (High-Density | |
62 Value line), STM32100B-EVAL (Medium-Density Value line), STM3210C-EVAL | |
63 (Connectivity line), STM3210E-EVAL (High-Density and XL-Density) and STM3210B-EVAL | |
64 (Medium-Density) evaluation boards and can be easily tailored to any other | |
65 supported device and development board. | |
66 To select the STMicroelectronics evaluation board used to run the example, | |
67 uncomment the corresponding line in stm32_eval.h file (under Utilities\STM32_EVAL) | |
68 | |
69 - STM32100E-EVAL Set-up | |
70 - Connect a null-modem female/female RS232 cable between the DB9 connector | |
71 CN10 and PC serial port. | |
72 | |
73 - STM32100B-EVAL Set-up | |
74 - Connect a null-modem female/female RS232 cable between the DB9 connector | |
75 CN10 and PC serial port. | |
76 | |
77 - STM3210C-EVAL Set-up | |
78 - Connect a null-modem female/female RS232 cable between the DB9 connector | |
79 CN6 and PC serial port. | |
80 @note Make sure that jumpers JP19 and JP18 are open. | |
81 | |
82 - STM3210E-EVAL Set-up | |
83 - Connect a null-modem female/female RS232 cable between the DB9 connector | |
84 CN12 and PC serial port. | |
85 | |
86 - STM3210B-EVAL Set-up | |
87 - Connect a null-modem female/female RS232 cable between the DB9 connector | |
88 CN6 and PC serial port. | |
89 | |
90 - Hyperterminal configuration: | |
91 - Word Length = 8 Bits | |
92 - One Stop Bit | |
93 - No parity | |
94 - BaudRate = 115200 baud | |
95 - flow control: None | |
96 | |
97 | |
98 @par How to use it ? | |
99 | |
100 In order to make the program work, you must do the following : | |
101 - Copy all source files from this example folder to the template folder under | |
102 Project\STM32F10x_StdPeriph_Template | |
103 - Open your preferred toolchain | |
104 - Add the required example files | |
105 - stm32f10x_ip_dbg.c | |
106 | |
107 @note | |
108 - The free Lite version of TrueSTUDIO do not support printf() redirection. | |
109 For more information, see "note.txt" under "STM32F10x_StdPeriph_Template\TrueSTUDIO". | |
110 | |
111 - Rebuild all files and load your image into target memory | |
112 - Run the example | |
113 | |
114 @note | |
115 - Low-density Value line devices are STM32F100xx microcontrollers where the | |
116 Flash memory density ranges between 16 and 32 Kbytes. | |
117 - Low-density devices are STM32F101xx, STM32F102xx and STM32F103xx | |
118 microcontrollers where the Flash memory density ranges between 16 and 32 Kbytes. | |
119 - Medium-density Value line devices are STM32F100xx microcontrollers where | |
120 the Flash memory density ranges between 64 and 128 Kbytes. | |
121 - Medium-density devices are STM32F101xx, STM32F102xx and STM32F103xx | |
122 microcontrollers where the Flash memory density ranges between 64 and 128 Kbytes. | |
123 - High-density Value line devices are STM32F100xx microcontrollers where | |
124 the Flash memory density ranges between 256 and 512 Kbytes. | |
125 - High-density devices are STM32F101xx and STM32F103xx microcontrollers where | |
126 the Flash memory density ranges between 256 and 512 Kbytes. | |
127 - XL-density devices are STM32F101xx and STM32F103xx microcontrollers where | |
128 the Flash memory density ranges between 512 and 1024 Kbytes. | |
129 - Connectivity line devices are STM32F105xx and STM32F107xx microcontrollers. | |
130 | |
131 * <h3><center>© COPYRIGHT 2011 STMicroelectronics</center></h3> | |
132 */ |