Add comments to top-level files to "excuse" their Doxygen markup.
[openocd.git] / TODO
diff --git a/TODO b/TODO
index 998521e538c8fb5aea9e3e7df0459e709d858940..d000d5a25298d69af7c7d672e505c93efa14ab7b 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,3 +1,4 @@
+// This file is part of the Doyxgen Developer Manual
 /** @page tasks Pending and Open Tasks
 
 This page lists pending and open tasks being considered or worked upon
@@ -5,13 +6,6 @@ by the OpenOCD community.
 
 @section thelist The List
 
-Items with a current patch available should include a link to its
-posting on the openocd-developer mailing list archives.
-
-Some items may be in progress, usually indicated by the individual whose
-initials in parentheses following it.  A key for decoding these initials
-appears after The List.
-
 Most items are open for the taking, but please post to the mailing list
 before spending much time working on anything lists here.  The community
 may have evolved an idea since it was added here.
@@ -22,6 +16,9 @@ Feel free to send patches to add or clarify items on this list, too.
 
 This section provides possible things to improve with OpenOCD's TCL support.
 
+- Fix problem with incorrect line numbers reported for a syntax
+  error in a reset init event.
+
 - organize the TCL configurations:
   - provide more directory structure for boards/targets?
   - factor configurations into layers (encapsulation and re-use)
@@ -33,6 +30,8 @@ This section provides possible things to improve with OpenOCD's TCL support.
       above rely heavily on scripting event mechanisms.
   - Allow full TCL support? add --with-tcl=/path/to/installed/tcl
   - Move TCL support out of foo.[ch] and into foo_tcl.[ch] (other ideas?)
+    - 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
 
@@ -44,15 +43,6 @@ The following tasks have been suggeted 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)
-
-- retire jtag_add_end_state() and replace w/global variable:
-  - removes TAP_INVALID as an argument to jtag_add_xxxx().
-
-  - global variable as argument to jtag_add_xxxx() should be phased out,
-    but it is useful while we need to bug-by-bug compatible while
-    testing changes.
-
- - Suggested by ØH. Michael Bruck also interested in this.
 - Encapsulate cmd_queue_cur_state and related varaible handling.
 
 The following tasks have been suggested for adding new core JTAG support:
@@ -71,13 +61,11 @@ interface support:
 - rework USB communication to be more robust.  Two possible options are:
   -# use libusb-1.0.1 with libusb-compat-0.1.1 (non-blocking I/O wrapper)
   -# rewrite implementation to use non-blocking I/O
-- FT2232 driver:
-  - integrate FTD2XX High-Speed Device support @par
-      PATCH: https://lists.berlios.de/pipermail/openocd-development/2009-April/005479.html
-  - fix outstanding bugs
 - J-Link driver:
   - fix to work with long scan chains, such as R.Doss's svf test.
-  - fix other outstanding bugs
+- FT2232 (libftdi):
+  - make performance comparable to alternatives
+  - make usability comparable to alternatives
 
 The following tasks have been suggested for adding new JTAG interfaces:
 
@@ -110,10 +98,16 @@ Once the above are completed:
 
 @section thelisttargets Target Support
 
-- general layer cleanup:
-  - https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
+- 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: @par
+  https://lists.berlios.de/pipermail/openocd-development/2009-July/009338.html
+- regression: "reset halt" between 729(works) and 788(fails): @par
+https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
+- ARM923EJS:
+  - reset run/halt/step is not robust; needs testing to map out problems.
 - ARM11 improvements (MB?)
-  - fix single stepping  (reported by ØH)
+  - fix single stepping  (reported by H)
   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
 - Cortex A8 support (ML)
   - add target implementation (ML)
@@ -130,7 +124,7 @@ Once the above are completed:
   - work out how to debug this target
   - AVR debugging protocol.
 - FPGA:
-  - improve things (??)
+  - Altera Nios Soft-CPU support
 - Coldfire (suggested by NC)
   - can we draw from the BDM project?  @par
     http://bdm.sourceforge.net/
@@ -140,16 +134,19 @@ Once the above are completed:
 
 @section thelistsvf SVF/XSVF
 
-- factor and clean-up code
-- review The Guide for OpenOCD Users for documentation errors or omissions
-- update The Manual for OpenOCD Developerrs:
-  - add documentation describing the architecture of each module
-  - provide Technical Primers to bootstrap contributor knowledge
 - develop SVF unit tests 
 - develop XSVF unit tests 
 
 @section thelistflash Flash Support
 
+- aduc702x segfault reported by Thomas A Moulton
+
+https://lists.berlios.de/pipermail/openocd-development/2009-July/009186.html
+
+- aduc7024 programming w/working area does not work:
+
+https://lists.berlios.de/pipermail/openocd-development/2009-July/009337.html
+
 - finish documentation for the following flash drivers:
   - avr
   - ecosflash
@@ -162,10 +159,12 @@ Once the above are completed:
 - finish implementing bus width/chip width handling (suggested by NC)
 - factor vendor-specific code into separate source files
   - add new callback interface for vendor-specific code
-- investigate/implement "thin wrapper" to use eCos CFI drivers (ØH)
+- investigate/implement "thin wrapper" to use eCos CFI drivers (H)
 
 @section thelistdebug Debugger Support
 
+- breakpoints can get lost in some circumstances: @par
+  https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
 
 @section thelisttesting Testing Suite
@@ -210,7 +209,7 @@ This section includes several related groups of ideas:
 
 @subsection thelisttestreports Test Feedback Tools
 
-These ideas were first introduced here:
+These ideas were first introduced here: @par
   https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
 
 - provide report submission scripts for e-mail and web forms
@@ -225,8 +224,13 @@ These ideas were first introduced here:
 
 @section thelistautotools Autotools Build System
 
-- investigate fixes to permit the use of -Wshadow
-- eliminate sources of confusion in @c boostrap script:
+- make entire configure process require less user consideration:
+  - 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
+    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.
 - automatically build tool-chains required for cross-compiling
@@ -239,8 +243,8 @@ These ideas were first introduced here:
 The following architectural tasks need to be accomplished and should be
 fairly easy to complete:
 
+- clean-up code to match style guides
 - factor code to eliminate duplicated functionality
-- overhaul use of types to improve 32/64-bit portability
 - rewrite code that uses casts to access 16-bit and larger types
   from unaligned memory addresses
 - libopenocd support: @par
@@ -250,13 +254,24 @@ fairly easy to complete:
 The following strategic tasks will require ambition, knowledge, and time
 to complete:
 
+- overhaul use of types to improve 32/64-bit portability
+  - types for both host and target word sizes?
+  - can we use GDB's CORE_TYPE support?
 - Allow N:M:P mapping of servers, targets, and interfaces
-- loadable module support for interface/target/flash drivers
-
-@section thelistadmin Administrative Tasks
-
-- Develop "style" guidelines for committing to Subversion
-- Develop milestone and release guidelines.
+- loadable module support for interface/target/flash drivers and commands
+  - support both static and dynamic modules.
+  - should probably use libltdl for dynamic library handing.
+
+@section thelistadmin Documentation Tasks
+
+- 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:
+  - Add documentation describing the architecture of each module
+  - Provide more Technical Primers to bootstrap contributor knowledge
 
 */
 /** @file

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)