Merge changes from 3.15 branch into 7.0

modules/database/src/std/rec/aoRecord.dbd.pod

@@ -4,7 +4,7 @@
 # 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. 
+# in file LICENSE that is included with this distribution.
 #*************************************************************************
 
 =title Analog Output Record (ao)
@@ -104,33 +104,32 @@ The LINR field can specify C<LINEAR> or C<SLOPE> for linear conversions,
 C<NO CONVERSION> for no conversions at all, or the name of a breakpoint table
 such as C<typeKdegC> for breakpoint conversions.
 
-Note that the ESLO, EOFF, EGUF, and EGUL fields are only used for linear
-conversions.
-Also note that none of these fields have any significance for records that use
-the Soft Channel device support module.
+The EGUF and EGUL fields should be set for C<LINEAR> conversions, and the ESLO
+and EOFF fields for C<SLOPE> conversion. Note that none of these fields have any
+significance for records that use the Soft Channel device support module.
 
 =over
 
 =item EGUF, EGUF
 
-The user must calculate these fields when configuring the database for records
+The user must set these fields when configuring the database for records
 that use C<LINEAR> conversions.
 They are used to calculate the values for ESLO and EOFF.
 See Conversion Specification for more information on how to calculate these
 fields.
 
+=item ESLO, EOFF
+
+Computed by device support from EGUF and EGUL when LINR specifies C<LINEAR>.
+These values must be supplied by the user when LINR specifies C<SLOPE>.
+Used only when LINR is C<LINEAR> or C<SLOPE>.
+
 =item AOFF, ASLO
 
 These fields are adjustment parameters for the raw output values.
 They are applied to the raw output value after conversion from engineering
 units.
 
-=item ESLO, EOFF
-
-Computed by device support using EGUF and EGUL when LINR specifies C<LINEAR>.
-These values must be supplied by the user when LINR specifies C<SLOPE>.
-Used only when LINR is C<LINEAR> or C<SLOPE>.
-
 =item ROFF
 
 This field can be used to offset the raw value generated by the conversion
@@ -168,8 +167,7 @@ addresses.
 
 For soft records the output link can be a database link, a channel
 access link, or a constant value. If the link is a constant, no output
-is sent. See Address Specification for information on the format of
-database and channel access addresses.
+is sent.
 
 =fields DTYP, OUT
 
@@ -193,8 +191,8 @@ The PREC field determines the floating point precision with which to
 display VAL, OVAL and PVAL. It is used whenever the get_precision
 record support routine is called.
 
-See Fields Common to All Record Types for more on the record name
-(NAME) and description (DESC) fields.
+See L<Fields Common to All Record Types|dbCommonRecord/Operator Display
+Parameters> for more on the record name (NAME) and description (DESC) fields.
 
 =fields EGU, HOPR, LOPR, PREC, NAME, DESC
 
@@ -209,9 +207,10 @@ and LOW fields, which must be floating-point values. For each of these
 fields, there is a corresponding severity field which can be either
 NO_ALARM, MINOR, or MAJOR.
 
-See Alarm Specification for a complete explanation of alarms and these
-fields. See Invalid Alarm Output Action for more information on the
-IVOA and IVOV fields. Alarm Fields lists other fields related to a
+See L<Invalid Output Action Fields|dbCommonOutput/Invalid Output Action Fields>
+for more information on the IVOA and IVOV fields.
+
+L<Alarm Fields|dbCommonRecord/Alarm Fields> lists other fields related to a
 alarms that are common to all record types.
 
 =fields HIHI, HIGH, LOW, LOLO, HHSV, HSV, LSV, LLSV, HYST, IVOA, IVOV
@@ -260,15 +259,15 @@ processing.
 
 =fields ORAW, RBV, ORBV, LALM, ALST, MLST, INIT, PBRK, LBRK, PVAL, OMOD
 
-The following fields are used to operate the analog output in the
-simulation mode. See Fields Common to Many Record Types for more
-information on these fields.
+The following fields are used when the record is in simulation mode. See
+L<Fields Common to Output Record Types|dbCommonOutput/Simulation Fields> for
+more information on these fields.
 
 =fields SIOL, SIML, SIMM, SIMS
 
 =cut
 
-    include "dbCommon.dbd" 
+    include "dbCommon.dbd"
     field(VAL,DBF_DOUBLE) {
         prompt("Desired Output")
         promptgroup("50 - Output")
@@ -602,6 +601,8 @@ get_precision, get_graphic_double, and get_control_double routines.
 
 =item init_record
 
+C<long init_record(aoRecord *prec, int pass);>
+
 This routine initializes SIMM if SIML is a constant or creates a
 channel access link if SIML is PV_LINK. If SIOL is PV_LINK a channel
 access link is created.
@@ -633,10 +634,14 @@ then set to FALSE. PVAL is set to VAL.
 
 =item process
 
+C<long process(aoRecord *prec);>
+
 See next section.
 
 =item special
 
+C<long special(DBADDR *paddr, int after);>
+
 The only special processing for analog output records is SPC_LINCONV
 which is invoked whenever either of the fields LINR, EGUF, EGUL or ROFF
 is changed If the device support routine special_linconv exists it is
@@ -647,6 +652,8 @@ re-initialized.
 
 =item get_alarm_double
 
+C<long get_alarm_double(DBADDR *, struct dbr_alDouble *);>
+
 Sets the following values:
 
  upper_alarm_limit = HIHI
@@ -796,7 +803,9 @@ Device support consists of the following routines:
 
 =over
 
-=item C<long report(int level)>
+=item report
+
+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.
@@ -806,7 +815,9 @@ information at higher levels, or to select different types of information with
 different levels.
 Level zero should print no more than a small summary.
 
-=item C<long init(int after)>
+=item init
+
+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
@@ -814,7 +825,9 @@ 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.
 
-=item C<long init_record(aoRecord *prec)>
+=item init_record
+
+C<long init_record(aoRecord *prec);>
 
 This optional routine is called by the record initialization code for each ao
 record instance that has its DTYP field set to use this device support.
@@ -836,7 +849,9 @@ should also fetch that value and put it into the record's RVAL or VAL field. The
 return value should be zero if the RVAL field has been set, or 2 if either the
 VAL field has been set or if the last output value cannot be retrieved.
 
-=item C<long get_ioint_info(int cmd, aoRecord *prec, IOSCANPVT *piosl)>
+=item get_ioint_info
+
+C<long get_ioint_info(int cmd, aoRecord *prec, IOSCANPVT *piosl);>
 
 This optional routine is called whenever the record's SCAN field is being
 changed to or from the value C<I/O Intr> to find out which I/O Interrupt Scan
@@ -864,7 +879,9 @@ thread.
 The C<scanIoRequest()> routine is safe to call from an interrupt service routine
 on embedded architectures (vxWorks and RTEMS).
 
-=item C<long write_ao(aoRecord *prec)>
+=item write_ao
+
+C<long write_ao(aoRecord *prec);>
 
 This essential routine is called whenever the record has a new output value to
 send to the device. It is responsible for performing the write operation, using
@@ -883,7 +900,9 @@ that happens the C<write_ao()> routine will be called again with PACT still set
 to TRUE; it should then set it to FALSE to indicate the write has completed, and
 return.
 
-=item C<long special_linconv(aoRecord *prec, int after)>
+=item special_linconv
+
+C<long special_linconv(aoRecord *prec, int after);>
 
 This optional routine should be provided if the record type's unit conversion
 features are used by the device support's C<write_ao()> routine utilizing the