X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=testing%2Findex.html;h=57085b9523bf1c3d6d7382ec1e09014f66248d1d;hp=df9e81a1a3602d94c2fe246ce3610be63a8ed34a;hb=6ef27f4534b7a8926866b1156b6a309fc7c3d300;hpb=71e3bb892f4ddc8424e3a75211c78f9c10477a62 diff --git a/testing/index.html b/testing/index.html index df9e81a1a3..57085b9523 100644 --- a/testing/index.html +++ b/testing/index.html @@ -3,266 +3,35 @@ -

Testing

- A test should be done on code committed to svn. Commit, then test. That way one can know for sure *what* code was actually tested. +

Release testing

+ 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. +

+ Note that this testing document does not have anything to do with testing that is done + before committing to svn. It is a test document for released code. Pre-commit testing + is done mostly by the developer who has written the change. Sometimes code is committed + to synchronize work, even if it has known problems. Release testing is + done on code believed to be stable, often a couple of weeks old, and not by + the developers, but rather users and community testers who has the requisite hardware + and test setup. Also the testing will take place over an extended period of time. +

+ All of the above makes it imperative that there can be no doubt about *which* code + is tested and thus all tests refer to committed code by subversion number.

Release procedure

- OpenOCD trunk is work in progress. Expect it to change daily and to have some work in progress. + OpenOCD trunk is work in progress. Expect it to change daily and to have some quirks.

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.

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.

-

Vocabulary

- - - - - - - - - - - - - -
Passed versionThe latest version on which the test is known to pass
Broken versionThe latest version on which the test is known to fail. n/a when older than passed version.
IDA unqiue ID to refer to a test. The unique numbers are maintained in this file.
-


-

OpenOCD test results

- These tests can be performed on any JTAG device as long as they are executed using the unmodified code from SVN. -

The latest version in which the test is known to have passed is in the table below.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IDSynopsisJTAG devicePassed versionBroken version
ocd1Telnet Windowsn/an/an/a
ocd2Telnet Linuxn/an/an/a
ocd3Telnet Cygwinn/an/an/a
ocd4ARM7 debuggingn/an/an/a
xscale1XScale debuggingn/an/an/a
xscale2XScale MMUn/an/an/a
bdte-ramstr710 ram debuggingJTAGkey423n/a
bdte-romstr710 rom debuggingJTAGkey423n/a
bdte-ramstr912 ram debuggingJTAGkey423n/a
bdte-romstr912 rom debuggingJTAGkey423n/a
bdte-ramlpc2148 ram debuggingJTAGkey423n/a
bdte-romlpc2148 rom debuggingJTAGkey423n/a
bdte-ramlpc2294 ram debuggingJTAGkey423n/a
bdte-romlpc2294 rom debuggingJTAGkey423n/a
bdte-ramsam7s256 ram debuggingJTAGkey423n/a
bdte-romsam7s256 rom debuggingJTAGkey423n/a
bdte-ramsam7x256 ram debuggingJTAGkey423n/a
bdte-romsam7x256 rom debuggingJTAGkey423n/a
bdte-ramat91r40008 ram debuggingJTAGkey423n/a
-

-
-

OpenOCD JTAG device test results

- Each JTAG device must be tested - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IDSynopsisPassed versionBroken version
jtag1Parportn/an/a
jtag2JTAGkey432n/a
jtag3Turtelizer2432n/a
jtag4add new onen/an/a
-

-
-

OpenOCD JTAG device speed test result

-

The test result is in KB/sec.

- - - - - - - - - - - - - - - - - - - - - - -
IDSynopsisr320r420r423
speed1JTAGkey9364 93
speed2add new onen/an/an/a
-

-
-

Policy on removing features from OpenOCD

- 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. -

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.

-

Policy on adding features from OpenOCD

- 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. -

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.

-
-

ocd4 - ARM7 debugging

- Connect to ARM7 device(any), use GDB load to load a program into RAM and single halt, resume and single step. -
-

bdte-ram (Basic debugging test with Eclipse in RAM)

-

This test was made under Eclipse with the Zylin Embedded CDT plugin. For the GDB "Initialize commands" take a look in the examples/<target>/prj/eclipse_ram.gdb file.

-

Start debugging, the debugger should stop at main. set some breakpoints and "Resume". If the debugger hit a breakpoint check if the "Variables" looks correct. Remove some breakpoints and "Resume" again. If the target is running, use the "Suspend" function and use "Step Into" or "Step Over" through the source. Even open the "Disassembly" view and enable the "Instruction Stepping Mode". Now you can single step through the assembler source. Use "Resume" 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...

-
-

bdte-rom (Basic debugging test with Eclipse in ROM)

-

This test was made under Eclipse with the Zylin Embedded CDT plugin. For the GDB "Initialize commands" take a look in the examples/<target>/prj/eclipse_rom.gdb file.

-

Start debugging, the debugger should download and store the program in the flash of the target.

-

Now you can make some tests like described in the bdte-ram section above too.

-
-

speed1 - Download speed test

-

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 can look like:

-

Loading section .text, size 0x6019c lma 0x62000000
- Start address 0x62000040, load size 393628
- Transfer rate: 93 KB/sec, 2008 bytes/write.

-

In this example a speed of 93 KB/sec was reached. The hardware which was used for the test can be found here.

-

+

OpenOCD smoketests

+ This is a set of tests that exercise the entire OpenOCD system and various targets. It + is a small suite of systemwide smoketests. +

+ Smoketests +

Test cases

+ Additionally OpenOCD has test cases that target specific functionality more precisely. +

+ A full release test must include both smoketests and unit testing. +

+ Test cases \ No newline at end of file