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 Items with a current patch available should include a link to its
   9 posting on the openocd-developer mailing list archives.
  10
  11 Some items may be in progress, usually indicated by the individual whose
  12 initials in parentheses following it.  A key for decoding these initials
  13 appears after The List.
  14
  15 Most items are open for the taking, but please post to the mailing list
  16 before spending much time working on anything lists here.  The community
  17 may have evolved an idea since it was added here.
  18
  19 Feel free to send patches to add or clarify items on this list, too.
  20
  21 @section thelisttcl TCL
  22
  23 This section provides possible things to improve with OpenOCD's TCL support.
  24
  25 - organize the TCL configurations:
  26   - provide more directory structure for boards/targets?
  27   - factor configurations into layers (encapsulation and re-use)
  28
  29 - Isolate all TCL command support:
  30   - Pure C CLI implementations using --disable-builtin-tcl.
  31     - Allow developers to build new dongles using OpenOCD's JTAG core.
  32     - At first, provide only low-level JTAG support; target layer and
  33       above rely heavily on scripting event mechanisms.
  34   - Allow full TCL support? add --with-tcl=/path/to/installed/tcl
  35   - Move TCL support out of foo.[ch] and into foo_tcl.[ch] (other ideas?)
  36
  37 @section thelistjtag JTAG
  38
  39 This section list issues that need to be resolved in the JTAG layer.
  40
  41 @subsection thelistjtagcore JTAG Core
  42
  43 The following tasks have been suggeted for cleaning up the JTAG layer:
  44
  45 - use tap_set_state everywhere to allow logging TAP state transitions
  46 - rename other tap_states to use standard JTAG names (suggested by ML)
  47
  48 - retire jtag_add_end_state() and replace w/global variable:
  49   - removes TAP_INVALID as an argument to jtag_add_xxxx().
  50
  51   - global variable as argument to jtag_add_xxxx() should be phased out,
  52     but it is useful while we need to bug-by-bug compatible while
  53     testing changes.
  54
  55  - Suggested by ØH. Michael Bruck also interested in this.
  56 - Encapsulate cmd_queue_cur_state and related varaible handling.
  57
  58 The following tasks have been suggested for adding new core JTAG support:
  59
  60 - autodetect devices present on the scan chain
  61   - implement 'discover_taps' command
  62 - SPI/UART emulation:
  63   - (ab)use bit-banging JTAG interfaces to emulate SPI/UART
  64   - allow SPI to program flash, MCUs, etc.
  65
  66 @subsection thelistjtaginterfaces JTAG Interfaces
  67
  68 The following tasks have been suggeted for improving OpenOCD's JTAG
  69 interface support:
  70
  71 - rework USB communication to be more robust.  Two possible options are:
  72   -# use libusb-1.0.1 with libusb-compat-0.1.1 (non-blocking I/O wrapper)
  73   -# rewrite implementation to use non-blocking I/O
  74 - FT2232 driver:
  75   - integrate FTD2XX High-Speed Device support @par
  76       PATCH: https://lists.berlios.de/pipermail/openocd-development/2009-April/005479.html
  77   - fix outstanding bugs
  78 - J-Link driver:
  79   - fix to work with long scan chains, such as R.Doss's svf test.
  80   - fix other outstanding bugs
  81
  82 The following tasks have been suggested for adding new JTAG interfaces:
  83
  84 - TCP driver: allow client/server for remote JTAG interface control.
  85
  86 @section thelistswd Serial Wire Debug
  87
  88 - implement Serial Wire Debug interface
  89
  90 @section thelistbs Boundary Scan Support
  91
  92 - add STAPL support?
  93 - add BSDL support?
  94
  95 A few possible options for the above:
  96   -# Fake a TCL equivalent?
  97   -# Integrate an existing library?
  98   -# Write a new C implementation a la Jim?
  99
 100 Once the above are completed:
 101 - add support for programming flash using boundary scan techniques
 102 - add integration with a modified gerber view program:
 103   - provide means to view the PCB and select pins and traces
 104   - allow use-cases such as the following:
 105     - @b Stimulus
 106       -# Double-click on a pin (or trace) with the mouse.
 107     - @b Effects
 108       -# The trace starts blinking, and
 109       -# OpenOCD toggles the pin(s) 0/1.
 110
 111 @section thelisttargets Target Support
 112
 113 - general layer cleanup:
 114   - https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
 115 - ARM11 improvements (MB?)
 116   - fix single stepping  (reported by ØH)
 117   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
 118 - Cortex A8 support (ML)
 119   - add target implementation (ML)
 120 - MC1322x support (JW/DE?)
 121   - integrate and test support from JW (and DE?)
 122   - get working with a known good interface (i.e. not today's jlink)
 123 - AT91SAM92xx:
 124   - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
 125 - STR9x: (ZW)
 126   - improvements to str912.cfg to be more general purpose
 127 - AVR: (SQ)
 128   - independently verify implementation
 129   - incrementally improve working prototype in trunk. (SQ)
 130   - work out how to debug this target
 131   - AVR debugging protocol.
 132 - FPGA:
 133   - improve things (??)
 134 - Coldfire (suggested by NC)
 135   - can we draw from the BDM project?  @par
 136     http://bdm.sourceforge.net/
 137
 138     or the OSBDM package @par
 139     http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
 140
 141 @section thelistsvf SVF/XSVF
 142
 143 - factor and clean-up code
 144 - review The Guide for OpenOCD Users for documentation errors or omissions
 145 - update The Manual for OpenOCD Developerrs:
 146   - add documentation describing the architecture of each module
 147   - provide Technical Primers to bootstrap contributor knowledge
 148 - develop SVF unit tests
 149 - develop XSVF unit tests
 150
 151 @section thelistflash Flash Support
 152
 153 - finish documentation for the following flash drivers:
 154   - avr
 155   - ecosflash
 156   - pic32mx
 157   - ocl
 158   - str9xpec
 159
 160 @subsection thelistflashcfi CFI
 161
 162 - finish implementing bus width/chip width handling (suggested by NC)
 163 - factor vendor-specific code into separate source files
 164   - add new callback interface for vendor-specific code
 165 - investigate/implement "thin wrapper" to use eCos CFI drivers (ØH)
 166
 167 @section thelistdebug Debugger Support
 168
 169 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
 170
 171 @section thelisttesting Testing Suite
 172
 173 This section includes several related groups of ideas:
 174 - @ref thelistunittests
 175 - @ref thelistsmoketests
 176 - @ref thelisttestreports
 177 - @ref thelisttestgenerichw
 178
 179 @subsection thelistunittests Unit Tests
 180
 181 - add testing skeleton to provide frameworks for adding tests
 182 - implement server unit tests
 183 - implement JTAG core unit tests
 184 - implement JTAG interface unit tests
 185 - implement flash unit tests
 186 - implement target unit tests
 187
 188 @subsection thelistsmoketests Smoke Test Tools
 189
 190 -# extend 'make check' with a smoketest app
 191   - checks for OOCD_TEST_CONFIG, etc. in environment (or config file)
 192   - if properly set, runs the smoke test with specified parameters
 193     - openocd -f ${OOCD_TEST_CONFIG}
 194     - implies a modular test suite (see below)
 195   - should be able to run some minimal tests with dummy interface:
 196     - compare results of baseline sanity checks with expected results
 197
 198 -# builds a more complete test suite:
 199   - existing testing/examples/ look like a great start
 200   - all targets should be tested fully and for all capabilities
 201     - we do NOT want a "lowest common denominator" test suite
 202     - ... but can we start with one to get going?
 203   - probably requires one test configuration file per board/target
 204     - modularization can occur here, just like with targets/boards/chips
 205     - coverage can increase over time, building up bundles of tests
 206
 207 -# add new 'smoketest' Makefile target:
 208   - calls 'make check' (and the smoketest app)
 209   - gather inputs and output into a report file
 210
 211 @subsection thelisttestreports Test Feedback Tools
 212
 213 These ideas were first introduced here:
 214   https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
 215
 216 - provide report submission scripts for e-mail and web forms
 217 - add new Makefile targets to post the report:
 218   - 'checkreportsend' -- send to list via e-mail (via sendmail)
 219   - 'checkreportpost' -- send web form (via curl or other script)
 220
 221 @subsection thelisttestgenerichw Generic Hardware Tester
 222
 223 - implement VHDL to use for FPGA-based JTAG TAP testing device
 224 - develop test suite that utilizes this testing device
 225
 226 @section thelistautotools Autotools Build System
 227
 228 - investigate fixes to permit the use of -Wshadow
 229 - eliminate sources of confusion in @c boostrap script:
 230   -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
 231   -# Add @c buildstrap script to assist with boostrap and configure steps.
 232 - automatically build tool-chains required for cross-compiling
 233   - produce mingw32, arm-elf, others using in-tree scripts
 234   - build all required target code from sources
 235 - make JTAG and USB debug output a run-time configuration option
 236
 237 @section thelistarchitecture Architectural Tasks
 238
 239 The following architectural tasks need to be accomplished and should be
 240 fairly easy to complete:
 241
 242 - factor code to eliminate duplicated functionality
 243 - overhaul use of types to improve 32/64-bit portability
 244 - rewrite code that uses casts to access 16-bit and larger types
 245   from unaligned memory addresses
 246 - libopenocd support: @par
 247     https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
 248 - review and clean up interface/target/flash APIs
 249
 250 The following strategic tasks will require ambition, knowledge, and time
 251 to complete:
 252
 253 - Allow N:M:P mapping of servers, targets, and interfaces
 254 - loadable module support for interface/target/flash drivers
 255
 256 @section thelistadmin Administrative Tasks
 257
 258 - Develop "style" guidelines for committing to Subversion
 259 - Develop milestone and release guidelines.
 260
 261 */
 262 /** @file
 263 This file contains the @ref thelist page.
 264 */