docs: update cli documentation to refer to cynthion rather than apollo

greatscottgadgets · May 23, 2024 · e434c3f · e434c3f
1 parent 1ba7816
commit e434c3f
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 38 deletions.
diff --git a/docs/source/developer/apollo.rst b/docs/source/developer/apollo.rst
diff --git a/docs/source/developer/cli.rst b/docs/source/developer/cli.rst
@@ -0,0 +1,40 @@
+========================
+The ``cynthion`` Utility
+========================
+
+The ``cynthion`` distribution provides the ``cynthion`` command-line utility,
+that can be used to perform various simple functions useful in development;
+including simple JTAG operations, SVF playback, manipulating the board’s flash,
+and debug comms.
+
+.. code:: text
+
+    $ cynthion
+    usage: cynthion [-h] command ...
+
+    Cynthion FPGA Configuration / Debug tool
+
+    positional arguments:
+      command
+        info                Print device info.
+        jtag-scan           Prints information about devices on the onboard JTAG chain.
+        flash-info          Prints information about the FPGA's attached configuration flash.
+        flash-erase         Erases the contents of the FPGA's flash memory.
+        flash-program (flash)
+                            Programs the target bitstream onto the FPGA's configuration flash.
+        flash-fast          Programs a bitstream onto the FPGA's configuration flash using a SPI bridge
+        flash-read          Reads the contents of the attached FPGA's configuration flash.
+        svf                 Plays a given SVF file over JTAG.
+        configure           Uploads a bitstream to the device's FPGA over JTAG.
+        reconfigure         Requests the attached ECP5 reconfigure itself from its SPI flash.
+        force-offline       Forces the board's FPGA offline.
+        spi                 Sends the given list of bytes over debug-SPI, and returns the response.
+        spi-inv             Sends the given list of bytes over SPI with inverted CS.
+        spi-reg             Reads or writes to a provided register over the debug-SPI.
+        jtag-spi            Sends the given list of bytes over SPI-over-JTAG, and returns the response.
+        jtag-reg            Reads or writes to a provided register of JTAG-tunneled debug SPI.
+        leds                Sets the specified pattern for the Debug LEDs.
+        selftest            Run a hardware self-test on a connected Cynthion.
+
+    optional arguments:
+      -h, --help            show this help message and exit
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -16,7 +16,7 @@ Cynthion Host Software Installation
 
 You can install the Cynthion host software from the `Python Package Index (PyPI) <https://pypi.org/project/cynthion/>`__ or :doc:`directly from source <developer/introduction>`.
 
-Install the Cynthion host software from PyPI using the `pip <https://pypi.org/project/pip/>`__ tool:
+To install the GreatFET host software from PyPI using the `pip <https://pypi.org/project/pip/>`__ tool:
 
 .. code-block :: sh
 
@@ -74,6 +74,6 @@ If everything is working you will see the following output:
 
 .. code-block :: text
 
-   Detected a Cynthion device!
-       Hardware: Cynthion r1.4
-       Serial number: <snip>
+    Detected a Cynthion device!
+        Hardware: Cynthion r1.4
+        Serial number: <snip>
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -38,4 +38,4 @@ Cynthion Documentation
   developer/introduction
   developer/bitstream_generation
   developer/soc_firmware_compilation
-  developer/apollo
+  developer/cli