Deploying to gh-pages from @ 8c69a5b 🚀

applets/api/applet.html

@@ -391,7 +391,7 @@ <h1><code class="docutils literal notranslate"><span class="pre">squishy.applets
 
 <dl class="py method">
 <dt class="sig sig-object py" id="squishy.applets.SquishyApplet.init_applet">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">init_applet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AppletElaboratable</span></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.init_applet" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">init_applet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.12)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AppletElaboratable</span></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.init_applet" title="Link to this definition">#</a></dt>
 <dd><p>Applet Initialization</p>
 <p>Called to initialize the applet prior to
 the applet being built and ran</p>
@@ -413,7 +413,7 @@ <h1><code class="docutils literal notranslate"><span class="pre">squishy.applets
 
 <dl class="py method">
 <dt class="sig sig-object py" id="squishy.applets.SquishyApplet.register_args">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">register_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parser</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.register_args" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">register_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parser</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser" title="(in Python v3.12)"><span class="pre">ArgumentParser</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.register_args" title="Link to this definition">#</a></dt>
 <dd><p>Applet argument registration</p>
 <p>Called to register any applet specific arguments.</p>
 <dl class="field-list simple">
@@ -428,7 +428,7 @@ <h1><code class="docutils literal notranslate"><span class="pre">squishy.applets
 
 <dl class="py method">
 <dt class="sig sig-object py" id="squishy.applets.SquishyApplet.run">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.run" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="device.html#squishy.core.device.SquishyHardwareDevice" title="squishy.core.device.SquishyHardwareDevice"><span class="pre">SquishyHardwareDevice</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.12)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.run" title="Link to this definition">#</a></dt>
 <dd><p>Applet run step</p>
 <p>Called to run any specialized machinery for the applet.</p>
 <dl class="field-list simple">

applets/api/device.html

@@ -388,7 +388,7 @@ <h1><code class="docutils literal notranslate"><span class="pre">squishy.core.de
 
 <dl class="py method">
 <dt class="sig sig-object py" id="squishy.core.device.SquishyHardwareDevice.get_device">
-<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_device</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">serial</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#squishy.core.device.SquishyHardwareDevice" title="squishy.core.device.SquishyHardwareDevice"><span class="pre">SquishyHardwareDevice</span></a></span></span><a class="headerlink" href="#squishy.core.device.SquishyHardwareDevice.get_device" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_device</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">serial</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Type" title="(in Python v3.12)"><span class="pre">Type</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#squishy.core.device.SquishyHardwareDevice" title="squishy.core.device.SquishyHardwareDevice"><span class="pre">SquishyHardwareDevice</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#squishy.core.device.SquishyHardwareDevice.get_device" title="Link to this definition">#</a></dt>
 <dd><p>Get attached Squishy device.</p>
 <p>Get the attached and selected squishy device if possible, or if only
 one is attached to the system use that one.</p>

faq.html

@@ -341,6 +341,21 @@
           <section id="frequently-asked-questions">
 <h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Link to this heading">#</a></h1>
 <p>The following are some commonly asked questions, while this section is not exhaustive it will be updated when appropriate. For more specific questions, please join the IRC channel <a class="reference external" href="https://web.libera.chat/#squishy">#squishy on libera.chat</a> or use the <a class="reference external" href="https://github.com/squishy-scsi/squishy/discussions,">GitHub Discussions</a>.</p>
+<section id="why-should-i-use-squishy-rather-than-one-of-the-other-scsi-projects">
+<h2>Why should I use Squishy rather than one of the other SCSI projects?<a class="headerlink" href="#why-should-i-use-squishy-rather-than-one-of-the-other-scsi-projects" title="Link to this heading">#</a></h2>
+<p>That really depends on what you need. If you just want/need storage emulation, then please do go with one of the other projects, <a class="reference external" href="https://scsi.blue/">BlueSCSI</a> et. al. are awesome projects and deserve your support.</p>
+<p>But if you need something more flexible, or support for arcane hardware, then Squishy might be the right choice. It’s not as turnkey as the other projects, but it is far more capable in more ways than one.</p>
+</section>
+<section id="why-is-squishy-so-complex">
+<h2>Why is Squishy so complex?<a class="headerlink" href="#why-is-squishy-so-complex" title="Link to this heading">#</a></h2>
+<p>Squishy, at first, seems overly complicated for what it is, after all, the other SCSI projects are fairly simple, not more than a handful of parts, where as Squishy is this monster with multiple boards, large power requirements and a complex software stack.</p>
+<p>But it’s for a good reason, Squishy was designed to be as capable, covering everything for SCSI-1 and HVD all the way to ULTRA-320 LVD, and everything between. Such capabilities demand complexity in order to be achieved, this is the primary driver behind the complexity of both the hardware and software ecosystem. However, this allows Squishy to be as flexible as possible, able to hopefully meet any possible needs that may arise.</p>
+</section>
+<section id="why-is-squishy-so-expensive">
+<h2>Why is Squishy so expensive?<a class="headerlink" href="#why-is-squishy-so-expensive" title="Link to this heading">#</a></h2>
+<p>This goes in tandem with <a class="reference internal" href="#why-is-squishy-so-complex">Why is Squishy so complex?</a>. It is not expensive for the sake of being expensive, the upmost care and detail has been put in to the design, as such I like to say that Squishy is not built down to a price, but up to a standard, and that standard is very high.</p>
+<p>This, unfortunately leads to the hardware being expensive, there is sadly nothing that can be done about that. However, as Squishy is 100% Open Source Hardware under the <a class="reference external" href="https://ohwr.org/cern_ohl_s_v2.pdf">CERN-OHL-S v2</a>, you can go and build it yourself to try to cut down on costs. However, assembling Squishy yourself is not a trivial task due to several large BGA components and fairly tight tolerances for manufacturing.</p>
+</section>
 <section id="why-does-squishy-not-have-a-discord">
 <h2>Why Does Squishy not have a Discord?<a class="headerlink" href="#why-does-squishy-not-have-a-discord" title="Link to this heading">#</a></h2>
 <p>Squishy likes to do things out in the open, this means that Discords model of walled-off communities is not conducive to how we want to do things. In addition to this, there is a trend to moving documentation away from things like Wiki’s and websites into Discord servers, which causes that information to no longer be publicly accessible, this is a huge problem when it comes to things like Open Source projects such as Squishy.</p>
@@ -410,6 +425,9 @@ <h2>Why Does Squishy not have a Discord?<a class="headerlink" href="#why-does-sq
           <div class="toc-tree">
             <ul>
 <li><a class="reference internal" href="#">Frequently Asked Questions</a><ul>
+<li><a class="reference internal" href="#why-should-i-use-squishy-rather-than-one-of-the-other-scsi-projects">Why should I use Squishy rather than one of the other SCSI projects?</a></li>
+<li><a class="reference internal" href="#why-is-squishy-so-complex">Why is Squishy so complex?</a></li>
+<li><a class="reference internal" href="#why-is-squishy-so-expensive">Why is Squishy so expensive?</a></li>
 <li><a class="reference internal" href="#why-does-squishy-not-have-a-discord">Why Does Squishy not have a Discord?</a></li>
 </ul>
 </li>

genindex.html

@@ -366,11 +366,13 @@ <h2>C</h2>
         <ul>
           <li><a href="library/gateware/platform/rev2.html#squishy.gateware.platform.rev2.SquishyRev2.clock_domain_generator">(squishy.gateware.platform.rev2.SquishyRev2 attribute)</a>
 </li>
-        </ul></li>
-        <li><a href="library/python/messages.html#squishy.scsi.messages.MessageCodes.COMMAND_COMPLETE">COMMAND_COMPLETE (squishy.scsi.messages.MessageCodes attribute)</a>
+          <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.clock_domain_generator">(squishy.gateware.SquishyPlatform property)</a>
 </li>
+        </ul></li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="library/python/messages.html#squishy.scsi.messages.MessageCodes.COMMAND_COMPLETE">COMMAND_COMPLETE (squishy.scsi.messages.MessageCodes attribute)</a>
+</li>
         <li><a href="library/python/commands/index.html#squishy.scsi.command.CommandEmitter">CommandEmitter (class in squishy.scsi.command)</a>
 </li>
         <li><a href="library/python/commands/common.html#squishy.scsi.commands.common.Compare">Compare (in module squishy.scsi.commands.common)</a>
@@ -666,10 +668,12 @@ <h2>P</h2>
 </li>
         <li><a href="library/python/device.html#squishy.scsi.device.PeripheralDeviceType">PeripheralDeviceType (class in squishy.scsi.device)</a>
 </li>
-        <li><a href="library/python/commands/direct.html#squishy.scsi.commands.direct.prevent_allow_media_removal">prevent_allow_media_removal (in module squishy.scsi.commands.direct)</a>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.pll_config">pll_config (squishy.gateware.SquishyPlatform property)</a>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="library/python/commands/direct.html#squishy.scsi.commands.direct.prevent_allow_media_removal">prevent_allow_media_removal (in module squishy.scsi.commands.direct)</a>
+</li>
         <li><a href="library/python/commands/printer.html#squishy.scsi.commands.printer.print_cmd">print_cmd (in module squishy.scsi.commands.printer)</a>
 </li>
         <li><a href="library/python/device.html#squishy.scsi.device.PeripheralDeviceType.Printer">Printer (squishy.scsi.device.PeripheralDeviceType attribute)</a>
@@ -725,6 +729,8 @@ <h2>R</h2>
         <li><a href="library/python/messages.html#squishy.scsi.messages.MessageCodes.RESTORE_PTR">RESTORE_PTR (squishy.scsi.messages.MessageCodes attribute)</a>
 </li>
         <li><a href="library/gateware/usb/index.html#squishy.gateware.usb.rev1.Rev1USB">Rev1USB (class in squishy.gateware.usb.rev1)</a>
+</li>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.revision">revision (squishy.gateware.SquishyPlatform property)</a>
 </li>
         <li><a href="library/python/commands/direct.html#squishy.scsi.commands.direct.rezero_unit">rezero_unit (in module squishy.scsi.commands.direct)</a>
 </li>
@@ -757,6 +763,8 @@ <h2>S</h2>
         <li><a href="library/gateware/scsi/device.html#squishy.gateware.scsi.device.SCSI3Device">SCSI3Device() (in module squishy.gateware.scsi.device)</a>
 </li>
         <li><a href="library/gateware/scsi/initiator.html#squishy.gateware.scsi.initiator.SCSI3Initiator">SCSI3Initiator() (in module squishy.gateware.scsi.initiator)</a>
+</li>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.scsi_vid">scsi_vid (squishy.gateware.SquishyPlatform property)</a>
 </li>
         <li><a href="library/python/commands/index.html#squishy.scsi.command.SCSICommand">SCSICommand (class in squishy.scsi.command)</a>
 </li>
@@ -1095,6 +1103,8 @@ <h2>S</h2>
         <li><a href="library/gateware/platform/mixins.html#squishy.gateware.platform.mixins.SquishyCacheMixin">SquishyCacheMixin (class in squishy.gateware.platform.mixins)</a>
 </li>
         <li><a href="applets/api/device.html#squishy.core.device.SquishyHardwareDevice">SquishyHardwareDevice (class in squishy.core.device)</a>
+</li>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform">SquishyPlatform (class in squishy.gateware)</a>
 </li>
         <li><a href="library/gateware/platform/rev1.html#squishy.gateware.platform.rev1.SquishyRev1">SquishyRev1 (class in squishy.gateware.platform.rev1)</a>
 </li>
@@ -1125,10 +1135,20 @@ <h2>U</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="library/gateware/core/uart.html#squishy.gateware.core.uart.UARTInterface">UARTInterface (class in squishy.gateware.core.uart)</a>
+</li>
+        <li><a href="applets/api/device.html#squishy.core.device.SquishyHardwareDevice.upload">upload() (squishy.core.device.SquishyHardwareDevice method)</a>
+</li>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.usb_mfr">usb_mfr (squishy.gateware.SquishyPlatform property)</a>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="applets/api/device.html#squishy.core.device.SquishyHardwareDevice.upload">upload() (squishy.core.device.SquishyHardwareDevice method)</a>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.usb_pid_app">usb_pid_app (squishy.gateware.SquishyPlatform property)</a>
+</li>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.usb_pid_boot">usb_pid_boot (squishy.gateware.SquishyPlatform property)</a>
+</li>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.usb_prod">usb_prod (squishy.gateware.SquishyPlatform property)</a>
+</li>
+        <li><a href="library/gateware/index.html#squishy.gateware.SquishyPlatform.usb_vid">usb_vid (squishy.gateware.SquishyPlatform property)</a>
 </li>
     </ul></td>
   </tr></table>