441 lines
12 KiB
C
441 lines
12 KiB
C
/*************************************************************************\
|
||
* Copyright (c) 2008 UChicago Argonne LLC, as Operator of Argonne
|
||
* National Laboratory.
|
||
* Copyright (c) 2002 The Regents of the University of California, as
|
||
* Operator of Los Alamos National Laboratory.
|
||
* SPDX-License-Identifier: EPICS
|
||
* EPICS BASE is distributed subject to a Software License Agreement found
|
||
* in file LICENSE that is included with this distribution.
|
||
\*************************************************************************/
|
||
|
||
/* recLongin.c - Record Support Routines for Longin records */
|
||
/*
|
||
* Author: Janet Anderson
|
||
* Date: 9/23/91
|
||
*/
|
||
|
||
#include <stddef.h>
|
||
#include <stdlib.h>
|
||
#include <stdarg.h>
|
||
#include <stdio.h>
|
||
#include <string.h>
|
||
#include <math.h>
|
||
|
||
#include "dbDefs.h"
|
||
#include "epicsPrint.h"
|
||
#include "epicsMath.h"
|
||
#include "alarm.h"
|
||
#include "callback.h"
|
||
#include "dbAccess.h"
|
||
#include "dbEvent.h"
|
||
#include "dbFldTypes.h"
|
||
#include "devSup.h"
|
||
#include "errMdef.h"
|
||
#include "recSup.h"
|
||
#include "recGbl.h"
|
||
#include "special.h"
|
||
#include "menuYesNo.h"
|
||
|
||
#define GEN_SIZE_OFFSET
|
||
#include "longinRecord.h"
|
||
#undef GEN_SIZE_OFFSET
|
||
#include "epicsExport.h"
|
||
|
||
/* Hysteresis for alarm filtering: 1-1/e */
|
||
#define THRESHOLD 0.6321
|
||
/* Create RSET - Record Support Entry Table*/
|
||
#define report NULL
|
||
#define initialize NULL
|
||
static long init_record(struct dbCommon *, int);
|
||
static long process(struct dbCommon *);
|
||
static long special(DBADDR *, int);
|
||
#define get_value NULL
|
||
#define cvt_dbaddr NULL
|
||
#define get_array_info NULL
|
||
#define put_array_info NULL
|
||
static long get_units(DBADDR *, char *);
|
||
#define get_precision NULL
|
||
#define get_enum_str NULL
|
||
#define get_enum_strs NULL
|
||
#define put_enum_str NULL
|
||
static long get_graphic_double(DBADDR *, struct dbr_grDouble *);
|
||
static long get_control_double(DBADDR *, struct dbr_ctrlDouble *);
|
||
static long get_alarm_double(DBADDR *, struct dbr_alDouble *);
|
||
|
||
rset longinRSET={
|
||
RSETNUMBER,
|
||
report,
|
||
initialize,
|
||
init_record,
|
||
process,
|
||
special,
|
||
get_value,
|
||
cvt_dbaddr,
|
||
get_array_info,
|
||
put_array_info,
|
||
get_units,
|
||
get_precision,
|
||
get_enum_str,
|
||
get_enum_strs,
|
||
put_enum_str,
|
||
get_graphic_double,
|
||
get_control_double,
|
||
get_alarm_double
|
||
};
|
||
epicsExportAddress(rset,longinRSET);
|
||
|
||
static void checkAlarms(longinRecord *prec, epicsTimeStamp *timeLast);
|
||
static void monitor(longinRecord *prec);
|
||
static long readValue(longinRecord *prec);
|
||
|
||
|
||
static long init_record(struct dbCommon *pcommon, int pass)
|
||
{
|
||
struct longinRecord *prec = (struct longinRecord *)pcommon;
|
||
longindset *pdset = (longindset *) prec->dset;
|
||
|
||
if (pass == 0) return 0;
|
||
|
||
recGblInitSimm(pcommon, &prec->sscn, &prec->oldsimm, &prec->simm, &prec->siml);
|
||
recGblInitConstantLink(&prec->siol, DBF_LONG, &prec->sval);
|
||
|
||
if (!pdset) {
|
||
recGblRecordError(S_dev_noDSET, prec, "longin: init_record");
|
||
return S_dev_noDSET;
|
||
}
|
||
|
||
/* must have read_longin function defined */
|
||
if ((pdset->common.number < 5) || (pdset->read_longin == NULL)) {
|
||
recGblRecordError(S_dev_missingSup, prec, "longin: init_record");
|
||
return S_dev_missingSup;
|
||
}
|
||
|
||
if (pdset->common.init_record) {
|
||
long status = pdset->common.init_record(pcommon);
|
||
|
||
if (status)
|
||
return status;
|
||
}
|
||
|
||
prec->mlst = prec->val;
|
||
prec->alst = prec->val;
|
||
prec->lalm = prec->val;
|
||
return 0;
|
||
}
|
||
|
||
static long process(struct dbCommon *pcommon)
|
||
{
|
||
struct longinRecord *prec = (struct longinRecord *)pcommon;
|
||
longindset *pdset = (longindset *)(prec->dset);
|
||
long status;
|
||
unsigned char pact=prec->pact;
|
||
epicsTimeStamp timeLast;
|
||
|
||
if( (pdset==NULL) || (pdset->read_longin==NULL) ) {
|
||
prec->pact=TRUE;
|
||
recGblRecordError(S_dev_missingSup, prec, "read_longin");
|
||
return(S_dev_missingSup);
|
||
}
|
||
timeLast = prec->time;
|
||
|
||
status=readValue(prec); /* read the new value */
|
||
/* check if device support set pact */
|
||
if ( !pact && prec->pact ) return(0);
|
||
prec->pact = TRUE;
|
||
|
||
recGblGetTimeStampSimm(prec, prec->simm, &prec->siol);
|
||
|
||
if (status==0) prec->udf = FALSE;
|
||
|
||
/* check for alarms */
|
||
checkAlarms(prec, &timeLast);
|
||
/* check event list */
|
||
monitor(prec);
|
||
/* process the forward scan link record */
|
||
recGblFwdLink(prec);
|
||
|
||
prec->pact=FALSE;
|
||
return(status);
|
||
}
|
||
|
||
static long special(DBADDR *paddr, int after)
|
||
{
|
||
longinRecord *prec = (longinRecord *)(paddr->precord);
|
||
int special_type = paddr->special;
|
||
|
||
switch(special_type) {
|
||
case(SPC_MOD):
|
||
if (dbGetFieldIndex(paddr) == longinRecordSIMM) {
|
||
if (!after)
|
||
recGblSaveSimm(prec->sscn, &prec->oldsimm, prec->simm);
|
||
else
|
||
recGblCheckSimm((dbCommon *)prec, &prec->sscn, prec->oldsimm, prec->simm);
|
||
return(0);
|
||
}
|
||
default:
|
||
recGblDbaddrError(S_db_badChoice, paddr, "longin: special");
|
||
return(S_db_badChoice);
|
||
}
|
||
}
|
||
|
||
#define indexof(field) longinRecord##field
|
||
|
||
static long get_units(DBADDR *paddr,char *units)
|
||
{
|
||
longinRecord *prec=(longinRecord *)paddr->precord;
|
||
|
||
if(paddr->pfldDes->field_type == DBF_LONG) {
|
||
strncpy(units,prec->egu,DB_UNITS_SIZE);
|
||
}
|
||
return(0);
|
||
}
|
||
|
||
|
||
static long get_graphic_double(DBADDR *paddr, struct dbr_grDouble *pgd)
|
||
{
|
||
longinRecord *prec=(longinRecord *)paddr->precord;
|
||
|
||
switch (dbGetFieldIndex(paddr)) {
|
||
case indexof(VAL):
|
||
case indexof(HIHI):
|
||
case indexof(HIGH):
|
||
case indexof(LOW):
|
||
case indexof(LOLO):
|
||
case indexof(LALM):
|
||
case indexof(ALST):
|
||
case indexof(MLST):
|
||
case indexof(SVAL):
|
||
pgd->upper_disp_limit = prec->hopr;
|
||
pgd->lower_disp_limit = prec->lopr;
|
||
break;
|
||
default:
|
||
recGblGetGraphicDouble(paddr,pgd);
|
||
}
|
||
return(0);
|
||
}
|
||
|
||
static long get_control_double(DBADDR *paddr, struct dbr_ctrlDouble *pcd)
|
||
{
|
||
longinRecord *prec=(longinRecord *)paddr->precord;
|
||
|
||
switch (dbGetFieldIndex(paddr)) {
|
||
case indexof(VAL):
|
||
case indexof(HIHI):
|
||
case indexof(HIGH):
|
||
case indexof(LOW):
|
||
case indexof(LOLO):
|
||
case indexof(LALM):
|
||
case indexof(ALST):
|
||
case indexof(MLST):
|
||
case indexof(SVAL):
|
||
pcd->upper_ctrl_limit = prec->hopr;
|
||
pcd->lower_ctrl_limit = prec->lopr;
|
||
break;
|
||
default:
|
||
recGblGetControlDouble(paddr,pcd);
|
||
}
|
||
return(0);
|
||
}
|
||
|
||
static long get_alarm_double(DBADDR *paddr, struct dbr_alDouble *pad)
|
||
{
|
||
longinRecord *prec=(longinRecord *)paddr->precord;
|
||
|
||
if (dbGetFieldIndex(paddr) == indexof(VAL)){
|
||
pad->upper_alarm_limit = prec->hhsv ? prec->hihi : epicsNAN;
|
||
pad->upper_warning_limit = prec->hsv ? prec->high : epicsNAN;
|
||
pad->lower_warning_limit = prec->lsv ? prec->low : epicsNAN;
|
||
pad->lower_alarm_limit = prec->llsv ? prec->lolo : epicsNAN;
|
||
}
|
||
else
|
||
recGblGetAlarmDouble(paddr,pad);
|
||
return 0;
|
||
}
|
||
|
||
static void checkAlarms(longinRecord *prec, epicsTimeStamp *timeLast)
|
||
{
|
||
enum {
|
||
range_Lolo = 1,
|
||
range_Low,
|
||
range_Normal,
|
||
range_High,
|
||
range_Hihi
|
||
} alarmRange;
|
||
static const epicsEnum16 range_stat[] = {
|
||
SOFT_ALARM, LOLO_ALARM, LOW_ALARM,
|
||
NO_ALARM, HIGH_ALARM, HIHI_ALARM
|
||
};
|
||
|
||
double aftc, afvl;
|
||
epicsInt32 val, hyst, lalm;
|
||
epicsInt32 alev;
|
||
epicsEnum16 asev;
|
||
|
||
if (prec->udf) {
|
||
recGblSetSevr(prec, UDF_ALARM, prec->udfs);
|
||
prec->afvl = 0;
|
||
return;
|
||
}
|
||
|
||
val = prec->val;
|
||
hyst = prec->hyst;
|
||
lalm = prec->lalm;
|
||
|
||
/* check VAL against alarm limits */
|
||
if ((asev = prec->hhsv) &&
|
||
(val >= (alev = prec->hihi) ||
|
||
((lalm == alev) && (val >= alev - hyst))))
|
||
alarmRange = range_Hihi;
|
||
else
|
||
if ((asev = prec->llsv) &&
|
||
(val <= (alev = prec->lolo) ||
|
||
((lalm == alev) && (val <= alev + hyst))))
|
||
alarmRange = range_Lolo;
|
||
else
|
||
if ((asev = prec->hsv) &&
|
||
(val >= (alev = prec->high) ||
|
||
((lalm == alev) && (val >= alev - hyst))))
|
||
alarmRange = range_High;
|
||
else
|
||
if ((asev = prec->lsv) &&
|
||
(val <= (alev = prec->low) ||
|
||
((lalm == alev) && (val <= alev + hyst))))
|
||
alarmRange = range_Low;
|
||
else {
|
||
alev = val;
|
||
asev = NO_ALARM;
|
||
alarmRange = range_Normal;
|
||
}
|
||
|
||
aftc = prec->aftc;
|
||
afvl = 0;
|
||
|
||
if (aftc > 0) {
|
||
/* Apply level filtering */
|
||
afvl = prec->afvl;
|
||
if (afvl == 0) {
|
||
afvl = (double)alarmRange;
|
||
} else {
|
||
double t = epicsTimeDiffInSeconds(&prec->time, timeLast);
|
||
double alpha = aftc / (t + aftc);
|
||
|
||
/* The sign of afvl indicates whether the result should be
|
||
* rounded up or down. This gives the filter hysteresis.
|
||
* If afvl > 0 the floor() function rounds to a lower alarm
|
||
* level, otherwise to a higher.
|
||
*/
|
||
afvl = alpha * afvl +
|
||
((afvl > 0) ? (1 - alpha) : (alpha - 1)) * alarmRange;
|
||
if (afvl - floor(afvl) > THRESHOLD)
|
||
afvl = -afvl; /* reverse rounding */
|
||
|
||
alarmRange = abs((int)floor(afvl));
|
||
switch (alarmRange) {
|
||
case range_Hihi:
|
||
asev = prec->hhsv;
|
||
alev = prec->hihi;
|
||
break;
|
||
case range_High:
|
||
asev = prec->hsv;
|
||
alev = prec->high;
|
||
break;
|
||
case range_Normal:
|
||
asev = NO_ALARM;
|
||
break;
|
||
case range_Low:
|
||
asev = prec->lsv;
|
||
alev = prec->low;
|
||
break;
|
||
case range_Lolo:
|
||
asev = prec->llsv;
|
||
alev = prec->lolo;
|
||
break;
|
||
}
|
||
}
|
||
}
|
||
prec->afvl = afvl;
|
||
|
||
if (asev) {
|
||
/* Report alarm condition, store LALM for future HYST calculations */
|
||
if (recGblSetSevr(prec, range_stat[alarmRange], asev))
|
||
prec->lalm = alev;
|
||
} else {
|
||
/* No alarm condition, reset LALM */
|
||
prec->lalm = val;
|
||
}
|
||
}
|
||
|
||
/* DELTA calculates the absolute difference between its arguments
|
||
* expressed as an unsigned 32-bit integer */
|
||
#define DELTA(last, val) \
|
||
((epicsUInt32) ((last) > (val) ? (last) - (val) : (val) - (last)))
|
||
|
||
static void monitor(longinRecord *prec)
|
||
{
|
||
unsigned short monitor_mask = recGblResetAlarms(prec);
|
||
|
||
if (prec->mdel < 0 ||
|
||
DELTA(prec->mlst, prec->val) > (epicsUInt32) prec->mdel) {
|
||
/* post events for value change */
|
||
monitor_mask |= DBE_VALUE;
|
||
/* update last value monitored */
|
||
prec->mlst = prec->val;
|
||
}
|
||
|
||
if (prec->adel < 0 ||
|
||
DELTA(prec->alst, prec->val) > (epicsUInt32) prec->adel) {
|
||
/* post events for archive value change */
|
||
monitor_mask |= DBE_LOG;
|
||
/* update last archive value monitored */
|
||
prec->alst = prec->val;
|
||
}
|
||
|
||
/* send out monitors connected to the value field */
|
||
if (monitor_mask)
|
||
db_post_events(prec, &prec->val, monitor_mask);
|
||
}
|
||
|
||
static long readValue(longinRecord *prec)
|
||
{
|
||
longindset *pdset = (longindset *) prec->dset;
|
||
long status = 0;
|
||
|
||
if (!prec->pact) {
|
||
status = recGblGetSimm((dbCommon *)prec, &prec->sscn, &prec->oldsimm, &prec->simm, &prec->siml);
|
||
if (status) return status;
|
||
}
|
||
|
||
switch (prec->simm) {
|
||
case menuYesNoNO:
|
||
status = pdset->read_longin(prec);
|
||
break;
|
||
|
||
case menuYesNoYES: {
|
||
recGblSetSevr(prec, SIMM_ALARM, prec->sims);
|
||
if (prec->pact || (prec->sdly < 0.)) {
|
||
status = dbGetLink(&prec->siol, DBR_LONG, &prec->sval, 0, 0);
|
||
if (status == 0) {
|
||
prec->val = prec->sval;
|
||
prec->udf = FALSE;
|
||
}
|
||
prec->pact = FALSE;
|
||
} else { /* !prec->pact && delay >= 0. */
|
||
epicsCallback *pvt = prec->simpvt;
|
||
if (!pvt) {
|
||
pvt = calloc(1, sizeof(epicsCallback)); /* very lazy allocation of callback structure */
|
||
prec->simpvt = pvt;
|
||
}
|
||
if (pvt) callbackRequestProcessCallbackDelayed(pvt, prec->prio, prec, prec->sdly);
|
||
prec->pact = TRUE;
|
||
}
|
||
break;
|
||
}
|
||
|
||
default:
|
||
recGblSetSevr(prec, SOFT_ALARM, INVALID_ALARM);
|
||
status = -1;
|
||
}
|
||
|
||
return status;
|
||
}
|