Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Generic variable definition

First, define the usual environment variables in the startup script.

Code Block
languagebash
# ===========================================
#            ENVIRONMENT VARIABLES
# ===========================================
# Setup environment variables
epicsEnvSet("LOCATION","SYS0"         )   
epicsEnvSet("SYS_PV", "TPR:SYS0:MS12" )
epicsEnvSet("IOC_PV", "SIOC:SYS0:MS12")
epicsEnvSet("IOC",    "sioc-sys0-ms12")
epicsEnvSet("SUBSYS" ,"trigAlign"     )   
epicsEnvSet("SYS", "SYS0"             )   
epicsEnvSet("UNIT", "MS12"            )   

# Support Large Arrays/Waveforms; Number in Bytes
# The default max size for a channel access array is 16Kb
epicsEnvSet("EPICS_CA_MAX_ARRAY_BYTES", "80000000")


Common setup

Load dbd and IOC health/monitoring records.  Also, set up autosave and load the LCLS access configuration file.  Finally, copy the archive file in $IOC_DATA to enable record archiving.

Code Block
languagebash
## Load dbd
dbLoadDatabase("dbd/masterSource.dbd", 0, 0)
masterSource_registerRecordDeviceDriver(pdbbase)

## Environment variables
epicsEnvSet("ENGINEER", "MATT WEAVER")
epicsEnvSet("STREAM_PROTOCOL_PATH", "${TOP}/db")
## Tag log messages with IOC name
epicsEnvSet("EPICS_IOC_LOG_CLIENT_INET", "${IOC}")

## Load records
# **** Load iocAdmin databases to support IOC Health and monitoring ****
dbLoadRecords("db/iocAdminSoft.db", "IOC=${IOC_NAME}")
dbLoadRecords("db/iocAdminScanMon.db", "IOC=${IOC_NAME}")
dbLoadRecords("db/iocRelease.db", "IOC=${IOC_NAME}")

## Autosave initialization
< $(TOP)/iocBoot/common/autosave_init.cmd

## Channel Access Security:
# This is required if you use caPutLog.
# Set access security file
# Load common LCLS Access Configuration File
< ${ACF_INIT}

## Update archive pv list in ${IOC_DATA}
system("cp $(TOP)/archive/${IOC}.archive ${IOC_DATA}/${IOC}/archive/")

Autosave initialization

Tell the IOC where to find the list of record names and where they will be autosaved.  Also, restore previously autosaved values.

Code Block
languagebash
# =====================================================================
# Load database for autosave status
# =====================================================================
dbLoadRecords("db/save_restoreStatus.db", "P=${IOC_NAME}:")
                                                                                                                                                   
# ============================================================
# If all PVs don't connect continue anyway
# ============================================================
save_restoreSet_IncompleteSetsOk(1)

# ============================================================
# created save/restore backup files with date string
# useful for recovery.
# ============================================================
save_restoreSet_DatedBackupFiles(1)

# ============================================================
# Where to find the list of PVs to save
# ============================================================
set_requestfile_path("${IOC_DATA}/${IOC}/autosave-req")

# ============================================================
# Where to write the save files that will be used to restore
# ============================================================
set_savefile_path("${IOC_DATA}/${IOC}/autosave")

# ============================================================
# Prefix that is use to update save/restore status database
# records
# ============================================================
save_restoreSet_status_prefix("${IOC_NAME}:")

## Restore datasets
set_pass0_restoreFile("info_positions.sav")
set_pass1_restoreFile("info_positions.sav")

set_pass0_restoreFile("info_settings.sav")
set_pass1_restoreFile("info_settings.sav")


Besides the auto-generated record names for autosave, copy the manually generated list of records to be autosaved and restore their previously autosaved values.

Code Block
languagebash
# Copy over the manual settings request file
system("cp $(TOP)/autosave/${IOC}.req ${IOC_DATA}/${IOC}/autosave-req/")

# Load manual settings from autosave
set_pass0_restoreFile("${IOC}.sav")
set_pass1_restoreFile("${IOC}.sav")

Real-time environment & databases

Yaml initialization

Load the YAML hierarchy and register configuration.

Database loading

Load the relevant trigger alignment records.

Asyn driver configuration

Initialize and configure the trigger alignment Asyn driver to interface with the FPGA registers.

Archiver list

...


Code Block
languagebash
# ===========================================
#               DB LOADING
# ===========================================
# Driver DB
dbLoadRecords("db/trigAlignAsynDriver.db", "DEVICE=${SYS_PV},PORT=trigAlignPort")

# Load database for autosave status
dbLoadRecords("db/save_restoreStatus.db", "P=${IOC_PV}:")

# Load sequence admin
dbLoadRecords("db/devSeqCar.db","SIOC=${IOC_PV}")

Asyn driver configuration

Initialize and configure the trigger alignment Asyn driver to interface with the FPGA registers.


Code Block
languagebash
# ===========================================
#              DRIVER SETUP
# ===========================================
trigAlignAsynDriverConfigure("trigAlignPort","/dev/tprb")

epicsThreadSleep(5.)

Archiver list

A complete list of the records to archive is provided below.


Code Block
languagebash
(base) skoufis@aird-b50-srv01  (master) $ cat archive/sioc-sys0-ms12.archive 
# archive_iocAdmin Archive template
# Format:
# <PVNAME> <PERIOD> [ monitor ]

# Archive these values only when they change
SIOC:SYS0:MS12:APP_DIR 30 monitor 
SIOC:SYS0:MS12:APP_DIR1 30 monitor 
SIOC:SYS0:MS12:APP_DIR2 30 monitor 
SIOC:SYS0:MS12:CA_CLNT_CNT 1 monitor 
SIOC:SYS0:MS12:CA_CONN_CNT 1 monitor 
SIOC:SYS0:MS12:EPICS_VERS 30 monitor
SIOC:SYS0:MS12:FD_CNT 1 monitor 
SIOC:SYS0:MS12:FD_FREE 1 monitor 
SIOC:SYS0:MS12:FD_MAX 1 monitor 
SIOC:SYS0:MS12:HOSTNAME 30 monitor
SIOC:SYS0:MS12:KERNEL_VERS 30 monitor
SIOC:SYS0:MS12:RECORD_CNT 10 monitor
SIOC:SYS0:MS12:START_CNT 30 monitor
SIOC:SYS0:MS12:STARTTOD 30 monitor
SIOC:SYS0:MS12:ST_SCRIPT 30 monitor 
SIOC:SYS0:MS12:ST_SCRIPT1 30 monitor 
SIOC:SYS0:MS12:ST_SCRIPT2 30 monitor 
SIOC:SYS0:MS12:SUSP_TASK_CNT 30 monitor 
SIOC:SYS0:MS12:SYSRESET 30 monitor 

# Archive these values at the specified rate
SIOC:SYS0:MS12:SYS_CPU_LOAD 10
SIOC:SYS0:MS12:LOAD 10 
SIOC:SYS0:MS12:MEM_BLK_FREE 10 
SIOC:SYS0:MS12:MEM_FREE 10 
SIOC:SYS0:MS12:MEM_USED 10 
SIOC:SYS0:MS12:UPTIME 3600 

IOC initialization

Initialize the IOC and logging capability.

...