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. workaround:
 104   use -s option on command line to place xscale/debug_handler.bin in search path @par
 105   https://lists.berlios.de/pipermail/openocd-development/2009-July/009338.html
 106 - bug: either USBprog is broken with new tms sequence or there is a general
 107   problem with XScale and the new tms sequence. Workaround: use "tms_sequence long"
 108   @par
 109   https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html
 110 - regression: "reset halt" between 729(works) and 788(fails): @par
 111 https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
 112 - ARM923EJS:
 113   - reset run/halt/step is not robust; needs testing to map out problems.
 114 - ARM11 improvements (MB?)
 115   - fix single stepping  (reported by �H)
 116   - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
 117 - Cortex A8 support (ML)
 118   - add target implementation (ML)
 119 - MC1322x support (JW/DE?)
 120   - integrate and test support from JW (and DE?)
 121   - get working with a known good interface (i.e. not today's jlink)
 122 - AT91SAM92xx:
 123   - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
 124 - STR9x: (ZW)
 125   - improvements to str912.cfg to be more general purpose
 126 - AVR: (SQ)
 127   - independently verify implementation
 128   - incrementally improve working prototype in trunk. (SQ)
 129   - work out how to debug this target
 130   - AVR debugging protocol.
 131 - FPGA:
 132   - Altera Nios Soft-CPU support
 133 - Coldfire (suggested by NC)
 134   - can we draw from the BDM project?  @par
 135     http://bdm.sourceforge.net/
 136
 137     or the OSBDM package @par
 138     http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
 139
 140 @section thelistsvf SVF/XSVF
 141
 142 - develop SVF unit tests
 143 - develop XSVF unit tests
 144
 145 @section thelistflash Flash Support
 146
 147 - aduc702x segfault reported by Thomas A Moulton
 148
 149 https://lists.berlios.de/pipermail/openocd-development/2009-July/009186.html
 150
 151 - aduc7024 programming w/working area does not work:
 152
 153 https://lists.berlios.de/pipermail/openocd-development/2009-July/009337.html
 154
 155 - finish documentation for the following flash drivers:
 156   - avr
 157   - ecosflash
 158   - pic32mx
 159   - ocl
 160   - str9xpec
 161
 162 @subsection thelistflashcfi CFI
 163
 164 - finish implementing bus width/chip width handling (suggested by NC)
 165 - factor vendor-specific code into separate source files
 166   - add new callback interface for vendor-specific code
 167 - investigate/implement "thin wrapper" to use eCos CFI drivers (�H)
 168
 169 @section thelistdebug Debugger Support
 170
 171 - breakpoints can get lost in some circumstances: @par
 172   https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
 173 - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
 174
 175 @section thelisttesting Testing Suite
 176
 177 This section includes several related groups of ideas:
 178 - @ref thelistunittests
 179 - @ref thelistsmoketests
 180 - @ref thelisttestreports
 181 - @ref thelisttestgenerichw
 182
 183 @subsection thelistunittests Unit Tests
 184
 185 - add testing skeleton to provide frameworks for adding tests
 186 - implement server unit tests
 187 - implement JTAG core unit tests
 188 - implement JTAG interface unit tests
 189 - implement flash unit tests
 190 - implement target unit tests
 191
 192 @subsection thelistsmoketests Smoke Test Tools
 193
 194 -# extend 'make check' with a smoketest app
 195   - checks for OOCD_TEST_CONFIG, etc. in environment (or config file)
 196   - if properly set, runs the smoke test with specified parameters
 197     - openocd -f ${OOCD_TEST_CONFIG}
 198     - implies a modular test suite (see below)
 199   - should be able to run some minimal tests with dummy interface:
 200     - compare results of baseline sanity checks with expected results
 201
 202 -# builds a more complete test suite:
 203   - existing testing/examples/ look like a great start
 204   - all targets should be tested fully and for all capabilities
 205     - we do NOT want a "lowest common denominator" test suite
 206     - ... but can we start with one to get going?
 207   - probably requires one test configuration file per board/target
 208     - modularization can occur here, just like with targets/boards/chips
 209     - coverage can increase over time, building up bundles of tests
 210
 211 -# add new 'smoketest' Makefile target:
 212   - calls 'make check' (and the smoketest app)
 213   - gather inputs and output into a report file
 214
 215 @subsection thelisttestreports Test Feedback Tools
 216
 217 These ideas were first introduced here: @par
 218   https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
 219
 220 - provide report submission scripts for e-mail and web forms
 221 - add new Makefile targets to post the report:
 222   - 'checkreportsend' -- send to list via e-mail (via sendmail)
 223   - 'checkreportpost' -- send web form (via curl or other script)
 224
 225 @subsection thelisttestgenerichw Generic Hardware Tester
 226
 227 - implement VHDL to use for FPGA-based JTAG TAP testing device
 228 - develop test suite that utilizes this testing device
 229
 230 @section thelistautotools Autotools Build System
 231
 232 - make entire configure process require less user consideration:
 233   - automatically detect the features that are available, unless
 234     options were specifically provided to configure
 235   - provide a report of the drivers that will be build at the end of
 236     running configure, so the users can verify which driverswill be
 237     built during 'make' (and their options) .
 238 - eliminate sources of confusion in @c bootstrap script:
 239   -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
 240   -# Add @c buildstrap script to assist with boostrap and configure steps.
 241 - automatically build tool-chains required for cross-compiling
 242   - produce mingw32, arm-elf, others using in-tree scripts
 243   - build all required target code from sources
 244 - make JTAG and USB debug output a run-time configuration option
 245
 246 @section thelistarchitecture Architectural Tasks
 247
 248 The following architectural tasks need to be accomplished and should be
 249 fairly easy to complete:
 250
 251 - clean-up code to match style guides
 252 - factor code to eliminate duplicated functionality
 253 - rewrite code that uses casts to access 16-bit and larger types
 254   from unaligned memory addresses
 255 - libopenocd support: @par
 256     https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
 257 - review and clean up interface/target/flash APIs
 258
 259 The following strategic tasks will require ambition, knowledge, and time
 260 to complete:
 261
 262 - overhaul use of types to improve 32/64-bit portability
 263   - types for both host and target word sizes?
 264   - can we use GDB's CORE_TYPE support?
 265 - Allow N:M:P mapping of servers, targets, and interfaces
 266 - loadable module support for interface/target/flash drivers and commands
 267   - support both static and dynamic modules.
 268   - should probably use libltdl for dynamic library handing.
 269
 270 @section thelistadmin Documentation Tasks
 271
 272 - Develop milestone and release guidelines, processes, and scripts.
 273 - Develop "style" guidelines (and scripts) for maintainers:
 274   - reviewing patches
 275   - committing to Subversion
 276 - Review The Guide for OpenOCD Users for documentation errors or omissions
 277 - Update The Manual for OpenOCD Developerrs:
 278   - Add documentation describing the architecture of each module
 279   - Provide more Technical Primers to bootstrap contributor knowledge
 280
 281 */
 282 /** @file
 283 This file contains the @ref thelist page.
 284 */