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.
 
 
 
 
 
 

381 lines
16 KiB

  1. // This file is part of the Doxygen 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 variable 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. - Improve autodetection of TAPs by supporting tcl escape procedures that
  42. can configure discovered TAPs based on IDCODE value ... they could:
  43. - Remove guessing for irlen
  44. - Allow non-default irmask/ircapture values
  45. - SPI/UART emulation:
  46. - (ab)use bit-banging JTAG interfaces to emulate SPI/UART
  47. - allow SPI to program flash, MCUs, etc.
  48. @subsection thelistjtaginterfaces JTAG Interfaces
  49. There are some known bugs to fix in JTAG adapter drivers:
  50. - For JTAG_STATEMOVE to TAP_RESET, all drivers must ignore the current
  51. recorded state. The tap_get_state() call won't necessarily return
  52. the correct value, especially at server startup. Fix is easy: in
  53. that case, always issue five clocks with TMS high.
  54. - amt_jtagaccel.c
  55. - arm-jtag-ew.c
  56. - bitbang.c
  57. - bitq.c
  58. - gw16012.c
  59. - jlink.c
  60. - usbprog.c
  61. - vsllink.c
  62. - rlink/rlink.c
  63. - bug: USBprog is broken with new tms sequence; it needs 7-clock cycles.
  64. Fix promised from Peter Denison openwrt at marshadder.org
  65. Workaround: use "tms_sequence long" @par
  66. https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html
  67. The following tasks have been suggested for improving OpenOCD's JTAG
  68. interface support:
  69. - rework USB communication to be more robust. Two possible options are:
  70. -# use libusb-1.0.1 with libusb-compat-0.1.1 (non-blocking I/O wrapper)
  71. -# rewrite implementation to use non-blocking I/O
  72. - J-Link driver:
  73. - fix to work with long scan chains, such as R.Doss's svf test.
  74. - FT2232 (libftdi):
  75. - make performance comparable to alternatives (on Win32, D2XX is faster)
  76. - make usability comparable to alternatives
  77. - Autodetect USB based adapters; this should be easy on Linux. If there's
  78. more than one, list the options; otherwise, just select that one.
  79. The following tasks have been suggested for adding new JTAG interfaces:
  80. - TCP driver: allow client/server for remote JTAG interface control.
  81. This requires a client and a server. The server is built into the
  82. normal OpenOCD and takes commands from the client and executes
  83. them on the interface returning the result of TCP/IP. The client
  84. is an OpenOCD which is built with a TCP/IP minidriver. The use
  85. of a minidriver is required to capture all the jtag_add_xxx()
  86. fn's at a high enough level and repackage these cmd's as
  87. TCP/IP packets handled by the server.
  88. @section thelistswd Serial Wire Debug
  89. - implement Serial Wire Debug interface
  90. @section thelistbs Boundary Scan Support
  91. - add STAPL support?
  92. - add BSDL support?
  93. A few possible options for the above:
  94. -# Fake a TCL equivalent?
  95. -# Integrate an existing library?
  96. -# Write a new C implementation a la Jim?
  97. Once the above are completed:
  98. - add support for programming flash using boundary scan techniques
  99. - add integration with a modified gerber view program:
  100. - provide means to view the PCB and select pins and traces
  101. - allow use-cases such as the following:
  102. - @b Stimulus
  103. -# Double-click on a pin (or trace) with the mouse.
  104. - @b Effects
  105. -# The trace starts blinking, and
  106. -# OpenOCD toggles the pin(s) 0/1.
  107. @section thelisttargets Target Support
  108. - Many common ARM cores could be autodetected using IDCODE
  109. - general layer cleanup: @par
  110. https://lists.berlios.de/pipermail/openocd-development/2009-May/006590.html
  111. - regression: "reset halt" between 729(works) and 788(fails): @par
  112. https://lists.berlios.de/pipermail/openocd-development/2009-July/009206.html
  113. - registers
  114. - add flush-value operation, call them all on resume/reset
  115. - mcr/mrc target->type support
  116. - missing from ARM920t, ARM966e, XScale.
  117. It's possible that the current syntax is unable to support read-modify-write
  118. operations(see arm966e).
  119. - mcr/mrc - retire cp15 commands when there the mrc/mrc commands have been
  120. tested from: arm926ejs, arm720t, cortex_a8
  121. - ARM7/9:
  122. - clean up "arm9tdmi vector_catch". Available for some arm7 cores? @par
  123. https://lists.berlios.de/pipermail/openocd-development/2009-October/011488.html
  124. https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html
  125. - add reset option to allow programming embedded ice while srst is asserted.
  126. Some CPUs will gate the JTAG clock when srst is asserted and in this case,
  127. it is necessary to program embedded ice and then assert srst afterwards.
  128. - ARM926EJS:
  129. - reset run/halt/step is not robust; needs testing to map out problems.
  130. - ARM11 improvements (MB?)
  131. - add support for asserting srst to reset the core.
  132. - Single stepping works, but should automatically
  133. use hardware stepping if available.
  134. - mdb can return garbage data if read byte operation fails for
  135. a memory region(16 & 32 byte access modes may be supported). Is this
  136. a bug in the .MX31 PDK init script? Try on i.MX31 PDK:
  137. mdw 0xb80005f0 0x8, mdh 0xb80005f0 0x10, mdb 0xb80005f0 0x20. mdb returns
  138. garabage.
  139. - implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
  140. - Thumb2 single stepping: ARM1156T2 needs simulator support
  141. - Cortex A8 support (ML)
  142. - add target implementation (ML)
  143. - Cortex M3 support
  144. - when stepping, only write dirtied registers (be faster)
  145. - when connecting to halted core, fetch registers (startup is quirky)
  146. - Generic ARM run_algorithm() interface
  147. - tagged struct wrapping ARM instructions and metadata
  148. - not revision-specific (current: ARMv4+ARMv5 -or- ARMv6 -or- ARMv7)
  149. - usable with at least arm_nandwrite() and generic CFI drivers
  150. - ETM
  151. - don't show FIFOFULL registers if they're not supported
  152. - use comparators to get more breakpoints and watchpoints
  153. - add "etm drivers" command
  154. - trace driver init() via examine() paths only, not setup()/reset
  155. - MC1322x support (JW/DE?)
  156. - integrate and test support from JW (and DE?)
  157. - get working with a known good interface (i.e. not today's jlink)
  158. - AT91SAM92xx:
  159. - improvements for unknown-board-atmel-at91sam9260.cfg (RD)
  160. - STR9x: (ZW)
  161. - improvements to str912.cfg to be more general purpose
  162. - AVR: (SQ)
  163. - independently verify implementation
  164. - incrementally improve working prototype in trunk. (SQ)
  165. - work out how to debug this target
  166. - AVR debugging protocol.
  167. - FPGA:
  168. - Altera Nios Soft-CPU support
  169. - Coldfire (suggested by NC)
  170. - can we draw from the BDM project? @par
  171. http://bdm.sourceforge.net/
  172. or the OSBDM package @par
  173. http://forums.freescale.com/freescale/board/message?board.id=OSBDM08&thread.id=422
  174. @section thelistsvf SVF/XSVF
  175. - develop SVF unit tests
  176. - develop XSVF unit tests
  177. @section thelistflash Flash Support
  178. - finish documentation for the following flash drivers:
  179. - avr
  180. - pic32mx
  181. - ocl
  182. - str9xpec
  183. - Don't expect writing all-ones to be a safe way to write without
  184. changing bit values. Minimally it loses on flash modules with
  185. internal ECC, where it may change the ECC.
  186. - NOR flash_write_unlock() does that between sectors
  187. - there may be other cases too
  188. - Make sure all commands accept either a bank name or a bank number,
  189. and be sure both identifiers show up in "flash banks" and "nand list".
  190. Right now the user-friendly names are pretty much hidden...
  191. @subsection thelistflashcfi CFI
  192. - finish implementing bus width/chip width handling (suggested by NC)
  193. - factor vendor-specific code into separate source files
  194. - add new callback interface for vendor-specific code
  195. - investigate/implement "thin wrapper" to use eCos CFI drivers (ØH)
  196. @section thelistdebug Debugger Support
  197. - add support for masks in watchpoints? @par
  198. https://lists.berlios.de/pipermail/openocd-development/2009-October/011507.html
  199. - breakpoints can get lost in some circumstances: @par
  200. https://lists.berlios.de/pipermail/openocd-development/2009-June/008853.html
  201. - add support for masks in watchpoints. The trick is that GDB does not
  202. support a breakpoint mask in the remote protocol. One way to work around
  203. this is to add a separate command "watchpoint_mask add/rem <addr> <mask>", that
  204. is run to register a list of masks that the gdb_server knows to use with
  205. a particular watchpoint address.
  206. - integrate Keil AGDI interface to OpenOCD? (submitted by Dario Vecchio)
  207. @section thelisttesting Testing Suite
  208. This section includes several related groups of ideas:
  209. - @ref thelistunittests
  210. - @ref thelistsmoketests
  211. - @ref thelisttestreports
  212. - @ref thelisttestgenerichw
  213. @subsection thelistunittests Unit Tests
  214. - add testing skeleton to provide frameworks for adding tests
  215. - implement server unit tests
  216. - implement JTAG core unit tests
  217. - implement JTAG interface unit tests
  218. - implement flash unit tests
  219. - implement target unit tests
  220. @subsection thelistsmoketests Smoke Test Tools
  221. -# extend 'make check' with a smoketest app
  222. - checks for OOCD_TEST_CONFIG, etc. in environment (or config file)
  223. - if properly set, runs the smoke test with specified parameters
  224. - openocd -f ${OOCD_TEST_CONFIG}
  225. - implies a modular test suite (see below)
  226. - should be able to run some minimal tests with dummy interface:
  227. - compare results of baseline sanity checks with expected results
  228. -# builds a more complete test suite:
  229. - existing testing/examples/ look like a great start
  230. - all targets should be tested fully and for all capabilities
  231. - we do NOT want a "lowest common denominator" test suite
  232. - ... but can we start with one to get going?
  233. - probably requires one test configuration file per board/target
  234. - modularization can occur here, just like with targets/boards/chips
  235. - coverage can increase over time, building up bundles of tests
  236. -# add new 'smoketest' Makefile target:
  237. - calls 'make check' (and the smoketest app)
  238. - gather inputs and output into a report file
  239. @subsection thelisttestreports Test Feedback Tools
  240. These ideas were first introduced here: @par
  241. https://lists.berlios.de/pipermail/openocd-development/2009-May/006358.html
  242. - provide report submission scripts for e-mail and web forms
  243. - add new Makefile targets to post the report:
  244. - 'checkreportsend' -- send to list via e-mail (via sendmail)
  245. - 'checkreportpost' -- send web form (via curl or other script)
  246. @subsection thelisttestgenerichw Generic Hardware Tester
  247. - implement VHDL to use for FPGA-based JTAG TAP testing device
  248. - develop test suite that utilizes this testing device
  249. @section thelistautotools Autotools Build System
  250. - make entire configure process require less user consideration:
  251. - automatically detect the features that are available, unless
  252. options were specifically provided to configure
  253. - provide a report of the drivers that will be build at the end of
  254. running configure, so the users can verify which drivers will be
  255. built during 'make' (and their options) .
  256. - eliminate sources of confusion in @c bootstrap script:
  257. -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
  258. -# Add @c buildstrap script to assist with bootstrap and configure steps.
  259. - automatically build tool-chains required for cross-compiling
  260. - produce mingw32, arm-elf, others using in-tree scripts
  261. - build all required target code from sources
  262. - make JTAG and USB debug output a run-time configuration option
  263. @section thelistarchitecture Architectural Tasks
  264. The following architectural tasks need to be accomplished and should be
  265. fairly easy to complete:
  266. - use dynamic allocations for working memory. Scan & fix code
  267. for excessive stack allocations. take linux/scripts/checkstack.pl and
  268. see what the worst offenders are. Dynamic stack allocations are found
  269. at the bottom of the list below. Example, on amd64:
  270. $ objdump -d | checkstack.pl | head -10
  271. 0x004311e3 image_open [openocd]: 13464
  272. 0x00431301 image_open [openocd]: 13464
  273. 0x004237a4 target_array2mem [openocd]: 4376
  274. 0x0042382b target_array2mem [openocd]: 4376
  275. 0x00423e74 target_mem2array [openocd]: 4360
  276. 0x00423ef9 target_mem2array [openocd]: 4360
  277. 0x00404aed handle_svf_command [openocd]: 2248
  278. 0x00404b7e handle_svf_command [openocd]: 2248
  279. 0x00413581 handle_flash_fill_command [openocd]: 2200
  280. 0x004135fa handle_flash_fill_command [openocd]: 2200
  281. - clean-up code to match style guides
  282. - factor code to eliminate duplicated functionality
  283. - rewrite code that uses casts to access 16-bit and larger types
  284. from unaligned memory addresses
  285. - libopenocd support: @par
  286. https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
  287. - review and clean up interface/target/flash APIs
  288. The following strategic tasks will require ambition, knowledge, and time
  289. to complete:
  290. - overhaul use of types to improve 32/64-bit portability
  291. - types for both host and target word sizes?
  292. - can we use GDB's CORE_TYPE support?
  293. - Allow N:M:P mapping of servers, targets, and interfaces
  294. - loadable module support for interface/target/flash drivers and commands
  295. - support both static and dynamic modules.
  296. - should probably use libltdl for dynamic library handing.
  297. @section thelistadmin Documentation Tasks
  298. - Develop milestone and release guidelines, processes, and scripts.
  299. - Develop "style" guidelines (and scripts) for maintainers:
  300. - reviewing patches
  301. - committing to git
  302. - Review Users' Guide for documentation errors or omissions
  303. - "capture" and "ocd_find" commands
  304. - "ocd_" prefix on various stuff
  305. - Update Developer's Manual (doxygen output)
  306. - Add documentation describing the architecture of each module
  307. - Provide more Technical Primers to bootstrap contributor knowledge
  308. */
  309. /** @file
  310. This file contains the @ref thelist page.
  311. */