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