epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Fix header levels in some .dbd.pod files

Browse Source
This commit is contained in:
Andrew Johnson
2025-05-23 16:19:26 -05:00
parent 9eca4bc448
commit 99682610a0
5 changed files with 60 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
modules/database/src/ioc/db/dbCommon.dbd.pod
View File

@@ -7,7 +7,7 @@
# in file LICENSE that is included with this distribution.
#*************************************************************************
=head3 Operator Display Parameters
=head2 Operator Display Parameters
The B<NAME> field contains the record name which must be unique within an
EPICS Channel Access name space. The name is supplied by the application
@@ -43,7 +43,7 @@ record's purpose. Maximum length is 40 characters.
size(29)
}
=head3 Scan Fields
=head2 Scan Fields
These fields contain information related to how and when a record processes. A
few records have unique fields that also affect how they process. These
@@ -244,7 +244,7 @@ The B<SPVT> field is for internal use by the scanning system.
interest(3)
}
=head3 Alarm Fields
=head2 Alarm Fields
Alarm fields indicate the status and severity of record alarms, or determine
how and when alarms are triggered. Of course, many records have alarm-related
@@ -391,7 +391,7 @@ initial severity of the record being undefined after the IOC boots.
extra("struct scan_element *spvt")
}
=head3 Device Fields
=head2 Device Fields
The B<RSET> field contains the address of the Record Support Entry Table. See
the Application Developers Guide for details on usage.
@@ -445,7 +445,7 @@ The B<DPVT> field is is for private use of the device support modules.
menu(menuPriority)
}
=head3 Debugging Fields
=head2 Debugging Fields
The B<TPRO> field can be used to trace record processing. When this field is
non-zero and the record is processed, a trace message will be be printed for
@@ -460,7 +460,7 @@ database processing can be supported using this.
=fields TPRO, BKPT
=head3 Miscellaneous Fields
=head2 Miscellaneous Fields
The B<ASG> string field sets the name of the access security group used for this
record. If left empty, the record is placed in group C<DEFAULT>.

10
modules/database/src/ioc/db/dbCommonInput.dbd.pod
View File

@@ -11,7 +11,7 @@ These fields usually have the same meaning whenever they are used.
See also L<Fields Common to All Record Types|dbCommonRecord> and L<Fields Common
to Output Record Types|dbCommonOutput>.
=head3 Input and Value Fields
=head2 Input and Value Fields
The B<INP> field specifies an input link. It is used by the device support
routines to obtain input. For soft analog records it can be a constant, a
@@ -30,7 +30,7 @@ reads values directly into VAL, bypassing this field.
The B<VAL> field contains the record's final value, after any needed
conversions have been performed.
=head3 Device Input
=head2 Device Input
A device input routine normally returns one of the following values to its
associated record support routine:
@@ -65,7 +65,7 @@ to the engineering units value.
=back
=head3 Device Support for Soft Records
=head2 Device Support for Soft Records
In most cases, two soft output device support modules are provided: Soft Channel
and Raw Soft Channel. Both allow INP to be a constant, a database link, or a
@@ -83,7 +83,7 @@ If a value was returned by the link the UDF field is set to FALSE. The device
support read routine normally returns the status from C<dbGetLink()>.
=head3 Input Simulation Fields
=head2 Input Simulation Fields
The B<SIMM> field controls simulation mode.
By setting this field to YES or RAW, the record can be switched into
@@ -121,7 +121,7 @@ The B<SSCN> field specifies the SCAN mechanism to be used in simulation mode.
This is specifically useful for 'I/O Intr' scanned records, which would
otherwise never be scanned in simulation mode.
=head3 Simulation Mode for Input Records
=head2 Simulation Mode for Input Records
An input record can be switched into simulation mode of operation by setting
the value of SIMM to YES or RAW.

16
modules/database/src/ioc/db/dbCommonOutput.dbd.pod
View File

@@ -11,7 +11,7 @@ These fields usually have the same meaning whenever they are used.
See also L<Fields Common to All Record Types|dbCommonRecord> and L<Fields Common to
Input Records|dbCommonInput>.
=head3 Output and Value Fields
=head2 Output and Value Fields
The B<OUT> field specifies an output link. It is used by the device support
routines to decide where to send output. For soft records, it can be a
@@ -38,7 +38,7 @@ The B<RBV> field contains - whenever possible - the actual read back value
obtained from the hardware itself or from the associated device driver.
=head3 Device Support for Soft Records
=head2 Device Support for Soft Records
Normally two soft output device support modules are provided, Soft Channel and
and Raw Soft Channel. Both write a value through the output link OUT.
@@ -50,7 +50,7 @@ The device support write routine normally calls C<dbPutLink()> which writes a
value through the OUT link, and returns the status from that call.
=head3 Input and Mode Select Fields
=head2 Input and Mode Select Fields
The B<DOL> field is a link from which the desired output value can be fetched.
DOL can be a constant, a database link, or a channel access link. If DOL is a
@@ -63,7 +63,7 @@ value C<closed_loop>. By setting this field a record can be switched between
supervisory and closed loop mode of operation. While in closed loop mode, the
VAL field cannot be set via dbPuts.
=head3 Output Mode Selection
=head2 Output Mode Selection
The fields DOL and OMSL are used to allow the output record to be part of a
closed loop control algorithm. OMSL is meaningful only if DOL refers to a
@@ -76,7 +76,7 @@ types with an OIF field and OIF is Full, VAL is set equal to the value obtained
from the location referenced by DOL; if OIF is Incremental VAL is incremented by
the value obtained from DOL.
=head3 Invalid Output Action Fields
=head2 Invalid Output Action Fields
The B<IVOA> field specifies the output action for the case that the record is
put into an INVALID alarm severity. IVOA can be one of the following actions:
@@ -102,7 +102,7 @@ in engineering units. If a new severity has been set to INVALID and IVOA is
C<Set output to IVOV>, then VAL is set to IVOV and converted to RVAL before
device support is called.
=head3 Invalid Alarm Output Action
=head2 Invalid Alarm Output Action
Whenever an output record is put into INVALID alarm severity, IVOA specifies
an action to take. The record support process routine for each output record
@@ -142,7 +142,7 @@ If IVOA not one of the above, an error message is generated.
=back
=head3 Output Simulation Fields
=head2 Output Simulation Fields
The B<SIMM> field controls simulation mode. It has either the value YES or NO.
By setting this field to YES, the record can be switched into simulation mode
@@ -171,7 +171,7 @@ The B<SSCN> field specifies the SCAN mechanism to be used in simulation mode.
This is specifically useful for 'I/O Intr' scanned records, which would
otherwise never be scanned in simulation mode.
=head3 Simulation Mode for Output Records
=head2 Simulation Mode for Output Records
An output record can be switched into simulation mode of operation by setting
the value of SIMM to YES. During simulation, the record will be put into alarm

4
modules/database/src/ioc/db/dbCommonRecord.dbd.pod
View File

@@ -8,8 +8,8 @@
This section contains a description of the fields that are common to all record
types. These fields are defined in dbCommon.dbd.
See also L<Fields Common to Input Record Types|dbCommonInput> and L<Fields
Common to Output Record Types|dbCommonOutput>.
See also L<Fields Common to Input Record Types|dbCommonInput> and
L<Fields Common to Output Record Types|dbCommonOutput>.
=recordtype dbCommon

64
modules/database/src/std/rec/boRecord.dbd.pod
View File

@@ -21,7 +21,7 @@ the HIGH field is configured.
recordtype(bo) {
=head3 Scan Parameters
=head2 Scan Parameters
The binary output record has the standard fields for specifying under what
circumstances the record will be processed.
@@ -29,7 +29,7 @@ These fields are described in L<Scan Fields|dbCommonRecord/Scan Fields>.
=fields SCAN, PHAS, EVNT, PRIO, PINI
=head3 Desired Output Parameters
=head2 Desired Output Parameters
The binary output record must specify where its desired output originates.
The desired output needs to be in engineering units.
@@ -50,7 +50,7 @@ for information on hardware addresses and links.
=fields DOL, OMSL
=head3 Convert and Write Parameters
=head2 Convert and Write Parameters
These parameters are used to determine where the binary output writes to
and how to convert the engineering units to a raw signal. After VAL is set
@@ -76,7 +76,7 @@ device back to 0 after I<N> number of seconds.
=fields DTYP, OUT, VAL, RVAL, HIGH, ZNAM, ONAM
=head3 Conversion Parameters
=head2 Conversion Parameters
The ZNAM field has the string that corresponds to the 0 state, and the ONAM
field holds the string that corresponds to the 1 state. These fields, other
@@ -98,7 +98,7 @@ the device or link to 1, then changes it back to 0 after I<N> number of seconds.
=fields ZNAM, ONAM, HIGH
=head3 Output Specification
=head2 Output Specification
The OUT field specifies where the binary output record writes its output.
It must specify the address of an I/O card if the record sends its output
@@ -116,7 +116,7 @@ for information on the format of the database and channel access addresses.
Also, see L<Device Support For Soft Records> in this chapter for more on output
to other records.
=head3 Operator Display Parameters
=head2 Operator Display Parameters
These parameters are used to present meaningful data to the operator, The
C<get_enum_str()> record support routine can retrieve the state string
@@ -129,7 +129,7 @@ Parameters> for more on the record name (NAME) and description (DESC) fields.
=fields ZNAM, ONAM, NAME, DESC
=head3 Alarm Parameters
=head2 Alarm Parameters
These parameters are used to determine the binary output's alarm condition
and to determine the severity of that condition. The possible alarm
@@ -147,7 +147,7 @@ common to all record types.
=fields ZSV, OSV, COSV, IVOA, IVOV
=head3 Run-Time Parameters
=head2 Run-Time Parameters
These parameters are used by the run-time code for processiong the binary
output. They are not configurable using a configuration tool. They
@@ -178,7 +178,7 @@ The WPDT field is a private field for honoring seconds to hold HIGH.
=fields ORAW, MASK, RBV, ORBV, LALM, MLST, RPVT, WDPT
=head3 Simulation Mode Parameters
=head2 Simulation Mode Parameters
The following fields are used to operate the record in simulation mode.
@@ -376,11 +376,9 @@ for more information on simulation mode and its fields.
}
=head2 Record Support
=head2 Record Support Routines
=head3 Record Support Routines
=head2 C<init_record>
=head3 C<init_record>
This routine initializes SIMM if SIML is a constant or creates a channel
access link if SIML is PV_LINK. If SIOL is a PV_LINK a channel access link
@@ -398,19 +396,19 @@ or initialzed to 0 if DOL is zero, and UDF is set to FALSE.
If device support includes C<init_record()>, it is called. VAL is set using
RVAL, and UDF is set to FALSE.
=head2 C<process>
=head3 C<process>
See next section.
=head2 C<get_enum_str>
=head3 C<get_enum_str>
Retrieves ASCII string corresponding to VAL.
=head2 C<get_enum_strs>
=head3 C<get_enum_strs>
Retrieves ASCII strings for ZNAM and ONAM.
=head2 C<put_enum_str>
=head3 C<put_enum_str>
Checks if string matches ZNAM or ONAM, and if it does, sets VAL.
@@ -434,30 +432,37 @@ If PACT is FALSE
=over
=item *
If DOL holds a link and OMSL is C<closed_loop>
=over
=item *
get values from DOL
=item *
check for link alarm
=item *
force VAL to be 0 or 1
=item *
if MASK is defined
=over
=item *
if VAL is 0 set RVAL = 0
=back
=item *
else set RVAL = MASK
=back
@@ -489,24 +494,28 @@ VAL=0 after WAIT seconds.
Check to see if monitors should be invoked.
=over 1
=over
=item *
Alarm monitors are invoked if the alarm status or severity has changed.
=item *
Archive and value change monitors are invoked if MLST is not equal to VAL.
=item *
Monitors for RVAL and for RBV are checked whenever other monitors are
invoked.
=item *
NSEV and NSTA are reset to 0.
=back
=item 8
=item 8.
Scan forward link if necessary, set PACT FALSE, and return
@@ -527,7 +536,7 @@ are primarily interested in the following fields:
Device support consists of the following routines:
=head4 long report(int level)
=head4 C<long report(int level)>
This optional routine is called by the IOC command C<dbior> and is passed the
report level that was requested by the user.
@@ -537,7 +546,7 @@ information at higher levels, or to select different types of information with
different levels.
Level zero should print no more than a small summary.
=head4 long init(int after)
=head4 C<long init(int after)>
This optional routine is called twice at IOC initialization time.
The first call happens before any of the C<init_record()> calls are made, with
@@ -545,41 +554,46 @@ the integer parameter C<after> set to 0.
The second call happens after all of the C<init_record()> calls have been made,
with C<after> set to 1.
=head2 C<init_record(precord)>
=head4 C<init_record(precord)>
This routine is optional. If provided, it is called by record support
This routine is optional. If provided, it is called by the record support's
C<init_record()> routine. It should determine MASK if it is needed.
=over
=item *
0: Success. RVAL modified (VAL will be set accordingly)
=item *
2: Success. VAL modified
=item *
other: Error
=back
=head2 C<get_ioint_info(int cmd, struct dbCommon *precord, IOSCANPVT *ppvt)>
=head4 C<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. C<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.
=head2 C<write_bo(precord)>
=head4 C<write_bo(precord)>
This routine must output a new value. It returns the following values:
=over
=item *
0: Success
=item *
other: Error.
=back