m-labs · Oct 27, 2014 · Oct 27, 2014
Showing with 38 additions and 16 deletions.

+23 −0 doc/manual/core_drivers_reference.rst

0 doc/manual/{core_reference.rst → core_language_reference.rst}

+9 −11 doc/manual/drivers_reference.rst

+2 −2 doc/manual/{tutorial.rst → getting_started.rst}

+4 −3 doc/manual/index.rst
diff --git a/doc/manual/core_drivers_reference.rst b/doc/manual/core_drivers_reference.rst
@@ -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:
diff --git a/doc/manual/core_reference.rst → doc/manual/core_language_reference.rst b/doc/manual/core_reference.rst → doc/manual/core_language_reference.rst
diff --git a/doc/manual/drivers_reference.rst b/doc/manual/drivers_reference.rst
@@ -1,20 +1,18 @@
 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
-    :members:
+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.
 
-: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:
 
-.. automodule:: artiq.coredevice.dds
-    :members:
+* 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.coredevice.runtime_exceptions` module
--------------------------------------------------
+:mod:`artiq.devices.pdq2` module
+----------------------------------
 
-.. automodule:: artiq.coredevice.runtime_exceptions
+.. automodule:: artiq.devices.pdq2
     :members:
diff --git a/doc/manual/tutorial.rst → doc/manual/getting_started.rst b/doc/manual/tutorial.rst → doc/manual/getting_started.rst
@@ -1,5 +1,5 @@
-Tutorial
-========
+Getting started
+===============
 
 Connecting to the core device
 -----------------------------

diff --git a/doc/manual/index.rst b/doc/manual/index.rst
@@ -7,7 +7,8 @@ Contents:
     :maxdepth: 2
 
     installing
-    tutorial
-    core_reference
-    drivers_reference
+    getting_started
+    core_language_reference
+    core_drivers_reference
     management_reference
+    drivers_reference