#==================================
#----------------------------------
# cav_step.template:
#----------------------------------
#==================================

#==================================
# Seq program diagnostics
#==================================

# Prints messages to ioc console
record(bo, "$(PREF)STEP:DBGCTRL") {
  field(DESC, "Cav stepper SNL msg verbosity")
  field(OMSL, "supervisory")
  field(ZNAM, "Off")
  field(ONAM, "On")
  field(OSV,  "MINOR")
  field(VAL,  "0")
}

#==================================
# Stepper mode, manual or auto
#==================================

record(bo, "$(PREF)STEP:MODECTRL") {
  field(DESC, "Set auto/manual tuner")
  field(OMSL, "supervisory")
  field(VAL,  "0")
  field(ZNAM, "Manual")
  field(ONAM, "Auto")
  field(PINI, "YES")
  field(OUT,  "$(PREF)STEP:CTRLWRD.B7 PP")
#  field(ASG,  "")
}

record(bi, "$(PREF)STEP:MODE") {
  field(DESC, "Auto/manual tuner")
  field(SCAN, "1 second")
  field(ZNAM, "Manual")
  field(ONAM, "Auto")
  field(INP,  "$(PREF)STEP:CTRLWRD.B7")
#  field(ASG,  "")
}

#==================================
# Tuner stepper mover command 
# requests. Set to 1 to make request.
# Seq program listens to these, 
# takes action, then resets PV(s) to 0.
#==================================

# Move request in positive direction. 
# Moves tuner mover by NSTEPS steps
record(bo, "$(PREF)STEP:MOV_REQ_POS") {
  field(DESC, "Request tuner positive move")
  field(OMSL, "supervisory")
  field(VAL,  "0")
  field(PINI, "YES")
#  field(ASG,  "")
}

# Move request in negative direction. 
# Moves tuner mover by NSTEPS steps
record(bo, "$(PREF)STEP:MOV_REQ_NEG") {
  field(DESC, "Request tuner negative move")
  field(OMSL, "supervisory")
  field(ZNAM, "No request")
  field(ONAM, "Move request")
  field(VAL,  "0")
  field(PINI, "YES")
#  field(ASG,  "")
}

# Move abort request. 
record(bo, "$(PREF)STEP:ABORT_REQ") {
  field(DESC, "Request abort tuner move")
  field(OMSL, "supervisory")
  field(ZNAM, "No request")
  field(ONAM, "Abort request")
  field(VAL,  "0")
  field(PINI, "YES")
#  field(ASG,  "")
}

## Move 'clear' request. 
# Eventually remove.
record(bo, "$(PREF)STEP:CLEAR_REQ") {
  field(DESC, "Request tuner clear")
  field(OMSL, "supervisory")
  field(ZNAM, "No request")
  field(ONAM, "Clear request")
  field(VAL,  "0")
  field(PINI, "YES")
#  field(ASG,  "")
}

# Last status
record(mbbo, "$(PREF)STEP:STATMSG") {
  field(OMSL, "supervisory")
  field(ZRST, "Await request")
  field(ZRSV, "NO_ALARM")
  field(ONST, "Move requested")
  field(ONSV, "NO_ALARM")
  field(TWST, "Move issued")
  field(TWSV, "NO_ALARM")
  field(THST, "Abort issued")
  field(THSV, "NO_ALARM")
  field(FRST, "Clear issued")
  field(FRSV, "NO_ALARM")
  field(FVST, "Still moving")
  field(FVSV, "MAJOR")
  field(SXST, "Inhibit bit set")
  field(SXSV, "MAJOR")
  field(SVST, "In auto mode")
  field(SVSV, "MAJOR")
  field(EIST, "Abort bit set")
  field(EISV, "MAJOR")
  field(NIST, "Sign limit")
  field(NISV, "MAJOR")
  field(TEST, "Abs limit")
  field(TESV, "MAJOR")
  field(ELST, "At limit A")
  field(ELSV, "MAJOR")
  field(TVST, "At limit B")
  field(TVSV, "MAJOR")
  field(PINI, "YES")
  info(autosaveFields, "VAL")
}

#==================================
# Tuner move request number of steps.
# Absolute value. Direction of
# move is determined by which
# move request PV is used (above)--
# POS(itive) or NEG(ative).
# Seq program pushes value
# to REGNSTEPS when executing move
#==================================

record(longout, "$(PREF)STEP:NSTEPS") {
  field(OMSL, "supervisory")
  field(PINI, "YES")
  field(EGU,  "steps")
# DRVL set to enforce positive value
  field(DRVL, "0")
# 50000 from LLRF func req doc, but
# not practical, so try 1e6
  field(DRVH, "1000000")
  info(autosaveFields, "VAL DRVH")
}

#==================================
# Motor settings
#==================================

# Set correct motor settings
record(seq, "$(PREF)STEP:INIT_SETTINGS") {
  field(DESC, "Set motor settings")
  field(SELM, "All")
  field(SCAN, "Passive")
  field(PINI, "NO")
  field(DOL1, "20000")
  field(LNK1, "$(PREF)STEP:VELO PP")
  field(DOL2, "4000")
  field(LNK2, "$(PREF)STEP:ACCEL PP")
  field(DOL3, "11")
  field(LNK3, "$(PREF)STEP:DRVI PP")
}

record(longout, "$(PREF)STEP:VELO") {
  field(DESC, "Stepper velocity")
  field(DTYP, "FEED Register Write")
  field(OMSL, "supervisory")
  field(OUT , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_vlcty")
  field(EGU,  "usteps/s")
  field(PINI, "YES")
  field(VAL,  "20000")
# TODO: autosave?
# info(autosaveFields, "VAL")
  info(feed:info:setting, "$(PREF)STEP:VELO")
}

record(longin, "$(PREF)STEP:VELO_RBV") {
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_vlcty")
  field(EGU,  "usteps/s")
  field(LOLO, "19999")
  field(HIHI, "20001")
  field(LLSV, "MAJOR")
  field(HHSV, "MAJOR")
  info(feed:info:setting, "$(PREF)STEP:VELO_RBV")
}

record(longout, "$(PREF)STEP:ACCEL") {
  field(DESC, "Stepper acceleration")
  field(DTYP, "FEED Register Write")
  field(OMSL, "supervisory")
  field(OUT , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_acc")
  field(EGU,  "usteps/s")
  field(PINI, "YES")  
  field(VAL,  "4000")
# TODO: autosave?
# info(autosaveFields, "VAL")
  info(feed:info:setting, "$(PREF)STEP:ACCEL")
}

record(longin, "$(PREF)STEP:ACCEL_RBV") {
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_acc")
  field(EGU,  "usteps/s")
  info(feed:info:setting, "$(PREF)STEP:ACCEL_RBV")
  field(LOLO, "3999")
  field(HIHI, "4001")
  field(LLSV, "MAJOR")
  field(HHSV, "MAJOR")
}

record(longout, "$(PREF)STEP:DRVI") {
  field(DESC, "Stepper drive current")
  field(DTYP, "FEED Register Write")
  field(OMSL, "supervisory")
  field(OUT , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_drvI")
  field(EGU,  "raw")
  field(VAL,  "11")
  field(PINI, "YES")
# TODO: autosave?
# info(autosaveFields, "VAL")
  info(feed:info:setting, "$(PREF)STEP:DRVI")
}

record(longin, "$(PREF)STEP:DRVI_RBV") {
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_drvI")
  field(EGU,  "raw")
  field(LOLO, "10")
  field(HIHI, "12")
  field(LLSV, "MAJOR")
  field(HHSV, "MAJOR")
  field(FLNK, "$(PREF)STEP:DRVI_RBV_A")
  info(feed:info:setting, "$(PREF)STEP:DRVI_RBV")
}

record(calc, "$(PREF)STEP:DRVI_RBV_A") {
  field(CALC, "((A+1)/32)*1.17*1000")
  field(INPA, "$(PREF)STEP:DRVI_RBV MS")
  field(EGU,  "mA")
}

#==================================
# Status and control words
#==================================

# Status word, readback only
# Bit definitions (from edm screen, double-check):
# 0 - Motor moving
# 1 - Last direction, 0=positive, 1=negative
# 2 - Motor done
# 3 - Limit B
# 4 - Limit A
# 5 - Any limit
# 6 - Inhibit
# 7 - Low current (25%)
# 8 - Sign limit
# 9 - Absolute limit
# Temporary make output record
record(mbbiDirect, "$(PREF)STEP:STATWRD") {
  field(INP, "$(PREF)STEP:REG_STATWRD MS")
}

# Control word
# Bit definitions (from seq program, double-check):
# 0 - Move command
# 1 -
# 2 -
# 3 - Abort command
# 4 - Clear-done commandx
# 5 - Move direction, 0=positive, 1=negative
# 6 - 
# 7 - Control mode, 0=manual, 1=auto
record(mbboDirect, "$(PREF)STEP:CTRLWRD") {
  field(OMSL, "supervisory")
  field(FLNK, "$(PREF)STEP:REG_CTRLWRD")
  field(PINI, "")
  info(autosaveFields_pass0, "VAL B0 B1 B2 B3 B4 B5 B6 B7 B8 B9 BA BB")
}

record(mbbiDirect, "$(PREF)STEP:CTRLWRD_RBV") {
  field(SCAN, "1 second")
  field(INP, "$(PREF)STEP:REG_CTRLWRD_RBV MS")
#  field(INP, "TST0:reg_m_status_$(BIT)_RBV MS")
}

#==================================
# Clear step counts
#==================================

record(bo, "$(PREF)STEP:TOTABS_RESET") {
  field(DESC, "Reset abs steps count")
  field(OMSL, "supervisory")
  field(VAL,  "0")
  field(ZNAM, "No reset")
  field(ONAM, "Reset")
  field(OUT,  "$(PREF)STEP:CTRLWRD.B9 PP")
  field(HIGH, "0.5")
#  field(ASG,  "")
}

record(bo, "$(PREF)STEP:TOTSGN_RESET") {
  field(DESC, "Reset signed steps count")
  field(OMSL, "supervisory")
  field(VAL,  "0")
  field(ZNAM, "No reset")
  field(ONAM, "Reset")
  field(OUT,  "$(PREF)STEP:CTRLWRD.B8 PP")
  field(HIGH, "0.5")
#  field(ASG,  "")
}


#==================================
# Firmware registers
#==================================

record(longout, "$(PREF)STEP:REG_CTRLWRD") {
  field(DTYP, "FEED Register Write")
  field(OMSL, "closed_loop")
  field(DOL,  "$(PREF)STEP:CTRLWRD MS")
  field(OUT , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_cntl")
  info(feed:info:setting, "$(PREF)STEP:REG_CTRLWRD")
}

record(longin, "$(PREF)STEP:REG_CTRLWRD_RBV") {
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_cntl")
  info(feed:info:setting, "$(PREF)STEP:REG_CTRLWRD_RBV")
  field(FLNK, "$(PREF)STEP:CTRLWRD_RBV")
}

record(longin, "$(PREF)STEP:REG_STATWRD") {
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=m_status_$(BIT)")
  info(feed:info:setting, "$(PREF)STEP:REG_STATWRD")
  field(FLNK, "$(PREF)STEP:STATWRD")
}

record(longout, "$(PREF)STEP:REG_NSTEPS") {
  field(DTYP, "FEED Register Write")
  field(OMSL, "supervisory")
  field(EGU,  "steps")
  field(OUT , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_steps")
  info(feed:info:setting, "$(PREF)STEP:REG_NSTEPS")
}

record(longin, "$(PREF)STEP:REG_NSTEPS_RBV") {
  field(DESC, "Last request steps")
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=rc_dsp_$(BIT)_m_steps")
  field(EGU,  "steps")
  info(feed:info:setting, "$(PREF)STEP:REG_NSTEPS_RBV")
}

record(longin, "$(PREF)STEP:REG_TOTABS") {
  field(DESC, "Total steps moved, absolute")
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=m_abs_steps_$(BIT)")
  field(EGU,  "steps")
  info(feed:info:setting, "$(PREF)STEP:REG_STEPSABS")
}

record(longin, "$(PREF)STEP:REG_TOTSGN") {
  field(DESC, "Total steps moved, signed")
  field(DTYP, "FEED Register Read")
  field(SCAN, "1 second")
  field(INP , "@name=$(NAME) reg=m_sgn_steps_$(BIT)")
  field(EGU,  "steps")
  info(feed:info:setting, "$(PREF)STEP:REG_TOTSGN")
}
