git.gag.com Git - fw/openocd/blob - doc/manual/jtag.txt

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