TODO: ref 'checkstack.pl' not 'checkpatch.pl'
[fw/openocd] / TODO
diff --git a/TODO b/TODO
index 7301e981f8c1fc40f1d49cc1a7068560b9989522..c7e341d9a51a201e5579211093e9c5572e7c8de3 100644 (file)
--- a/TODO
+++ b/TODO
@@ -23,6 +23,10 @@ This section provides possible things to improve with OpenOCD's TCL support.
   - provide more directory structure for boards/targets?
   - factor configurations into layers (encapsulation and re-use)
 
+- Fix handling of variables between multiple command line "-c" and "-f"
+  parameters.  Currently variables assigned through one such parameter
+  command/script are unset before the next one is invoked.
+
 - Isolate all TCL command support: 
   - Pure C CLI implementations using --disable-builtin-tcl. 
     - Allow developers to build new dongles using OpenOCD's JTAG core.
@@ -42,7 +46,6 @@ This section list issues that need to be resolved in the JTAG layer.
 The following tasks have been suggested for cleaning up the JTAG layer:
 
 - use tap_set_state everywhere to allow logging TAP state transitions
-- rename other tap_states to use standard JTAG names (suggested by ML)
 - Encapsulate cmd_queue_cur_state and related varaible handling.
 - add slick 32 bit versions of jtag_add_xxx_scan() that avoids
 buf_set_u32() calls and other evidence of poor impedance match between
@@ -52,14 +55,36 @@ directly in minidriver API for better embedded host performance.
 
 The following tasks have been suggested for adding new core JTAG support:
 
-- autodetect devices present on the scan chain
-  - implement 'discover_taps' command
+- Improve autodetection of TAPs by supporting tcl escape procedures that
+  can configure discovered TAPs based on IDCODE value ... they could:
+    - Remove guessing for irlen
+    - Allow non-default irmask/ircapture values
 - SPI/UART emulation:
   - (ab)use bit-banging JTAG interfaces to emulate SPI/UART
   - allow SPI to program flash, MCUs, etc.
 
 @subsection thelistjtaginterfaces JTAG Interfaces
 
+There are some known bugs to fix in JTAG adapter drivers:
+
+- For JTAG_STATEMOVE to TAP_RESET, all drivers must ignore the current
+  recorded state.  The tap_get_state() call won't necessarily return
+  the correct value, especially at server startup.  Fix is easy:  in
+  that case, always issue five clocks with TMS high.
+  - amt_jtagaccel.c
+  - arm-jtag-ew.c
+  - bitbang.c
+  - bitq.c
+  - gw16012.c
+  - jlink.c
+  - usbprog.c
+  - vsllink.c
+  - rlink/rlink.c
+- bug: USBprog is broken with new tms sequence; it needs 7-clock cycles.
+  Fix promised from  Peter Denison openwrt at marshadder.org
+  Workaround: use "tms_sequence long" @par
+  https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html
+
 The following tasks have been suggeted for improving OpenOCD's JTAG
 interface support:
 
@@ -69,12 +94,21 @@ interface support:
 - J-Link driver:
   - fix to work with long scan chains, such as R.Doss's svf test.
 - FT2232 (libftdi):
-  - make performance comparable to alternatives
+  - make performance comparable to alternatives (on Win32, D2XX is faster)
   - make usability comparable to alternatives
+- Autodetect USB based adapters; this should be easy on Linux.  If there's
+  more than one, list the options; otherwise, just select that one.
 
 The following tasks have been suggested for adding new JTAG interfaces:
 
 - TCP driver: allow client/server for remote JTAG interface control.
+This requires a client and a server. The server is built into the
+normal OpenOCD and takes commands from the client and executes
+them on the interface returning the result of TCP/IP. The client
+is an OpenOCD which is built with a TCP/IP minidriver. The use
+of a minidriver is required to capture all the jtag_add_xxx()
+fn's at a high enough level and repackage these cmd's as
+TCP/IP packets handled by the server.
 
 @section thelistswd Serial Wire Debug
 
@@ -103,25 +137,30 @@ Once the above are completed:
 
 @section thelisttargets Target Support
 
+- Many common ARM cores could be autodetected using IDCODE
 - general layer cleanup: @par
   https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
-- regression: xscale does not place debug_handler.bin into the right spot. workaround:
-  use -s option on command line to place xscale/debug_handler.bin in search path @par
-  https://lists.berlios.de/pipermail/openocd-development/2009-July/009338.html
-- bug: either USBprog is broken with new tms sequence or there is a general
-  problem with XScale and the new tms sequence. Workaround: use "tms_sequence long"
-  @par
-  https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html
 - regression: "reset halt" between 729(works) and 788(fails): @par
 https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
-- ARM923EJS:
+- mcr/mrc target->type support
+  - missing from ARM920t, ARM966e, XScale.
+  It's possible that the current syntax is unable to support read-modify-write
+  operations(see arm966e).
+  - mcr/mrc - retire cp15 commands when there the mrc/mrc commands have been
+  tested from: arm926ejs, arm720t, cortex_a8
+- ARM7/9:
+  - clean up "arm9tdmi vector_catch". Available for some arm7 cores? @par
+https://lists.berlios.de/pipermail/openocd-development/2009-October/011488.html
+https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html
+  - add reset option to allow programming embedded ice while srst is asserted.
+  Some CPUs will gate the JTAG clock when srst is asserted and in this case,
+  it is necessary to program embedded ice and then assert srst afterwards.
+- ARM926EJS:
   - reset run/halt/step is not robust; needs testing to map out problems.
 - ARM11 improvements (MB?)
-  - fix single stepping  (reported by ØH). Need to automatically
+  - add support for asserting srst to reset the core.
+  - Single stepping works, but should automatically
   use hardware stepping if available.
-  - hunt down and add timeouts to all infinite loops, e.g. arm11_run_instr_no_data would
-    lock up in infinite loop if e.g. an "mdh" command tries to read memory from invalid memory location.
-    Try mdh 0x40000000 on i.MX31 PDK
   - mdb can return garbage data if read byte operation fails for
   a memory region(16 & 32 byte access modes may be supported). Is this
   a bug in the .MX31 PDK init script? Try on i.MX31 PDK: 
@@ -180,8 +219,15 @@ https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
 
 @section thelistdebug Debugger Support
 
+- add support for masks in watchpoints? @par
+  https://lists.berlios.de/pipermail/openocd-development/2009-October/011507.html
 - breakpoints can get lost in some circumstances: @par
   https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
+- add support for masks in watchpoints. The trick is that GDB does not
+  support a breakpoint mask in the remote protocol. One way to work around
+  this is to add a separate command "watchpoint_mask add/rem <addr> <mask>", that
+  is run to register a list of masks that the gdb_server knows to use with
+  a particular watchpoint address.
 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
 
 @section thelisttesting Testing Suite
@@ -260,6 +306,22 @@ These ideas were first introduced here: @par
 The following architectural tasks need to be accomplished and should be
 fairly easy to complete:
 
+
+- use dynamic allocations for working memory. Scan & fix code
+for excessive stack allocations. take linux/scripts/checkstack.pl and
+see what the worst offenders are.  Example, on amd64:
+
+ $ objdump -d | checkstack.pl | head -10
+ 0x004311e3 image_open [openocd]:                      13464
+ 0x00431301 image_open [openocd]:                      13464
+ 0x004237a4 target_array2mem [openocd]:                        4376
+ 0x0042382b target_array2mem [openocd]:                        4376
+ 0x00423e74 target_mem2array [openocd]:                        4360
+ 0x00423ef9 target_mem2array [openocd]:                        4360
+ 0x00404aed handle_svf_command [openocd]:              2248
+ 0x00404b7e handle_svf_command [openocd]:              2248
+ 0x00413581 handle_flash_fill_command [openocd]:               2200
+ 0x004135fa handle_flash_fill_command [openocd]:               2200
 - clean-up code to match style guides
 - factor code to eliminate duplicated functionality
 - rewrite code that uses casts to access 16-bit and larger types
@@ -294,3 +356,4 @@ to complete:
 /** @file
 This file contains the @ref thelist page.
 */
+