artiq/doc/manual/drivers_reference.rst

Drivers reference
=================

These drivers are for "slow" devices that are directly controlled by a PC, typically over a non-realtime channel such as USB.

Certain devices (such as the PDQ2) may still perform real-time operations by having certain controls physically connected to the core device (for example, the trigger and frame selection signals on the PDQ2). For handling such cases, parts of the drivers may be kernels executed on the core device.

Each driver is run in a separate "controller" that exposes a RPC interface (based on :class:`artiq.management.pc_rpc`) to its functions. The master never does direct I/O to the devices, but issues RPCs to the controllers when needed. As opposed to running everything on the master, this architecture has those main advantages:

* Each driver can be run on a different machine, which alleviates cabling issues and OS compatibility problems.
* Reduces the impact of driver crashes.
* Reduces the impact of driver memory leaks.

:mod:`artiq.devices.pdq2` module
----------------------------------

.. automodule:: artiq.devices.pdq2
    :members:


Default TCP port list
---------------------

When writing a new driver, choose a free TCP port and add it to this list.

+-----------+--------------+
| Component | Default port |
+===========+==============+
| Master    | 8888         |
+-----------+--------------+
| PDQ2      | 8889         |
+-----------+--------------+
| LDA       | 8890         |
+-----------+--------------+
devices/rtio_core: rename RTIOCounter to RTIOIn and document 2014-09-30 16:42:07 +08:00			`Drivers reference`
			`=================`

doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			`These drivers are for "slow" devices that are directly controlled by a PC, typically over a non-realtime channel such as USB.`
devices/rtio_core: rename RTIOCounter to RTIOIn and document 2014-09-30 16:42:07 +08:00
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			`Certain devices (such as the PDQ2) may still perform real-time operations by having certain controls physically connected to the core device (for example, the trigger and frame selection signals on the PDQ2). For handling such cases, parts of the drivers may be kernels executed on the core device.`
devices/dds_core: document 2014-09-30 17:38:52 +08:00
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			Each driver is run in a separate "controller" that exposes a RPC interface (based on :class:`artiq.management.pc_rpc`) to its functions. The master never does direct I/O to the devices, but issues RPCs to the controllers when needed. As opposed to running everything on the master, this architecture has those main advantages:
devices/dds_core: document 2014-09-30 17:38:52 +08:00
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			`* Each driver can be run on a different machine, which alleviates cabling issues and OS compatibility problems.`
			`* Reduces the impact of driver crashes.`
			`* Reduces the impact of driver memory leaks.`
rtio: raise RTIOSequenceError exceptions when events are not submitted in-order 2014-09-30 19:32:11 +08:00
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			:mod:`artiq.devices.pdq2` module
			`----------------------------------`
rtio: raise RTIOSequenceError exceptions when events are not submitted in-order 2014-09-30 19:32:11 +08:00
doc/manual: split core/controller drivers 2014-10-27 16:41:48 +08:00			`.. automodule:: artiq.devices.pdq2`
rtio: raise RTIOSequenceError exceptions when events are not submitted in-order 2014-09-30 19:32:11 +08:00			`:members:`
doc/manual: add controller default TCP port list 2014-11-25 20:24:57 +08:00

			`Default TCP port list`
			`---------------------`

			`When writing a new driver, choose a free TCP port and add it to this list.`

			`+-----------+--------------+`
			`\| Component \| Default port \|`
			`+===========+==============+`
			`\| Master \| 8888 \|`
			`+-----------+--------------+`
			`\| PDQ2 \| 8889 \|`
			`+-----------+--------------+`
			`\| LDA \| 8890 \|`
			`+-----------+--------------+`