NB: This manual documents a 20+ year old version of EPICS, see here for the EPICS 7 Record Reference documentation.
EPICS Record Reference Manual
Continuous Electron Beam Accelerator Facility
Southeastern Universities Research Association
This record's operation is similar to that of the multi-bit binary input record, and it has many fields in common with it. This record also has two available soft device support modules--Soft Channel
and Raw Soft Channel
. The fields fall into the following categories:
scan parameters
read and convert parameters
operator display parameters
alarm parameters
run-time and simulation mode parameters
dbst
utility in R3.13.
Two soft device support modules can be specified in DTYP--Soft Channel
and Raw Soft Channel
. Raw Soft Channel
reads the value into RVAL, upon which the normal conversion process is undergone. Soft Channel
reads any unsigned integer directly into VAL. For a soft mbbiDirect record, the INP field can be a constant, a database, or a channel access link. If INP is a constant, then the VAL is initialized to the INP value but can be changed at run-time via dbPutField or dbPutLink. See Address Specification, Chapter 1, 2, for information on how to database links.
For records that don't use Soft Channel
device support, RVAL is used to determine VAL as follows:
Field | Summary | Type | DCT | Initial | Access | Modify | Rec Proc Monitor | PP |
---|---|---|---|---|---|---|---|---|
VAL | Value Field | ENUM | No | 0 | Yes | Yes | Yes | Yes |
INP | Input Link | INLINK | Yes | 0 | No | No | N/A | No |
RVAL | Raw Data Value | ULONG | No | 0 | Yes | Yes | Yes | Yes |
SHFT | Shift | USHORT | No | 0 | Yes | No | No | No |
B0 | Bit 0 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B1 | Bit 1 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B2 | Bit 2 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B3 | Bit 3 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B4 | Bit 4 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B5 | Bit 5 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B6 | Bit 6 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B7 | Bit 7 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B8 | Bit 8 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
B9 | Bit 9 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
BA | Bit 10 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
BB | Bit 12 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
BC | Bit 13 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
BD | Bit 14 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
BE | Bit 15 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
BF | Bit 16 Value | UCHAR | Yes | 0 | Yes | Yes | Yes | Yes |
See Chapter 2, Fields Common to All Record Types, for more on the record name (NAME) and description (DESC) fields.
Field | Summary | Type | DCT | Initial | Access | Modify | Rec Proc Monitor | PP |
---|---|---|---|---|---|---|---|---|
NAME | Record Name | STRING [29] | Yes | 0 | Yes | No | No | No |
DESC | Description | STRING [29] | Yes | Null | Yes | Yes | No | No |
Alarm Fields, Chapter 2, 3, lists other fields related to a alarms that are common to all record types.
MASK is used by device support routine to read hardware register. Record support sets low order NOBT bits in MASK. Device support can shift this value.
The LALM field implements the change of state alarm severity by holding the value of VAL when the previous change of state alarm was issued.
MLST holds the value when the last monitor for value change was triggered.
SDEF is used by record support to save time if no states are defined.
Field | Summary | Type | DCT | Initial | Access | Modify | Rec Proc Monitor | PP |
---|---|---|---|---|---|---|---|---|
NOBT | Number of Bits | SHORT | Yes | 0 | Yes | No | No | No |
ORAW | Old Raw Data | ULONG | No | 0 | Yes | No | No | No |
MASK | Mask | ULONG | No | 0 | Yes | No | No | No |
LALM | Last Alarmed | USHORT | No | 0 | Yes | No | No | No |
MLST | Monitor Last | USHORT | No | 0 | Yes | No | No | No |
SDEF | States Defined? | SHORT | No | 0 | Yes | No | No | No |
The following fields are used to operate the mbbiDirect record in the simulation mode. See Chapter 3, Fields Common to Many Record Types, for more information on these fields.
Field | Summary | Type | DCT | Initial | Access | Modify | Rec Proc Monitor | PP |
---|---|---|---|---|---|---|---|---|
SIOL | Simulation Value Location | INLINK | Yes | 0 | No | No | N/A | No |
SVAL | Simulation Value | DOUBLE | No | 0 | Yes | Yes | No | No |
SIML | Simulation Mode Location | INLINK | Yes | 0 | No | No | N/A | No |
SIMM | Simulation Mode | GBLCHOICE | No | 0 | Yes | Yes | No | No |
SIMS | Simulation Mode Alarm Severity | GBLCHOICE | Yes | 0 | Yes | Yes | No | No |
This routine next checks to see that device support is available and a device support read routine is defined. If either does not exist, an error message is issued and processing is terminated.
Clears MASK and then sets the NOBT low order bits.
If device support includes init_record, it is called.
refresh_bits is then called to refresh all the bit fields based on a hardware value.
The primary responsibility of the device support routines is to obtain a new raw input value whenever read_mbbiDirect is called. The device support routines are primarily interested in the following fields:
Name | Summary | Description |
---|---|---|
PACT | Processing Active | See Chapter 2, Fields Common to All Record Types for an explanation of these fields. |
DPVT | Device Private | |
UDF | VAL Undefined | |
NSEV | New Alarm Severity | |
NSTA | New Alarm Status | |
NOBT | Number of Bits | Number of hardware bits accessed. They must be consecutive. |
VAL | Value Field | This field is set by the device support routines if they don't want record support to set it. |
INP | Input Link | This field is used by the device support routines to locate its input. |
RVAL | Raw Data Value | It is the responsibility of the device support routine to give this field a value. |
MASK | Mask | This is a mask used to read the hardware. Record support sets the low order NOBT bits. The device support routine can shift the bits. The device support routine should perform the shift in init_record. |
SHFT | Shift | This can be set by the device support module at init_record time. |
report(FILE fp, paddr)Not currently used.
init()This routine is called once during IOC initialization.
init_record(precord)This routine is optional. If provided, it is called by the record support init_record routine. If it uses MASK, it should shift it as necessary and also give SHFT a value.
get_ioint_info(int cmd,struct dbCommon *precord,IOSCANPVT *ppvt)This routine is called by the ioEventScan system each time the record is added or deleted from an I/O event scan list. cmd has the value (0,1) if the record is being (added to, deleted from) an I/O event list. It must be provided for any device type that can use the ioEvent scanner.
read_mbbiDirect(precord)This routine must provide a new input value. It returns the following values:
Soft Channel
and Raw Soft Channel
, are provided for multi-bit binary input direct records not related to actual hardware devices. The INP link type must be either CONSTANT, DB_LINK, or CA_LINK.If the INP link type is constant, then the constant value is stored into VAL by init_record, and UDF is set to FALSE. VAL can be changed via dbPut requests. If the INP link type is PV_LINK, then dbCaAddInlink is called by init_record.
read_mbbiDirect calls recGblGetLinkValue to read the current value of VAL.
See Input Records, Chapter 3, 2, for a further explanation.
If the return status of recGblGetLinkValue is zero, then read_mbbi sets UDF to FALSE. The status of recGblGetLinkValue is returned.
Generated with Harlequin WebMaker