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