Merge branch 'master' of ssh://dbrownell@openocd.git.sourceforge.net/gitroot/openocd...
[openocd.git] / TODO
1 // This file is part of the Doyxgen Developer Manual
2 /** @page tasks Pending and Open Tasks
3
4 This page lists pending and open tasks being considered or worked upon
5 by the OpenOCD community.
6
7 @section thelist The List
8
9 Most items are open for the taking, but please post to the mailing list
10 before spending much time working on anything lists here.  The community
11 may have evolved an idea since it was added here.
12
13 Feel free to send patches to add or clarify items on this list, too.
14
15 @section thelisttcl TCL
16
17 This section provides possible things to improve with OpenOCD's TCL support.
18
19 - Fix problem with incorrect line numbers reported for a syntax
20   error in a reset init event.
21
22 - organize the TCL configurations:
23   - provide more directory structure for boards/targets?
24   - factor configurations into layers (encapsulation and re-use)
25
26 - Isolate all TCL command support: 
27   - Pure C CLI implementations using --disable-builtin-tcl. 
28     - Allow developers to build new dongles using OpenOCD's JTAG core.
29     - At first, provide only low-level JTAG support; target layer and
30       above rely heavily on scripting event mechanisms.
31   - Allow full TCL support? add --with-tcl=/path/to/installed/tcl
32   - Move TCL support out of foo.[ch] and into foo_tcl.[ch] (other ideas?)
33     - See src/jtag/core.c and src/jtag/tcl.c for an example.
34     - allow some of these TCL command modules to be dynamically loadable?
35
36 @section thelistjtag JTAG
37
38 This section list issues that need to be resolved in the JTAG layer.
39
40 @subsection thelistjtagcore JTAG Core
41
42 The following tasks have been suggested for cleaning up the JTAG layer:
43
44 - use tap_set_state everywhere to allow logging TAP state transitions
45 - rename other tap_states to use standard JTAG names (suggested by ML)
46 - Encapsulate cmd_queue_cur_state and related varaible handling.
47 - add slick 32 bit versions of jtag_add_xxx_scan() that avoids
48 buf_set_u32() calls and other evidence of poor impedance match between
49 API and calling code. New API should cut down # of lines in calling
50 code by 100's and make things clearer. Also potentially be supported
51 directly in minidriver API for better embedded host performance.
52
53 The following tasks have been suggested for adding new core JTAG support:
54
55 - autodetect devices present on the scan chain
56   - implement 'discover_taps' command
57 - SPI/UART emulation:
58   - (ab)use bit-banging JTAG interfaces to emulate SPI/UART
59   - allow SPI to program flash, MCUs, etc.
60
61 @subsection thelistjtaginterfaces JTAG Interfaces
62
63 There are some known bugs to fix in JTAG adapter drivers:
64
65 - For JTAG_STATEMOVE to TAP_RESET, all drivers must ignore the current
66   recorded state.  The tap_get_state() call won't necessarily return
67   the correct value, especially at server startup.  Fix is easy:  in
68   that case, always issue five clocks with TMS high.
69   - amt_jtagaccel.c
70   - arm-jtag-ew.c
71   - bitbang.c
72   - bitq.c
73   - gw16012.c
74   - jlink.c
75   - usbprog.c
76   - vsllink.c
77   - rlink/rlink.c
78
79 The following tasks have been suggeted for improving OpenOCD's JTAG
80 interface support:
81
82 - rework USB communication to be more robust.  Two possible options are:
83   -# use libusb-1.0.1 with libusb-compat-0.1.1 (non-blocking I/O wrapper)
84   -# rewrite implementation to use non-blocking I/O
85 - J-Link driver:
86   - fix to work with long scan chains, such as R.Doss's svf test.
87 - FT2232 (libftdi):
88   - make performance comparable to alternatives (on Win32, D2XX is faster)
89   - make usability comparable to alternatives
90
91 The following tasks have been suggested for adding new JTAG interfaces:
92
93 - TCP driver: allow client/server for remote JTAG interface control.
94
95 @section thelistswd Serial Wire Debug
96
97 - implement Serial Wire Debug interface 
98
99 @section thelistbs Boundary Scan Support
100
101 - add STAPL support?
102 - add BSDL support?
103
104 A few possible options for the above:
105   -# Fake a TCL equivalent?
106   -# Integrate an existing library?
107   -# Write a new C implementation a la Jim?
108
109 Once the above are completed:
110 - add support for programming flash using boundary scan techniques
111 - add integration with a modified gerber view program:
112   - provide means to view the PCB and select pins and traces
113   - allow use-cases such as the following:
114     - @b Stimulus
115       -# Double-click on a pin (or trace) with the mouse.
116     - @b Effects
117       -# The trace starts blinking, and
118       -# OpenOCD toggles the pin(s) 0/1.
119
120 @section thelisttargets Target Support
121
122 - general layer cleanup: @par
123   https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
124 - regression: xscale does not place debug_handler.bin into the right spot. workaround:
125   use -s option on command line to place xscale/debug_handler.bin in search path @par
126   https://lists.berlios.de/pipermail/openocd-development/2009-July/009338.html
127 - bug: either USBprog is broken with new tms sequence or there is a general
128   problem with XScale and the new tms sequence. Workaround: use "tms_sequence long"
129   @par
130   https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html
131 - regression: "reset halt" between 729(works) and 788(fails): @par
132 https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
133 - ARM7/9:
134   - add reset option to allow programming embedded ice while srst is asserted.
135   Some CPUs will gate the JTAG clock when srst is asserted and in this case,
136   it is necessary to program embedded ice and then assert srst afterwards.
137 - ARM923EJS:
138   - reset run/halt/step is not robust; needs testing to map out problems.
139 - ARM11 improvements (MB?)
140   - Single stepping works, but should automatically
141   use hardware stepping if available.
142   - hunt down and add timeouts to all infinite loops, e.g. arm11_run_instr_no_data would
143     lock up in infinite loop if e.g. an "mdh" command tries to read memory from invalid memory location.
144     Try mdh 0x40000000 on i.MX31 PDK
145   - mdb can return garbage data if read byte operation fails for
146   a memory region(16 & 32 byte access modes may be supported). Is this
147   a bug in the .MX31 PDK init script? Try on i.MX31 PDK: 
148   mdw 0xb80005f0 0x8, mdh 0xb80005f0 0x10, mdb 0xb80005f0 0x20. mdb returns
149   garabage.
150   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
151   - thumb support is missing: ISTR ARMv6 requires Thumb.
152   ARM1156 has Thumb2; ARM1136 doesn't.
153 - Cortex A8 support (ML)
154   - add target implementation (ML)
155 - Generic ARM run_algorithm() interface
156   - tagged struct wrapping ARM instructions and metadata
157   - not revision-specific (current: ARMv4+ARMv5 -or- ARMv6 -or- ARMv7)
158   - usable with at least arm_nandwrite() and generic CFI drivers
159 - MC1322x support (JW/DE?)
160   - integrate and test support from JW (and DE?)
161   - get working with a known good interface (i.e. not today's jlink)
162 - AT91SAM92xx:
163   - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
164 - STR9x: (ZW)
165   - improvements to str912.cfg to be more general purpose
166 - AVR: (SQ)
167   - independently verify implementation
168   - incrementally improve working prototype in trunk. (SQ)
169   - work out how to debug this target
170   - AVR debugging protocol.
171 - FPGA:
172   - Altera Nios Soft-CPU support
173 - Coldfire (suggested by NC)
174   - can we draw from the BDM project?  @par
175     http://bdm.sourceforge.net/
176
177     or the OSBDM package @par
178     http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
179
180 @section thelistsvf SVF/XSVF
181
182 - develop SVF unit tests 
183 - develop XSVF unit tests 
184
185 @section thelistflash Flash Support
186
187 - finish documentation for the following flash drivers:
188   - avr
189   - ecosflash
190   - pic32mx
191   - ocl
192   - str9xpec
193
194 @subsection thelistflashcfi CFI
195
196 - finish implementing bus width/chip width handling (suggested by NC)
197 - factor vendor-specific code into separate source files
198   - add new callback interface for vendor-specific code
199 - investigate/implement "thin wrapper" to use eCos CFI drivers (ØH)
200
201 @section thelistdebug Debugger Support
202
203 - breakpoints can get lost in some circumstances: @par
204   https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
205 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
206
207 @section thelisttesting Testing Suite
208
209 This section includes several related groups of ideas:
210 - @ref thelistunittests
211 - @ref thelistsmoketests
212 - @ref thelisttestreports
213 - @ref thelisttestgenerichw
214
215 @subsection thelistunittests Unit Tests
216
217 - add testing skeleton to provide frameworks for adding tests
218 - implement server unit tests
219 - implement JTAG core unit tests
220 - implement JTAG interface unit tests
221 - implement flash unit tests
222 - implement target unit tests
223
224 @subsection thelistsmoketests Smoke Test Tools
225
226 -# extend 'make check' with a smoketest app
227   - checks for OOCD_TEST_CONFIG, etc. in environment (or config file)
228   - if properly set, runs the smoke test with specified parameters
229     - openocd -f ${OOCD_TEST_CONFIG}
230     - implies a modular test suite (see below)
231   - should be able to run some minimal tests with dummy interface:
232     - compare results of baseline sanity checks with expected results
233
234 -# builds a more complete test suite:
235   - existing testing/examples/ look like a great start
236   - all targets should be tested fully and for all capabilities
237     - we do NOT want a "lowest common denominator" test suite
238     - ... but can we start with one to get going?
239   - probably requires one test configuration file per board/target
240     - modularization can occur here, just like with targets/boards/chips
241     - coverage can increase over time, building up bundles of tests
242
243 -# add new 'smoketest' Makefile target:
244   - calls 'make check' (and the smoketest app)
245   - gather inputs and output into a report file
246
247 @subsection thelisttestreports Test Feedback Tools
248
249 These ideas were first introduced here: @par
250   https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
251
252 - provide report submission scripts for e-mail and web forms
253 - add new Makefile targets to post the report:
254   - 'checkreportsend' -- send to list via e-mail (via sendmail)
255   - 'checkreportpost' -- send web form (via curl or other script)
256
257 @subsection thelisttestgenerichw Generic Hardware Tester
258
259 - implement VHDL to use for FPGA-based JTAG TAP testing device
260 - develop test suite that utilizes this testing device
261
262 @section thelistautotools Autotools Build System
263
264 - make entire configure process require less user consideration:
265   - automatically detect the features that are available, unless
266     options were specifically provided to configure
267   - provide a report of the drivers that will be build at the end of
268     running configure, so the users can verify which driverswill be
269     built during 'make' (and their options) .
270 - eliminate sources of confusion in @c bootstrap script:
271   -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
272   -# Add @c buildstrap script to assist with boostrap and configure steps.
273 - automatically build tool-chains required for cross-compiling
274   - produce mingw32, arm-elf, others using in-tree scripts
275   - build all required target code from sources
276 - make JTAG and USB debug output a run-time configuration option
277
278 @section thelistarchitecture Architectural Tasks
279
280 The following architectural tasks need to be accomplished and should be
281 fairly easy to complete:
282
283 - clean-up code to match style guides
284 - factor code to eliminate duplicated functionality
285 - rewrite code that uses casts to access 16-bit and larger types
286   from unaligned memory addresses
287 - libopenocd support: @par
288     https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
289 - review and clean up interface/target/flash APIs 
290
291 The following strategic tasks will require ambition, knowledge, and time
292 to complete:
293
294 - overhaul use of types to improve 32/64-bit portability
295   - types for both host and target word sizes?
296   - can we use GDB's CORE_TYPE support?
297 - Allow N:M:P mapping of servers, targets, and interfaces
298 - loadable module support for interface/target/flash drivers and commands
299   - support both static and dynamic modules.
300   - should probably use libltdl for dynamic library handing.
301
302 @section thelistadmin Documentation Tasks
303
304 - Develop milestone and release guidelines, processes, and scripts.
305 - Develop "style" guidelines (and scripts) for maintainers:
306   - reviewing patches
307   - committing to Subversion
308 - Review The Guide for OpenOCD Users for documentation errors or omissions
309 - Update The Manual for OpenOCD Developerrs:
310   - Add documentation describing the architecture of each module
311   - Provide more Technical Primers to bootstrap contributor knowledge
312
313 */
314 /** @file
315 This file contains the @ref thelist page.
316 */
317