py-modindex.html

<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
  <head><meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width,initial-scale=1"/>
    <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
        <link rel="canonical" href="https://docs.scsi.moe/py-modindex.html" />

    <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 --><title>Python Module Index - Squishy 0.0.1.dev227 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
    <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
    <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=4c969af8" />
    <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
    <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
    <link rel="stylesheet" type="text/css" href="_static/css/styles.css?v=88ac24ee" />
    
    
<style>
  body {
    --color-code-background: #f8f8f8;
  --color-code-foreground: black;
  
  }
  @media not print {
    body[data-theme="dark"] {
      --color-code-background: #272822;
  --color-code-foreground: #f8f8f2;
  
    }
    @media (prefers-color-scheme: dark) {
      body:not([data-theme="light"]) {
        --color-code-background: #272822;
  --color-code-foreground: #f8f8f2;
  
      }
    }
  }
</style></head>
  <body>
    
    <script>
      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
    </script>
    

<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
  <symbol id="svg-toc" viewBox="0 0 24 24">
    <title>Contents</title>
    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
    </svg>
  </symbol>
  <symbol id="svg-menu" viewBox="0 0 24 24">
    <title>Menu</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
      <line x1="3" y1="12" x2="21" y2="12"></line>
      <line x1="3" y1="6" x2="21" y2="6"></line>
      <line x1="3" y1="18" x2="21" y2="18"></line>
    </svg>
  </symbol>
  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
    <title>Expand</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
      <polyline points="9 18 15 12 9 6"></polyline>
    </svg>
  </symbol>
  <symbol id="svg-sun" viewBox="0 0 24 24">
    <title>Light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
      <circle cx="12" cy="12" r="5"></circle>
      <line x1="12" y1="1" x2="12" y2="3"></line>
      <line x1="12" y1="21" x2="12" y2="23"></line>
      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
      <line x1="1" y1="12" x2="3" y2="12"></line>
      <line x1="21" y1="12" x2="23" y2="12"></line>
      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
    </svg>
  </symbol>
  <symbol id="svg-moon" viewBox="0 0 24 24">
    <title>Dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
    </svg>
  </symbol>
  <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
    <title>Auto light/dark, in light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
      <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
      <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
      <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
      <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
      <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
      <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
      <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
      <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
      <circle cx="14.5" cy="9.55" r="3.6"/>
    </svg>
  </symbol>
  <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
    <title>Auto light/dark, in dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
      <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
      <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
      <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
      <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
      <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
      <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
      <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
      <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
      <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
    </svg>
  </symbol>
  <symbol id="svg-pencil" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
      <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
      <path d="M13.5 6.5l4 4" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
  <symbol id="svg-eye" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
      <path
        d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
</svg>

<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
  <div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
  <div class="visually-hidden">Hide table of contents sidebar</div>
</label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>


<div class="page">
  <header class="mobile-header">
    <div class="header-left">
      <label class="nav-overlay-icon" for="__navigation">
        <div class="visually-hidden">Toggle site navigation sidebar</div>
        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
      </label>
    </div>
    <div class="header-center">
      <a href="index.html"><div class="brand">Squishy 0.0.1.dev227 documentation</div></a>
    </div>
    <div class="header-right">
      <div class="theme-toggle-container theme-toggle-header">
        <button class="theme-toggle">
          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
        </button>
      </div>
      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
        <div class="visually-hidden">Toggle table of contents sidebar</div>
        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
      </label>
    </div>
  </header>
  <aside class="sidebar-drawer">
    <div class="sidebar-container">
      
      <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
  
  
  <span class="sidebar-brand-text">Squishy 0.0.1.dev227 documentation</span>
  
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
  <ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="hardware/index.html">Hardware</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Hardware</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="hardware/rev1.html">Revision 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="hardware/rev2.html">Revision 2</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="applets/index.html">Applets</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Applets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="applets/analyzer.html">Analyzer Applet</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="library/index.html">Squishy as a Library</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Squishy as a Library</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="library/applet/index.html">Applet API</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Applet API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/applet/applet.html">Squishy Applet</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Squishy Applet</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/applet/device.html">Squishy Device</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Squishy Device</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="library/gateware/index.html">Gateware Library</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of Gateware Library</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/gateware/applet/index.html">Applets</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of Applets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/gateware/bootloader/index.html">Bootloader</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of Bootloader</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="library/gateware/bootloader/rev1.html">Squishy Rev1 Bootloader</a></li>
<li class="toctree-l4"><a class="reference internal" href="library/gateware/bootloader/rev2.html">Squishy Rev2 Bootloader</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/gateware/core/index.html">Core</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of Core</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/gateware/peripherals/index.html">Peripherals</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle navigation of Peripherals</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/gateware/platform/index.html">Hardware Platforms</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle navigation of Hardware Platforms</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4 has-children"><a class="reference internal" href="library/gateware/platform/rev1.html">Rev1</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><div class="visually-hidden">Toggle navigation of Rev1</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l4 has-children"><a class="reference internal" href="library/gateware/platform/rev2.html">Rev2</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><div class="visually-hidden">Toggle navigation of Rev2</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l4 has-children"><a class="reference internal" href="library/gateware/platform/resources.html">Platform Resources</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" role="switch" type="checkbox"/><label for="toctree-checkbox-15"><div class="visually-hidden">Toggle navigation of Platform Resources</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/gateware/scsi/index.html">SCSI</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" role="switch" type="checkbox"/><label for="toctree-checkbox-16"><div class="visually-hidden">Toggle navigation of SCSI</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4 has-children"><a class="reference internal" href="library/gateware/scsi/quirks/index.html">SCSI Quirks</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" role="switch" type="checkbox"/><label for="toctree-checkbox-17"><div class="visually-hidden">Toggle navigation of SCSI Quirks</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/gateware/usb/index.html">USB</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" role="switch" type="checkbox"/><label for="toctree-checkbox-18"><div class="visually-hidden">Toggle navigation of USB</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4 has-children"><a class="reference internal" href="library/gateware/usb/quirks/index.html">USB Quirks</a><input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" role="switch" type="checkbox"/><label for="toctree-checkbox-19"><div class="visually-hidden">Toggle navigation of USB Quirks</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="library/gateware/test.html">Test Harness</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="library/python/index.html">Python Library</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" role="switch" type="checkbox"/><label for="toctree-checkbox-20"><div class="visually-hidden">Toggle navigation of Python Library</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/python/core/index.html">Core Components</a><input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" role="switch" type="checkbox"/><label for="toctree-checkbox-21"><div class="visually-hidden">Toggle navigation of Core Components</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="library/python/core/pcapng.html">PCAPNG Writer</a></li>
</ul>
</li>
<li class="toctree-l3 has-children"><a class="reference internal" href="library/python/scsi/index.html">SCSI</a><input class="toctree-checkbox" id="toctree-checkbox-22" name="toctree-checkbox-22" role="switch" type="checkbox"/><label for="toctree-checkbox-22"><div class="visually-hidden">Toggle navigation of SCSI</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4 has-children"><a class="reference internal" href="library/python/scsi/commands/index.html">Commands</a><input class="toctree-checkbox" id="toctree-checkbox-23" name="toctree-checkbox-23" role="switch" type="checkbox"/><label for="toctree-checkbox-23"><div class="visually-hidden">Toggle navigation of Commands</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l5 has-children"><a class="reference internal" href="library/python/scsi/commands/common.html">Common</a><input class="toctree-checkbox" id="toctree-checkbox-24" name="toctree-checkbox-24" role="switch" type="checkbox"/><label for="toctree-checkbox-24"><div class="visually-hidden">Toggle navigation of Common</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l5 has-children"><a class="reference internal" href="library/python/scsi/commands/direct.html">Direct-Access</a><input class="toctree-checkbox" id="toctree-checkbox-25" name="toctree-checkbox-25" role="switch" type="checkbox"/><label for="toctree-checkbox-25"><div class="visually-hidden">Toggle navigation of Direct-Access</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l5 has-children"><a class="reference internal" href="library/python/scsi/commands/printer.html">Printer</a><input class="toctree-checkbox" id="toctree-checkbox-26" name="toctree-checkbox-26" role="switch" type="checkbox"/><label for="toctree-checkbox-26"><div class="visually-hidden">Toggle navigation of Printer</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l5 has-children"><a class="reference internal" href="library/python/scsi/commands/processor.html">Processor</a><input class="toctree-checkbox" id="toctree-checkbox-27" name="toctree-checkbox-27" role="switch" type="checkbox"/><label for="toctree-checkbox-27"><div class="visually-hidden">Toggle navigation of Processor</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l5 has-children"><a class="reference internal" href="library/python/scsi/commands/ro_direct.html">Read-Only Direct-Access</a><input class="toctree-checkbox" id="toctree-checkbox-28" name="toctree-checkbox-28" role="switch" type="checkbox"/><label for="toctree-checkbox-28"><div class="visually-hidden">Toggle navigation of Read-Only Direct-Access</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l5 has-children"><a class="reference internal" href="library/python/scsi/commands/sequential.html">Sequential</a><input class="toctree-checkbox" id="toctree-checkbox-29" name="toctree-checkbox-29" role="switch" type="checkbox"/><label for="toctree-checkbox-29"><div class="visually-hidden">Toggle navigation of Sequential</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l5 has-children"><a class="reference internal" href="library/python/scsi/commands/worm.html">WORM</a><input class="toctree-checkbox" id="toctree-checkbox-30" name="toctree-checkbox-30" role="switch" type="checkbox"/><label for="toctree-checkbox-30"><div class="visually-hidden">Toggle navigation of WORM</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
</ul>
</li>
<li class="toctree-l4 has-children"><a class="reference internal" href="library/python/scsi/device.html">Device</a><input class="toctree-checkbox" id="toctree-checkbox-31" name="toctree-checkbox-31" role="switch" type="checkbox"/><label for="toctree-checkbox-31"><div class="visually-hidden">Toggle navigation of Device</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l4 has-children"><a class="reference internal" href="library/python/scsi/messages.html">Messages</a><input class="toctree-checkbox" id="toctree-checkbox-32" name="toctree-checkbox-32" role="switch" type="checkbox"/><label for="toctree-checkbox-32"><div class="visually-hidden">Toggle navigation of Messages</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="tutorials/index.html">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-33" name="toctree-checkbox-33" role="switch" type="checkbox"/><label for="toctree-checkbox-33"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="tutorials/applets/index.html">Custom Applets</a><input class="toctree-checkbox" id="toctree-checkbox-34" name="toctree-checkbox-34" role="switch" type="checkbox"/><label for="toctree-checkbox-34"><div class="visually-hidden">Toggle navigation of Custom Applets</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="tutorials/provisioning.html">Provisioning a New Device</a><input class="toctree-checkbox" id="toctree-checkbox-35" name="toctree-checkbox-35" role="switch" type="checkbox"/><label for="toctree-checkbox-35"><div class="visually-hidden">Toggle navigation of Provisioning a New Device</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli.html">CLI</a></li>
<li class="toctree-l1"><a class="reference internal" href="extra.html">Extra Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="mascot.html">Mascot - Sachi</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently Asked Questions</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://github.com/squishy-scsi/squishy">Source Code</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/squishy-scsi/hardware">Hardware</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/squishy-scsi/squishy/blob/main/CONTRIBUTING.md">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">Licenses</a></li>
</ul>

</div>
</div>

      </div>
      
    </div>
  </aside>
  <div class="main">
    <div class="content">
      <div class="article-container">
        <a href="#" class="back-to-top muted-link">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
          </svg>
          <span>Back to top</span>
        </a>
        <div class="content-icon-container">
          <div class="theme-toggle-container theme-toggle-content">
            <button class="theme-toggle">
              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
            </button>
          </div>
          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
            <div class="visually-hidden">Toggle table of contents sidebar</div>
            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
          </label>
        </div>
        <article role="main" id="furo-main-content">
          
<section class="domainindex-section">
  <h1>Python Module Index</h1>
  <div class="domainindex-jumpbox"><a href="#cap-s"><strong>s</strong></a></div>
</section>
<table class="domainindex-table">
  <tr class="pcap">
    <td></td><td>&#160;</td><td></td>
  </tr>
  <tr class="cap" id="cap-s">
    <td></td><td><strong>s</strong></td><td></td>
  </tr>
  <tr>
    <td><img src="_static/minus.png" class="toggler"
              id="toggle-1" style="display: none" alt="-" /></td>
    <td>
        <code class="xref">squishy</code></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="applets/analyzer.html#module-squishy.applets.analyzer"><code class="xref">squishy.applets.analyzer</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/core/pcapng.html#module-squishy.core.pcapng"><code class="xref">squishy.core.pcapng</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/index.html#module-squishy.gateware"><code class="xref">squishy.gateware</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/applet/index.html#module-squishy.gateware.applet"><code class="xref">squishy.gateware.applet</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/bootloader/index.html#module-squishy.gateware.bootloader"><code class="xref">squishy.gateware.bootloader</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/bootloader/rev1.html#module-squishy.gateware.bootloader.rev1"><code class="xref">squishy.gateware.bootloader.rev1</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/bootloader/rev2.html#module-squishy.gateware.bootloader.rev2"><code class="xref">squishy.gateware.bootloader.rev2</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/core/index.html#module-squishy.gateware.core"><code class="xref">squishy.gateware.core</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/peripherals/index.html#module-squishy.gateware.peripherals"><code class="xref">squishy.gateware.peripherals</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/peripherals/index.html#module-squishy.gateware.peripherals.flash"><code class="xref">squishy.gateware.peripherals.flash</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/peripherals/index.html#module-squishy.gateware.peripherals.psram"><code class="xref">squishy.gateware.peripherals.psram</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/peripherals/index.html#module-squishy.gateware.peripherals.spi"><code class="xref">squishy.gateware.peripherals.spi</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/platform/index.html#module-squishy.gateware.platform"><code class="xref">squishy.gateware.platform</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/platform/resources.html#module-squishy.gateware.platform.resources"><code class="xref">squishy.gateware.platform.resources</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/platform/rev1.html#module-squishy.gateware.platform.rev1"><code class="xref">squishy.gateware.platform.rev1</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/platform/rev2.html#module-squishy.gateware.platform.rev2"><code class="xref">squishy.gateware.platform.rev2</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/scsi/index.html#module-squishy.gateware.scsi"><code class="xref">squishy.gateware.scsi</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/scsi/quirks/index.html#module-squishy.gateware.scsi.quirks"><code class="xref">squishy.gateware.scsi.quirks</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/usb/index.html#module-squishy.gateware.usb"><code class="xref">squishy.gateware.usb</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/usb/index.html#module-squishy.gateware.usb.dfu"><code class="xref">squishy.gateware.usb.dfu</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/usb/quirks/index.html#module-squishy.gateware.usb.quirks"><code class="xref">squishy.gateware.usb.quirks</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/usb/quirks/index.html#module-squishy.gateware.usb.quirks.windows"><code class="xref">squishy.gateware.usb.quirks.windows</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/index.html#module-squishy.scsi"><code class="xref">squishy.scsi</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/index.html#module-squishy.scsi.command"><code class="xref">squishy.scsi.command</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/index.html#module-squishy.scsi.commands"><code class="xref">squishy.scsi.commands</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/common.html#module-squishy.scsi.commands.common"><code class="xref">squishy.scsi.commands.common</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/direct.html#module-squishy.scsi.commands.direct"><code class="xref">squishy.scsi.commands.direct</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/printer.html#module-squishy.scsi.commands.printer"><code class="xref">squishy.scsi.commands.printer</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/processor.html#module-squishy.scsi.commands.processor"><code class="xref">squishy.scsi.commands.processor</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/ro_direct.html#module-squishy.scsi.commands.ro_direct"><code class="xref">squishy.scsi.commands.ro_direct</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/sequential.html#module-squishy.scsi.commands.sequential"><code class="xref">squishy.scsi.commands.sequential</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/commands/worm.html#module-squishy.scsi.commands.worm"><code class="xref">squishy.scsi.commands.worm</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/device.html#module-squishy.scsi.device"><code class="xref">squishy.scsi.device</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/python/scsi/messages.html#module-squishy.scsi.messages"><code class="xref">squishy.scsi.messages</code></a></td><td>
    <em></em></td>
  </tr>
  <tr class="cg-1">
    <td></td>
    <td>&#160;&#160;&#160;
        <a href="library/gateware/test.html#module-squishy.support.test"><code class="xref">squishy.support.test</code></a></td><td>
    <em></em></td>
  </tr>
</table>

        </article>
      </div>
      <footer>
        
        <div class="related-pages">
          
          
        </div>
        <div class="bottom-of-page">
          <div class="left-details">
            <div class="copyright">
                Copyright &#169; 2025, Aki &#34;lethalbit&#34; Van Ness, et. al.
            </div>
            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
            
            <a href="https://github.com/pradyunsg/furo">Furo</a>
            
          </div>
          <div class="right-details">
            
          </div>
        </div>
        
      </footer>
    </div>
    <aside class="toc-drawer no-toc">
      
      
    </aside>
  </div>
</div><script src="_static/documentation_options.js?v=440f0ca5"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/scripts/furo.js?v=5fa4622c"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=f281be69"></script>
    <script src="_static/tabs.js?v=3ee01567"></script>
    <script src="_static/wavedrom.skin.js"></script>
    <script src="_static/wavedrom.min.js"></script>
    <script src="_static/design-tabs.js?v=f930bc37"></script>
    <script type="module" src="https://cdn.jsdelivr.net/npm/mermaid@11.2.0/dist/mermaid.esm.min.mjs"></script>
    <script type="module" src="https://cdn.jsdelivr.net/npm/@mermaid-js/layout-elk@0.1.4/dist/mermaid-layout-elk.esm.min.mjs"></script>
    <script type="module">import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@11.2.0/dist/mermaid.esm.min.mjs";import elkLayouts from "https://cdn.jsdelivr.net/npm/@mermaid-js/layout-elk@0.1.4/dist/mermaid-layout-elk.esm.min.mjs";mermaid.registerLayoutLoaders(elkLayouts);mermaid.initialize({startOnLoad:false});</script>
    <script src="https://cdn.jsdelivr.net/npm/d3@7.9.0/dist/d3.min.js"></script>
    <script type="module">
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@11.2.0/dist/mermaid.esm.min.mjs";
window.addEventListener("load", () => mermaid.run());
</script>
    <script src="_static/js/mermaid.min.js?v=be593db9"></script>
    <script src="_static/js/wavedrom.min.js?v=912bf3a3"></script>
    <script src="_static/js/wavedrom.skin.js?v=be5c2381"></script>
    </body>
</html>