doc: add stm32lx mass_erase description
authorPaul Fertser <fercerpav@gmail.com>
Sat, 24 Jan 2015 10:42:00 +0000 (13:42 +0300)
committerSpencer Oliver <spen@spen-soft.co.uk>
Wed, 4 Feb 2015 22:02:36 +0000 (22:02 +0000)
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>
doc/openocd.texi

index c5975c9d3fc8f381f7777b83c345ad13e91d89a5..a97ad85679034fa6f46cbf4cd179d763c4dbe214 100644 (file)
@@ -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