boRecord.c

Go to the documentation of this file.

/*************************************************************************\
* 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.
* EPICS BASE is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/

/* recBo.c - Record Support Routines for Binary Output records */
/*
 *      Original Author: Bob Dalesio
 *      Date:            7-14-89
 */

#include <stddef.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdio.h>
#include <string.h>

#include "dbDefs.h"
#include "epicsPrint.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 "menuIvoa.h"
#include "menuOmsl.h"
#include "menuYesNo.h"

#define GEN_SIZE_OFFSET
#include "boRecord.h"
#undef  GEN_SIZE_OFFSET
#include "epicsExport.h"

/* 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 *);
static long get_precision(const DBADDR *, long *);
static long get_enum_str(const DBADDR *, char *);
static long get_enum_strs(const DBADDR *, struct dbr_enumStrs *);
static long put_enum_str(const DBADDR *, const char *);
#define get_graphic_double NULL
static long get_control_double(DBADDR *, struct dbr_ctrlDouble *);
#define get_alarm_double NULL

rset boRSET={
    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,boRSET);

int boHIGHprecision = 2;
epicsExportAddress(int, boHIGHprecision);
double boHIGHlimit = 100000;
epicsExportAddress(double, boHIGHlimit);

/* control block for callback*/
typedef struct myCallback {
        epicsCallback        callback;
        struct dbCommon *precord;
}myCallback;

static void checkAlarms(boRecord *);
static void monitor(boRecord *);
static long writeValue(boRecord *);

static void myCallbackFunc(epicsCallback *arg)
{
    myCallback *pcallback;
    boRecord *prec;

    callbackGetUser(pcallback,arg);
    prec=(boRecord *)pcallback->precord;
    dbScanLock((struct dbCommon *)prec);
    if(prec->pact) {
        if((prec->val==1) && (prec->high>0)){
            myCallback *pcallback;
            pcallback = (myCallback *)(prec->rpvt);
            callbackSetPriority(prec->prio, &pcallback->callback);
            callbackRequestDelayed(&pcallback->callback,(double)prec->high);
        }
    } else {
        prec->val = 0;
        dbProcess((struct dbCommon *)prec);
    }
    dbScanUnlock((struct dbCommon *)prec);
}

static long init_record(struct dbCommon *pcommon,int pass)
{
    struct boRecord *prec = (struct boRecord *)pcommon;
    bodset *pdset = (bodset *) prec->dset;
    unsigned short ival = 0;
    long status = 0;
    myCallback *pcallback;

    if (pass == 0) return 0;

    recGblInitSimm(pcommon, &prec->sscn, &prec->oldsimm, &prec->simm, &prec->siml);

    if (!pdset) {
        recGblRecordError(S_dev_noDSET, prec, "bo: init_record");
        return S_dev_noDSET;
    }

    /* must have  write_bo functions defined */
    if ((pdset->common.number < 5) || (pdset->write_bo == NULL)) {
        recGblRecordError(S_dev_missingSup, prec, "bo: init_record");
        return S_dev_missingSup;
    }

    /* get the initial value */
    if (recGblInitConstantLink(&prec->dol, DBF_USHORT, &ival)) {
        prec->val = !!ival;
        prec->udf = FALSE;
    }

    pcallback = (myCallback *) calloc(1, sizeof(myCallback));
    prec->rpvt = pcallback;
    callbackSetCallback(myCallbackFunc, &pcallback->callback);
    callbackSetUser(pcallback, &pcallback->callback);
    pcallback->precord = (struct dbCommon *) prec;

    if (pdset->common.init_record) {
    status=(*pdset->common.init_record)(pcommon);
        if(status==0) {
            if(prec->rval==0) prec->val = 0;
            else prec->val = 1;
            prec->udf = FALSE;
        } else if (status==2) status=0;
    }
    prec->mlst = prec->val;
    /* convert val to rval */
    if ( prec->mask != 0 ) {
        if(prec->val==0) prec->rval = 0;
        else prec->rval = prec->mask;
    } else prec->rval = (epicsUInt32)prec->val;

    prec->mlst = prec->val;
    prec->lalm = prec->val;
    prec->oraw = prec->rval;
    prec->orbv = prec->rbv;
    return(status);
}

static long process(struct dbCommon *pcommon)
{
    struct boRecord *prec = (struct boRecord *)pcommon;
    bodset  *pdset = (bodset *)(prec->dset);
    long            status=0;
    unsigned char   pact=prec->pact;

    if( (pdset==NULL) || (pdset->write_bo==NULL) ) {
        prec->pact=TRUE;
        recGblRecordError(S_dev_missingSup,(void *)prec,"write_bo");
        return(S_dev_missingSup);
    }
    if (!prec->pact) {
        if (!dbLinkIsConstant(&prec->dol) &&
                prec->omsl == menuOmslclosed_loop) {
            unsigned short val;

            prec->pact = TRUE;
            status=dbGetLink(&prec->dol,DBR_USHORT, &val,0,0);
            prec->pact = FALSE;
            if(status==0){
                prec->val = val;
                prec->udf = FALSE;
            }else {
                recGblSetSevr(prec,LINK_ALARM,INVALID_ALARM);
            }
        }

        /* convert val to rval */
        if ( prec->mask != 0 ) {
            if(prec->val==0) prec->rval = 0;
            else prec->rval = prec->mask;
        } else prec->rval = (epicsUInt32)prec->val;
    }

    /* check for alarms */
    checkAlarms(prec);

    if (prec->nsev < INVALID_ALARM )
            status=writeValue(prec); /* write the new value */
    else {
        switch (prec->ivoa) {
            case (menuIvoaContinue_normally) :
                status=writeValue(prec); /* write the new value */
                break;
            case (menuIvoaDon_t_drive_outputs) :
                break;
            case (menuIvoaSet_output_to_IVOV) :
                if(prec->pact == FALSE){
                    /* convert val to rval */
                    prec->val=prec->ivov;
                    if ( prec->mask != 0 ) {
                        if(prec->val==0) prec->rval = 0;
                        else prec->rval = prec->mask;
                    } else prec->rval = (epicsUInt32)prec->val;
                }
                status=writeValue(prec); /* write the new value */
                break;
            default :
                status=-1;
                recGblRecordError(S_db_badField,(void *)prec,
                        "bo:process Illegal IVOA field");
        }
    }

    /* check if device support set pact */
    if ( !pact && prec->pact ) return(0);
    prec->pact = TRUE;

    recGblGetTimeStampSimm(prec, prec->simm, NULL);

    if((prec->val==1) && (prec->high>0)){
        myCallback *pcallback;
        pcallback = (myCallback *)(prec->rpvt);
        callbackSetPriority(prec->prio, &pcallback->callback);
        callbackRequestDelayed(&pcallback->callback,(double)prec->high);
    }
    /* 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)
{
    boRecord    *prec = (boRecord *)(paddr->precord);
    int          special_type = paddr->special;

    switch(special_type) {
        case(SPC_MOD):
            if (dbGetFieldIndex(paddr) == boRecordSIMM) {
                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, "bo: special");
            return(S_db_badChoice);
    }
}

#define indexof(field) boRecord##field

static long get_units(DBADDR *paddr, char *units)
{
    if(dbGetFieldIndex(paddr) == indexof(HIGH))
        strcpy(units, "s");
    return(0);
}

static long get_precision(const DBADDR *paddr, long *precision)
{
    if(dbGetFieldIndex(paddr) == indexof(HIGH))
        *precision = boHIGHprecision;
    else
        recGblGetPrec(paddr,precision);
    return(0);
}

static long get_control_double(DBADDR *paddr,struct dbr_ctrlDouble *pcd)
{
    if(dbGetFieldIndex(paddr) == indexof(HIGH)) {
        pcd->lower_ctrl_limit = 0.0;
        pcd->upper_ctrl_limit = boHIGHlimit;
    } else
        recGblGetControlDouble(paddr,pcd);
    return(0);
}

static long get_enum_str(const DBADDR *paddr, char *pstring)
{
    boRecord        *prec=(boRecord *)paddr->precord;
    int             index;
    unsigned short  *pfield = (unsigned short *)paddr->pfield;


    index = dbGetFieldIndex(paddr);
    if(index!=indexof(VAL)) {
        strcpy(pstring,"Illegal_Value");
    } else if(*pfield==0) {
        strncpy(pstring,prec->znam,sizeof(prec->znam));
        pstring[sizeof(prec->znam)] = 0;
    } else if(*pfield==1) {
        strncpy(pstring,prec->onam,sizeof(prec->onam));
        pstring[sizeof(prec->onam)] = 0;
    } else {
        strcpy(pstring,"Illegal_Value");
    }
    return(0);
}

static long get_enum_strs(const DBADDR *paddr,struct dbr_enumStrs *pes)
{
    boRecord    *prec=(boRecord *)paddr->precord;

    /*SETTING no_str=0 breaks channel access clients*/
    pes->no_str = 2;
    memset(pes->strs,'\0',sizeof(pes->strs));
    strncpy(pes->strs[0],prec->znam,sizeof(pes->strs[0]));
    if(*prec->znam!=0) pes->no_str=1;
    strncpy(pes->strs[1],prec->onam,sizeof(pes->strs[1]));
    if(*prec->onam!=0) pes->no_str=2;
    return(0);
}
static long put_enum_str(const DBADDR *paddr, const char *pstring)
{
    boRecord     *prec=(boRecord *)paddr->precord;

    if(strncmp(pstring,prec->znam,sizeof(prec->znam))==0) prec->val = 0;
    else  if(strncmp(pstring,prec->onam,sizeof(prec->onam))==0) prec->val = 1;
    else return(S_db_badChoice);
    return(0);
}


static void checkAlarms(boRecord *prec)
{
    unsigned short val = prec->val;

    /* check for udf alarm */
    if(prec->udf == TRUE ){
        recGblSetSevr(prec,UDF_ALARM,prec->udfs);
    }

    /* check for  state alarm */
    if (val == 0){
        recGblSetSevr(prec,STATE_ALARM,prec->zsv);
    }else{
        recGblSetSevr(prec,STATE_ALARM,prec->osv);
    }

        /* check for cos alarm */
    if(val == prec->lalm) return;
    recGblSetSevr(prec,COS_ALARM,prec->cosv);
    prec->lalm = val;
    return;
}

static void monitor(boRecord *prec)
{
    unsigned short  monitor_mask;

    monitor_mask = recGblResetAlarms(prec);
    /* check for value change */
    if (prec->mlst != prec->val){
        /* post events for value change and archive change */
        monitor_mask |= (DBE_VALUE | DBE_LOG);
        /* update last value monitored */
        prec->mlst = prec->val;
    }

    /* send out monitors connected to the value field */
    if (monitor_mask){
        db_post_events(prec,&prec->val,monitor_mask);
    }
    if(prec->oraw!=prec->rval) {
        db_post_events(prec,&prec->rval,
            monitor_mask|DBE_VALUE|DBE_LOG);
        prec->oraw = prec->rval;
    }
    if(prec->orbv!=prec->rbv) {
        db_post_events(prec,&prec->rbv,
            monitor_mask|DBE_VALUE|DBE_LOG);
        prec->orbv = prec->rbv;
    }
    return;
}

static long writeValue(boRecord *prec)
{
    bodset *pdset = (bodset *) 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->write_bo(prec);
        break;

    case menuYesNoYES: {
        recGblSetSevr(prec, SIMM_ALARM, prec->sims);
        if (prec->pact || (prec->sdly < 0.)) {
            status = dbPutLink(&prec->siol, DBR_USHORT, &prec->val, 1);
            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;
}