Merge branch 'master' into rss

crossroadsfpga · May 14, 2023 · 683ae48 · 683ae48
2 parents 80801ee + 8420e0e
commit 683ae48
Show file tree

Hide file tree

Showing 44 changed files with 95 additions and 104 deletions.
diff --git a/docs/compiling_hardware.md b/docs/compiling_hardware.md
@@ -35,7 +35,7 @@ The resulting bitstream will be placed in the directory where you ran the comman
 !!! note
 
     The above command will use a single seed to synthesize the hardware. It is often advantageous to synthesize with multiple seeds to increase the probability of finding a design that meets timing. If you have enough memory, you can synthesize with multiple seeds in parallel. (Requires GNU Parallel to be installed.)
-    
+
     To do so, you can specify multiple seeds when running the command. For example, to synthesize with seeds 1, 2, 3, and 4, run:
 
     ```bash

diff --git a/docs/compiling_software.md b/docs/compiling_software.md
@@ -113,4 +113,4 @@ mkdocs serve
 Note that this does not automatically rebuild the hardware and software API reference. You need to rerun `meson compile docs` to do that.
 
 
-<!-- Compile-time configuration -->
+<!-- Compile-time configuration -->
diff --git a/docs/ensogen.md b/docs/ensogen.md
@@ -7,7 +7,7 @@ EnsōGen is a software packet generator built on top of the Ensō NIC interface.
 EnsōGen is built as part of Ensō. Make sure to follow the instructions in [Compiling Software](compiling_software.md) to build Ensō and that you have the [`enso` command](enso_cli.md) installed.
 
 To run EnsōGen, you first need to set up the NIC with the right parameters. By default, you should run the `enso` command as follows:
-    
+
 ```bash
 enso <path to enso repo> --fpga <fpga ID> --fallback-queues 4 --enable-rr
 ```
@@ -25,7 +25,7 @@ Both `<pcie address>` and `<number of packets>` are optional but it's recommende
 
 Recall that you may obtain the PCIe address of all Ensō NICs in your system by running `scripts/list_enso_nics.sh`.
 
-The `scripts/ensogen.sh` script makes it easier to run EnsōGen by automatically figuring out the hardware rate limiter parameters based on the input pcap file and the desired rate. 
+The `scripts/ensogen.sh` script makes it easier to run EnsōGen by automatically figuring out the hardware rate limiter parameters based on the input pcap file and the desired rate.
 
 You may also choose to run EnsōGen manually. Run the following command to see the available options:
 

diff --git a/docs/hardware/modules/basic_data_mover.md b/docs/hardware/modules/basic_data_mover.md
@@ -50,4 +50,4 @@
 - hp_flags: hyper_pipe
 ## State machines
 
-![Diagram_state_machine_0]( stm_basic_data_mover_00.svg "Diagram")
+![Diagram_state_machine_0]( stm_basic_data_mover_00.svg "Diagram")
diff --git a/docs/hardware/modules/basic_data_mover.svg b/docs/hardware/modules/basic_data_mover.svg
diff --git a/docs/hardware/modules/configurator.svg b/docs/hardware/modules/configurator.svg
diff --git a/docs/hardware/modules/dc_back_pressure.svg b/docs/hardware/modules/dc_back_pressure.svg
-Original file line number
+Diff line change
@@ Expand Up @@
     !!! note
         The above command will use a single seed to synthesize the hardware. It is often advantageous to synthesize with multiple seeds to increase the probability of finding a design that meets timing. If you have enough memory, you can synthesize with multiple seeds in parallel. (Requires GNU Parallel to be installed.)
         To do so, you can specify multiple seeds when running the command. For example, to synthesize with seeds 1, 2, 3, and 4, run:
         ```bash
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -113,4 +113,4 @@ mkdocs serve
		Note that this does not automatically rebuild the hardware and software API reference. You need to rerun `meson compile docs` to do that.


		<!-- Compile-time configuration -->
		<!-- Compile-time configuration -->