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