From: Paul Fertser <fercerpav@gmail.com>
Date: Sat, 24 Jan 2015 10:42:00 +0000 (+0300)
Subject: doc: add stm32lx mass_erase description
X-Git-Tag: v0.9.0-rc1~159
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=97c96ac13ff2d900345b71e12d1ac5c22417832f;p=openocd

doc: add stm32lx mass_erase description

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

diff --git a/doc/openocd.texi b/doc/openocd.texi
index c5975c9d..a97ad856 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -5562,6 +5562,15 @@ the flash driver.
 @example
 flash bank $_FLASHNAME stm32lx 0 0x20000 0 0 $_TARGETNAME
 @end example
+
+Some stm32lx-specific commands are defined:
+
+@deffn Command {stm32lx mass_erase} num
+Mass erases the entire stm32lx device (all flash banks and EEPROM
+data). This is the only way to unlock a protected flash (unless RDP
+Level is 2 which can't be unlocked at all).
+The @var{num} parameter is a value shown by @command{flash banks}.
+@end deffn
 @end deffn
 
 @deffn {Flash Driver} str7x