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.
 
 
 
 
 
 

74 lines
1.9 KiB

  1. /** @page jtagdocs JTAG APIs
  2. For new developers unfamiliar with the technology, @ref primerjtag provides
  3. a brief introduction to the IEEE JTAG interface.
  4. The OpenOCD JTAG library API covers several functional areas. The jtag
  5. @b core communicates through the @b minidriver API with either its full
  6. @a driver implementation (src/jtag/jtag_driver.c) or a @a minidriver .
  7. Internally, the @b command API is used by the JTAG driver for managing
  8. asynchronous transactions.
  9. - @subpage jtagcore
  10. - @b public API routines
  11. - declared in @c src/jtag/jtag.h
  12. - used by other modules
  13. - @subpage jtagtcl
  14. - @b private TCL handling routines
  15. - defined in @c src/jtag/tcl.c
  16. - registers and handles Jim commands that configure and use the JTAG core
  17. - @subpage jtagcmd
  18. - @b private command queue API
  19. - declared in @c src/jtag/commands.h
  20. - provides routines used internally by the full JTAG drivers.
  21. - @subpage jtagiface
  22. - @b private interface driver API
  23. - declared in @c src/jtag/interface.h
  24. - used by the core, minidrivers, and the full interface device drivers.
  25. - allows implementing new interface device drivers.
  26. - includes the Cable/TAP API (commands starting with @c tap_)
  27. - @subpage jtagdriver
  28. - @b private minidriver API
  29. - declared in @c src/jtag/minidriver.h
  30. - used @a only by the core and minidriver implementations:
  31. - @c jtag_driver.c (in-tree OpenOCD drivers)
  32. - @c zy1000/build/include/jtag_minidriver.h (ZY1000 minidriver)
  33. - future implementations (on other embedded hosts)
  34. - interface device drivers do @b not need this API.
  35. */
  36. /** @page jtagcore JTAG Core API
  37. This section needs to be expanded.
  38. */
  39. /** @page jtagtcl JTAG TCL API
  40. This section needs to be expanded.
  41. */
  42. /** @page jtagcmd JTAG Command API
  43. This section needs to be expanded.
  44. */
  45. /** @page jtagiface JTAG Interface API
  46. This section needs to be expanded.
  47. */
  48. /** @page jtagdriver JTAG Minidriver API
  49. This section needs to be expanded.
  50. */