some arm11 stuff that isn't done yet.
[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 - ARM923EJS:
118   - reset run/halt/step is not robust; needs testing to map out problems.
119 - ARM11 improvements (MB?)
120   - fix single stepping  (reported by ØH). Michael Bruck explained
121   that what's required is to emulate the current instruction(just like the
122   arm7 code) to know what address to set the breakpoint at for single
123   stepping an instruction.
124   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
125   - thumb support is missing: ISTR ARMv6 requires Thumb.
126   ARM1156 has Thumb2; ARM1136 doesn't.
127 - Cortex A8 support (ML)
128   - add target implementation (ML)
129 - MC1322x support (JW/DE?)
130   - integrate and test support from JW (and DE?)
131   - get working with a known good interface (i.e. not today's jlink)
132 - AT91SAM92xx:
133   - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
134 - STR9x: (ZW)
135   - improvements to str912.cfg to be more general purpose
136 - AVR: (SQ)
137   - independently verify implementation
138   - incrementally improve working prototype in trunk. (SQ)
139   - work out how to debug this target
140   - AVR debugging protocol.
141 - FPGA:
142   - Altera Nios Soft-CPU support
143 - Coldfire (suggested by NC)
144   - can we draw from the BDM project?  @par
145     http://bdm.sourceforge.net/
146
147     or the OSBDM package @par
148     http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
149
150 @section thelistsvf SVF/XSVF
151
152 - develop SVF unit tests 
153 - develop XSVF unit tests 
154
155 @section thelistflash Flash Support
156
157 - finish documentation for the following flash drivers:
158   - avr
159   - ecosflash
160   - pic32mx
161   - ocl
162   - str9xpec
163
164 @subsection thelistflashcfi CFI
165
166 - finish implementing bus width/chip width handling (suggested by NC)
167 - factor vendor-specific code into separate source files
168   - add new callback interface for vendor-specific code
169 - investigate/implement "thin wrapper" to use eCos CFI drivers (ØH)
170
171 @section thelistdebug Debugger Support
172
173 - breakpoints can get lost in some circumstances: @par
174   https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
175 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
176
177 @section thelisttesting Testing Suite
178
179 This section includes several related groups of ideas:
180 - @ref thelistunittests
181 - @ref thelistsmoketests
182 - @ref thelisttestreports
183 - @ref thelisttestgenerichw
184
185 @subsection thelistunittests Unit Tests
186
187 - add testing skeleton to provide frameworks for adding tests
188 - implement server unit tests
189 - implement JTAG core unit tests
190 - implement JTAG interface unit tests
191 - implement flash unit tests
192 - implement target unit tests
193
194 @subsection thelistsmoketests Smoke Test Tools
195
196 -# extend 'make check' with a smoketest app
197   - checks for OOCD_TEST_CONFIG, etc. in environment (or config file)
198   - if properly set, runs the smoke test with specified parameters
199     - openocd -f ${OOCD_TEST_CONFIG}
200     - implies a modular test suite (see below)
201   - should be able to run some minimal tests with dummy interface:
202     - compare results of baseline sanity checks with expected results
203
204 -# builds a more complete test suite:
205   - existing testing/examples/ look like a great start
206   - all targets should be tested fully and for all capabilities
207     - we do NOT want a "lowest common denominator" test suite
208     - ... but can we start with one to get going?
209   - probably requires one test configuration file per board/target
210     - modularization can occur here, just like with targets/boards/chips
211     - coverage can increase over time, building up bundles of tests
212
213 -# add new 'smoketest' Makefile target:
214   - calls 'make check' (and the smoketest app)
215   - gather inputs and output into a report file
216
217 @subsection thelisttestreports Test Feedback Tools
218
219 These ideas were first introduced here: @par
220   https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
221
222 - provide report submission scripts for e-mail and web forms
223 - add new Makefile targets to post the report:
224   - 'checkreportsend' -- send to list via e-mail (via sendmail)
225   - 'checkreportpost' -- send web form (via curl or other script)
226
227 @subsection thelisttestgenerichw Generic Hardware Tester
228
229 - implement VHDL to use for FPGA-based JTAG TAP testing device
230 - develop test suite that utilizes this testing device
231
232 @section thelistautotools Autotools Build System
233
234 - make entire configure process require less user consideration:
235   - automatically detect the features that are available, unless
236     options were specifically provided to configure
237   - provide a report of the drivers that will be build at the end of
238     running configure, so the users can verify which driverswill be
239     built during 'make' (and their options) .
240 - eliminate sources of confusion in @c bootstrap script:
241   -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
242   -# Add @c buildstrap script to assist with boostrap and configure steps.
243 - automatically build tool-chains required for cross-compiling
244   - produce mingw32, arm-elf, others using in-tree scripts
245   - build all required target code from sources
246 - make JTAG and USB debug output a run-time configuration option
247
248 @section thelistarchitecture Architectural Tasks
249
250 The following architectural tasks need to be accomplished and should be
251 fairly easy to complete:
252
253 - clean-up code to match style guides
254 - factor code to eliminate duplicated functionality
255 - rewrite code that uses casts to access 16-bit and larger types
256   from unaligned memory addresses
257 - libopenocd support: @par
258     https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
259 - review and clean up interface/target/flash APIs 
260
261 The following strategic tasks will require ambition, knowledge, and time
262 to complete:
263
264 - overhaul use of types to improve 32/64-bit portability
265   - types for both host and target word sizes?
266   - can we use GDB's CORE_TYPE support?
267 - Allow N:M:P mapping of servers, targets, and interfaces
268 - loadable module support for interface/target/flash drivers and commands
269   - support both static and dynamic modules.
270   - should probably use libltdl for dynamic library handing.
271
272 @section thelistadmin Documentation Tasks
273
274 - Develop milestone and release guidelines, processes, and scripts.
275 - Develop "style" guidelines (and scripts) for maintainers:
276   - reviewing patches
277   - committing to Subversion
278 - Review The Guide for OpenOCD Users for documentation errors or omissions
279 - Update The Manual for OpenOCD Developerrs:
280   - Add documentation describing the architecture of each module
281   - Provide more Technical Primers to bootstrap contributor knowledge
282
283 */
284 /** @file
285 This file contains the @ref thelist page.
286 */