Merge branch 'master' into tpr

docs/source/upcoming_release_notes/1155-Add_LCLS-II_timing_support_for_Qadc134.rst

@@ -0,0 +1,31 @@
+1155 Add LCLS-II timing support for Qadc134
+#################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- N/A
+
+Device Updates
+--------------
+- Restructured Qadc134 with new Qadc134Common and QadcLcls1Timing parent
+  classes.
+
+New Devices
+-----------
+- Qadc134Lcls2: A class for LCLS-II timing versions of the FMC134
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- N/A
+
+Contributors
+------------
+- slactjohnson

pcdsdevices/qadc.py

@@ -0,0 +1,148 @@
+from ophyd import Component as Cpt
+from ophyd import Device, EpicsSignal
+
+from .interface import BaseInterface
+from .variety import set_metadata
+
+
+class QadcCommon(BaseInterface, Device):
+    """
+    Common class for Abaco FMC digitizers. Used in Qadc and Qadc134.
+    """
+
+    ch0 = Cpt(EpicsSignal, ":CH0", kind="normal", doc="Input 0 of the ADC")
+    ch1 = Cpt(EpicsSignal, ":CH1", kind="normal", doc="Input 1 of the ADC")
+    ch2 = Cpt(EpicsSignal, ":CH2", kind="normal", doc="Input 2 of the ADC")
+    ch3 = Cpt(EpicsSignal, ":CH3", kind="normal", doc="Input 3 of the ADC")
+    config = Cpt(EpicsSignal, ":CONFIG", kind="config",
+                 doc="Write the current config to the QADC")
+    set_metadata(config, dict(variety='command-proc', value=1))
+    start = Cpt(EpicsSignal, ":START", kind="normal",
+                doc="Start/stop acquisition")
+
+
+class QadcLcls1Timing(BaseInterface, Device):
+    """
+    LCLS-I timing interface for FMC134 QADCs.
+    """
+    trig_event = Cpt(
+        EpicsSignal, ":TRIG_EVENT_RBV", write_pv=":TRIG_EVENT", kind="config",
+        doc="LCLS-I event code to trigger on"
+    )
+
+
+class QadcLcls2Timing(BaseInterface, Device):
+    """
+    LCLS-II timing interface for FMC134 QADCs.
+    """
+    trig_rate_mode = Cpt(EpicsSignal, ":TRIG_RATEMODE", kind="config",
+                         doc="LCLS-II trigger mode")
+    trig_fixed_rate = Cpt(EpicsSignal, ":TRIG_FIXEDRATE", kind="config",
+                          doc="Rate to use for fixed trigger mode")
+    trig_ac_rate = Cpt(EpicsSignal, ":TRIG_ACRATE", kind="config",
+                       doc="Rate to use for AC trigger mode")
+    trig_ts_mask = Cpt(EpicsSignal, ":TRIG_TSMASK", kind="config",
+                       doc="Trigger mask")
+    trig_seq_num = Cpt(EpicsSignal, ":TRIG_SEQNUM", kind="config",
+                       doc="Trigger sequence number")
+    trig_seq_bit = Cpt(EpicsSignal, ":TRIG_SEQBIT", kind="config",
+                       doc="Trigger sequence bit")
+    trig_partition = Cpt(EpicsSignal, ":TRIG_PARTITION", kind="config",
+                         doc="Trigger partition number")
+
+
+class Qadc134Common(QadcCommon):
+    """
+    Common class for FMC134 digitizers.
+    """
+    trig_delay = Cpt(
+        EpicsSignal, ":TRIG_DELAY_RBV", write_pv=":TRIG_DELAY", kind="config",
+        doc="Trigger delay in EVR/TPR ticks"
+    )
+    full_en = Cpt(EpicsSignal, ":FULL_EN_RBV", write_pv=":FULL_EN", kind="config",
+                  doc="Enable full stream")
+    hi_thresh = Cpt(EpicsSignal, ":HI_THRESH_RBV", write_pv=":HI_THRESH", kind="config",
+                    doc="High threshold, in Volts")
+    hi_thresh_raw = Cpt(
+        EpicsSignal, ":HI_THRESH_RAW_RBV", write_pv=":HI_THRESH_RAW", kind="config",
+        doc="High threshold, raw"
+    )
+    ichan = Cpt(EpicsSignal, ":ICHAN_RBV", write_pv=":ICHAN", kind="config",
+                doc="Channel to interleave on")
+    interleave = Cpt(
+        EpicsSignal, ":INTERLEAVE_RBV", write_pv=":INTERLEAVE", kind="config",
+        doc="Interleave enabled?"
+    )
+    length = Cpt(EpicsSignal, ":LENGTH_RBV", write_pv=":LENGTH", kind="config",
+                 doc="Waveform length")
+    lo_thresh = Cpt(EpicsSignal, ":LO_THRESH_RBV", write_pv=":LO_THRESH",
+                    kind="config", doc="Low threshold, in Volts")
+    lo_thresh_raw = Cpt(
+        EpicsSignal, ":LO_THRESH_RAW_RBV", write_pv=":LO_THRESH_RAW",
+        kind="config", doc="Low threshold, raw")
+    prescale = Cpt(EpicsSignal, ":PRESCALE_RBV", write_pv=":PRESCALE",
+                   kind="config", doc="Trigger prescale divider")
+    rows_after = Cpt(
+        EpicsSignal, ":ROWS_AFTER_RBV", write_pv=":ROWS_AFTER", kind="config"
+    )
+    rows_before = Cpt(
+        EpicsSignal, ":ROWS_BEFORE_RBV", write_pv=":ROWS_BEFORE", kind="config"
+    )
+    sparse_en = Cpt(EpicsSignal, ":SPARSE_EN_RBV", write_pv=":SPARSE_EN",
+                    kind="config", doc="Enable sparsified mode")
+    clear_config = Cpt(EpicsSignal, ":CLEAR_CONFIG", kind="config",
+                       doc="Clear the current configuration")
+    set_metadata(clear_config, dict(variety='command-proc', value=1))
+    out0 = Cpt(EpicsSignal, ":OUT0", kind="normal", doc="Full output zero")
+    out1 = Cpt(EpicsSignal, ":OUT1", kind="normal", doc="Full output one")
+    rawdata0 = Cpt(EpicsSignal, ":RAWDATA0", kind="normal",
+                   doc="Raw output zero")
+    rawdata1 = Cpt(EpicsSignal, ":RAWDATA1", kind="normal",
+                   doc="Raw output one")
+    sparse0 = Cpt(EpicsSignal, ":SPARSE0", kind="normal",
+                  doc="Sparsified output zero")
+    sparse1 = Cpt(EpicsSignal, ":SPARSE1", kind="normal",
+                  doc="Sparsified output one")
+
+
+class Qadc134(Qadc134Common, QadcLcls1Timing):
+    """
+    Class for LCLS-I FMC134 digitizers. Implements LCLS-I timing interface.
+    """
+
+
+class Qadc134Lcls2(Qadc134Common, QadcLcls2Timing):
+    """
+    Class for LCLS-2 FMC134 digitizers. Implements LCLS-2 timing interface.
+    """
+
+
+class Qadc(QadcCommon):
+    """
+    Class for an older Abaco FMC PCIe digitzer, used in the LCLS-I hutches.
+    """
+
+    gain0_i = Cpt(EpicsSignal, ":GAIN0_I", kind="config")
+    gain0_ni = Cpt(EpicsSignal, ":GAIN0_NI", kind="config")
+    gain1_i = Cpt(EpicsSignal, ":GAIN1_I", kind="config")
+    gain1_ni = Cpt(EpicsSignal, ":GAIN1_NI", kind="config")
+    gain2_i = Cpt(EpicsSignal, ":GAIN2_I", kind="config")
+    gain2_ni = Cpt(EpicsSignal, ":GAIN2_NI", kind="config")
+    gain3_i = Cpt(EpicsSignal, ":GAIN3_I", kind="config")
+    gain3_ni = Cpt(EpicsSignal, ":GAIN3_NI", kind="config")
+    ichan = Cpt(EpicsSignal, ":ICHAN", kind="config")
+    interleave = Cpt(EpicsSignal, ":INTERLEAVE", kind="config")
+    length = Cpt(EpicsSignal, ":LENGTH", kind="config")
+    off0_i = Cpt(EpicsSignal, ":OFF0_I", kind="config")
+    off0_ni = Cpt(EpicsSignal, ":OFF0_NI", kind="config")
+    off1_i = Cpt(EpicsSignal, ":OFF1_I", kind="config")
+    off1_ni = Cpt(EpicsSignal, ":OFF1_NI", kind="config")
+    off2_i = Cpt(EpicsSignal, ":OFF2_I", kind="config")
+    off2_ni = Cpt(EpicsSignal, ":OFF2_NI", kind="config")
+    off3_i = Cpt(EpicsSignal, ":OFF3_I", kind="config")
+    off3_ni = Cpt(EpicsSignal, ":OFF3_NI", kind="config")
+    out = Cpt(EpicsSignal, ":OUT", kind="normal")
+    rawdata = Cpt(EpicsSignal, ":RAWDATA", kind="normal")
+    train = Cpt(EpicsSignal, ":TRAIN", kind="config")
+    trig_delay = Cpt(EpicsSignal, ":TRIG_DELAY", kind="config")
+    trig_event = Cpt(EpicsSignal, ":TRIG_EVENT", kind="config")