added known arm926ejs regressions
[openocd.git] / TODO
1 /** @page tasks Pending and Open Tasks
2
3 This page lists pending and open tasks being considered or worked upon
4 by the OpenOCD community.
5
6 @section thelist The List
7
8 Most items are open for the taking, but please post to the mailing list
9 before spending much time working on anything lists here.  The community
10 may have evolved an idea since it was added here.
11
12 Feel free to send patches to add or clarify items on this list, too.
13
14 @section thelisttcl Regressions
15
16 - Dominic has spotted a "reset halt" regression between 838(fails) and 729(works)
17
18 https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
19
20 @section thelisttcl Bugs
21
22 - reset run/halt/step for arm926ejs is not robust. Needs lots of testing to
23 map out problems.
24
25 @section thelisttcl TCL
26
27 This section provides possible things to improve with OpenOCD's TCL support.
28
29 - Fix problem with incorrect line numbers reported for a syntax
30   error in a reset init event.
31
32 - organize the TCL configurations:
33   - provide more directory structure for boards/targets?
34   - factor configurations into layers (encapsulation and re-use)
35
36 - Isolate all TCL command support: 
37   - Pure C CLI implementations using --disable-builtin-tcl. 
38     - Allow developers to build new dongles using OpenOCD's JTAG core.
39     - At first, provide only low-level JTAG support; target layer and
40       above rely heavily on scripting event mechanisms.
41   - Allow full TCL support? add --with-tcl=/path/to/installed/tcl
42   - Move TCL support out of foo.[ch] and into foo_tcl.[ch] (other ideas?)
43     - See src/jtag/core.c and src/jtag/tcl.c for an example.
44     - allow some of these TCL command modules to be dynamically loadable?
45
46 @section thelistjtag JTAG
47
48 This section list issues that need to be resolved in the JTAG layer.
49
50 @subsection thelistjtagcore JTAG Core
51
52 The following tasks have been suggeted for cleaning up the JTAG layer:
53
54 - use tap_set_state everywhere to allow logging TAP state transitions
55 - rename other tap_states to use standard JTAG names (suggested by ML)
56 - Encapsulate cmd_queue_cur_state and related varaible handling.
57
58 The following tasks have been suggested for adding new core JTAG support:
59
60 - autodetect devices present on the scan chain
61   - implement 'discover_taps' command
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 The following tasks have been suggeted for improving OpenOCD's JTAG
69 interface support:
70
71 - rework USB communication to be more robust.  Two possible options are:
72   -# use libusb-1.0.1 with libusb-compat-0.1.1 (non-blocking I/O wrapper)
73   -# rewrite implementation to use non-blocking I/O
74 - J-Link driver:
75   - fix to work with long scan chains, such as R.Doss's svf test.
76 - FT2232 (libftdi):
77   - make performance comparable to alternatives
78   - make usability comparable to alternatives
79
80 The following tasks have been suggested for adding new JTAG interfaces:
81
82 - TCP driver: allow client/server for remote JTAG interface control.
83
84 @section thelistswd Serial Wire Debug
85
86 - implement Serial Wire Debug interface 
87
88 @section thelistbs Boundary Scan Support
89
90 - add STAPL support?
91 - add BSDL support?
92
93 A few possible options for the above:
94   -# Fake a TCL equivalent?
95   -# Integrate an existing library?
96   -# Write a new C implementation a la Jim?
97
98 Once the above are completed:
99 - add support for programming flash using boundary scan techniques
100 - add integration with a modified gerber view program:
101   - provide means to view the PCB and select pins and traces
102   - allow use-cases such as the following:
103     - @b Stimulus
104       -# Double-click on a pin (or trace) with the mouse.
105     - @b Effects
106       -# The trace starts blinking, and
107       -# OpenOCD toggles the pin(s) 0/1.
108
109 @section thelisttargets Target Support
110
111 - general layer cleanup: @par
112   https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
113 - ARM11 improvements (MB?)
114   - fix single stepping  (reported by �H)
115   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
116 - Cortex A8 support (ML)
117   - add target implementation (ML)
118 - MC1322x support (JW/DE?)
119   - integrate and test support from JW (and DE?)
120   - get working with a known good interface (i.e. not today's jlink)
121 - AT91SAM92xx:
122   - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
123 - STR9x: (ZW)
124   - improvements to str912.cfg to be more general purpose
125 - AVR: (SQ)
126   - independently verify implementation
127   - incrementally improve working prototype in trunk. (SQ)
128   - work out how to debug this target
129   - AVR debugging protocol.
130 - FPGA:
131   - Altera Nios Soft-CPU support
132 - Coldfire (suggested by NC)
133   - can we draw from the BDM project?  @par
134     http://bdm.sourceforge.net/
135
136     or the OSBDM package @par
137     http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
138
139 @section thelistsvf SVF/XSVF
140
141 - develop SVF unit tests 
142 - develop XSVF unit tests 
143
144 @section thelistflash Flash Support
145
146 - finish documentation for the following flash drivers:
147   - avr
148   - ecosflash
149   - pic32mx
150   - ocl
151   - str9xpec
152
153 @subsection thelistflashcfi CFI
154
155 - finish implementing bus width/chip width handling (suggested by NC)
156 - factor vendor-specific code into separate source files
157   - add new callback interface for vendor-specific code
158 - investigate/implement "thin wrapper" to use eCos CFI drivers (�H)
159
160 @section thelistdebug Debugger Support
161
162 - breakpoints can get lost in some circumstances: @par
163   https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
164 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
165
166 @section thelisttesting Testing Suite
167
168 This section includes several related groups of ideas:
169 - @ref thelistunittests
170 - @ref thelistsmoketests
171 - @ref thelisttestreports
172 - @ref thelisttestgenerichw
173
174 @subsection thelistunittests Unit Tests
175
176 - add testing skeleton to provide frameworks for adding tests
177 - implement server unit tests
178 - implement JTAG core unit tests
179 - implement JTAG interface unit tests
180 - implement flash unit tests
181 - implement target unit tests
182
183 @subsection thelistsmoketests Smoke Test Tools
184
185 -# extend 'make check' with a smoketest app
186   - checks for OOCD_TEST_CONFIG, etc. in environment (or config file)
187   - if properly set, runs the smoke test with specified parameters
188     - openocd -f ${OOCD_TEST_CONFIG}
189     - implies a modular test suite (see below)
190   - should be able to run some minimal tests with dummy interface:
191     - compare results of baseline sanity checks with expected results
192
193 -# builds a more complete test suite:
194   - existing testing/examples/ look like a great start
195   - all targets should be tested fully and for all capabilities
196     - we do NOT want a "lowest common denominator" test suite
197     - ... but can we start with one to get going?
198   - probably requires one test configuration file per board/target
199     - modularization can occur here, just like with targets/boards/chips
200     - coverage can increase over time, building up bundles of tests
201
202 -# add new 'smoketest' Makefile target:
203   - calls 'make check' (and the smoketest app)
204   - gather inputs and output into a report file
205
206 @subsection thelisttestreports Test Feedback Tools
207
208 These ideas were first introduced here: @par
209   https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
210
211 - provide report submission scripts for e-mail and web forms
212 - add new Makefile targets to post the report:
213   - 'checkreportsend' -- send to list via e-mail (via sendmail)
214   - 'checkreportpost' -- send web form (via curl or other script)
215
216 @subsection thelisttestgenerichw Generic Hardware Tester
217
218 - implement VHDL to use for FPGA-based JTAG TAP testing device
219 - develop test suite that utilizes this testing device
220
221 @section thelistautotools Autotools Build System
222
223 - make entire configure process require less user consideration:
224   - automatically detect the features that are available, unless
225     options were specifically provided to configure
226   - provide a report of the drivers that will be build at the end of
227     running configure, so the users can verify which driverswill be
228     built during 'make' (and their options) .
229 - eliminate sources of confusion in @c bootstrap script:
230   -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
231   -# Add @c buildstrap script to assist with boostrap and configure steps.
232 - automatically build tool-chains required for cross-compiling
233   - produce mingw32, arm-elf, others using in-tree scripts
234   - build all required target code from sources
235 - make JTAG and USB debug output a run-time configuration option
236
237 @section thelistarchitecture Architectural Tasks
238
239 The following architectural tasks need to be accomplished and should be
240 fairly easy to complete:
241
242 - clean-up code to match style guides
243 - factor code to eliminate duplicated functionality
244 - rewrite code that uses casts to access 16-bit and larger types
245   from unaligned memory addresses
246 - libopenocd support: @par
247     https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
248 - review and clean up interface/target/flash APIs 
249
250 The following strategic tasks will require ambition, knowledge, and time
251 to complete:
252
253 - overhaul use of types to improve 32/64-bit portability
254   - types for both host and target word sizes?
255   - can we use GDB's CORE_TYPE support?
256 - Allow N:M:P mapping of servers, targets, and interfaces
257 - loadable module support for interface/target/flash drivers and commands
258   - support both static and dynamic modules.
259   - should probably use libltdl for dynamic library handing.
260
261 @section thelistadmin Documentation Tasks
262
263 - Develop milestone and release guidelines, processes, and scripts.
264 - Develop "style" guidelines (and scripts) for maintainers:
265   - reviewing patches
266   - committing to Subversion
267 - Review The Guide for OpenOCD Users for documentation errors or omissions
268 - Update The Manual for OpenOCD Developerrs:
269   - Add documentation describing the architecture of each module
270   - Provide more Technical Primers to bootstrap contributor knowledge
271
272 */
273 /** @file
274 This file contains the @ref thelist page.
275 */