forked from M-Labs/artiq
1
0
Fork 0

doc/manual: split core/controller drivers

This commit is contained in:
Sebastien Bourdeauducq 2014-10-27 16:41:48 +08:00
parent 4eda58fbc9
commit 4d0e5db955
4 changed files with 36 additions and 14 deletions

View File

@ -0,0 +1,23 @@
Core drivers reference
======================
These drivers are for peripherals closely integrated into the core device, which do not
follow the controller paradigm.
:mod:`artiq.coredevice.rtio` module
-----------------------------------
.. automodule:: artiq.coredevice.rtio
:members:
:mod:`artiq.coredevice.dds` module
----------------------------------
.. automodule:: artiq.coredevice.dds
:members:
:mod:`artiq.coredevice.runtime_exceptions` module
-------------------------------------------------
.. automodule:: artiq.coredevice.runtime_exceptions
:members:

View File

@ -1,20 +1,18 @@
Drivers reference Drivers reference
================= =================
:mod:`artiq.coredevice.rtio` module These drivers are for "slow" devices that are directly controlled by a PC, typically over a non-realtime channel such as USB.
-----------------------------------
.. automodule:: artiq.coredevice.rtio 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.
:members:
:mod:`artiq.coredevice.dds` module 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.coredevice.dds .. automodule:: artiq.devices.pdq2
:members:
:mod:`artiq.coredevice.runtime_exceptions` module
-------------------------------------------------
.. automodule:: artiq.coredevice.runtime_exceptions
:members: :members:

View File

@ -8,6 +8,7 @@ Contents:
installing installing
getting_started getting_started
core_reference core_language_reference
drivers_reference core_drivers_reference
management_reference management_reference
drivers_reference