You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

328 lines
13 KiB

  1. // This file is part of the Doyxgen Developer Manual
  2. /** @page tasks Pending and Open Tasks
  3. This page lists pending and open tasks being considered or worked upon
  4. by the OpenOCD community.
  5. @section thelist The List
  6. Most items are open for the taking, but please post to the mailing list
  7. before spending much time working on anything lists here. The community
  8. may have evolved an idea since it was added here.
  9. Feel free to send patches to add or clarify items on this list, too.
  10. @section thelisttcl TCL
  11. This section provides possible things to improve with OpenOCD's TCL support.
  12. - Fix problem with incorrect line numbers reported for a syntax
  13. error in a reset init event.
  14. - organize the TCL configurations:
  15. - provide more directory structure for boards/targets?
  16. - factor configurations into layers (encapsulation and re-use)
  17. - Fix handling of variables between multiple command line "-c" and "-f"
  18. parameters. Currently variables assigned through one such parameter
  19. command/script are unset before the next one is invoked.
  20. - Isolate all TCL command support:
  21. - Pure C CLI implementations using --disable-builtin-tcl.
  22. - Allow developers to build new dongles using OpenOCD's JTAG core.
  23. - At first, provide only low-level JTAG support; target layer and
  24. above rely heavily on scripting event mechanisms.
  25. - Allow full TCL support? add --with-tcl=/path/to/installed/tcl
  26. - Move TCL support out of foo.[ch] and into foo_tcl.[ch] (other ideas?)
  27. - See src/jtag/core.c and src/jtag/tcl.c for an example.
  28. - allow some of these TCL command modules to be dynamically loadable?
  29. @section thelistjtag JTAG
  30. This section list issues that need to be resolved in the JTAG layer.
  31. @subsection thelistjtagcore JTAG Core
  32. The following tasks have been suggested for cleaning up the JTAG layer:
  33. - use tap_set_state everywhere to allow logging TAP state transitions
  34. - Encapsulate cmd_queue_cur_state and related varaible handling.
  35. - add slick 32 bit versions of jtag_add_xxx_scan() that avoids
  36. buf_set_u32() calls and other evidence of poor impedance match between
  37. API and calling code. New API should cut down # of lines in calling
  38. code by 100's and make things clearer. Also potentially be supported
  39. directly in minidriver API for better embedded host performance.
  40. The following tasks have been suggested for adding new core JTAG support:
  41. - autodetect devices present on the scan chain
  42. - implement 'discover_taps' command
  43. - SPI/UART emulation:
  44. - (ab)use bit-banging JTAG interfaces to emulate SPI/UART
  45. - allow SPI to program flash, MCUs, etc.
  46. @subsection thelistjtaginterfaces JTAG Interfaces
  47. There are some known bugs to fix in JTAG adapter drivers:
  48. - For JTAG_STATEMOVE to TAP_RESET, all drivers must ignore the current
  49. recorded state. The tap_get_state() call won't necessarily return
  50. the correct value, especially at server startup. Fix is easy: in
  51. that case, always issue five clocks with TMS high.
  52. - amt_jtagaccel.c
  53. - arm-jtag-ew.c
  54. - bitbang.c
  55. - bitq.c
  56. - gw16012.c
  57. - jlink.c
  58. - usbprog.c
  59. - vsllink.c
  60. - rlink/rlink.c
  61. - bug: USBprog is broken with new tms sequence; it needs 7-clock cycles.
  62. Fix promised from Peter Denison openwrt at marshadder.org
  63. Workaround: use "tms_sequence long" @par
  64. https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html
  65. The following tasks have been suggeted for improving OpenOCD's JTAG
  66. interface support:
  67. - rework USB communication to be more robust. Two possible options are:
  68. -# use libusb-1.0.1 with libusb-compat-0.1.1 (non-blocking I/O wrapper)
  69. -# rewrite implementation to use non-blocking I/O
  70. - J-Link driver:
  71. - fix to work with long scan chains, such as R.Doss's svf test.
  72. - FT2232 (libftdi):
  73. - make performance comparable to alternatives (on Win32, D2XX is faster)
  74. - make usability comparable to alternatives
  75. The following tasks have been suggested for adding new JTAG interfaces:
  76. - TCP driver: allow client/server for remote JTAG interface control.
  77. This requires a client and a server. The server is built into the
  78. normal OpenOCD and takes commands from the client and executes
  79. them on the interface returning the result of TCP/IP. The client
  80. is an OpenOCD which is built with a TCP/IP minidriver. The use
  81. of a minidriver is required to capture all the jtag_add_xxx()
  82. fn's at a high enough level and repackage these cmd's as
  83. TCP/IP packets handled by the server.
  84. @section thelistswd Serial Wire Debug
  85. - implement Serial Wire Debug interface
  86. @section thelistbs Boundary Scan Support
  87. - add STAPL support?
  88. - add BSDL support?
  89. A few possible options for the above:
  90. -# Fake a TCL equivalent?
  91. -# Integrate an existing library?
  92. -# Write a new C implementation a la Jim?
  93. Once the above are completed:
  94. - add support for programming flash using boundary scan techniques
  95. - add integration with a modified gerber view program:
  96. - provide means to view the PCB and select pins and traces
  97. - allow use-cases such as the following:
  98. - @b Stimulus
  99. -# Double-click on a pin (or trace) with the mouse.
  100. - @b Effects
  101. -# The trace starts blinking, and
  102. -# OpenOCD toggles the pin(s) 0/1.
  103. @section thelisttargets Target Support
  104. - general layer cleanup: @par
  105. https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
  106. - regression: "reset halt" between 729(works) and 788(fails): @par
  107. https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
  108. - ARM7/9:
  109. - clean up "arm9tdmi vector_catch". Available for some arm7 cores? @par
  110. https://lists.berlios.de/pipermail/openocd-development/2009-October/011488.html
  111. https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html
  112. - add reset option to allow programming embedded ice while srst is asserted.
  113. Some CPUs will gate the JTAG clock when srst is asserted and in this case,
  114. it is necessary to program embedded ice and then assert srst afterwards.
  115. - ARM926EJS:
  116. - reset run/halt/step is not robust; needs testing to map out problems.
  117. - ARM11 improvements (MB?)
  118. - add support for asserting srst to reset the core.
  119. - Single stepping works, but should automatically
  120. use hardware stepping if available.
  121. - mdb can return garbage data if read byte operation fails for
  122. a memory region(16 & 32 byte access modes may be supported). Is this
  123. a bug in the .MX31 PDK init script? Try on i.MX31 PDK:
  124. mdw 0xb80005f0 0x8, mdh 0xb80005f0 0x10, mdb 0xb80005f0 0x20. mdb returns
  125. garabage.
  126. - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
  127. - thumb support is missing: ISTR ARMv6 requires Thumb.
  128. ARM1156 has Thumb2; ARM1136 doesn't.
  129. - Cortex A8 support (ML)
  130. - add target implementation (ML)
  131. - Generic ARM run_algorithm() interface
  132. - tagged struct wrapping ARM instructions and metadata
  133. - not revision-specific (current: ARMv4+ARMv5 -or- ARMv6 -or- ARMv7)
  134. - usable with at least arm_nandwrite() and generic CFI drivers
  135. - MC1322x support (JW/DE?)
  136. - integrate and test support from JW (and DE?)
  137. - get working with a known good interface (i.e. not today's jlink)
  138. - AT91SAM92xx:
  139. - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
  140. - STR9x: (ZW)
  141. - improvements to str912.cfg to be more general purpose
  142. - AVR: (SQ)
  143. - independently verify implementation
  144. - incrementally improve working prototype in trunk. (SQ)
  145. - work out how to debug this target
  146. - AVR debugging protocol.
  147. - FPGA:
  148. - Altera Nios Soft-CPU support
  149. - Coldfire (suggested by NC)
  150. - can we draw from the BDM project? @par
  151. http://bdm.sourceforge.net/
  152. or the OSBDM package @par
  153. http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
  154. @section thelistsvf SVF/XSVF
  155. - develop SVF unit tests
  156. - develop XSVF unit tests
  157. @section thelistflash Flash Support
  158. - finish documentation for the following flash drivers:
  159. - avr
  160. - ecosflash
  161. - pic32mx
  162. - ocl
  163. - str9xpec
  164. @subsection thelistflashcfi CFI
  165. - finish implementing bus width/chip width handling (suggested by NC)
  166. - factor vendor-specific code into separate source files
  167. - add new callback interface for vendor-specific code
  168. - investigate/implement "thin wrapper" to use eCos CFI drivers (ØH)
  169. @section thelistdebug Debugger Support
  170. - add support for masks in watchpoints? @par
  171. https://lists.berlios.de/pipermail/openocd-development/2009-October/011507.html
  172. - breakpoints can get lost in some circumstances: @par
  173. https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
  174. - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
  175. @section thelisttesting Testing Suite
  176. This section includes several related groups of ideas:
  177. - @ref thelistunittests
  178. - @ref thelistsmoketests
  179. - @ref thelisttestreports
  180. - @ref thelisttestgenerichw
  181. @subsection thelistunittests Unit Tests
  182. - add testing skeleton to provide frameworks for adding tests
  183. - implement server unit tests
  184. - implement JTAG core unit tests
  185. - implement JTAG interface unit tests
  186. - implement flash unit tests
  187. - implement target unit tests
  188. @subsection thelistsmoketests Smoke Test Tools
  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. -# builds a more complete test suite:
  197. - existing testing/examples/ look like a great start
  198. - all targets should be tested fully and for all capabilities
  199. - we do NOT want a "lowest common denominator" test suite
  200. - ... but can we start with one to get going?
  201. - probably requires one test configuration file per board/target
  202. - modularization can occur here, just like with targets/boards/chips
  203. - coverage can increase over time, building up bundles of tests
  204. -# add new 'smoketest' Makefile target:
  205. - calls 'make check' (and the smoketest app)
  206. - gather inputs and output into a report file
  207. @subsection thelisttestreports Test Feedback Tools
  208. These ideas were first introduced here: @par
  209. https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
  210. - provide report submission scripts for e-mail and web forms
  211. - add new Makefile targets to post the report:
  212. - 'checkreportsend' -- send to list via e-mail (via sendmail)
  213. - 'checkreportpost' -- send web form (via curl or other script)
  214. @subsection thelisttestgenerichw Generic Hardware Tester
  215. - implement VHDL to use for FPGA-based JTAG TAP testing device
  216. - develop test suite that utilizes this testing device
  217. @section thelistautotools Autotools Build System
  218. - make entire configure process require less user consideration:
  219. - automatically detect the features that are available, unless
  220. options were specifically provided to configure
  221. - provide a report of the drivers that will be build at the end of
  222. running configure, so the users can verify which driverswill be
  223. built during 'make' (and their options) .
  224. - eliminate sources of confusion in @c bootstrap script:
  225. -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
  226. -# Add @c buildstrap script to assist with boostrap and configure steps.
  227. - automatically build tool-chains required for cross-compiling
  228. - produce mingw32, arm-elf, others using in-tree scripts
  229. - build all required target code from sources
  230. - make JTAG and USB debug output a run-time configuration option
  231. @section thelistarchitecture Architectural Tasks
  232. The following architectural tasks need to be accomplished and should be
  233. fairly easy to complete:
  234. - clean-up code to match style guides
  235. - factor code to eliminate duplicated functionality
  236. - rewrite code that uses casts to access 16-bit and larger types
  237. from unaligned memory addresses
  238. - libopenocd support: @par
  239. https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
  240. - review and clean up interface/target/flash APIs
  241. The following strategic tasks will require ambition, knowledge, and time
  242. to complete:
  243. - overhaul use of types to improve 32/64-bit portability
  244. - types for both host and target word sizes?
  245. - can we use GDB's CORE_TYPE support?
  246. - Allow N:M:P mapping of servers, targets, and interfaces
  247. - loadable module support for interface/target/flash drivers and commands
  248. - support both static and dynamic modules.
  249. - should probably use libltdl for dynamic library handing.
  250. @section thelistadmin Documentation Tasks
  251. - Develop milestone and release guidelines, processes, and scripts.
  252. - Develop "style" guidelines (and scripts) for maintainers:
  253. - reviewing patches
  254. - committing to Subversion
  255. - Review The Guide for OpenOCD Users for documentation errors or omissions
  256. - Update The Manual for OpenOCD Developerrs:
  257. - Add documentation describing the architecture of each module
  258. - Provide more Technical Primers to bootstrap contributor knowledge
  259. */
  260. /** @file
  261. This file contains the @ref thelist page.
  262. */