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