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.
 
 
 
 
 
 

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