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.
 
 
 
 
 
 

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