doc: add missing target types
[openocd.git] / TODO
1 // This file is part of the Doxygen 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 - Fix handling of variables between multiple command line "-c" and "-f"
27   parameters.  Currently variables assigned through one such parameter
28   command/script are unset before the next one is invoked.
29
30 - Isolate all TCL command support:
31   - Pure C CLI implementations using --disable-builtin-tcl.
32     - Allow developers to build new dongles using OpenOCD's JTAG core.
33     - At first, provide only low-level JTAG support; target layer and
34       above rely heavily on scripting event mechanisms.
35   - Allow full TCL support? add --with-tcl=/path/to/installed/tcl
36   - Move TCL support out of foo.[ch] and into foo_tcl.[ch] (other ideas?)
37     - See src/jtag/core.c and src/jtag/tcl.c for an example.
38     - allow some of these TCL command modules to be dynamically loadable?
39
40 @section thelistadapter Adapter
41
42 This section list issues that need to be resolved in the Adapter layer.
43
44 @subsection thelistadapterrework Code restructuring
45
46 This section lists pending reworks to complete the restructure from the
47 old JTAG centric implementation to a generic Adapter layer.
48 This restructuring is very invasive and will prevent the merge of several
49 changes pending in gerrit.
50
51 - rename folder src/jtag/ to src/adapter/
52 - rename var "jtag" to "adapter" in src/jtag/core.c
53 - split content of src/adapter/ in the different protocols jtag.[ch],
54   swd.[ch], ...
55 - wrap the calls to adapter->transport_ops->api() with transport_api()
56   and reduce the visibility of global var "adapter"
57 - complete the migration of JTAG-only drivers to adapter->reset()
58 - try to remove JTAG_SLEEP also from JTAG mode?
59 - tap_set_state(TAP_RESET) is already done in src/jtag/core.c. No need
60   to replicate it in the drivers, apart in case the driver sets TRST
61   independently
62 - separate SWIM from HLA and make it independent
63 - add .hla_ops and .swim_ops to "adapter"
64 - HLA is a API level (.hla_ops). Transport should simply be {jtag,swd},
65   not {hla_jtag,hla_swd}.
66
67 @subsection thelistadapterjtagcore JTAG Core
68
69 The following tasks have been suggested for cleaning up the JTAG layer:
70
71 - use tap_set_state everywhere to allow logging TAP state transitions
72 - Encapsulate cmd_queue_cur_state and related variable handling.
73 - add slick 32 bit versions of jtag_add_xxx_scan() that avoids
74 buf_set_u32() calls and other evidence of poor impedance match between
75 API and calling code. New API should cut down # of lines in calling
76 code by 100's and make things clearer. Also potentially be supported
77 directly in minidriver API for better embedded host performance.
78
79 The following tasks have been suggested for adding new core JTAG support:
80
81 - Improve autodetection of TAPs by supporting tcl escape procedures that
82   can configure discovered TAPs based on IDCODE value ... they could:
83     - Remove guessing for irlen
84     - Allow non-default irmask/ircapture values
85 - SPI/UART emulation:
86   - (ab)use bit-banging JTAG interfaces to emulate SPI/UART
87   - allow SPI to program flash, MCUs, etc.
88
89 @subsection thelistadapterinterfaces Interface drivers
90
91 There are some known bugs to fix in Interface drivers:
92
93 - For JTAG_STATEMOVE to TAP_RESET, all drivers must ignore the current
94   recorded state.  The tap_get_state() call won't necessarily return
95   the correct value, especially at server startup.  Fix is easy:  in
96   that case, always issue five clocks with TMS high.
97   - amt_jtagaccel.c
98   - arm-jtag-ew.c
99   - bitbang.c
100   - bitq.c
101   - gw16012.c
102   - jlink.c
103   - usbprog.c
104   - vsllink.c
105   - rlink/rlink.c
106 - bug: USBprog is broken with new tms sequence; it needs 7-clock cycles.
107   Fix promised from  Peter Denison openwrt at marshadder.org
108   Workaround: use "tms_sequence long" @par
109   https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html
110
111 The following tasks have been suggested for improving OpenOCD's JTAG
112 interface support:
113
114 - rework USB communication to be more robust.  Two possible options are:
115   -# use libusb-1.0.1 with libusb-compat-0.1.1 (non-blocking I/O wrapper)
116   -# rewrite implementation to use non-blocking I/O
117 - J-Link driver:
118   - fix to work with long scan chains, such as R.Doss's svf test.
119 - Autodetect USB based adapters; this should be easy on Linux.  If there's
120   more than one, list the options; otherwise, just select that one.
121
122 The following tasks have been suggested for adding new JTAG interfaces:
123
124 - TCP driver: allow client/server for remote JTAG interface control.
125 This requires a client and a server. The server is built into the
126 normal OpenOCD and takes commands from the client and executes
127 them on the interface returning the result of TCP/IP. The client
128 is an OpenOCD which is built with a TCP/IP minidriver. The use
129 of a minidriver is required to capture all the jtag_add_xxx()
130 fn's at a high enough level and repackage these cmd's as
131 TCP/IP packets handled by the server.
132
133 @section thelistbs Boundary Scan Support
134
135 - add STAPL support?
136 - add BSDL support?
137
138 A few possible options for the above:
139   -# Fake a TCL equivalent?
140   -# Integrate an existing library?
141   -# Write a new C implementation a la Jim?
142
143 Once the above are completed:
144 - add support for programming flash using boundary scan techniques
145 - add integration with a modified gerber view program:
146   - provide means to view the PCB and select pins and traces
147   - allow use-cases such as the following:
148     - @b Stimulus
149       -# Double-click on a pin (or trace) with the mouse.
150     - @b Effects
151       -# The trace starts blinking, and
152       -# OpenOCD toggles the pin(s) 0/1.
153
154 @section thelisttargets Target Support
155
156 - Many common ARM cores could be autodetected using IDCODE
157 - general layer cleanup: @par
158   https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
159 - regression: "reset halt" between 729(works) and 788(fails): @par
160 https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
161 - registers
162   - add flush-value operation, call them all on resume/reset
163 - mcr/mrc target->type support
164   - missing from ARM920t, ARM966e, XScale.
165   It's possible that the current syntax is unable to support read-modify-write
166   operations(see arm966e).
167   - mcr/mrc - retire cp15 commands when there the mrc/mrc commands have been
168   tested from: arm926ejs, arm720t, cortex_a8
169 - ARM7/9:
170   - clean up "arm9tdmi vector_catch". Available for some arm7 cores? @par
171 https://lists.berlios.de/pipermail/openocd-development/2009-October/011488.html
172 https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html
173   - add reset option to allow programming embedded ice while srst is asserted.
174   Some CPUs will gate the JTAG clock when srst is asserted and in this case,
175   it is necessary to program embedded ice and then assert srst afterwards.
176 - ARM926EJS:
177   - reset run/halt/step is not robust; needs testing to map out problems.
178 - ARM11 improvements (MB?)
179   - add support for asserting srst to reset the core.
180   - Single stepping works, but should automatically
181   use hardware stepping if available.
182   - mdb can return garbage data if read byte operation fails for
183   a memory region(16 & 32 byte access modes may be supported). Is this
184   a bug in the .MX31 PDK init script? Try on i.MX31 PDK:
185   mdw 0xb80005f0 0x8, mdh 0xb80005f0 0x10, mdb 0xb80005f0 0x20. mdb returns
186   garabage.
187   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
188 - Thumb2 single stepping: ARM1156T2 needs simulator support
189 - Cortex-A8 support (ML)
190   - add target implementation (ML)
191 - Cortex-M3 support
192   - when stepping, only write dirtied registers (be faster)
193   - when connecting to halted core, fetch registers (startup is quirky)
194 - Generic ARM run_algorithm() interface
195   - tagged struct wrapping ARM instructions and metadata
196   - not revision-specific (current: ARMv4+ARMv5 -or- ARMv6 -or- ARMv7)
197   - usable with at least arm_nandwrite() and generic CFI drivers
198 - ETM
199   - don't show FIFOFULL registers if they're not supported
200   - use comparators to get more breakpoints and watchpoints
201   - add "etm drivers" command
202   - trace driver init() via examine() paths only, not setup()/reset
203 - MC1322x support (JW/DE?)
204   - integrate and test support from JW (and DE?)
205   - get working with a known good interface (i.e. not today's jlink)
206 - AT91SAM92xx:
207   - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
208 - STR9x: (ZW)
209   - improvements to str912.cfg to be more general purpose
210 - AVR: (SQ)
211   - independently verify implementation
212   - incrementally improve working prototype in trunk. (SQ)
213   - work out how to debug this target
214   - AVR debugging protocol.
215 - FPGA:
216   - Altera Nios Soft-CPU support
217 - Coldfire (suggested by NC)
218   - can we draw from the BDM project?  @par
219     http://bdm.sourceforge.net/
220
221     or the OSBDM package @par
222     http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
223
224 @section thelistsvf SVF/XSVF
225
226 - develop SVF unit tests
227 - develop XSVF unit tests
228
229 @section thelistflash Flash Support
230
231 - finish documentation for the following flash drivers:
232   - avr
233   - pic32mx
234   - ocl
235   - str9xpec
236
237 - Don't expect writing all-ones to be a safe way to write without
238   changing bit values.  Minimally it loses on flash modules with
239   internal ECC, where it may change the ECC.
240   - NOR flash_write_unlock() does that between sectors
241   - there may be other cases too
242
243 - Make sure all commands accept either a bank name or a bank number,
244   and be sure both identifiers show up in "flash banks" and "nand list".
245   Right now the user-friendly names are pretty much hidden...
246
247 @subsection thelistflashcfi CFI
248
249 - finish implementing bus width/chip width handling (suggested by NC)
250 - factor vendor-specific code into separate source files
251   - add new callback interface for vendor-specific code
252 - investigate/implement "thin wrapper" to use eCos CFI drivers (ØH)
253
254 @section thelistdebug Debugger Support
255
256 - add support for masks in watchpoints? @par
257   https://lists.berlios.de/pipermail/openocd-development/2009-October/011507.html
258 - breakpoints can get lost in some circumstances: @par
259   https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
260 - add support for masks in watchpoints. The trick is that GDB does not
261   support a breakpoint mask in the remote protocol. One way to work around
262   this is to add a separate command "watchpoint_mask add/rem <addr> <mask>", that
263   is run to register a list of masks that the gdb_server knows to use with
264   a particular watchpoint address.
265 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
266
267 @section thelisttesting Testing Suite
268
269 This section includes several related groups of ideas:
270 - @ref thelistunittests
271 - @ref thelistsmoketests
272 - @ref thelisttestreports
273 - @ref thelisttestgenerichw
274
275 @subsection thelistunittests Unit Tests
276
277 - add testing skeleton to provide frameworks for adding tests
278 - implement server unit tests
279 - implement JTAG core unit tests
280 - implement JTAG interface unit tests
281 - implement flash unit tests
282 - implement target unit tests
283
284 @subsection thelistsmoketests Smoke Test Tools
285
286 -# extend 'make check' with a smoketest app
287   - checks for OOCD_TEST_CONFIG, etc. in environment (or config file)
288   - if properly set, runs the smoke test with specified parameters
289     - openocd -f ${OOCD_TEST_CONFIG}
290     - implies a modular test suite (see below)
291   - should be able to run some minimal tests with dummy interface:
292     - compare results of baseline sanity checks with expected results
293
294 -# builds a more complete test suite:
295   - existing testing/examples/ look like a great start
296   - all targets should be tested fully and for all capabilities
297     - we do NOT want a "lowest common denominator" test suite
298     - ... but can we start with one to get going?
299   - probably requires one test configuration file per board/target
300     - modularization can occur here, just like with targets/boards/chips
301     - coverage can increase over time, building up bundles of tests
302
303 -# add new 'smoketest' Makefile target:
304   - calls 'make check' (and the smoketest app)
305   - gather inputs and output into a report file
306
307 @subsection thelisttestreports Test Feedback Tools
308
309 These ideas were first introduced here: @par
310   https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
311
312 - provide report submission scripts for e-mail and web forms
313 - add new Makefile targets to post the report:
314   - 'checkreportsend' -- send to list via e-mail (via sendmail)
315   - 'checkreportpost' -- send web form (via curl or other script)
316
317 @subsection thelisttestgenerichw Generic Hardware Tester
318
319 - implement VHDL to use for FPGA-based JTAG TAP testing device
320 - develop test suite that utilizes this testing device
321
322 @section thelistautotools Autotools Build System
323
324 - make entire configure process require less user consideration:
325   - automatically detect the features that are available, unless
326     options were specifically provided to configure
327   - provide a report of the drivers that will be build at the end of
328     running configure, so the users can verify which drivers will be
329     built during 'make' (and their options) .
330 - eliminate sources of confusion in @c bootstrap script:
331   -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
332   -# Add @c buildstrap script to assist with bootstrap and configure steps.
333 - automatically build tool-chains required for cross-compiling
334   - produce mingw32, arm-elf, others using in-tree scripts
335   - build all required target code from sources
336 - make JTAG and USB debug output a run-time configuration option
337
338 @section thelistarchitecture Architectural Tasks
339
340 The following architectural tasks need to be accomplished and should be
341 fairly easy to complete:
342
343
344 - use dynamic allocations for working memory. Scan & fix code
345 for excessive stack allocations. take linux/scripts/checkstack.pl and
346 see what the worst offenders are. Dynamic stack allocations are found
347 at the bottom of the list below.  Example, on amd64:
348
349  $ objdump -d | checkstack.pl | head -10
350  0x004311e3 image_open [openocd]:                      13464
351  0x00431301 image_open [openocd]:                      13464
352  0x004237a4 target_array2mem [openocd]:                        4376
353  0x0042382b target_array2mem [openocd]:                        4376
354  0x00423e74 target_mem2array [openocd]:                        4360
355  0x00423ef9 target_mem2array [openocd]:                        4360
356  0x00404aed handle_svf_command [openocd]:              2248
357  0x00404b7e handle_svf_command [openocd]:              2248
358  0x00413581 handle_flash_fill_command [openocd]:               2200
359  0x004135fa handle_flash_fill_command [openocd]:               2200
360 - clean-up code to match style guides
361 - factor code to eliminate duplicated functionality
362 - rewrite code that uses casts to access 16-bit and larger types
363   from unaligned memory addresses
364 - libopenocd support: @par
365     https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
366 - review and clean up interface/target/flash APIs
367
368 The following strategic tasks will require ambition, knowledge, and time
369 to complete:
370
371 - overhaul use of types to improve 32/64-bit portability
372   - types for both host and target word sizes?
373   - can we use GDB's CORE_TYPE support?
374 - Allow N:M:P mapping of servers, targets, and interfaces
375 - loadable module support for interface/target/flash drivers and commands
376   - support both static and dynamic modules.
377   - should probably use libltdl for dynamic library handing.
378
379 @section thelistadmin Documentation Tasks
380
381 - Develop milestone and release guidelines, processes, and scripts.
382 - Develop "style" guidelines (and scripts) for maintainers:
383   - reviewing patches
384   - committing to git
385 - Review Users' Guide for documentation errors or omissions
386   - "capture" and "ocd_find" commands
387 - Update Developer's Manual (doxygen output)
388   - Add documentation describing the architecture of each module
389   - Provide more Technical Primers to bootstrap contributor knowledge
390
391 */
392 /** @file
393 This file contains the @ref thelist page.
394 */