1 /** @page jtagdocs JTAG APIs
3 For new developers unfamiliar with the technology, @ref primerjtag provides
4 a brief introduction to the IEEE JTAG interface.
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.
13 - @b public API routines
14 - declared in @c src/jtag/jtag.h
15 - used by other modules
18 - @b private command queue API
19 - declared in @c src/jtag/commands.h
20 - provides routines used internally by the full JTAG drivers.
23 - @b private interface driver API
24 - declared in @c src/jtag/interface.h
25 - used by the core, minidrivers, and the full interface device drivers.
26 - allows implementing new interface device drivers.
27 - includes the Cable/TAP API (commands starting with @c tap_)
30 - @b private minidriver API
31 - declared in @c src/jtag/minidriver.h
32 - used @a only by the core and minidriver implementations:
33 - @c jtag_driver.c (in-tree OpenOCD drivers)
34 - @c zy1000/build/include/jtag_minidriver.h (ZY1000 minidriver)
35 - future implementations (on other embedded hosts)
36 - interface device drivers do @b not need this API.
40 /** @page jtagcore JTAG Core API
42 This section needs to be expanded.
46 /** @page jtagcmd JTAG Command API
48 This section needs to be expanded.
52 /** @page jtagiface JTAG Interface API
54 This section needs to be expanded.
58 /** @page jtagdriver JTAG Minidriver API
60 This section needs to be expanded.