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