TODO

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