artiq/doc/manual/core_drivers_reference.rst

Core drivers reference
======================

These drivers are for the core device and the peripherals closely integrated into it, which do not use the controller mechanism.

System drivers
--------------

:mod:`artiq.coredevice.core` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.core
    :members:

:mod:`artiq.coredevice.exceptions` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.exceptions
    :members:

:mod:`artiq.coredevice.dma` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.dma
    :members:

:mod:`artiq.coredevice.cache` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.cache
    :members:


Digital I/O drivers
-------------------

:mod:`artiq.coredevice.ttl` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.ttl
    :members:

:mod:`artiq.coredevice.edge_counter` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.edge_counter
    :members:

:mod:`artiq.coredevice.spi2` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.spi2
    :members:

:mod:`artiq.coredevice.i2c` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.i2c
    :members:

RF generation drivers
---------------------

:mod:`artiq.coredevice.urukul` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.urukul
    :members:

:mod:`artiq.coredevice.ad9910` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.ad9910
    :members:

:mod:`artiq.coredevice.ad9912` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.ad9912
    :members:

:mod:`artiq.coredevice.ad9914` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.ad9914
    :members:

:mod:`artiq.coredevice.mirny` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.mirny
    :members:

:mod:`artiq.coredevice.almazny` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.almazny
    :members:

:mod:`artiq.coredevice.adf5356` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.adf5356
    :members:

:mod:`artiq.coredevice.phaser` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.phaser
    :members:

DAC/ADC drivers
---------------

:mod:`artiq.coredevice.ad53xx` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.ad53xx
    :members:

:mod:`artiq.coredevice.zotino` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.zotino
    :members:

:mod:`artiq.coredevice.sampler` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.sampler
    :members:

:mod:`artiq.coredevice.fastino` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.fastino
    :members:

:mod:`artiq.coredevice.shuttler` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.shuttler
    :members:


Miscellaneous
-------------

:mod:`artiq.coredevice.suservo` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.suservo
    :members:


:mod:`artiq.coredevice.grabber` module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: artiq.coredevice.grabber
    :members:
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			`Core drivers reference`
			`======================`

doc: document core device driver. Closes #119 2015-10-06 18:12:57 +08:00			`These drivers are for the core device and the peripherals closely integrated into it, which do not use the controller mechanism.`

manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`System drivers`
			`--------------`

doc: document core device driver. Closes #119 2015-10-06 18:12:57 +08:00			:mod:`artiq.coredevice.core` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
doc: document core device driver. Closes #119 2015-10-06 18:12:57 +08:00
			`.. automodule:: artiq.coredevice.core`
			`:members:`
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			:mod:`artiq.coredevice.exceptions` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`.. automodule:: artiq.coredevice.exceptions`
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			`:members:`

manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			:mod:`artiq.coredevice.dma` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`.. automodule:: artiq.coredevice.dma`
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			`:members:`

manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			:mod:`artiq.coredevice.cache` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
Implement recording of DMA traces on the core device. 2017-02-26 10:50:20 +08:00
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`.. automodule:: artiq.coredevice.cache`
Implement recording of DMA traces on the core device. 2017-02-26 10:50:20 +08:00			`:members:`

spi2: add RTIO gateware and coredevice driver https://github.com/m-labs/misoc/commit/1006218997c40d570686196cb8a25d01add8fab7 2018-02-21 21:34:45 +08:00
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`Digital I/O drivers`
manual: fix core_drivers_reference 2018-03-22 13:26:45 +08:00			`-------------------`
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00
			:mod:`artiq.coredevice.ttl` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00
			`.. automodule:: artiq.coredevice.ttl`
spi2: add RTIO gateware and coredevice driver https://github.com/m-labs/misoc/commit/1006218997c40d570686196cb8a25d01add8fab7 2018-02-21 21:34:45 +08:00			`:members:`

Add gateware input event counter 2018-12-11 06:21:26 +08:00			:mod:`artiq.coredevice.edge_counter` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
Add gateware input event counter 2018-12-11 06:21:26 +08:00
			`.. automodule:: artiq.coredevice.edge_counter`
			`:members:`

manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			:mod:`artiq.coredevice.spi2` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00
			`.. automodule:: artiq.coredevice.spi2`
ad53xx->ad5360 and refactor 2016-03-04 07:00:25 +08:00			`:members:`
coredevice.spi, doc/manual: add spi 2016-03-02 04:29:09 +08:00
doc: I2C/QC2 2016-03-05 19:02:03 +08:00			:mod:`artiq.coredevice.i2c` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
doc: I2C/QC2 2016-03-05 19:02:03 +08:00
			`.. automodule:: artiq.coredevice.i2c`
			`:members:`

manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`RF generation drivers`
			`---------------------`

			:mod:`artiq.coredevice.urukul` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00
			`.. automodule:: artiq.coredevice.urukul`
coredevice: put cache into separate file/device 2016-03-10 10:45:16 +08:00			`:members:`

integrate new AD9914 driver moninj, analyzer, docs, examples, tests. 2018-05-13 23:29:35 +08:00			:mod:`artiq.coredevice.ad9910` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
integrate new AD9914 driver moninj, analyzer, docs, examples, tests. 2018-05-13 23:29:35 +08:00
			`.. automodule:: artiq.coredevice.ad9910`
			`:members:`

manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			:mod:`artiq.coredevice.ad9912` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`.. automodule:: artiq.coredevice.ad9912`
			`:members:`

integrate new AD9914 driver moninj, analyzer, docs, examples, tests. 2018-05-13 23:29:35 +08:00			:mod:`artiq.coredevice.ad9914` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00
integrate new AD9914 driver moninj, analyzer, docs, examples, tests. 2018-05-13 23:29:35 +08:00			`.. automodule:: artiq.coredevice.ad9914`
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			`:members:`
phaser: add jesd204b rtio dds gateware: add jesd204b awg gateware: copy phaser (df3825a) dsp/tools: update satadd mixin phaser: no DDS stubs dsp: accu fix phaser: cleanup/reduce sawg: kernel support and docs sawg: coredevice api fixes sawg: example ddb/experiment phaser: add conda package examples/phaser: typo sawg: adapt tests, fix accu stb sawg: tweak dds parameters sawg: move/adapt/extend tests sawg: test phy, refactor phaser: non-rtio spi phaser: target cli update phaser: ad9154-fmc-ebz pins phaser: reorganize fmc signal naming phaser: add test mode stubs phaser: txen is LVTTL phaser: clk spi xfer test phaser: spi for ad9154 and ad9516 phaser: spi tweaks ad9154: add register map from ad9144.xml ad9516: add register map from ad9517.xml and manual adaptation ad9154_reg: just generate getter/setter macros as well ad9154: reg WIP ad9154: check and fix registers kc705: single ended rtio_external_clk use single ended user_sma_clk_n instead of p/n to free up one clock sma kc705: mirror clk200 at user_sma_clock_p ad9516_regs.h: fix B_COUNTER_MSB phase: wire up clocking differently needs patched misoc kc705: feed rtio_external_clock directly kc705: remove rtio_external_clk for phaser phaser: spi tweaks ad9516: some startup ad9516_reg fixes phaser: setup ad9516 for supposed 500 MHz operation ad9516: use full duplex spi ad9154_reg: add CONFIG_REG_2 ad9154_reg: fixes phaser: write some ad9154 config ad9154_reg: fixes ad9154: more init, and human readable setup ad9154/ad9516: merge spi support ad9154: status readout Revert "kc705: remove rtio_external_clk for phaser" This reverts commit d500288bb44f2bf2eeb0c2f237aa207b0a8b1366. Revert "kc705: feed rtio_external_clock directly" This reverts commit 8dc7825519e3e75b7d3d29c9abf10fc6e3a8b4c5. Revert "phase: wire up clocking differently" This reverts commit ad9cc450ffa35abb54b0842d56f6cf6c53c6fbcc. Revert "kc705: mirror clk200 at user_sma_clock_p" This reverts commit 7f0dffdcdd28e648af84725682f82ec6e5642eba. Revert "kc705: single ended rtio_external_clk" This reverts commit a9426d983fbf5c1cb768da8f1da26d9b7335e9cf. ad9516: 2000 MHz clock phaser: test clock dist phaser: test freqs ad9154: iostandards phaser: drop clock monitor phaser: no separate i2c phaser: drive rtio from refclk, wire up sysref phaser: ttl channel for sync ad9154: 4x interp, status, tweaks phaser: sync/sysref 33V banks phaser: sync/sysref LVDS_25 inputs are VCCO tolerant phaser: user input-only ttls phaser: rtio fully from refclk ad9154: reg name usage fix ad9154: check register modifications Revert "ad9154: check register modifications" This reverts commit 45121d90edf89f7bd8703503f9f317ad050f9564. ad9154: fix status code ad9154: addrinc, recal serdes pll phaser: coredevice, example tweaks sawg: missing import sawg: type fixes ad9514: move setup functions ad9154: msb first also decreasing addr phaser: use sys4x for rtio internal ref phaser: move init code to main phaser: naming cleanup phaser: cleanup pins phaser: move spi to kernel cpu phaser: kernel support for ad9154 spi ad9154: add r/w methods ad9154: need return annotations ad9154: r/w methods are kernels ad9154_reg: portable helpers phaser: cleanup startup kernel ad9154: status test ad9154: prbs test ad9154: move setup, document phaser: more documentation 2016-07-22 21:56:09 +08:00
mirny: add to manual 2020-01-20 20:07:20 +08:00			:mod:`artiq.coredevice.mirny` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
mirny: add to manual 2020-01-20 20:07:20 +08:00
			`.. automodule:: artiq.coredevice.mirny`
			`:members:`

Almazny v1.2 support Based on PR #2060 by Robert Jördens. 2023-05-09 12:54:48 +08:00			:mod:`artiq.coredevice.almazny` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
Almazny v1.2 support Based on PR #2060 by Robert Jördens. 2023-05-09 12:54:48 +08:00
			`.. automodule:: artiq.coredevice.almazny`
			`:members:`

coredevice: adf5356: fix/adjust docs Signed-off-by: Etienne Wodey <wodey@iqo.uni-hannover.de> 2020-11-10 03:08:33 +08:00			:mod:`artiq.coredevice.adf5356` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
mirny: add to manual 2020-01-20 20:07:20 +08:00
coredevice: adf5356: fix/adjust docs Signed-off-by: Etienne Wodey <wodey@iqo.uni-hannover.de> 2020-11-10 03:08:33 +08:00			`.. automodule:: artiq.coredevice.adf5356`
mirny: add to manual 2020-01-20 20:07:20 +08:00			`:members:`

phaser: documentation 2020-08-29 00:36:44 +08:00			:mod:`artiq.coredevice.phaser` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
phaser: documentation 2020-08-29 00:36:44 +08:00
			`.. automodule:: artiq.coredevice.phaser`
			`:members:`
basemod_att: add dB functions, document 2019-12-21 14:56:41 +08:00
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`DAC/ADC drivers`
			`---------------`
sampler: add coredevice driver 2018-03-21 18:06:31 +08:00
doc: ad5360 -> ad53xx, add zotino 2018-03-24 22:18:08 +08:00			:mod:`artiq.coredevice.ad53xx` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
urukul: document ad9912, and cpld, fix api 2018-02-14 16:45:17 +08:00
doc: ad5360 -> ad53xx, add zotino 2018-03-24 22:18:08 +08:00			`.. automodule:: artiq.coredevice.ad53xx`
			`:members:`

			:mod:`artiq.coredevice.zotino` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
doc: ad5360 -> ad53xx, add zotino 2018-03-24 22:18:08 +08:00
			`.. automodule:: artiq.coredevice.zotino`
urukul: document ad9912, and cpld, fix api 2018-02-14 16:45:17 +08:00			`:members:`

manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			:mod:`artiq.coredevice.sampler` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
urukul: document ad9912, and cpld, fix api 2018-02-14 16:45:17 +08:00
manual: reorganize core drivers 2018-03-22 12:06:01 +08:00			`.. automodule:: artiq.coredevice.sampler`
urukul: document ad9912, and cpld, fix api 2018-02-14 16:45:17 +08:00			`:members:`

fastino: add [WIP] 2019-09-17 01:28:36 +08:00			:mod:`artiq.coredevice.fastino` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
fastino: add [WIP] 2019-09-17 01:28:36 +08:00
			`.. automodule:: artiq.coredevice.fastino`
			`:members:`

shuttler: add documentation 2023-09-25 17:47:47 +08:00			:mod:`artiq.coredevice.shuttler` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
shuttler: add documentation 2023-09-25 17:47:47 +08:00
			`.. automodule:: artiq.coredevice.shuttler`
			`:members:`

suservo: documentation, small API changes 2018-04-27 22:53:11 +08:00
grabber: add coredevice driver 2018-07-24 18:06:44 +08:00			`Miscellaneous`
			`-------------`
suservo: documentation, small API changes 2018-04-27 22:53:11 +08:00
			:mod:`artiq.coredevice.suservo` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
suservo: documentation, small API changes 2018-04-27 22:53:11 +08:00
			`.. automodule:: artiq.coredevice.suservo`
			`:members:`
grabber: add coredevice driver 2018-07-24 18:06:44 +08:00

			:mod:`artiq.coredevice.grabber` module
doc: Edit of manual reference pages (#2466) Co-authored-by: architeuthis <am@m-labs.hk> 2024-07-18 17:53:34 +08:00			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
grabber: add coredevice driver 2018-07-24 18:06:44 +08:00
			`.. automodule:: artiq.coredevice.grabber`
			`:members:`