[doc] Document the requirement for OpenOCD 0.11
After a rather extensive release cycle the OpenOCD finally produced an
upstream stable release with RISC-V support. This allows us to switch
back to the normal upstream version of OpenOCD, which will soon also
appear in distribution.
CI is already using OpenOCD 0.11.0 (rc2 before, since today the final
0.11.0 release), giving us the confidence that what we document actually
works.
Signed-off-by: Philipp Wagner <phw@lowrisc.org>
diff --git a/doc/ug/getting_started_fpga.md b/doc/ug/getting_started_fpga.md
index 0d7539f..5c6d1ac 100644
--- a/doc/ug/getting_started_fpga.md
+++ b/doc/ug/getting_started_fpga.md
@@ -195,11 +195,10 @@
```console
$ cd $REPO_TOP
-$ /tools/openocd/bin/openocd -s util/openocd -f board/lowrisc-earlgrey-nexysvideo.cfg
+$ openocd -s util/openocd -f board/lowrisc-earlgrey-nexysvideo.cfg
```
-Note that you must use the [RISC-V fork of OpenOCD](https://github.com/riscv/riscv-openocd).
-See the [install instructions]({{< relref "install_instructions#openocd" >}}) for guidance on building OpenOCD.
+See the [install instructions]({{< relref "install_instructions#openocd" >}}) for guidance on installing OpenOCD.
To actually debug through OpenOCD, it must either be connected through telnet or GDB.
diff --git a/doc/ug/install_instructions/index.md b/doc/ug/install_instructions/index.md
index 2c224d1..57a9a34 100644
--- a/doc/ug/install_instructions/index.md
+++ b/doc/ug/install_instructions/index.md
@@ -53,7 +53,7 @@
* libftdi with development headers
* OpenSSL 1.0 or 1.1 with development headers
* libusb 1.0 (called libusbx in older distributions)
-* OpenOCD
+* OpenOCD 0.11.0
* [Verible](https://github.com/google/verible) {{< tool_version "verible" >}}
To synthesize and simulate the hardware components of OpenTitan multiple EDA tools are supported.
@@ -213,15 +213,17 @@
OpenOCD is a tool to connect with the target chip over JTAG and similar transports.
It also provides a GDB server which is an "intermediate" when debugging software on the chip with GDB.
-Unfortunately the upstream sources of OpenOCD do not contain all necessary patches to support RISC-V, and hence typical distribution packages don't work.
-We therefore need to build OpenOCD from source from a forked repository.
+At least OpenOCD 0.11.0 is required.
-To build OpenOCD (this should be done outside the `$REPO_TOP` directory):
+It is recommended to use the regular upstream version of OpenOCD instead of the [RISC-V downstream fork](https://github.com/riscv/riscv-openocd).
+
+As most distributions do not yet include OpenOCD 0.11 in its package repositories building from source is likely to be required.
+The following steps build OpenOCD (this should be done outside the `$REPO_TOP` directory):
```console
-$ git clone https://github.com/riscv/riscv-openocd.git
-$ cd riscv-openocd
-$ ./bootstrap
+$ wget https://downloads.sourceforge.net/project/openocd/openocd/0.11.0/openocd-0.11.0.tar.bz2
+$ tar -xf openocd-0.11.0.tar.bz2
+$ cd openocd-0.11.0/
$ mkdir build
$ cd build
$ ../configure --enable-ftdi --enable-verbose-jtag-io --disable-vsllink --enable-remote-bitbang --prefix=/tools/openocd
