OpenOCD
Related Pages
Here is a list of all related documentation pages:
[detail level 123]
oOpenOCD Technical PrimersThis pages lists Technical Primers available for OpenOCD Developers
|oOpenOCD Documentation PrimersThis page provides an introduction to OpenOCD's documentation processes
||oTexinfo PrimerThe OpenOCD User's Guide presently exists entirely within the doc/openocd.texi document
||oLaTeX PrimerThe OpenOCD project provides a number of reference guides using the LaTeX typesetting language
||\Doxygen PrimerDoxygen-style comments are used to provide documentation in-line with the OpenOCD source code
|oOpenOCD Autotools PrimerThis page provides an overview to OpenOCD's use of the GNU autotool suite:
|oOpenOCD TCL PrimerThe
||\Scripting Overview
|oOpenOCD JTAG PrimerJTAG is unnecessarily confusing, because JTAG is often confused with boundary scan, which is just one of its possible functions
||\JTAG Boundary Scan PrimerThe following page provides an introduction on JTAG that focuses on its boundary scan capabilities:
|\Command Development PrimerThis page provides a primer for writing commands by introducing hello module
oOpenOCD ArchitectureThe OpenOCD library consists of several APIs that build together to provide the support functionality
|oOpenOCD Helper APIsOpenOCD uses several low-level APIs as the foundation for high-level APIs:
||oOpenOCD Types/Portability APIsThis section needs to be expanded to describe OpenOCD's type and portability API
||oOpenOCD Jim APIThe Jim API provides access to a small-footprint TCL implementation
||oOpenOCD Command APIOpenOCD's command API allows modules to register callbacks that are then available to the scripting services
||oOpenOCD Logging APIThis section needs to be expanded to describe OpenOCD's Logging API
||\OpenOCD Byte Buffer APIThis section needs to be expanded to describe OpenOCD's Byte Buffer API
|oJTAG APIsFor new developers unfamiliar with the technology, OpenOCD JTAG Primer provides a brief introduction to the IEEE JTAG interface
||oJTAG Core APIThis section needs to be expanded
||oJTAG TCL APIThis section needs to be expanded
||oJTAG Command APIThis section needs to be expanded
||oJTAG Interface APIThis section needs to be expanded
||\JTAG Minidriver APIThis section needs to be expanded
|oOpenOCD Target APIsOpenOCD provides its Target APIs to allow developers to provide trace and debugging support for specific device targets
||oOpenOCD ARM TargetsThis section needs to describe OpenOCD's ARM target support
||oOpenOCD Non-ARM TargetsThis page describes outstanding issues w.r.t
||oOpenOCD MIPS Targets
||oOpenOCD Target Register APIThis section needs to describe OpenOCD's Target Register API, as provided by 'src/target/register.h'
||oOpenOCD Target Image APIThis section needs to describe OpenOCD's Target Image API, as provided by 'src/target/image.h'
||\OpenOCD Target Trace APIThis section needs to describe OpenOCD's Target Trace API, as provided by 'src/target/trace.h'
|oOpenOCD Flash APIsOpenOCD provides its Flash APIs for developers to support different types of flash devices, some of which are built-in to target devices while others may be connected via standard memory interface (e.g
||oOpenOCD CFI Flash APIThis section needs to be expanded to describe OpenOCD's CFI Flash API
||oOpenOCD NAND Flash APIThis section needs to be expanded to describe OpenOCD's NAND Flash API
||\OpenOCD Target Flash APIThis section needs to be expanded to describe OpenOCD's Target Flash API
|oOpenOCD Server APIsOpenOCD provides support for implementing different types of servers
||oOpenOCD GDB Server APIThis section needs to be expanded
||oOpenOCD Telnet Server APIThis section needs to be expanded
||\OpenOCD http Server APIThis section needs to be expanded
|\OpenOCD Application APIsThe top-level APIs in the OpenOCD library allow applications to integrate all of the low-level functionality using a set of simple function calls
oPending and Open TasksThis page lists pending and open tasks being considered or worked upon by the OpenOCD community
oJTAG Mini-DriverThe JTAG minidriver interface allows the definition of alternate interface functions, instead of the built-in asynchronous driver module that is used by the standard JTAG interface drivers
\Todo List