Skip to content

Commit

Permalink
docs: update docs with review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
antoinevg committed Jun 28, 2024
1 parent c4c0f31 commit db00e47
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 38 deletions.
4 changes: 2 additions & 2 deletions docs/source/developer/soc_firmware_compilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ Running Firmware Unit Tests

Once the firmware is running on the SoC you can execute some unittests to exercise the firmware.

In order to do this you will need to connect both the ``control`` and
``aux`` ports of the Cynthion to the host and then run:
In order to do this you will need to connect both the **CONTROL** and
**AUX** ports of the Cynthion to the host and then run:

.. code-block:: sh
Expand Down
9 changes: 5 additions & 4 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,8 @@ Connect Hardware
:width: 800
:alt: Connection diagram for testing Cynthion installation.

- Connect the Host computer to the Cynthion Control port.
- Connect the Host computer to the Cynthion **CONTROL** port.
- Check that the :ref:`LED A power-on indicator <introduction:Top View>` lights up.
- Check that the :ref:`LED E fault indicator <introduction:Top View>` remains off.


Test Hardware Connectivity
Expand All @@ -79,8 +78,10 @@ If everything is working you will see the following output:
Detected a Cynthion device!
Hardware: Cynthion r1.4
Serial number: <snip>
Serial number: xxxxxxxxxxxxxxxxxxxxxxxxxx
Firmware version: v1.0.4
USB API version: 1.1
Flash UID: xxxxxxxxxxxxxxxx
Upgrading Cynthion Host Software
Expand Down
6 changes: 2 additions & 4 deletions docs/source/getting_started_facedancer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ To put Cynthion back into analyzer mode you can run:
`cynthion program TODO`
TODO above may not be needed if we have unified gateware by release

You can verify that everything is working by running:

.. code-block :: sh
Expand All @@ -76,7 +74,7 @@ Connect Hardware
:width: 800
:alt: Connection diagram for using Cynthion with Facedancer.

Make sure that the target device is running a program that can receive keyboard input such as a terminal or text editor and that it has focus.
Make sure that the target host is running a program that can receive keyboard input such as a terminal or text editor and that it has focus.

Run a Facedancer example
------------------------
Expand All @@ -93,7 +91,7 @@ Open a terminal and run:
python ./rubber-ducky.py
If all goes well, you should see the string ``hello, facedancer`` typed into the target device.
If all goes well, you should see the string ``hello, facedancer`` typed into the target host.

More Information
----------------
Expand Down
6 changes: 3 additions & 3 deletions docs/source/getting_started_usbproxy.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
=============================
Using Cynthion with USB proxy
Using Cynthion with USB Proxy
=============================

Before proceeding, please ensure you have completed all steps in the :doc:`getting_started` and :doc:`getting_started_facedancer` sections.
Expand All @@ -14,8 +14,8 @@ Connect Hardware



Run a USBProxy example
----------------------
Run a USB Proxy example
-----------------------

Create a new Python file called ``usbproxy.py`` with the following content:

Expand Down
4 changes: 2 additions & 2 deletions docs/source/hardware/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Introduction
============

.. image:: ../../images/cynthion_hardware.png
:alt: TODO Cynthion PCB front (and back ?)
.. image:: ../../images/cynthion_hardware.jpg
:alt: Cynthion PCB (Front)


Cynthion Hardware
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Cynthion Documentation
======================

.. image:: ../images/cynthion.png
.. image:: ../images/cynthion.jpg
:width: 400
:alt: Cynthion

Expand Down
47 changes: 25 additions & 22 deletions docs/source/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Cynthion is an all-in-one tool for building, testing, monitoring, and experiment

Out-of-the-box, Cynthion acts as a USB protocol analyzer capable of capturing and analyzing traffic between a host and any Low-, Full-, or High-Speed ("USB 2.0") USB device. It works seamlessly with our `Packetry <https://github.com/greatscottgadgets/packetry>`__ open-source analysis software.

Combined with our `LUNA <https://luna.readthedocs.io>`__ gateware and `Facedancer <https://facedancer.readthedocs.io>`__ libraries, Cynthion becomes a versatile USB-hacking and development tool. Facedancer makes it quick and easy to create or tamper with real USB devices—not just emulations—even if you don’t have experience with digital-hardware design, HDL, or FPGA architecture!
Combined with our `LUNA <https://luna.readthedocs.io>`__ gateware and `Facedancer <https://facedancer.readthedocs.io>`__ libraries, Cynthion becomes a versatile USB-hacking and development tool. Facedancer makes it quick and easy to create or tamper with real USB devices—not just emulations—even if you don’t have experience with digital hardware design, HDL, or FPGA architecture!


Device Overview
Expand All @@ -23,13 +23,15 @@ Top View
:width: 300
:alt: Cynthion Top View

- **LEDS A-E** - Five status LEDs managed by the debug micro-contoller.
- **A-E** - Five status LEDs managed by the debug microcontoller.

- **A** - Power Indicator.
- **B** - FPGA is online.
- **C** - FPGA has requested control of the **CONTROL USB-C** port.
- **D** - FPGA has control of the **CONTROL USB-C** port.
- **E** - Fault Indicator.
- **LEDS 0-5** - Six user LEDs connected to the FPGA
- **C** - FPGA has requested control of the **CONTROL** port.
- **D** - FPGA has control of the **CONTROL** port.
- **E** - Reserved for future use.

- **0-5** - Six user LEDs connected to the FPGA


Left View
Expand All @@ -39,13 +41,13 @@ Left View
:width: 400
:alt: Cynthion Left View

- **PROGRAM BUTTON** - Returns control of the **CONTROL USB-C** port to the debug micro-controller and holds the FPGA in an unconfigured state.
- **PROGRAM** - Press this button to return control of the **CONTROL** port to the debug microcontroller and hold the FPGA in an unconfigured state.

- *Recovery mode*: If this button is pressed during power-on it will invoke the `Saturn-V <https://github.com/greatscottgadgets/saturn-v>`__ bootloader on the **CONTROL USB-C** port.
- *Recovery mode*: Press this button during power-on to invoke the `Saturn-V <https://github.com/greatscottgadgets/saturn-v>`__ bootloader on the **CONTROL** port.

- **CONTROL USB-C** - Primary USB connector used by the host computer to control Cynthion.
- **USER BUTTON** - A user-assignable button that can be used in your own designs.
- **AUX USB-C** - An auxillary USB connection that can be used in your own designs.
- **CONTROL** - Primary USB connector used by the host computer to control Cynthion.
- **USER** - A user-assignable button that can be used in your own designs.
- **AUX** - An auxiliary USB connection that can be used in your own designs.


Right View
Expand All @@ -55,9 +57,9 @@ Right View
:width: 400
:alt: Cynthion Right View

- **TARGET USB-C** - USB Type-C connector for Packetry traffic capture and Facedancer device emulation.
- **TARGET USB-A** - USB Type-A connector shared with the TARGET USB-C connector.
- **RESET BUTTON** - Resets Cynthion's debug micro-controller and reconfigures the FPGA from flash.
- **TARGET C** - USB Type-C connector for Packetry traffic capture and Facedancer device emulation.
- **TARGET A** - USB Type-A connector shared with the **TARGET C** connector.
- **RESET** - Press this button to reset Cynthion's debug microcontroller and reconfigure the FPGA from flash.


Front View
Expand All @@ -67,15 +69,16 @@ Front View
:width: 400
:alt: Cynthion Front View

- **PMOD A & B** - Digilent Pmod™ Compatible I/O connector with a total of 16 high-speed FPGA user IOs.
- **PMOD B** can also be configured to act as a serial port and JTAG connector for debugging SoC designs.
- **A & B** - Digilent Pmod™ Compatible I/O connector with a total of 16 high-speed FPGA user IOs.

- **B** can also be configured to act as a serial port and JTAG connector for debugging SoC designs:

- **Pin 1** - SERIAL RX
- **Pin 2** - SERIAL TX
- **Pin 7** - JTAG TMS
- **Pin 8** - JTAG TDI
- **Pin 9** - JTAG TDO
- **Pin 10** - JTAG TCK
- **1** - SERIAL RX
- **2** - SERIAL TX
- **7** - JTAG TMS
- **8** - JTAG TDI
- **9** - JTAG TDO
- **10** - JTAG TCK



Expand Down

0 comments on commit db00e47

Please sign in to comment.