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