From e440b0648fd5a9ced8b3a05ff1a73b17c00cd144 Mon Sep 17 00:00:00 2001 From: Ryan QIAN Date: Mon, 27 Jan 2025 12:06:50 +0800 Subject: [PATCH] doc: add hpm_xpi flash driver description - add description for hpm_xpi flash driver Change-Id: I5336c11c8dbe5ab646d08e4e70aeef1ed6cbd970 Signed-off-by: Ryan QIAN Reviewed-on: https://review.openocd.org/c/openocd/+/8726 Tested-by: jenkins Reviewed-by: Tomas Vanek --- doc/openocd.texi | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/openocd.texi b/doc/openocd.texi index f623d716e..4c2956334 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -6225,6 +6225,22 @@ flash bank $_FLASHNAME cfi 0x00000000 0x02000000 2 4 $_TARGETNAME @c "cfi part_id" disabled @end deffn +@deffn {Flash Driver} {hpm_xpi} +All members of the HPMxxxx microcontroller family from HPMicro. +Additional parameters are required to configure the driver: @option{io_base} is +the base address of the configuration register interface, @option{opt0} and +@option{opt1} are the options for the flash. + +@example +flash bank $@{_FLASHNAME@}0 hpm_xpi base_address size_bytes 0 0 $_TARGETNAME \ + io_base opt0 opt1 +@end example + +@deffn {Command} {hpm_xpi mass_erase} bank_id +Erase all pages in data memory for the bank identified by @option{bank_id}. +@end deffn +@end deffn + @anchor{jtagspi} @deffn {Flash Driver} {jtagspi} @cindex Generic JTAG2SPI driver