summaryrefslogtreecommitdiff
path: root/doc/manual/flash.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manual/flash.txt')
-rw-r--r--doc/manual/flash.txt35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/manual/flash.txt b/doc/manual/flash.txt
new file mode 100644
index 00000000..dbc4b94b
--- /dev/null
+++ b/doc/manual/flash.txt
@@ -0,0 +1,35 @@
+/** @page flashdocs 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. CFI,
+FMI, etc.).
+
+The Flash module provides the following APIs:
+
+ - @subpage flashcfi
+ - @subpage flashnand
+ - @subpage flashtarget
+
+This section needs to be expanded.
+
+*/
+
+
+/** @page flashcfi OpenOCD CFI Flash API
+
+This section needs to be expanded to describe OpenOCD's CFI Flash API.
+
+*/
+
+/** @page flashnand OpenOCD NAND Flash API
+
+This section needs to be expanded to describe OpenOCD's NAND Flash API.
+
+*/
+
+/** @page flashtarget OpenOCD Target Flash API
+
+This section needs to be expanded to describe OpenOCD's Target Flash API.
+
+*/