1005a4314ec91f2b5b9449b5d2883bf3646c13b2
[openocd.git] / testing / index.html
1 <html>
2
3 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
4
5 <body>
6 <h1>Release testing</h1>
7 A release test must be done on code committed to svn. Commit, then test. That way one can know for sure *what* code was actually tested.
8 <p>
9 Note that this testing document does not have anything to do with testing that is done
10 before committing to svn. It is a test document for released code. Pre-commit testing
11 is done mostly by the developer who has written the change. Release testing is
12 done on code believed to be stable, often a couple of weeks old, and not by
13 the developers, but rather users and community testers who has the requisite hardware
14 and test setup. Also the testing can take place over an extended period of time.
15 <p>
16 All of the above makes it imperative that there can be no doubt about *which* code
17 is tested and thus all tests refer to committed code by subversion number.
18 <h1>Release procedure</h1>
19 OpenOCD trunk is work in progress. Expect it to change daily and to have some quirks.
20 <p>If you need the latest released and tested version, look for binary snapshots of OpenOCD. Worst case look up the test result table below for the features that are important to you and extract and build the version that has the right cocktail of working features for you. You can also work with the community to address the problems you are seing. Testing work and bug reports are highly appreciated.</p>
21 <p>The OpenOCD community may decide to create release branches. If this happens, then a branch will be created from OpenOCD trunk. The particular version to create that branch might be an older version rather than the latest and greatest. Fixes are then ported to that release branch from OpenOCD trunk.</p>
22 <h2>Vocabulary</h2>
23 <table border="1">
24 <tr>
25 <td width="100">Passed version</td>
26 <td>The latest branch and version on which the test is known to pass</td>
27 </tr>
28 <tr>
29 <td width="100">Broken version</td>
30 <td>The latest branch and version on which the test is known to fail. n/a when older than passed version.</td>
31 </tr>
32 <tr>
33 <td width="100">ID</td>
34 <td>A unqiue ID to refer to a test. The unique numbers are maintained in this file. Note that the same test can be run on different hardware/interface. Each combination yields a unique id. </td>
35 </tr>
36 </table>
37 <p></p>
38 <hr>
39 <h1>OpenOCD test results</h1>
40 These tests can be performed on any JTAG device as long as they are executed using the unmodified code from SVN.
41 <p>The latest version in which the test is known to have passed is in the table below.</p>
42 <table border="1">
43 <tr>
44 <th width="100">Unique ID</th>
45 <th width="165">Synopsis</th>
46 <th align="center" width="110">JTAG device</th>
47 <th align="center" width="110">Passed version</th>
48 <th align="center" width="110">Broken version</th>
49 </tr>
50 <tr>
51 <td >fill_malloc</td>
52 <td width="165">Fill malloc() memory with garbage</td>
53 <td align="center" >n/a</td>
54 <td align="center" >n/a</td>
55 <td align="center" >n/a</td>
56 </tr>
57 <tr>
58 <td >ocd1</td>
59 <td width="165">Telnet Windows</td>
60 <td align="center" >n/a</td>
61 <td align="center" >n/a</td>
62 <td align="center" >n/a</td>
63 </tr>
64 <tr>
65 <td >ocd2</td>
66 <td width="165">Telnet Linux</td>
67 <td align="center" >n/a</td>
68 <td align="center" >n/a</td>
69 <td align="center" >n/a</td>
70 </tr>
71 <tr>
72 <td >ocd3</td>
73 <td width="165">Telnet Cygwin</td>
74 <td align="center" >n/a</td>
75 <td align="center" >n/a</td>
76 <td align="center" >n/a</td>
77 </tr>
78 <tr>
79 <td ><a href="#test_ocd4">ocd4</a></td>
80 <td width="165">ARM7 debugging</td>
81 <td align="center" >n/a</td>
82 <td align="center" >n/a</td>
83 <td align="center" >n/a</td>
84 </tr>
85 <tr>
86 <td >SAM9260</td>
87 <td width="165">SAM9260 debugging</td>
88 <td align="center">ft2232 </td>
89 <td align="center">500</td>
90 <td align="center">trunk</td>
91 </tr>
92 <tr>
93 <td >xscale1</td>
94 <td width="165">XScale debugging</td>
95 <td align="center" >bitbang</td>
96 <td align="center" >202</td>
97 <td align="center" >trunk</td>
98 </tr>
99 <tr>
100 <td >xscale2</td>
101 <td width="165">XScale debugging</td>
102 <td align="center" >FT2232</td>
103 <td align="center" >202</td>
104 <td align="center" >n/a</td>
105 </tr>
106 <tr>
107 <td ><a href="#bdte-ram">bdte-ram1</a></td>
108 <td width="165">str710 ram debugging</td>
109 <td align="center" >JTAGkey</td>
110 <td align="center" >459</td>
111 <td align="center" >n/a</td>
112 </tr>
113 <tr>
114 <td ><a href="#bdte-rom">bdte-rom2</a></td>
115 <td width="165">str710 rom debugging</td>
116 <td align="center" >JTAGkey</td>
117 <td align="center" >459</td>
118 <td align="center" >n/a</td>
119 </tr>
120 <tr>
121 <td ><a href="#bdte-ram">bdte-ram3</a></td>
122 <td width="165">str912 ram debugging</td>
123 <td align="center" >JTAGkey</td>
124 <td align="center" >459</td>
125 <td align="center" >n/a</td>
126 </tr>
127 <tr>
128 <td ><a href="#bdte-rom">bdte-rom4</a></td>
129 <td width="165">str912 rom debugging</td>
130 <td align="center" >JTAGkey</td>
131 <td align="center" >459</td>
132 <td align="center" >n/a</td>
133 </tr>
134 <tr>
135 <td ><a href="#bdte-ram">bdte-ram5</a></td>
136 <td width="165">lpc2148 ram debugging</td>
137 <td align="center" >JTAGkey</td>
138 <td align="center" >459</td>
139 <td align="center" >n/a</td>
140 </tr>
141 <tr>
142 <td ><a href="#bdte-rom">bdte-rom6</a></td>
143 <td width="165">lpc2148 rom debugging</td>
144 <td align="center" >JTAGkey</td>
145 <td align="center" >459</td>
146 <td align="center" >n/a</td>
147 </tr>
148 <tr>
149 <td ><a href="#bdte-ram">bdte-ram7</a></td>
150 <td width="165">lpc2294 ram debugging</td>
151 <td align="center" >JTAGkey</td>
152 <td align="center" >459</td>
153 <td align="center" >n/a</td>
154 </tr>
155 <tr>
156 <td ><a href="#bdte-rom">bdte-rom8</a></td>
157 <td width="165">lpc2294 rom debugging</td>
158 <td align="center" >JTAGkey</td>
159 <td align="center" >459</td>
160 <td align="center" >n/a</td>
161 </tr>
162 <tr>
163 <td ><a href="#bdte-ram">bdte-ram9</a></td>
164 <td width="165">sam7s256 ram debugging</td>
165 <td align="center" >JTAGkey</td>
166 <td align="center" >459</td>
167 <td align="center" >n/a</td>
168 </tr>
169 <tr>
170 <td ><a href="#bdte-rom">bdte-rom10</a></td>
171 <td width="165">sam7s256 rom debugging</td>
172 <td align="center" >JTAGkey</td>
173 <td align="center" >459</td>
174 <td align="center" >n/a</td>
175 </tr>
176 <tr>
177 <td ><a href="#bdte-ram">bdte-ram11</a></td>
178 <td width="165">sam7x256 ram debugging</td>
179 <td align="center" >JTAGkey</td>
180 <td align="center" >459</td>
181 <td align="center" >n/a</td>
182 </tr>
183 <tr>
184 <td ><a href="#bdte-rom">bdte-rom12</a></td>
185 <td width="165">sam7x256 rom debugging</td>
186 <td align="center" >JTAGkey</td>
187 <td align="center" >459</td>
188 <td align="center" >n/a</td>
189 </tr>
190 <tr>
191 <td ><a href="#bdte-ram">bdte-ram13</a></td>
192 <td width="165">at91r40008 ram debugging</td>
193 <td align="center" >JTAGkey</td>
194 <td align="center" >459</td>
195 <td align="center" >n/a</td>
196 </tr>
197 </table>
198 <p></p>
199 <hr>
200 <h1>OpenOCD JTAG device test results</h1>
201 Each JTAG device must be tested
202
203 <table border="1">
204 <tr>
205 <th align="center" width="40">ID</th>
206 <th width="90">Synopsis</th>
207 <th >Passed version</th>
208 <th >Broken version</th>
209 </tr>
210 <tr>
211 <td width="40">jtag1</td>
212 <td width="90">Parport</td>
213 <td align="center" >n/a</td>
214 <td align="center" >n/a</td>
215 </tr>
216 <tr>
217 <td width="40">jtag2</td>
218 <td width="90">JTAGkey</td>
219 <td align="center" >459</td>
220 <td align="center" >n/a</td>
221 </tr>
222 <tr>
223 <td width="40">jtag3</td>
224 <td width="90">Turtelizer2</td>
225 <td align="center" >459</td>
226 <td align="center" >n/a</td>
227 </tr>
228 <tr>
229 <td width="40">jtag4</td>
230 <td width="90">add new one</td>
231 <td align="center" >n/a</td>
232 <td align="center" >n/a</td>
233 </tr>
234 </table>
235 <p></p>
236 <hr>
237 <h1>OpenOCD JTAG device speed test result</h1>
238 <p>The test result is in KB/sec.</p>
239 <table border="1">
240 <tr>
241 <th align="center" width="50">ID</th>
242 <th width="90">Synopsis</th>
243 <th width="40">r320</th>
244 <th width="40">r420</th>
245 <th width="40">r423</th>
246 <th width="40">r459</th>
247 </tr>
248 <tr>
249 <td width="50"><a href="#speed1">speed1</a></td>
250 <td width="90">JTAGkey</td>
251 <td align="center" width="40">93</td>
252 <td align="center" width="40">64 </td>
253 <td align="center" width="40">93</td>
254 <td align="center" width="40">93</td>
255 </tr>
256 <tr>
257 <td width="50">speed2</td>
258 <td width="90">add new one</td>
259 <td align="center" width="40">n/a</td>
260 <td align="center" width="40">n/a</td>
261 <td align="center" width="40">n/a</td>
262 <td align="center" width="40">n/a</td>
263 </tr>
264 </table>
265 <p></p>
266 <hr>
267 <h1>Policy on removing features from OpenOCD</h1>
268 If a feature in OpenOCD is known to be broken and nobody has submitted a fix and the feature is causing trouble for maintainence, it can be removed from OpenOCD trunk. The threshold for temporarily removing something from OpenOCD trunk is low to ease maintainence and place the burden of maintainence on those that care about a feature.
269 <p>Note that code is never deleted from OpenOCD svn, it remains in svn so if somebody sees a feature removed that they would like kept, they have but to port and fix that feature back up to main trunk. This document can be helpful in this regard in that the latest working version and the known broken version may be listed.</p>
270 <h1>Policy on adding features from OpenOCD</h1>
271 To add a feature to OpenOCD, generally it should not break any existing features and it should be functional and the code reasonably readable and useful to others in the OpenOCD community. The code does not have to be completed. Work in progress is fine for OpenOCD trunk.
272 <p>Also new tests should be defined. Note that the code does not have to pass all the tests. In fact it can be helpful to have tests to describe facets that really should be working, but aren't done yet. </p>
273 <hr>
274 <h1>ocd4 - ARM7 debugging<a name="test_ocd4"></a></h1>
275 Connect to ARM7 device(any), use GDB load to load a program into RAM and single halt, resume and single step.
276 <hr>
277 <h1>bdte-ram (Basic debugging test with Eclipse in RAM)<a id="bdte-ram" name="bdte-ram"></a></h1>
278 <p>This test was made under Eclipse with the Zylin Embedded CDT&nbsp;plugin. For the GDB &quot;Initialize commands&quot; take a look in the examples/&lt;target&gt;/prj/<b>eclipse_ram.gdb</b> file.</p>
279 <p>Start debugging, the debugger should stop at main. set some breakpoints and &quot;Resume&quot;. If the debugger hit a breakpoint check if the &quot;Variables&quot; looks correct. Remove some breakpoints and &quot;Resume&quot; again. If the target is running, use the &quot;Suspend&quot; function and use &quot;Step Into&quot; or &quot;Step Over&quot; through the source. Even open the &quot;Disassembly&quot; view and enable the &quot;Instruction Stepping Mode&quot;. Now you can single step through the assembler source. Use &quot;Resume&quot; again to run the program, set a breakpoint while the target is running. Check if you can inspect the variables with the mouse over. Play a little with the target...</p>
280 <hr>
281 <h1>bdte-rom (Basic debugging test with Eclipse in ROM)<a id="bdte-rom" name="bdte-rom"></a></h1>
282 <p>This test was made under Eclipse with the Zylin Embedded CDT&nbsp;plugin. For the GDB &quot;Initialize commands&quot; take a look in the examples/&lt;target&gt;/prj/<b>eclipse_rom.gdb</b> file.</p>
283 <p>Start debugging, the debugger should download and store the program in the flash of the target.</p>
284 <p>Now you can make some tests like described in the <a href="#bdte-ram">bdte-ram</a> section above too.</p>
285 <hr>
286 <h1>speed1 - Download speed test<a id="speed1" name="speed1"></a></h1>
287 <p>For this test a STR710 with external memory was used. The example project can be found under examples/STR710JtagSpeed. Here Eclipse or the arm-elf-gdb can be used to download the test.elf file into the RAM. The result of the GDB&nbsp;can look like:</p>
288 <p>Loading section .text, size 0x6019c lma 0x62000000<br>
289 Start address 0x62000040, load size 393628<br>
290 Transfer rate: 93 KB/sec, 2008 bytes/write.</p>
291 <p>In this example a speed of 93 KB/sec was reached. The hardware which was used for the test can be found <a href="http://www.yagarto.de/projects/str7usbmsd/index.html" target="new">here</a>.</p>
292 <p></p>
293 </body>
294
295 </html>