# Per-device for PRC chassis
#
# Macros:
#  BASE - Our record prefix
#  CTRL - prefix used with feed_base.template
#

# JSON __metadata__

record(longin, "$(BASE)SLOWABI") {
    field(DTYP, "FEED __metadata__")
    field(INP , "@name=$(NAME) reg=slow_abi_ver default=0")
    field(SCAN, "I/O Intr") # on connect
}

record(longin, "$(BASE)TGENGRAN") {
	field(DESC, "TGEN granularity multiplier =  2^val")  
    field(DTYP, "FEED __metadata__")
    field(INP , "@name=$(NAME) reg=tgen_granularity_log2 default=0")
    field(SCAN, "I/O Intr") # on connect
}

#==================================
# On reconnect, set IF frequency
#==================================
record(longin, "$(BASE)INIT1_") {
  field(DTYP, "FEED On Connect")
  field(INP , "@name=$(NAME)")
  field(SCAN, "I/O Intr")
  field(PHAS, "0")
  field(FLNK, "$(BASE)INIT2_")
}

record(fanout, "$(BASE)INIT2_") {
  field(LNK1, "$(BASE)FREQ_SEL")
  field(LNK2, "$(BASE)DF_FC_SRC")
}

# status monitoring

# Read-only register clk_status_out:
#   0:  immediately after bitfile load, or after clock lost; needs setup
#   1:  transitional value during setup, system check in progress
#   2:  setup process completed successfully, data valid
record(mbbi, "$(BASE)CLK_STATUS") {
    field(DTYP, "FEED Register Read")
    field(INP , "@name=$(NAME) reg=clk_status_out")
    field(SCAN, "1 second")
    field(ZRVL, "0")
    field(ONVL, "1")
    field(TWVL, "2")
    field(ZRSV, "MAJOR")
    field(ONSV, "MAJOR")
    field(ZRST, "Invalid")
    field(ONST, "In Init")
    field(TWST, "Valid")
    field(TSE , "-2")
    field(FLNK, "$(BASE)CLKCHK_")
}

# force driver into Error state, and disable polling,
# when FPGA found in unconfigured state.
record(calcout, "$(BASE)CLKCHK_") {
    field(INPA, "$(BASE)CLK_STATUS NPP MSI")
    field(IVOA, "Don't drive outputs") # INVALID == timeout, handled elsewhere
    field(CALC, "A")
    field(OOPT, "When Zero")
    field(OUT , "$(BASE)CLKERR_.PROC PP")
}

record(stringout, "$(BASE)CLKERR_") {
    field(DTYP, "FEED Force Error")
    field(OUT , "@name=$(NAME)")
    field(VAL , "Need Init")
}

record(calc, "$(BASE)AGG_STS_") {
    field(INPA, "$(CTRL)BASESTATUS_.SEVR CP MSS")
    field(INPB, "$(BASE)CLK_STATUS.SEVR CP MSS")
    # CALC must do something with all inputs to run the MS logic
    # VAL is ignored
    field(CALC, "A+B")
    field(FLNK, "$(BASE)STATUS")
}

record(stringin, "$(BASE)STATUS") {
    field(INP , "$(BASE)AGG_STS_.SEVR NPP MSS")
}

# TODO: consider alarms and initialization behavior
record(mbbi, "$(BASE)DF_FC_SRC_RBV") {
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=cfreq_src_sel")
  field(TSE , "-2")
  field(ZRVL, "0")
  field(ZRST, "Loopback")
  field(ZRSV, "MAJOR")
  field(ONVL, "1")
  field(ONST, "Forward")
  field(ONSV, "MAJOR")
  field(TWVL, "2")
  field(TWST, "Reverse")
  field(TWSV, "MAJOR")
  field(THVL, "3")
  field(THST, "Cavity")
  info(feed:info:setting, "$(BASE)DF_FC_SRC_RBV")
}

# LCLS-II: cryo interlock will rely on this,
# must be set to Cavity
record(mbbo, "$(BASE)DF_FC_SRC") {
  field(DTYP, "FEED Register Write")
  field(OUT , "@name=$(NAME) reg=cfreq_src_sel")
  field(ZRVL, "0")
  field(ZRST, "Loopback")
  field(ONVL, "1")
  field(ONST, "Forward")
  field(TWVL, "2")
  field(TWST, "Reverse")
  field(THVL, "3")
  field(THST, "Cavity")
  field(VAL,  "3")
  field(PINI, "YES")
  info(autosaveFields, "VAL")
  info(feed:info:setting, "$(BASE)DF_FC_SRC")
}

record(mbbi, "$(BASE)J18_RBV") {
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=J18_debug")
  field(TSE , "-2")
  info(feed:info:setting, "$(BASE)J18_RBV")
}

record(mbbo, "$(BASE)FREQ_SEL") {
  field(DESC, "IF frequency FW selection")
  field(DTYP, "FEED Register Write")
  field(OMSL, "supervisory")
  field(ZRVL, "0")
  field(ZRST, "1.300e9 Hz")
  field(ONVL, "1")
  field(ONST, "3.900e9 Hz")
  field(VAL,  "0")
  field(OUT , "@name=$(NAME) reg=if_out_sel wait=false")
  field(PINI, "YES")
  info(autosaveFields, "VAL")
  info(feed:info:setting, "$(BASE)FREQ_SEL")
}

record(mbbi, "$(BASE)FREQ_SEL_RBV") {
  field(DESC, "IF frequency FW selection")
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(TSE , "-2")
  field(ZRVL, "0")
  field(ZRST, "1.300e9 Hz")
  field(ONVL, "1")
  field(ONST, "3.900e9 Hz")
  field(INP , "@name=$(NAME) reg=if_out_sel")
  info(feed:info:setting, "$(BASE)FREQ_SEL_RBV")
}
