summaryrefslogtreecommitdiff
path: root/doc/manual/target.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/target.txt')
-rw-r--r--doc/manual/target.txt51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/manual/target.txt b/doc/manual/target.txt
new file mode 100644
index 00000000..26f77084
--- /dev/null
+++ b/doc/manual/target.txt
@@ -0,0 +1,51 @@
+/** @page targetdocs OpenOCD Target APIs
+
+OpenOCD provides its Target APIs to allow developers to provide trace and
+debugging support for specific device targets. These primarily consist of
+ARM cores, but other types have been supported. New targets should be
+developed by following or using these APIs.
+
+The Target Support module contains APIs that cover several functional areas:
+
+ - @subpage targetarm
+ - @subpage targetnotarm
+ - @subpage targetregister
+ - @subpage targetimage
+ - @subpage targettrace
+
+This section needs to be expanded.
+
+*/
+
+/** @page targetarm OpenOCD ARM Targets
+
+This section needs to describe OpenOCD's ARM target support.
+
+ */
+
+/** @page targetnotarm OpenOCD Non-ARM Targets
+
+This section needs to describe OpenOCD's non-ARM target support.
+
+ */
+
+/** @page targetregister OpenOCD Target Register API
+
+This section needs to describe OpenOCD's Target Register API, as
+provided by 'src/target/register.h'.
+
+ */
+
+/** @page targetimage OpenOCD Target Image API
+
+This section needs to describe OpenOCD's Target Image API, as provided
+by 'src/target/image.h'.
+
+ */
+
+/** @page targettrace OpenOCD Target Trace API
+
+This section needs to describe OpenOCD's Target Trace API, as provided
+by 'src/target/trace.h'.
+
+ */