Code Documentation
==================

Hose side code, USB
:::::::::::::::::::

:mod:`pdq.host.crc` module
--------------------------

.. automodule:: pdq.host.crc
    :members:

:mod:`pdq.host.protocol` module
-------------------------------

.. automodule:: pdq.host.protocol
    :members:

:mod:`pdq.host.usb` module
--------------------------

.. automodule:: pdq.host.usb
    :members:

:mod:`pdq.host.cli` module
--------------------------

.. argparse::
    :ref: pdq.host.cli.get_argparser
    :prog: pdq

.. automodule:: pdq.host.cli
    :members:


ARTIQ-facing components
:::::::::::::::::::::::

:mod:`pdq.artiq.spi` module
---------------------------

.. automodule:: pdq.artiq.spi
    :members:

:mod:`pdq.artiq.aqctl_pdq` module
---------------------------------

.. argparse::
    :ref: pdq.artiq.aqctl_pdq.get_argparser
    :prog: aqctl_pdq

.. automodule:: pdq.artiq.aqctl_pdq
    :members:

:mod:`pdq.artiq.mediator` module
--------------------------------

.. automodule:: pdq.artiq.mediator
    :members:

Gateware
::::::::

:mod:`pdq.gateware.pdq` module
------------------------------

.. automodule:: pdq.gateware.pdq
    :members:

:mod:`pdq.gateware.comm` module
-------------------------------

.. automodule:: pdq.gateware.comm
    :members:

:mod:`pdq.gateware.dac` module
------------------------------

.. automodule:: pdq.gateware.dac
    :members:

:mod:`pdq.gateware.platform` module
-----------------------------------

.. automodule:: pdq.gateware.platform
    :members:

:mod:`pdq.gateware.escape` module
---------------------------------

.. automodule:: pdq.gateware.escape
    :members:

:mod:`pdq.gateware.ft245r` module
---------------------------------

.. automodule:: pdq.gateware.ft245r
    :members:

:mod:`pdq.gateware.spi` module
------------------------------

.. automodule:: pdq.gateware.spi
    :members: