aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorbarthess <barthess@yandex.ru>2016-12-11 15:11:41 +0300
committerPaul Fertser <fercerpav@gmail.com>2018-01-13 09:13:14 +0000
commitdc28a6e593cc53117ba9b8e6e7ab9d20f49c5e4b (patch)
treee2a1e5936832b4201c091fbf38d79d9c2a0b1799 /doc
parent99b03d3bfbde879f07b02990c9d8bec3b0ee3927 (diff)
downloadriscv-openocd-dc28a6e593cc53117ba9b8e6e7ab9d20f49c5e4b.zip
riscv-openocd-dc28a6e593cc53117ba9b8e6e7ab9d20f49c5e4b.tar.gz
riscv-openocd-dc28a6e593cc53117ba9b8e6e7ab9d20f49c5e4b.tar.bz2
XCF (Xilinx platfrom flash) support.
Change-Id: I4ee6db5f0abdb9fd279cc0edd13f71952a9d295d Signed-off-by: Uladzimir Pylinski <barthess@yandex.ru> Reviewed-on: http://openocd.zylin.com/3914 Tested-by: jenkins Reviewed-by: Paul Fertser <fercerpav@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index 8ff9010..7f5b72e 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -4926,6 +4926,52 @@ flash bank $_FLASHNAME spi 0x0 0 0 0 \
@end example
@end deffn
+@deffn {Flash Driver} xcf
+@cindex Xilinx Platform flash driver
+@cindex xcf
+Xilinx FPGAs can be configured from specialized flash ICs named Platform Flash.
+It is (almost) regular NOR flash with erase sectors, program pages, etc. The
+only difference is special registers controlling its FPGA specific behavior.
+They must be properly configured for successful FPGA loading using
+additional @var{xcf} driver command:
+
+@deffn Command {xcf ccb} <bank_id>
+command accepts additional parameters:
+@itemize
+@item @var{external|internal} ... selects clock source.
+@item @var{serial|parallel} ... selects serial or parallel data bus mode.
+@item @var{slave|master} ... selects slave of master mode for flash device.
+@item @var{40|20} ... selects clock frequency in MHz for internal clock
+in master mode.
+@end itemize
+@example
+xcf ccb 0 external parallel slave 40
+@end example
+All of them must be specified even if clock frequency is pointless
+in slave mode. If only bank id specified than command prints current
+CCB register value. Note: there is no need to write this register
+every time you erase/program data sectors because it stores in
+dedicated sector.
+@end deffn
+
+@deffn Command {xcf configure} <bank_id>
+Initiates FPGA loading procedure. Useful if your board has no "configure"
+button.
+@example
+xcf configure 0
+@end example
+@end deffn
+
+Additional driver notes:
+@itemize
+@item Only single revision supported.
+@item Driver automatically detects need of bit reverse, but
+only "bin" (raw binary, do not confuse it with "bit") and "mcs"
+(Intel hex) file types supported.
+@item For additional info check xapp972.pdf and ug380.pdf.
+@end itemize
+@end deffn
+
@deffn {Flash Driver} lpcspifi
@cindex NXP SPI Flash Interface
@cindex SPIFI