OpenOCD
|
▼OpenOCD Technical Primers | This pages lists Technical Primers available for OpenOCD Developers |
▼OpenOCD Documentation Primers | This page provides an introduction to OpenOCD's documentation processes |
Texinfo Primer | The OpenOCD User's Guide presently exists entirely within the doc/openocd.texi document |
LaTeX Primer | The OpenOCD project provides a number of reference guides using the LaTeX typesetting language |
Doxygen Primer | Doxygen-style comments are used to provide documentation in-line with the OpenOCD source code |
OpenOCD Autotools Primer | This page provides an overview to OpenOCD's use of the GNU autotool suite: |
▼OpenOCD TCL Primer | The Scripting Overview page provides additional TCL Primer material |
Scripting Overview | |
▼OpenOCD JTAG Primer | JTAG is unnecessarily confusing, because JTAG is often confused with boundary scan, which is just one of its possible functions |
JTAG Boundary Scan Primer | The following page provides an introduction on JTAG that focuses on its boundary scan capabilities: |
Command Development Primer | This page provides a primer for writing commands by introducing hello module |
▼OpenOCD Architecture | The OpenOCD library consists of several APIs that build together to provide the support functionality |
▼OpenOCD Helper APIs | OpenOCD uses several low-level APIs as the foundation for high-level APIs: |
OpenOCD Types/Portability APIs | This section needs to be expanded to describe OpenOCD's type and portability API |
OpenOCD Jim API | The Jim API provides access to a small-footprint TCL implementation |
OpenOCD Command API | OpenOCD's command API allows modules to register callbacks that are then available to the scripting services |
OpenOCD Logging API | This section needs to be expanded to describe OpenOCD's Logging API |
OpenOCD Byte Buffer API | This section needs to be expanded to describe OpenOCD's Byte Buffer API |
▼JTAG APIs | For new developers unfamiliar with the technology, OpenOCD JTAG Primer provides a brief introduction to the IEEE JTAG interface |
JTAG Core API | This section needs to be expanded |
JTAG TCL API | This section needs to be expanded |
JTAG Command API | This section needs to be expanded |
JTAG Interface API | This section needs to be expanded |
JTAG Minidriver API | This section needs to be expanded |
▼OpenOCD Target APIs | OpenOCD provides its Target APIs to allow developers to provide trace and debugging support for specific device targets |
OpenOCD ARM Targets | This section needs to describe OpenOCD's ARM target support |
OpenOCD Non-ARM Targets | This page describes outstanding issues w.r.t |
OpenOCD MIPS Targets | |
OpenOCD Target Register API | This section needs to describe OpenOCD's Target Register API, as provided by 'src/target/register.h' |
OpenOCD Target Image API | This section needs to describe OpenOCD's Target Image API, as provided by 'src/target/image.h' |
OpenOCD Target Trace API | This section needs to describe OpenOCD's Target Trace API, as provided by 'src/target/trace.h' |
▼OpenOCD Flash APIs | OpenOCD 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 |
OpenOCD CFI Flash API | This section needs to be expanded to describe OpenOCD's CFI Flash API |
OpenOCD NAND Flash API | This section needs to be expanded to describe OpenOCD's NAND Flash API |
OpenOCD Target Flash API | This section needs to be expanded to describe OpenOCD's Target Flash API |
▼OpenOCD Server APIs | OpenOCD provides support for implementing different types of servers |
OpenOCD GDB Server API | This section needs to be expanded |
OpenOCD Telnet Server API | This section needs to be expanded |
OpenOCD http Server API | This section needs to be expanded |
OpenOCD Application APIs | The top-level APIs in the OpenOCD library allow applications to integrate all of the low-level functionality using a set of simple function calls |
Pending and Open Tasks | This page lists pending and open tasks being considered or worked upon by the OpenOCD community |
JTAG Mini-Driver | The 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 |