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