flash/nor/at91samd: Use 32-bit register writes for ST-Link compat
[fw/openocd] / TODO
diff --git a/TODO b/TODO
index bdbb0ecc747f48d271d8bb00866011823f727866..ebb6c9980832dd1d76a00d38c6d2e3b18e194dbd 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,4 +1,4 @@
-// This file is part of the Doyxgen Developer Manual
+// This file is part of the Doxygen Developer Manual
 /** @page tasks Pending and Open Tasks
 
 This page lists pending and open tasks being considered or worked upon
@@ -27,8 +27,8 @@ This section provides possible things to improve with OpenOCD's TCL support.
   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. 
+- Isolate all TCL command support:
+  - Pure C CLI implementations using --disable-builtin-tcl.
     - Allow developers to build new dongles using OpenOCD's JTAG core.
     - At first, provide only low-level JTAG support; target layer and
       above rely heavily on scripting event mechanisms.
@@ -37,16 +37,38 @@ This section provides possible things to improve with OpenOCD's TCL support.
     - See src/jtag/core.c and src/jtag/tcl.c for an example.
     - allow some of these TCL command modules to be dynamically loadable?
 
-@section thelistjtag JTAG
+@section thelistadapter Adapter
 
-This section list issues that need to be resolved in the JTAG layer.
+This section list issues that need to be resolved in the Adapter layer.
 
-@subsection thelistjtagcore JTAG Core
+@subsection thelistadapterrework Code restructuring
+
+This section lists pending reworks to complete the restructure from the
+old JTAG centric implementation to a generic Adapter layer.
+This restructuring is very invasive and will prevent the merge of several
+changes pending in gerrit.
+
+- rename folder src/jtag/ to src/adapter/
+- rename var "jtag" to "adapter" in src/jtag/core.c
+- split content of src/adapter/ in the different protocols jtag.[ch],
+  swd.[ch], ...
+- wrap the calls to adapter->transport_ops->api() with transport_api()
+  and reduce the visibility of global var "adapter"
+- complete the migration of JTAG-only drivers to adapter->reset()
+- try to remove JTAG_SLEEP also from JTAG mode?
+- tap_set_state(TAP_RESET) is already done in src/jtag/core.c. No need
+  to replicate it in the drivers, apart in case the driver sets TRST
+  independently
+- add .hla_ops to "adapter"
+- HLA is a API level (.hla_ops). Transport should simply be {jtag,swd},
+  not {hla_jtag,hla_swd}.
+
+@subsection thelistadapterjtagcore JTAG Core
 
 The following tasks have been suggested for cleaning up the JTAG layer:
 
 - use tap_set_state everywhere to allow logging TAP state transitions
-- Encapsulate cmd_queue_cur_state and related varaible handling.
+- Encapsulate cmd_queue_cur_state and related variable 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
 API and calling code. New API should cut down # of lines in calling
@@ -63,9 +85,9 @@ The following tasks have been suggested for adding new core JTAG support:
   - (ab)use bit-banging JTAG interfaces to emulate SPI/UART
   - allow SPI to program flash, MCUs, etc.
 
-@subsection thelistjtaginterfaces JTAG Interfaces
+@subsection thelistadapterinterfaces Interface drivers
 
-There are some known bugs to fix in JTAG adapter drivers:
+There are some known bugs to fix in Interface drivers:
 
 - For JTAG_STATEMOVE to TAP_RESET, all drivers must ignore the current
   recorded state.  The tap_get_state() call won't necessarily return
@@ -85,7 +107,7 @@ There are some known bugs to fix in JTAG adapter drivers:
   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
+The following tasks have been suggested for improving OpenOCD's JTAG
 interface support:
 
 - rework USB communication to be more robust.  Two possible options are:
@@ -93,9 +115,6 @@ interface support:
   -# rewrite implementation to use non-blocking I/O
 - J-Link driver:
   - fix to work with long scan chains, such as R.Doss's svf test.
-- FT2232 (libftdi):
-  - 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.
 
@@ -110,10 +129,6 @@ 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
-
-- implement Serial Wire Debug interface 
-
 @section thelistbs Boundary Scan Support
 
 - add STAPL support?
@@ -142,6 +157,8 @@ Once the above are completed:
   https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
 - regression: "reset halt" between 729(works) and 788(fails): @par
 https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
+- registers
+  - add flush-value operation, call them all on resume/reset
 - mcr/mrc target->type support
   - missing from ARM920t, ARM966e, XScale.
   It's possible that the current syntax is unable to support read-modify-write
@@ -163,18 +180,25 @@ https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html
   use hardware stepping if available.
   - 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: 
+  a bug in the .MX31 PDK init script? Try on i.MX31 PDK:
   mdw 0xb80005f0 0x8, mdh 0xb80005f0 0x10, mdb 0xb80005f0 0x20. mdb returns
   garabage.
   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
-  - thumb support is missing: ISTR ARMv6 requires Thumb.
-  ARM1156 has Thumb2; ARM1136 doesn't.
-- Cortex A8 support (ML)
+- Thumb2 single stepping: ARM1156T2 needs simulator support
+- Cortex-A8 support (ML)
   - add target implementation (ML)
+- Cortex-M3 support
+  - when stepping, only write dirtied registers (be faster)
+  - when connecting to halted core, fetch registers (startup is quirky)
 - Generic ARM run_algorithm() interface
   - tagged struct wrapping ARM instructions and metadata
   - not revision-specific (current: ARMv4+ARMv5 -or- ARMv6 -or- ARMv7)
   - usable with at least arm_nandwrite() and generic CFI drivers
+- ETM
+  - don't show FIFOFULL registers if they're not supported
+  - use comparators to get more breakpoints and watchpoints
+  - add "etm drivers" command
+  - trace driver init() via examine() paths only, not setup()/reset
 - MC1322x support (JW/DE?)
   - integrate and test support from JW (and DE?)
   - get working with a known good interface (i.e. not today's jlink)
@@ -198,18 +222,27 @@ https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html
 
 @section thelistsvf SVF/XSVF
 
-- develop SVF unit tests 
-- develop XSVF unit tests 
+- develop SVF unit tests
+- develop XSVF unit tests
 
 @section thelistflash Flash Support
 
 - finish documentation for the following flash drivers:
   - avr
-  - ecosflash
   - pic32mx
   - ocl
   - str9xpec
 
+- Don't expect writing all-ones to be a safe way to write without
+  changing bit values.  Minimally it loses on flash modules with
+  internal ECC, where it may change the ECC.
+  - NOR flash_write_unlock() does that between sectors
+  - there may be other cases too
+
+- Make sure all commands accept either a bank name or a bank number,
+  and be sure both identifiers show up in "flash banks" and "nand list".
+  Right now the user-friendly names are pretty much hidden...
+
 @subsection thelistflashcfi CFI
 
 - finish implementing bus width/chip width handling (suggested by NC)
@@ -291,11 +324,11 @@ These ideas were first introduced here: @par
   - automatically detect the features that are available, unless
     options were specifically provided to configure
   - provide a report of the drivers that will be build at the end of
-    running configure, so the users can verify which driverswill be
+    running configure, so the users can verify which drivers will be
     built during 'make' (and their options) .
 - eliminate sources of confusion in @c bootstrap script:
   -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
-  -# Add @c buildstrap script to assist with boostrap and configure steps.
+  -# Add @c buildstrap script to assist with bootstrap and configure steps.
 - automatically build tool-chains required for cross-compiling
   - produce mingw32, arm-elf, others using in-tree scripts
   - build all required target code from sources
@@ -329,7 +362,7 @@ at the bottom of the list below.  Example, on amd64:
   from unaligned memory addresses
 - libopenocd support: @par
     https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
-- review and clean up interface/target/flash APIs 
+- review and clean up interface/target/flash APIs
 
 The following strategic tasks will require ambition, knowledge, and time
 to complete:
@@ -347,9 +380,10 @@ to complete:
 - Develop milestone and release guidelines, processes, and scripts.
 - Develop "style" guidelines (and scripts) for maintainers:
   - reviewing patches
-  - committing to Subversion
-- Review The Guide for OpenOCD Users for documentation errors or omissions
-- Update The Manual for OpenOCD Developerrs:
+  - committing to git
+- Review Users' Guide for documentation errors or omissions
+  - "capture" and "ocd_find" commands
+- Update Developer's Manual (doxygen output)
   - Add documentation describing the architecture of each module
   - Provide more Technical Primers to bootstrap contributor knowledge
 
@@ -357,4 +391,3 @@ to complete:
 /** @file
 This file contains the @ref thelist page.
 */
-