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