From: Paul Fertser <fercerpav@gmail.com>
Date: Tue, 3 Feb 2015 21:49:42 +0000 (+0300)
Subject: doc: document the OCL (on chip flash loader) driver
X-Git-Tag: v0.9.0-rc1~146
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=7f000f824bb405d3985256b123f3e4b55dc43b6b;p=openocd

doc: document the OCL (on chip flash loader) driver

Change-Id: I8afe870c7a16b04473f4822c2df9a7607f0480e7
Signed-off-by: Paul Fertser <fercerpav@gmail.com>
Reviewed-on: http://openocd.zylin.com/2529
Tested-by: jenkins
Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
---

diff --git a/doc/openocd.texi b/doc/openocd.texi
index 95c20541..9f975393 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -5409,7 +5409,13 @@ lpc2900 secure_jtag 0
 @end deffn
 
 @deffn {Flash Driver} ocl
-@emph{No idea what this is, other than using some arm7/arm9 core.}
+This driver is an implementation of the ``on chip flash loader''
+protocol proposed by Pavel Chromy.
+
+It is a minimalistic command-response protocol intended to be used
+over a DCC when communicating with an internal or external flash
+loader running from RAM. An example implementation for AT91SAM7x is
+available in @file{contrib/loaders/flash/at91sam7x/}.
 
 @example
 flash bank $_FLASHNAME ocl 0 0 0 0 $_TARGETNAME