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