squishy: big-renovation-wip

squishy-scsi · Nov 7, 2024 · 366bd17 · 366bd17
1 parent 269ee52
commit 366bd17
Show file tree

Hide file tree

Showing 122 changed files with 4,255 additions and 5,107 deletions.
diff --git a/docs/applets/api/device.md b/docs/applets/api/device.md
@@ -1,4 +1,4 @@
-# `squishy.core.device.SquishyHardwareDevice`
+# `squishy.device.SquishyDevice`
 
 ```{toctree}
 :hidden:
@@ -10,7 +10,7 @@ Flesh this out
 
 ```{eval-rst}
 
-.. autoclass:: squishy.core.device.SquishyHardwareDevice
+.. autoclass:: squishy.device.SquishyDevice
    :members:
 
 ```
diff --git a/docs/applets/index.md b/docs/applets/index.md
@@ -4,7 +4,6 @@
 :hidden:
 
 analyzer
-taperipper
 api/index
 ```
 
@@ -16,13 +15,12 @@ Flesh this section out
 Squishy allows for the development of modular pieces of combined code and [Torii HDL] gateware called an applet. It gives Squishy it's functionality and allows for the extension of said functionality and/or entirely new custom functionality.
 
 
-There are currently two built-in applets, the [analyzer], and [taperipper]applets. With more built-in applets are planned for the future.
+There is currently one built-in applet, the [analyzer], with more built-in applets are planned for the future.
 
 Squishy allows you to run your own custom applets, any python packages in the `SQUISHY_APPLETS` directory are attempted to be loaded as an applet, and then exposed to the user to allow them to invoke.
 
 For more details on custom applets, see the [Custom Applet] tutorial for a walkthrough of developing your own Squishy applet.
 
 [Custom Applet]: ../tutorials/applets/index.md
 [analyzer]: ./analyzer.md
-[taperipper]: ./taperipper.md
 [Torii HDL]: https://github.com/shrine-maiden-heavy-industries/torii-hdl
diff --git a/docs/applets/taperipper.md b/docs/applets/taperipper.md
diff --git a/docs/hardware/index.md b/docs/hardware/index.md
@@ -32,7 +32,7 @@ There are two main ways to get squishy hardware, buying it, or building it.
 ### Buying Hardware
 
 ```{note}
-As of 2024-03-10, Squishy hardware is not available for sale, however, once engineering and validation of Revision 2 is completed, rev2 units are expected to be available to purchase.
+As of 2024-11-07, Squishy hardware is not available for sale, however, once engineering and validation of Revision 2 is completed, rev2 units are expected to be available to purchase.
 ```
 
 ### Building Hardware
@@ -48,11 +48,11 @@ If you buy a pre-built Squishy, it will already be provisioned, but in case some
 
 ### Work-In-Progress Hardware
 
-The hardware is always a work in progress, you can view a live rendering of the WIP hardware in your web browser [here](https://kicanvas.org/?github=https%3A%2F%2Fgithub.com%2Fsquishy-scsi%2Fhardware%2Ftree%2Fmain%2Fboards%2Fsquishy), thanks to [KiCanvas].
+The hardware is always a work in progress, you can view a live rendering of the WIP hardware in your web browser [here](https://kicanvas.org/?github=https://github.com/squishy-scsi/hardware/blob/main/boards/squishy/main-unit/squishy-main.kicad_pro), thanks to [KiCanvas].
 
 
 [provisioning]: ../tutorials/provisioning.md
 [`rev1`]: ./rev1.md
 [`rev2`]: ./rev2.md
-[here]: https://kicanvas.org/?github=https%3A%2F%2Fgithub.com%2Fsquishy-scsi%2Fhardware%2Ftree%2Fmain%2Fboards%2Fsquishy
+[here]: https://kicanvas.org/?github=https://github.com/squishy-scsi/hardware/blob/main/boards/squishy/main-unit/squishy-main.kicad_pro
 [KiCanvas]: https://kicanvas.org
diff --git a/docs/library/gateware/applet/index.md b/docs/library/gateware/applet/index.md
@@ -0,0 +1,12 @@
+# `squishy.gateware.applet`
+
+```{toctree}
+:hidden:
+
+
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.applet
+  :members:
+```
diff --git a/docs/library/gateware/bootloader/index.md b/docs/library/gateware/bootloader/index.md
@@ -8,23 +8,16 @@
 
 ```{eval-rst}
 .. automodule:: squishy.gateware.bootloader
-
-```
-
-
-```{eval-rst}
-.. automodule:: squishy.gateware.bootloader.bitstream
   :members:
 ```
 
 
 ```{eval-rst}
-.. automodule:: squishy.gateware.bootloader.dfu
+.. automodule:: squishy.gateware.bootloader.rev1
   :members:
 ```
 
-
 ```{eval-rst}
-.. automodule:: squishy.gateware.bootloader.rev1
+.. automodule:: squishy.gateware.bootloader.rev2
   :members:
 ```
diff --git a/docs/library/gateware/core/index.md b/docs/library/gateware/core/index.md
@@ -3,10 +3,6 @@
 ```{toctree}
 :hidden:
 
-pll
-scsi
-spi
-uart
 ```
 
 ```{eval-rst}

diff --git a/docs/library/gateware/core/pll.md b/docs/library/gateware/core/pll.md
diff --git a/docs/library/gateware/core/scsi.md b/docs/library/gateware/core/scsi.md
diff --git a/docs/library/gateware/core/spi.md b/docs/library/gateware/core/spi.md
diff --git a/docs/library/gateware/core/uart.md b/docs/library/gateware/core/uart.md
diff --git a/docs/library/gateware/index.md b/docs/library/gateware/index.md
@@ -3,12 +3,12 @@
 ```{toctree}
 :hidden:
 
+applet/index
+bootloader/index
 core/index
+peripherals/index
 platform/index
-scsi/index
-usb/index
-quirks/index
-bootloader/index
+
 
 ```
 

diff --git a/docs/library/gateware/peripherals/index.md b/docs/library/gateware/peripherals/index.md
@@ -0,0 +1,23 @@
+# `squishy.gateware.peripherals`
+
+```{toctree}
+:hidden:
+
+scsi/index
+usb/index
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals
+
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals.spi
+	:members:
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals.flash
+	:members:
+```
diff --git a/docs/library/gateware/peripherals/scsi/index.md b/docs/library/gateware/peripherals/scsi/index.md
@@ -0,0 +1,12 @@
+# `squishy.gateware.peripherals.scsi`
+
+```{toctree}
+:hidden:
+
+quirks/index
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals.scsi
+
+```
diff --git a/docs/library/gateware/peripherals/scsi/quirks/index.md b/docs/library/gateware/peripherals/scsi/quirks/index.md
@@ -0,0 +1,11 @@
+# `squishy.gateware.peripherals.scsi.quirks`
+
+```{toctree}
+:hidden:
+
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals.scsi.quirks
+
+```
diff --git a/docs/library/gateware/peripherals/usb/index.md b/docs/library/gateware/peripherals/usb/index.md
@@ -0,0 +1,17 @@
+# `squishy.gateware.peripherals.usb`
+
+```{toctree}
+:hidden:
+
+quirks/index
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals.usb
+
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals.usb.dfu
+	:members:
+```
diff --git a/docs/library/gateware/peripherals/usb/quirks/index.md b/docs/library/gateware/peripherals/usb/quirks/index.md
@@ -0,0 +1,16 @@
+# `squishy.gateware.peripherals.usb.quirks`
+
+```{toctree}
+:hidden:
+
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals.usb.quirks
+
+```
+
+```{eval-rst}
+.. automodule:: squishy.gateware.peripherals.usb.quirks.windows
+	:members:
+```
diff --git a/docs/library/gateware/platform/index.md b/docs/library/gateware/platform/index.md
@@ -5,11 +5,10 @@
 
 rev1
 rev2
-mixins
 resources
 ```
 
 ```{eval-rst}
 .. automodule:: squishy.gateware.platform
-
+	:members:
 ```
diff --git a/docs/library/gateware/platform/mixins.md b/docs/library/gateware/platform/mixins.md
diff --git a/docs/library/gateware/platform/resources.md b/docs/library/gateware/platform/resources.md
@@ -8,9 +8,3 @@
 .. automodule:: squishy.gateware.platform.resources
 
 ```
-
-```{eval-rst}
-.. automodule:: squishy.gateware.platform.resources.scsi
-  :members:
-
-```
diff --git a/docs/library/gateware/quirks/index.md b/docs/library/gateware/quirks/index.md
diff --git a/docs/library/gateware/scsi/common.md b/docs/library/gateware/scsi/common.md
diff --git a/docs/library/gateware/scsi/device.md b/docs/library/gateware/scsi/device.md
diff --git a/docs/library/gateware/scsi/index.md b/docs/library/gateware/scsi/index.md
diff --git a/docs/library/gateware/scsi/initiator.md b/docs/library/gateware/scsi/initiator.md
diff --git a/docs/library/gateware/scsi/scsi1.md b/docs/library/gateware/scsi/scsi1.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,10 +3,6 @@ @@
     ```{toctree}
     :hidden:
-    pll
-    scsi
-    spi
-    uart
     ```
     ```{eval-rst}
@@ Expand Down @@