Update TODO file with more content and better style.
[openocd.git] / TODO
1 /** @page tasks Pending and Open Tasks
2
3 This page lists pending and open tasks being considered or worked upon
4 by the OpenOCD community.
5
6 @section thelist The List
7
8 Items with a current patch available should include a link to its
9 posting on the openocd-developer mailing list archives.
10
11 Some items may be in progress, usually indicated by the individual whose
12 initials in parentheses following it.  A key for decoding these initials
13 appears after The List.
14
15 Most items are open for the taking, but please post to the mailing list
16 before spending much time working on anything lists here.  The community
17 may have evolved an idea since it was added here.
18
19 Feel free to send patches to add or clarify items on this list, too.
20
21 @section thelisttcl TCL
22
23 This section provides possible things to improve with OpenOCD's TCL support.
24
25 - organize the TCL configurations:
26   - provide more directory structure for boards/targets?
27   - factor configurations into layers (encapsulation and re-use)
28
29 - Isolate all TCL command support: 
30   - Pure C CLI implementations using --disable-builtin-tcl. 
31     - Allow developers to build new dongles using OpenOCD's JTAG core.
32     - At first, provide only low-level JTAG support; target layer and
33       above rely heavily on scripting event mechanisms.
34   - Allow full TCL support? add --with-tcl=/path/to/installed/tcl
35   - Move TCL support out of foo.[ch] and into foo_tcl.[ch] (other ideas?)
36
37 @section thelistjtag JTAG
38
39 This section list issues that need to be resolved in the JTAG layer.
40
41 @subsection thelistjtagcore JTAG Core
42
43 The following tasks have been suggeted for cleaning up the JTAG layer:
44
45 - use tap_set_state everywhere to allow logging TAP state transitions
46 - rename other tap_states to use standard JTAG names (suggested by ML)
47 - retire jtag_add_end_state() and replace w/global variable:
48   - removes TAP_INVALID as an argument to jtag_add_xxxx().
49   - global variable as argument to jtag_add_xxxx() should be phased out, but
50     it is useful while we need to bug-by-bug compatible while testing changes.
51  - Suggested by ØH. Michael Bruck also interested in this.
52 - Encapsulate cmd_queue_cur_state and related varaible handling.
53
54 The following tasks have been suggested for adding new core JTAG support:
55
56 - autodetect devices present on the scan chain
57   - implement 'discover_taps' command
58 - SPI/UART emulation:
59   - (ab)use bit-banging JTAG interfaces to emulate SPI/UART
60   - allow SPI to program flash, MCUs, etc.
61
62 @subsection thelistjtaginterfaces JTAG Interfaces
63
64 The following tasks have been suggeted for improving OpenOCD's JTAG
65 interface support:
66
67 - rework USB communication to be more robust.  Two possible options are:
68   -# use libusb-1.0.1 with libusb-compat-0.1.1 (non-blocking I/O wrapper)
69   -# rewrite implementation to use non-blocking I/O
70 - FT2232 driver:
71   - integrate FTD2XX High-Speed Device support @par
72       PATCH: https://lists.berlios.de/pipermail/openocd-development/2009-April/005479.html
73   - fix outstanding bugs
74 - J-Link driver:
75   - fix to work with long scan chains, such as R.Doss's svf test.
76   - fix other outstanding bugs
77
78 The following tasks have been suggested for adding new JTAG interfaces:
79
80 - TCP driver: allow client/server for remote JTAG interface control.
81
82 @section thelistswd Serial Wire Debug
83
84 - implement Serial Wire Debug interface 
85
86 @section thelistbs Boundary Scan Support
87
88 - add STAPL support?
89 - add BSDL support?
90
91 A few possible options for the above:
92   -# Fake a TCL equivalent?
93   -# Integrate an existing library?
94   -# Write a new C implementation a la Jim?
95
96 Once the above are completed:
97 - add support for programming flash using boundary scan techniques
98 - add integration with a modified gerber view program:
99   - provide means to view the PCB and select pins and traces
100   - allow use-cases such as the following:
101     - @b Stimulus
102       -# Double-click on a pin (or trace) with the mouse.
103     - @b Effects
104       -# The trace starts blinking, and
105       -# OpenOCD toggles the pin(s) 0/1.
106
107 @section thelisttargets Target Support
108
109 - general layer cleanup:
110   - https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
111 - ARM11 improvements (MB?)
112   - fix single stepping  (reported by ØH)
113   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
114 - Cortex A8 support (ML)
115   - add target implementation (ML)
116 - MC1322x support (JW/DE?)
117   - integrate and test support from JW (and DE?)
118   - get working with a known good interface (i.e. not today's jlink)
119 - AT91SAM92xx:
120   - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
121 - STR9x: (ZW)
122   - improvements to str912.cfg to be more general purpose
123 - AVR: (SQ)
124   - independently verify implementation
125   - incrementally improve working prototype in trunk. (SQ)
126   - work out how to debug this target
127   - AVR debugging protocol.
128 - FPGA:
129   - improve things (??)
130 - Coldfire (suggested by NC)
131   - can we draw from the BDM project?  @par
132     http://bdm.sourceforge.net/
133
134     or the OSBDM package @par
135     http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
136
137 @section thelistsvf SVF/XSVF
138
139 - factor and clean-up code
140 - review The Guide for OpenOCD Users for documentation errors or omissions
141 - update The Manual for OpenOCD Developerrs:
142   - add documentation describing the architecture of each module
143   - provide Technical Primers to bootstrap contributor knowledge
144 - develop SVF unit tests 
145 - develop XSVF unit tests 
146
147 @section thelistflash Flash Support
148
149 - finish documentation for the following flash drivers:
150   - avr
151   - ecosflash
152   - pic32mx
153   - ocl
154   - str9xpec
155
156 @subsection thelistflashcfi CFI
157
158 - finish implementing bus width/chip width handling (suggested by NC)
159 - factor vendor-specific code into separate source files
160   - add new callback interface for vendor-specific code
161 - investigate/implement "thin wrapper" to use eCos CFI drivers (ØH)
162
163 @section thelistdebug Debugger Support
164
165 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
166
167 @section thelisttesting Testing Suite
168
169 This section includes several related groups of ideas:
170 - @ref thelistunittests
171 - @ref thelistsmoketests
172 - @ref thelisttestreports
173 - @ref thelisttestgenerichw
174
175 @subsection thelistunittests Unit Tests
176
177 - add testing skeleton to provide frameworks for adding tests
178 - implement server unit tests
179 - implement JTAG core unit tests
180 - implement JTAG interface unit tests
181 - implement flash unit tests
182 - implement target unit tests
183
184 @subsection thelistsmoketests Smoke Test Tools
185
186 -# extend 'make check' with a smoketest app
187   - checks for OOCD_TEST_CONFIG, etc. in environment (or config file)
188   - if properly set, runs the smoke test with specified parameters
189     - openocd -f ${OOCD_TEST_CONFIG}
190     - implies a modular test suite (see below)
191   - should be able to run some minimal tests with dummy interface:
192     - compare results of baseline sanity checks with expected results
193
194 -# builds a more complete test suite:
195   - existing testing/examples/ look like a great start
196   - all targets should be tested fully and for all capabilities
197     - we do NOT want a "lowest common denominator" test suite
198     - ... but can we start with one to get going?
199   - probably requires one test configuration file per board/target
200     - modularization can occur here, just like with targets/boards/chips
201     - coverage can increase over time, building up bundles of tests
202
203 -# add new 'smoketest' Makefile target:
204   - calls 'make check' (and the smoketest app)
205   - gather inputs and output into a report file
206
207 @subsection thelisttestreports Test Feedback Tools
208
209 These ideas were first introduced here:
210   https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
211
212 - provide report submission scripts for e-mail and web forms
213 - add new Makefile targets to post the report:
214   - 'checkreportsend' -- send to list via e-mail (via sendmail)
215   - 'checkreportpost' -- send web form (via curl or other script)
216
217 @subsection thelisttestgenerichw Generic Hardware Tester
218
219 - implement VHDL to use for FPGA-based JTAG TAP testing device
220 - develop test suite that utilizes this testing device
221
222 @section thelistautotools Autotools Build System
223
224 - investigate fixes to permit the use of -Wshadow
225 - eliminate sources of confusion in @c boostrap script:
226   -# Make @c bootstrap call 'configure --enable-maintainer-mode <opts>'?
227   -# Add @c buildstrap script to assist with boostrap and configure steps.
228 - automatically build tool-chains required for cross-compiling
229   - produce mingw32, arm-elf, others using in-tree scripts
230   - build all required target code from sources
231 - make JTAG and USB debug output a run-time configuration option
232
233 @section thelistarchitecture Architectural Tasks
234
235 The following architectural tasks need to be accomplished and should be
236 fairly easy to complete:
237
238 - factor code to eliminate duplicated functionality
239 - overhaul use of types to improve 32/64-bit portability
240 - rewrite code that uses casts to access 16-bit and larger types
241   from unaligned memory addresses
242 - libopenocd support: @par
243     https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
244 - review and clean up interface/target/flash APIs 
245
246 The following strategic tasks will require ambition, knowledge, and time
247 to complete:
248
249 - Allow N:M:P mapping of servers, targets, and interfaces
250 - loadable module support for interface/target/flash drivers
251
252 @section thelistadmin Administrative Tasks
253
254 - Develop "style" guidelines for committing to Subversion
255 - Develop milestone and release guidelines.
256
257 */
258 /** @file
259 This file contains the @ref thelist page.
260 */