diff --git a/documentation/RecordReference.md b/documentation/RecordReference.md index a43ac2b8a..2b09409ff 100644 --- a/documentation/RecordReference.md +++ b/documentation/RecordReference.md @@ -54,6 +54,9 @@ website where these original reference chapters are now being published. * [Field Type Menu](menuFtype.html) * [Invalid Value Output Action Menu](menuIvoa.html) * [Output Mode Select Menu](menuOmsl.html) +* [Process at iocInit Menu](menuPini.html) +* [Post Monitors Menu](menuPost.html) +* [Priority Menu](menuPrio.html) * [Scan Menu](menuScan.html) * [Simulation Mode Menu](menuSimm.html) * [Yes/No Menu](menuYesNo.html) diff --git a/src/ioc/db/menuIvoa.dbd.pod b/src/ioc/db/menuIvoa.dbd.pod index 8ea2c7a7d..d971c4680 100644 --- a/src/ioc/db/menuIvoa.dbd.pod +++ b/src/ioc/db/menuIvoa.dbd.pod @@ -9,7 +9,7 @@ =head1 Menu menuIvoa -This menu specifies the possibile actions to take when the INVALID alarm is +This menu specifies the possible actions to take when the INVALID alarm is triggered. See individual record types for more information. =menu menuIvoa diff --git a/src/ioc/db/menuPini.dbd b/src/ioc/db/menuPini.dbd deleted file mode 100644 index 96aca7298..000000000 --- a/src/ioc/db/menuPini.dbd +++ /dev/null @@ -1,16 +0,0 @@ -#************************************************************************* -# Copyright (c) 2009 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. -#************************************************************************* -menu(menuPini) { - choice(menuPiniNO,"NO") - choice(menuPiniYES,"YES") - choice(menuPiniRUN,"RUN") - choice(menuPiniRUNNING,"RUNNING") - choice(menuPiniPAUSE,"PAUSE") - choice(menuPiniPAUSED,"PAUSED") -} diff --git a/src/ioc/db/menuPini.dbd.pod b/src/ioc/db/menuPini.dbd.pod new file mode 100644 index 000000000..837f77146 --- /dev/null +++ b/src/ioc/db/menuPini.dbd.pod @@ -0,0 +1,66 @@ +#************************************************************************* +# Copyright (c) 2009 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. +#************************************************************************* + +=head1 Menu menuPini + +This menu defines the choices for the C field, which controls whether +and when each record should be processed during initialization or pausing +of the IOC. Choices other than C cause record processing at the +following initHook transitions: + +=over 4 + +=item YES + +C E All records and links have been +initialized but the scan threads and CA server are not running yet, nor +have CA links been connected up. The initHook C +immediately follows this procssing. + +=item RUN + +C E The C routine has just been called, +although not necessarily for the first time. + +=item RUNNING + +C E All remaining initializations have +taken place, C is enabled, the scan threads and CA server +are running and the IOC is processing records. CA links might not have +finished connecting though, and sequence programs won't usually have been +started yet. + +=item PAUSE + +C E The C routine has just been +called and the IOC is about to suspend operations. + +=item PAUSED + +C E The CA server, CA link operations and +the scan threads have been paused and C disabled. + +=back + +Note that the order in which records that have the same C value get +processed can be controlled by setting their C field, which is honored +for C processing as well as for regular scanning. + +=menu menuPini + +=cut + +menu(menuPini) { + choice(menuPiniNO,"NO") + choice(menuPiniYES,"YES") + choice(menuPiniRUN,"RUN") + choice(menuPiniRUNNING,"RUNNING") + choice(menuPiniPAUSE,"PAUSE") + choice(menuPiniPAUSED,"PAUSED") +} diff --git a/src/ioc/db/menuPost.dbd b/src/ioc/db/menuPost.dbd.pod similarity index 65% rename from src/ioc/db/menuPost.dbd rename to src/ioc/db/menuPost.dbd.pod index a86b25b5e..44683b276 100644 --- a/src/ioc/db/menuPost.dbd +++ b/src/ioc/db/menuPost.dbd.pod @@ -5,6 +5,16 @@ # in file LICENSE that is included with this distribution. #************************************************************************* +=head1 Menu menuPost + +This menu is used by the long string record types to specify whether they +should generate a monitor event only when their string value changes, or +every time it gets written to even if the value is the same. + +=menu menuPost + +=cut + menu(menuPost) { choice(menuPost_OnChange, "On Change") choice(menuPost_Always, "Always") diff --git a/src/ioc/db/menuPriority.dbd b/src/ioc/db/menuPriority.dbd.pod similarity index 61% rename from src/ioc/db/menuPriority.dbd rename to src/ioc/db/menuPriority.dbd.pod index 155caa5e7..17d2fd357 100644 --- a/src/ioc/db/menuPriority.dbd +++ b/src/ioc/db/menuPriority.dbd.pod @@ -7,6 +7,20 @@ # and higher are distributed subject to a Software License Agreement found # in file LICENSE that is included with this distribution. #************************************************************************* + +=head1 Menu menuPriority + +This menu is used for the C field of all record types. It controls +the relative priority of records scheduled with C or +C, and also of records that use asynchronous completion. + +=menu menuPriority + +The number of priorities is set in various other places in the code too, +so adding new entries to this menu will probably break the IOC build. + +=cut + menu(menuPriority) { choice(menuPriorityLOW,"LOW") choice(menuPriorityMEDIUM,"MEDIUM")