
#==================================
#----------------------------------
# pulse.template:
#
# Records to support pulsed RF.
# feed_launcher script executes
# lcls2_rf/software/prc/rf_pulse.py 
# on user request, which runs 
# TGEN program.
#----------------------------------
#==================================

#==================================
# User parameters. 
# Off time = wf sample period - on time
#==================================
# Dummy PV to allow python API to access actual PV
record(longin, "$(PREF)PULSE_ONTIMEDMY") {
  field(DTYP, "FEED Register Read")
  field(INP , "@name=$(NAME) reg=mbox_$(BIT)_PULSE_ONTIME")
  info(feed:info:input, "$(PREF)PULSE_ONTIME")
  info(feed:info:output, "$(PREF)PULSE_ONTIME")
}

record(ao, "$(PREF)PULSE_ONTIME") {
  field(DESC, "RF Pulse On Time")
  field(SCAN, "Passive")
  field(OMSL, "supervisory")
  field(VAL,  "70")
  field(EGU,  "ms")
  field(DRVL, "0")
# DRVH set by ACQ_PERIOD. Set default DRVH to enforce DRVL
  field(DRVH, "1000")
  field(PREC, "3")
  field(PINI, "YES")
  field(FLNK, "$(PREF)PULSE_OFFTIME_CALC")
  info(autosaveFields, "VAL DRVH")
}

record(calc, "$(PREF)PULSE_OFFTIME_CALC") {
  field(DESC, "Calc RF Pulse Off Time")
  field(SCAN, "Passive")
  field(CALC, "(A*B*C)-D")
  field(INPA, "$(PREF)ACQ_SAMP_PERIOD")
  field(INPB, "$(PREF)ACQ_NORD")
  field(INPC, "1000") # convert to ms
  field(INPD, "$(PREF)PULSE_ONTIME")
  field(FLNK, "$(PREF)PULSE_OFFTIME")
}

record(ao, "$(PREF)PULSE_OFFTIME") {
  field(DESC, "RF Pulse Off Time")
  field(SCAN, "Passive")
  field(OMSL, "closed_loop")
  field(DOL,  "$(PREF)PULSE_OFFTIME_CALC")
  field(DRVL, "0")
# DRVH set by ACQ_PERIOD. Set default DRVH to enforce DRVL
  field(DRVH, "1000")
  field(EGU,  "ms")
  field(PREC, "3")
  field(FLNK, "$(PREF)PULSE_ON_DIFF")
  info(autosaveFields, "VAL DRVH")
}

#==================================
# Records set by rf_pulse.py
# Status and values currently/last 
# in use.
#==================================
# Dummy PV to allow python API to access actual PV
record(longin, "$(PREF)PULSE_STATUSDMY") {
  field(DTYP, "FEED Register Read")
  field(INP , "@name=$(NAME) reg=mbox_$(BIT)_PULSE_STATUS")
  info(feed:info:input, "$(PREF)PULSE_STATUS")
  info(feed:info:output, "$(PREF)PULSE_STATUS")
}

record(mbbi, "$(PREF)PULSE_STATUS") {
    field(ZRST, "Awaiting request")
    field(ONST, "Pulse request")
    field(TWST, "Pulsing on")
    field(THST, "Stop request")
    field(FRST, "Pulsing off")
    field(ZRVL, "0")
    field(ONVL, "1")
    field(ONSV, "MINOR")
    field(TWVL, "2")
    field(TWSV, "MINOR")
    field(THVL, "3")
    field(THSV, "MINOR")
    field(FRVL, "4")
    field(PINI, "YES")
    info(autosaveFields, "VAL")
}

# Dummy PV to allow python API to access actual PV
record(longin, "$(PREF)PULSE_INUSE_ONDMY") {
  field(DTYP, "FEED Register Read")
  field(INP , "@name=$(NAME) reg=mbox_$(BIT)_PULSE_INUSE_ON")
  info(feed:info:input, "$(PREF)PULSE_INUSE_ON")
  info(feed:info:output, "$(PREF)PULSE_INUSE_ON")
}

record(ao, "$(PREF)PULSE_INUSE_ON") {
  field(DESC, "In-use RF Pulse On Time")
  field(SCAN, "Passive")
  field(OMSL, "supervisory")
  field(EGU,  "ms")
  field(PREC, "3")
  field(PINI, "YES")
  field(FLNK, "$(PREF)PULSE_ON_DIFF")
  info(autosaveFields, "VAL")
}
record(ao, "$(PREF)PULSE_INUSE_OFF") {
  field(DESC, "In-use RF Pulse Off Time")
  field(SCAN, "Passive")
  field(OMSL, "supervisory")
  field(EGU,  "ms")
  field(PREC, "3")
  field(PINI, "YES")
  info(autosaveFields, "VAL")
}

# Dummy PV to allow python API to access actual PV
record(longin, "$(PREF)PULSE_INUSE_ASETDMY") {
  field(DTYP, "FEED Register Read")
  field(INP , "@name=$(NAME) reg=mbox_$(BIT)_PULSE_INUSE_ASET")
  info(feed:info:input, "$(PREF)PULSE_INUSE_ASET")
  info(feed:info:output, "$(PREF)PULSE_INUSE_ASET")
}

record(ao, "$(PREF)PULSE_INUSE_ASET") {
  field(DESC, "In-use RF Pulse ADES")
  field(SCAN, "Passive")
  field(OMSL, "supervisory")
  field(EGU,  "%")
  field(PREC, "3")
  field(PINI, "YES")
  field(FLNK, "$(PREF)PULSE_ADES_DIFF")
  info(autosaveFields, "VAL")
}

record(calc, "$(PREF)PULSE_ON_DIFF") {
  field(DESC, "Diff latest and desired on time")
  field(SCAN, "Passive")
  field(CALC, "A=B?0:1")
  field(INPA, "$(PREF)PULSE_INUSE_ON")
  field(INPB, "$(PREF)PULSE_ONTIME")
  field(HIGH, "1")
  field(HSV,  "MINOR")
  field(PINI, "YES")
}

record(calc, "$(PREF)PULSE_ADES_DIFF") {
  field(DESC, "Diff latest and desired ADES")
  field(SCAN, "Passive")
  field(CALC, "A=B?0:1")
  field(INPA, "$(PREF)PULSE_INUSE_ASET")
  field(INPB, "$(PREF)SEL_ASET CP")
  field(HIGH, "1")
  field(HSV,  "MINOR")
  field(PINI, "YES")
}

record(calc, "$(PREF)PULSE_DIFF_SUM") {
  field(DESC, "Pulse parms need updating")
  field(SCAN, "1 second")
  field(CALC, "C#4?0:D#1?0:A?1:B?1:0")
  field(INPA, "$(PREF)PULSE_ON_DIFF")
  field(INPB, "$(PREF)PULSE_ADES_DIFF")
  field(INPC, "$(PREF)RFMODECTRL")
  field(INPD, "$(PREF)RFCTRL")
  field(HIGH, "1")
  field(HSV,  "MINOR")
}

record(stringin, "$(PREF)PULSE_MSG") {
  field(DESC, "Pulse message")
  field(SCAN, "Passive")
  field(PINI, "YES")
  info(autosaveFields, "VAL")
}

# Dummy PV to allow python API to access actual PV
record(longin, "$(PREF)PULSEONSTRTDMY") {
  field(DTYP, "FEED Register Read")
  field(INP , "@name=$(NAME) reg=mbox_$(BIT)_PULSEONSTRT")
  info(feed:info:input, "$(PREF)PULSEONSTRT")
  info(feed:info:output, "$(PREF)PULSEONSTRT")
}

# Dummy PV to allow python API to access actual PV
record(longin, "$(PREF)PULSEOFFSTRTDMY") {
  field(DTYP, "FEED Register Read")
  field(INP , "@name=$(NAME) reg=mbox_$(BIT)_PULSEOFFSTRT")
  info(feed:info:input, "$(PREF)PULSEOFFSTRT")
  info(feed:info:output, "$(PREF)PULSEOFFSTRT")
}

#==================================
# Support graphic for pulse set up
#==================================
record(aSub, "$(PREF)PULSESUB") {
  field(DESC, "Pulse display graphic")
  field(INAM, "")
  field(SNAM, "RF Pulse Diag")
  field(SCAN, "Passive")
  field(FTA, "SHORT") 
  field(NOA, "1")
  field(INPA, "$(PREF)PULSE_STATUS")
  field(FTB, "DOUBLE") 
  field(NOB, "1")
  field(INPB, "$(PREF)ACQ_PERIOD.OVAL CP")
  field(FTC, "DOUBLE") 
  field(NOC, "1")
  field(INPC, "$(PREF)SEL_ASET CP")
  field(FTD, "DOUBLE") 
  field(NOD, "1")
  field(INPD, "$(PREF)PULSE_INUSE_ASET CP")
  field(FTE, "DOUBLE") 
  field(NOE, "1")
  field(INPE, "$(PREF)PULSE_ONTIME")
  field(FTF, "DOUBLE") 
  field(NOF, "1")
  field(INPF, "$(PREF)PULSE_INUSE_ON CP")
  field(FTG, "DOUBLE") 
# Process when OFFTIME updates (not ONTIME) so will
# get consistent set of on/off values
  field(NOG, "1")
  field(INPG, "$(PREF)PULSE_OFFTIME CP")
  field(FTH, "DOUBLE") 
  field(NOH, "1")
  field(INPH, "$(PREF)PULSE_INUSE_OFF CP")
# VALA = amplitude for pulse graphic - new 
  field(FTVA, "DOUBLE")
  field(NOVA, "5")
# VALB = amplitude for pulse graphic - in use
  field(FTVB, "DOUBLE")
  field(NOVB, "5")
# VALC = time for pulse graphic - new
  field(FTVC, "DOUBLE")
  field(NOVC, "5")
# VALD = time for pulse graphic - in use
  field(FTVD, "DOUBLE")
  field(NOVD, "5")
}
