| |
There is a single copy of the message performed when sending a message
- (from the callers memory space) using CFE_SB_TransmitMsg.
+ (from the callers memory space) using CFE_SB_TransmitMsg.
When transmitting the message, the software bus copies the message from the
callers memory space into a buffer in the software bus memory space. There
is also the option to request a buffer from SB, write directly to the buffer
diff --git a/docs/src/cfe_tbl.dox b/docs/src/cfe_tbl.dox
index e0aedb8a8..59121495f 100644
--- a/docs/src/cfe_tbl.dox
+++ b/docs/src/cfe_tbl.dox
@@ -22,14 +22,14 @@
\subpage cfetblugregistry
\subpage cfetblugtelemetry
\subpage cfetblugprocreset
- \subpage cfetblugfaq
+ \subpage cfetblugfaq
**/
/**
\page cfetblugmanage Managing Tables
-
+
In order to effectively manage tables, an operator needs to understand how cFE Applications
manage tables from their end. There are a number of methods that cFE Applications typically
use to manage their tables. Each method is appropriate based upon the nature of the contents
@@ -38,7 +38,7 @@
cFE Applications are required to periodically check to see if their table is to be validated,
updated (or in the case of dump-only tables, dumped). Most Applications perform this periodic
management at the same time as housekeeping requests are processed. This table management is
- performed by the cFE Application that "owns" a table (ie - the cFE Application that registered
+ performed by the cFE Application that "owns" a table (ie - the cFE Application that registered
the table with cFE Table Services). It is possible for cFE Applications to "share" a table with
other cFE Applications. An Application that shares a table does not typically perform any of the
management duties associated with that table.
@@ -112,7 +112,7 @@
\subpage cfetblugdumponly
-
+
Next: \ref cfetblugsnglbuff
Prev: \ref cfetblugmanage
Up To: \ref cfetblovr
@@ -134,10 +134,10 @@
Since inactive single buffered table images share a common resource, it may not be prudent for an
operator to load an image and then delay on the image's activation for an extended period of time.
-
- Single buffered tables are allowed to be critical (see \ref cfetblugcritical), dump-only
+
+ Single buffered tables are allowed to be critical (see \ref cfetblugcritical), dump-only
(see \ref cfetblugdumponly) and/or have a user-defined address (see \ref cfetbluguserdef).
-
+
Next: \ref cfetblugdblbuff
Up To: \ref cfetblugtypes
**/
@@ -150,23 +150,23 @@
table data. With a dedicated inactive table image available, double buffered tables are then
capable of efficiently swapping table contents and/or delaying the activation of a table's contents
for an indeterminate amount of time.
-
+
Some cFE Applications prefer to delay the Activation of a table until a specified time (e.g. - a
Spacecraft Ephemeris). These tables are typically defined as double buffered tables so that the
Inactive image can be left sitting untouched for an extended period of time without interfering
with shared resources for other tables. Then the Application can perform the Update when the time
is right.
-
+
Applications which have unusually large tables may decide to conserve memory resources by making
them double buffered. This is because the shared buffers used by single buffered tables must be
sized to match the largest table. If there is one table that is unusually large, there is little
reason to allocate up to #CFE_PLATFORM_TBL_MAX_SIMULTANEOUS_LOADS number of buffers that size. A double
buffered table will only allocate ONE extra buffer of that size.
-
+
Performance minded Applications that are required to perform processing with tight timing deadlines
may choose to use double buffered tables because the Update for a double buffered table is deterministic
and quick.
-
+
Next: \ref cfetblugvalfunc
Prev: \ref cfetblugsnglbuff
Up To: \ref cfetblugtypes
@@ -174,15 +174,15 @@
/**
\page cfetblugvalfunc Tables with Validation Functions
-
+
Applications that associate Validation Functions with their tables when the tables are registered are
effectively requiring that the contents of a table be logically Validated before it is Activated. The
cFE will refuse to let a table with an associated Validation Function be Activated until a successful
Validation on the Inactive table image has occurred.
-
+
Tables that are NOT assigned a Validation Function are assumed to be valid regardless of the contents
of the table image. These tables do not require a Validation Command prior to Activation.
-
+
Next: \ref cfetblugcritical
Prev: \ref cfetblugdblbuff
Up To: \ref cfetblugtypes
@@ -190,15 +190,15 @@
/**
\page cfetblugcritical Critical Tables
-
+
Applications that must be able to recover quickly from a Processor Reset may select the "Critical" table
option when registering their table. Table Services automatically creates a Critical Data Store for the
table and ensures that the contents of the Critical Data Store are updated whenever a Table Activation
occurs.
-
+
If a Processor Reset happens, when the Application attempts to Register the table again, Table Services
automatically locates the associated Critical Data Store and initializes the Table with the saved contents.
-
+
Next: \ref cfetbluguserdef
Prev: \ref cfetblugvalfunc
Up To: \ref cfetblugtypes
@@ -206,18 +206,18 @@
/**
\page cfetbluguserdef User Defined Address Tables
-
+
In order to provide a mechanism for Flight Software Maintenance teams to quickly create a table image
for dumping contents of memory that isn't normally loaded by the ground, there is an option to create
User-Defined Address tables. These tables, when they are first registered, provide a memory address
where the Active image of the table is to be maintained. Normally, the address is specified by Table
Services from its memory pool.
-
+
By specifying the address, the Flight Software Maintenance team can create a Dump-Only table that contains
the contents of a data structure that is not normally accessible via telemetry or table dumps. Then, on
command, the Flight Software Maintenance team can periodically dump the data structure's contents to an
on-board file(s) that can then be transferred to the ground for later analysis.
-
+
Next: \ref cfetblugdumponly
Prev: \ref cfetblugcritical
Up To: \ref cfetblugtypes
@@ -225,19 +225,19 @@
/**
\page cfetblugdumponly Dump Only Tables
-
+
On occasion, cFE Applications require a segment of memory in which the Application writes data. The typical
cFE Table is not normally modified directly by an Application but only via Load and Activate commands from
either the Ground or Stored Command Processor. However, for those situations where an Application wishes to
modify the contents of a data structure and the Application is limited in its telemtry bandwidth so that the
modified data cannot be telemetered, the Application can create a Dump-Only table.
-
+
Dump-Only tables are not allowed to be modified via the Load/Validate/Activate process most other tables are.
They are only supposed to be modified by onboard Applications. The Operator can still command a Dump which will
be processed by the table's owning Application when it manages its tables. By letting the Application perform
the dump, the Operator can feel confident that the table contents are a complete snapshot in time and not
corrupted by taking a snapshot while the Application was in the process of modifying its contents.
-
+
Next: \ref cfetblugregistry
Prev: \ref cfetbluguserdef
Up To: \ref cfetblugtypes
@@ -245,10 +245,10 @@
/**
\page cfetblugregistry Table Registry
-
+
When Applications register tables, Table Services retains pertinent information on the table in the Table Registry.
The following information (along with other information that is less important for an operator) is kept for each table:
-
+
- The Application ID of the Application that Registered the table
- The full name of the table
@@ -265,7 +265,7 @@
- The filename of the last file loaded into the table
- The File Creation Time for the last file used to load the contents of the table
-
+
This information can be obtained by either sending the Dump Registry command which will put all of the
information from the Table Registry into an onboard file for later downlink or the operator can send a
command to Telemeter the Registry Entry for a single table. This will cause the pertinent registry entry
@@ -277,7 +277,7 @@
failed to register the table but nothing related to why the restoration from CDS might have failed. There
is, however, a message written to the System Error Log by Table Services that can be dumped by the ground
to get this information. Note that failure to restore a table from CDS is not an expected error and
- requires some sort of data corruption to occur.
+ requires some sort of data corruption to occur.
Next: \ref cfetblugtelemetry
Prev: \ref cfetblugtypes
@@ -286,12 +286,12 @@
/**
\page cfetblugtelemetry Table Services Telemetry
-
+
Table Services produces two different telemetry packets. The first packet, referred to as the Table
Services Housekeeping Packet, is routinely produced by Table Services upon receipt of the Housekeeping
Request message that is typically sent to all Applications by an on board scheduler. The contents and
format of this packet are described in detail at #CFE_TBL_HousekeepingTlm_t.
-
+
Next: \ref cfetblugprocreset
Prev: \ref cfetblugregistry
Up To: \ref cfetblovr
@@ -299,17 +299,17 @@
/**
\page cfetblugprocreset Effects of Processor Reset on Tables
-
+
When a processor resets, the Table Registry is re-initialized. All Applications must, therefore, re-register
and re-initialize their tables. The one exception, however, is if the Application has previously tagged a
table as "Critical" during Table Registration, then Table Services will attempt to locate a table image for
that table stored in the Critical Data Store. Table Services also attempts to locate the Critical Table
Registry which is also maintained in the Critical Data Store.
-
+
If Table Services is able to find a valid table image for a Critical table in the Critical Data Store, the
contents of the table are automatically loaded into the table and the Application is notified that the
table does not require additional initialization.
-
+
Next: \ref cfetblugfaq
Prev: \ref cfetblugtelemetry
Up To: \ref cfetblovr
@@ -317,17 +317,17 @@
/**
\page cfetblugfaq Frequently Asked Questions about Table Services
-
+
| (Q)
Is it an error to load a table image that is smaller than the registered size?
| | |
Table images that are smaller than the declared size of a table fall into one of two categories.
-
+
If the starting offset of the table image (as specified in the Table Image secondary file header) is
not equal to zero, then the table image is considered to be a "partial" table load. Partial loads
are valid as long as a table has been previously loaded with a non-"partial" table image.
-
+
If the starting offset of the table image is zero and the size is less than the declared size
of the table, the image is considered "short" but valid. This feature allows application developers
to use variable length tables.
@@ -343,8 +343,8 @@
| | (Q)
What commands do I use to load a table with a new image?
| | |
- There are a number of steps required to load a table.
- -# The operator needs to create a cFE Table Services compatible table image file with the
+ There are a number of steps required to load a table.
+ -# The operator needs to create a cFE Table Services compatible table image file with the
desired data contained in it. This can be accomplished by creating a 'C' source file, compiling
it with the appropriate cross compiler for the onboard platform and then running the elf2cfetbl
utility on the resultant object file.
@@ -357,64 +357,64 @@
results of the validation are reported in Table Services Housekeeping Telemetry. If a table does
not have a validation function associated with it, the operator may wish to compare the computed
CRC to verify the table contents match what was intended.
- -# Upon successful validation, the operator then sends the
+ -# Upon successful validation, the operator then sends the
\link #CFE_TBL_ACTIVATE_CC Activate Command. \endlink The application owning the table should, within
a reasonable amount of time, perform a table update and send an event message.
| | (Q)
What causes cFE Table Services to generate the following sys log message:
-
+
CFE_TBL:GetAddressInternal-App(\%d) attempt to access unowned Tbl Handle=\%d
| | |
- When an application sharing its table(s) with one or more applications is reloaded, the reloaded application's
- table handle(s) are released. cFE Table Services sees that the table(s) are shared and keeps a 'shadow' version
- of the table in the Table Services registry. The registry will show the released, shared tables with no name.
- When the applications sharing the table attempt to access the table via the 'old', released handle, Table Services
- will return an error code to the applications and generate the sys log message. The applications may then unregister
- the 'old' handle(s) in order to remove the released, shared table(s) from the Table Services registry and share the
+ When an application sharing its table(s) with one or more applications is reloaded, the reloaded application's
+ table handle(s) are released. cFE Table Services sees that the table(s) are shared and keeps a 'shadow' version
+ of the table in the Table Services registry. The registry will show the released, shared tables with no name.
+ When the applications sharing the table attempt to access the table via the 'old', released handle, Table Services
+ will return an error code to the applications and generate the sys log message. The applications may then unregister
+ the 'old' handle(s) in order to remove the released, shared table(s) from the Table Services registry and share the
newly loaded application table(s).
| | (Q)
When does the Table Services Abort Table Load command need to be issued?
| | |
- The Abort command should be used whenever a table image has been loaded but the application has not yet activated it and
+ The Abort command should be used whenever a table image has been loaded but the application has not yet activated it and
the operator no longer wants the table to be loaded.
-
- The purpose of the Abort command is to free a previously allocated table buffer. It should be noted, however, that multiple
- table loads to the SAME table without an intervening activation or abort, will simply OVERWRITE the previous table load using
+
+ The purpose of the Abort command is to free a previously allocated table buffer. It should be noted, however, that multiple
+ table loads to the SAME table without an intervening activation or abort, will simply OVERWRITE the previous table load using
the SAME buffer.
-
+
Therefore, the most likely scenarios that would lead to a needed abort are as follows:
-
+
- Operator loads a table and realizes immediately that the load is not wanted.
-
- - Operator loads a table and performs a validation on it. Regardless of whether
- the table passes or fails the validation, if the operator no longer wants to
- activate the table, the abort command should be issued.
-
- It should be noted that a table image that fails activation is retained in the
- inactive buffer for diagnosis, if necessary. It is NOT released until it is
+
+
- Operator loads a table and performs a validation on it. Regardless of whether
+ the table passes or fails the validation, if the operator no longer wants to
+ activate the table, the abort command should be issued.
+
+ It should be noted that a table image that fails activation is retained in the
+ inactive buffer for diagnosis, if necessary. It is NOT released until it is
aborted or overwritten and successfully validated and activated.
-
- - A table image was loaded; the image was successfully validated; the command for
- activation was sent; but the application fails to perform the activation.
-
- The Abort command will free the table buffer and clear the activation request.
-
- This situation can occur when either the application is improperly designed and
- fails to adequately manage its tables (sometimes seen in the lab during development)
+
+
- A table image was loaded; the image was successfully validated; the command for
+ activation was sent; but the application fails to perform the activation.
+
+ The Abort command will free the table buffer and clear the activation request.
+
+ This situation can occur when either the application is improperly designed and
+ fails to adequately manage its tables (sometimes seen in the lab during development)
or the application is "hung" and not performing as it should.
|
-
+
Prev: \ref cfetblugprocreset
Up To: \ref cfetblovr
**/
-/**
+/**
** \page cfetblcmds cFE Table Services Commands
**
-** The following is a list of commands that are processed by the cFE Table Services Task.
+** The following is a list of commands that are processed by the cFE Table Services Task.
**/
/**
diff --git a/docs/src/cfe_time.dox b/docs/src/cfe_time.dox
index aa5ed060b..f12ffa796 100644
--- a/docs/src/cfe_time.dox
+++ b/docs/src/cfe_time.dox
@@ -1,19 +1,19 @@
/**
\page cfetimeovr cFE Time Services Overview
- The cFE Time Service (TIME) is one of the cFE core services. TIME provides time
- correlation, distribution and synchronization services. TIME exists in two varieties:
- a Time Server responsible for maintaining the master time reference for all remote systems,
+ The cFE Time Service (TIME) is one of the cFE core services. TIME provides time
+ correlation, distribution and synchronization services. TIME exists in two varieties:
+ a Time Server responsible for maintaining the master time reference for all remote systems,
and a Time Client responsible for synchronizing to that master time reference.
- Since TIME is a generic implementation aimed to meet the needs of a variety of
- mission configurations, there are numerous configuration parameters, which dictate
- the behavior of TIME (see cfe_mission_cfg.h and cfe_platform_cfg.h for the specific
- mission configuration).
+ Since TIME is a generic implementation aimed to meet the needs of a variety of
+ mission configurations, there are numerous configuration parameters, which dictate
+ the behavior of TIME (see cfe_mission_cfg.h and cfe_platform_cfg.h for the specific
+ mission configuration).
- With the exception of those sections specific to Time Clients and Servers, this
- document assumes the most common physical environment - one instantiation of cFE
- installed on a single processor. Therefore, TIME represents cFE Time Services
+ With the exception of those sections specific to Time Clients and Servers, this
+ document assumes the most common physical environment - one instantiation of cFE
+ installed on a single processor. Therefore, TIME represents cFE Time Services
configured as a Time Server.
For additional detail on Time Services and how to manage it, see the following sections:
@@ -57,7 +57,7 @@
\subpage cfetimeugsetmet
- \subpage cfetimeugfaq
+ \subpage cfetimeugfaq
**/
@@ -65,55 +65,55 @@
/**
\page cfetimeugcomponents Time Components
- Time knowledge is stored in several pieces, so that the time information can more
+ Time knowledge is stored in several pieces, so that the time information can more
easily be manipulated and utilized. These components include:
- The Ground Epoch is an arbitrary date and time that establishes the zero point
- for spacecraft time calculations. The selection of the epoch is mission specific,
- although in the past, it was common to select the same epoch as defined for the
- Operating System used by the computers hosting the ground system software. Recent
- mission epoch selections have also included using zero seconds after midnight,
- Jan 1, 2001.
-
- Spacecraft Time is the number of seconds (and fraction of a second) since the
- ground epoch. Spacecraft time is the sum of Mission Elapsed Time (MET) and the
- Spacecraft Time Correlation Factor (STCF). By definition, MET is a measure of
- time since launch or separation. However, for most missions the MET actually
- represents the amount of time since powering on the hardware containing the MET
+ The Ground Epoch is an arbitrary date and time that establishes the zero point
+ for spacecraft time calculations. The selection of the epoch is mission specific,
+ although in the past, it was common to select the same epoch as defined for the
+ Operating System used by the computers hosting the ground system software. Recent
+ mission epoch selections have also included using zero seconds after midnight,
+ Jan 1, 2001.
+
+ Spacecraft Time is the number of seconds (and fraction of a second) since the
+ ground epoch. Spacecraft time is the sum of Mission Elapsed Time (MET) and the
+ Spacecraft Time Correlation Factor (STCF). By definition, MET is a measure of
+ time since launch or separation. However, for most missions the MET actually
+ represents the amount of time since powering on the hardware containing the MET
timer. The STCF correlates the MET to the ground epoch.
- The Tone is the signal that MET seconds have incremented. In most hardware
- configurations, the tone is synonymous with the 1 PPS signal. The tone signal
- may be generated by a local hardware timer, or by an external event (GPS receiver,
- spacewire time tick, 1553 bus signal, etc). TIME may also be configured to
- simulate the tone for lab environments that do not have the necessary hardware
- to provide a tone signal. Note that MET sub-seconds will be zero at the instant
- of the tone.
+ The Tone is the signal that MET seconds have incremented. In most hardware
+ configurations, the tone is synonymous with the 1 PPS signal. The tone signal
+ may be generated by a local hardware timer, or by an external event (GPS receiver,
+ spacewire time tick, 1553 bus signal, etc). TIME may also be configured to
+ simulate the tone for lab environments that do not have the necessary hardware
+ to provide a tone signal. Note that MET sub-seconds will be zero at the instant
+ of the tone.
Time at the Tone is the spacecraft time at the most recent "valid" tone.
- Time since the Tone is the amount of time since the tone (usually less than one
- second). This value is often measured using the local processor clock. Upon
- detecting the tone signal, TIME stores the contents of the local processor clock
+ Time since the Tone is the amount of time since the tone (usually less than one
+ second). This value is often measured using the local processor clock. Upon
+ detecting the tone signal, TIME stores the contents of the local processor clock
to facilitate this measurement.
- Thus, Current Spacecraft Time is the sum of "time at the tone" and
+ Thus, Current Spacecraft Time is the sum of "time at the tone" and
"time since the tone".
- Leap Seconds occur to keep clocks correlated to astronomical observations. The
- modern definition of a second (9,192,631,770 oscillations of a cesium-133 atom)
- is constant while the earth's rotation has been slow by a small fraction of a
- second per day. The International Earth Rotation and Reference System Service
- (IERS) maintains the count of leap seconds as a signed whole number that is
- subject to update twice a year. Although it is possible to have a negative
- leap second count if the earth rotates too fast, it is highly unlikely. The initial
- count of leap seconds (10) was established in January of 1972 and the first leap second
- was added to the initial count in June of 1972. The most recent leap seconds are announced
- by the International Earth Rotation Service (IERS):
- https://www.iers.org in IERS Bulletin C (leap second announcements). Search the IERS site
- for "Bulletin C" to obtain the latest issue/announcement.
-
-
+ Leap Seconds occur to keep clocks correlated to astronomical observations. The
+ modern definition of a second (9,192,631,770 oscillations of a cesium-133 atom)
+ is constant while the earth's rotation has been slow by a small fraction of a
+ second per day. The International Earth Rotation and Reference System Service
+ (IERS) maintains the count of leap seconds as a signed whole number that is
+ subject to update twice a year. Although it is possible to have a negative
+ leap second count if the earth rotates too fast, it is highly unlikely. The initial
+ count of leap seconds (10) was established in January of 1972 and the first leap second
+ was added to the initial count in June of 1972. The most recent leap seconds are announced
+ by the International Earth Rotation Service (IERS):
+ https://www.iers.org in IERS Bulletin C (leap second announcements). Search the IERS site
+ for "Bulletin C" to obtain the latest issue/announcement.
+
+
Next: \ref cfetimeugstruct
Up To: \ref cfetimeovr
**/
@@ -121,12 +121,12 @@
/**
\page cfetimeugstruct Time Structure
- The cFE implementation of the System Time Structure is a modified version of the
- CCSDS Unsegmented Time Code (CUC) which includes 4 bytes of seconds, and 4 bytes of
- subseconds, where a subsecond is equivalent to 1/(2^32) seconds. The system time
- structure is used by TIME to store current time, time at the tone, time since the
+ The cFE implementation of the System Time Structure is a modified version of the
+ CCSDS Unsegmented Time Code (CUC) which includes 4 bytes of seconds, and 4 bytes of
+ subseconds, where a subsecond is equivalent to 1/(2^32) seconds. The system time
+ structure is used by TIME to store current time, time at the tone, time since the
tone, the MET, the STCF and command arguments for time adjustments. Note that typically
- the 32 bits of seconds and the upper 16 bits of subseconds are used for time stamping
+ the 32 bits of seconds and the upper 16 bits of subseconds are used for time stamping
Software bus messages, but this is dependent on the underlying defintion.
The system time structure is defined as follows:
@@ -138,7 +138,7 @@
} CFE_TIME_SysTime_t;
\endverbatim
-
+
Next: \ref cfetimeugformat
Prev: \ref cfetimeugcomponents
Up To: \ref cfetimeovr
@@ -147,37 +147,37 @@
/**
\page cfetimeugformat Time Formats
- International Atomic Time (TAI) is one of two time formats supported by cFE TIME.
- TAI is the number of seconds and sub-seconds elapsed since the ground epoch as measured
- with the atomic clock previously described. TAI has no reference to leap seconds and is
- calculated using the following equation:
+ International Atomic Time (TAI) is one of two time formats supported by cFE TIME.
+ TAI is the number of seconds and sub-seconds elapsed since the ground epoch as measured
+ with the atomic clock previously described. TAI has no reference to leap seconds and is
+ calculated using the following equation:
\verbatim
- TAI = MET + STCF
+ TAI = MET + STCF
\endverbatim
-
- It should be noted that TAI is only "true" TAI when the selected ground epoch is the same
- as the TAI epoch (zero seconds after midnight, January 1, 1958). However, nothing precludes
- configuring cFE TIME to calculate time in the TAI format and setting the STCF to correlate
+
+ It should be noted that TAI is only "true" TAI when the selected ground epoch is the same
+ as the TAI epoch (zero seconds after midnight, January 1, 1958). However, nothing precludes
+ configuring cFE TIME to calculate time in the TAI format and setting the STCF to correlate
to any other epoch definition.
- Coordinated Universal Time (UTC) is the other time format supported by cFE TIME. UTC
- differs from TAI in the fact that UTC includes a leap seconds adjustment. TIME computes UTC
- using the following equation:
+ Coordinated Universal Time (UTC) is the other time format supported by cFE TIME. UTC
+ differs from TAI in the fact that UTC includes a leap seconds adjustment. TIME computes UTC
+ using the following equation:
\verbatim
UTC = TAI - Leap Seconds.
\endverbatim
-
- The preceding UTC equation might seem to imply that TAI includes leap seconds and UTC does
- not - which is not the case. In fact, the UTC calculation includes a leap seconds adjustment
- that subtracts leap seconds from the same time components used to create TAI. Alternatively,
+
+ The preceding UTC equation might seem to imply that TAI includes leap seconds and UTC does
+ not - which is not the case. In fact, the UTC calculation includes a leap seconds adjustment
+ that subtracts leap seconds from the same time components used to create TAI. Alternatively,
it might be less confusing to express the UTC equation as follows:
\verbatim
UTC = MET + STCF - Leap Seconds
\endverbatim
-
+
Next: \ref cfetimeugconfig
Prev: \ref cfetimeugcomponents
@@ -187,46 +187,46 @@
/**
\page cfetimeugconfig Time Configuration
- All configurations of TIME require a local processor source for a 1Hz interrupt and access
- to a local clock with a resolution fine enough that it can be used to measure short periods
- of elapsed time. The local interrupt is used to wake-up TIME at a regular interval for the
- purpose of verifying that the tone is being received. The local clock is used to measure
- time since the tone and to provide coarse verification that the tone is occurring at
- approximately one second intervals. The presumption is that the tone is the most accurate
- timer in the system and, within reason, is to be trusted. Note that nothing precludes the
- use of the MET as the local clock, assuming the MET is both local and provides sub-second
+ All configurations of TIME require a local processor source for a 1Hz interrupt and access
+ to a local clock with a resolution fine enough that it can be used to measure short periods
+ of elapsed time. The local interrupt is used to wake-up TIME at a regular interval for the
+ purpose of verifying that the tone is being received. The local clock is used to measure
+ time since the tone and to provide coarse verification that the tone is occurring at
+ approximately one second intervals. The presumption is that the tone is the most accurate
+ timer in the system and, within reason, is to be trusted. Note that nothing precludes the
+ use of the MET as the local clock, assuming the MET is both local and provides sub-second
data. However, the tone must not be used as the source for the local 1Hz interrupt.
- Consider the following brief description of three hypothetical hardware configurations.
- These sample systems may be used as reference examples to help clarify the descriptions
+ Consider the following brief description of three hypothetical hardware configurations.
+ These sample systems may be used as reference examples to help clarify the descriptions
of the various TIME configuration selections.
- In the first system, there is no MET timer and therefore no tone signal. The MET is a count
- of the number of "fake" tones generated by TIME software. There is no validation performed
- regarding the quality of time data. This hardware configuration is a common lab environment
+ In the first system, there is no MET timer and therefore no tone signal. The MET is a count
+ of the number of "fake" tones generated by TIME software. There is no validation performed
+ regarding the quality of time data. This hardware configuration is a common lab environment
using COTS equipment.
- In the second system, the MET timer is a hardware register that is directly accessible by TIME.
- When MET seconds increment, a processor interrupt signals the tone. Upon detecting the tone,
- TIME can read the MET to establish the time at the tone. To verify that the tone is valid,
- TIME need only validate that this tone signal occurred approximately one second after the
+ In the second system, the MET timer is a hardware register that is directly accessible by TIME.
+ When MET seconds increment, a processor interrupt signals the tone. Upon detecting the tone,
+ TIME can read the MET to establish the time at the tone. To verify that the tone is valid,
+ TIME need only validate that this tone signal occurred approximately one second after the
previous tone signal (as measured with the local clock).
- In the third system, the MET is located on hardware connected via spacewire. When MET seconds
- increment, a spacewire time tick triggers a local processor interrupt to signal the tone.
- Shortly after announcing the tone, the hardware containing the MET also generates a spacewire
+ In the third system, the MET is located on hardware connected via spacewire. When MET seconds
+ increment, a spacewire time tick triggers a local processor interrupt to signal the tone.
+ Shortly after announcing the tone, the hardware containing the MET also generates a spacewire
data packet containing the MET value corresponding to the tone. TIME must wait until both
- the tone and data packet have been received before validating the tone. The tone must have
- occurred approximately one second after the previous tone signal and the data packet must
+ the tone and data packet have been received before validating the tone. The tone must have
+ occurred approximately one second after the previous tone signal and the data packet must
have been received within a specified window in time following the tone.
- The hardware design choice for how the tone signal is distributed is not material to TIME
- configuration. The software detecting the tone need only call the cFE API function announcing
+ The hardware design choice for how the tone signal is distributed is not material to TIME
+ configuration. The software detecting the tone need only call the cFE API function announcing
the arrival of the tone. This function is designed to be called from interrupt handlers.
For detail on each of the individual configuration settings for cFE Time Services, see the
following sections:
-
+
- \subpage cfetimeugformsel
- \subpage cfetimeugfaketone
@@ -250,9 +250,9 @@
Time format is defined in the mission configuration header file.
- This selection defines the default time format as TAI or UTC. The API functions
- to get time in either specific format are still enabled, but the API function to
- get time in the default format will follow this selection. Enable one, and only
+ This selection defines the default time format as TAI or UTC. The API functions
+ to get time in either specific format are still enabled, but the API function to
+ get time in the default format will follow this selection. Enable one, and only
one, of the following time format definitions:
\verbatim
@@ -261,15 +261,15 @@
\endverbatim
or
-
+
\verbatim
#define CFE_MISSION_TIME_CFG_DEFAULT_TAI FALSE
#define CFE_MISSION_TIME_CFG_DEFAULT_UTC TRUE
\endverbatim
- The choice of time format is a mission specific decision and is not directly
+ The choice of time format is a mission specific decision and is not directly
affected by the hardware configuration.
-
+
\sa #CFE_MISSION_TIME_CFG_DEFAULT_TAI, #CFE_MISSION_TIME_CFG_DEFAULT_UTC
@@ -282,9 +282,9 @@
The fake tone is defined in the mission configuration header file.
- If this selection is set to TRUE, TIME will generate a "fake" tone signal by calling
- the same API function as would be called upon detection of the "real" tone signal.
- Enable the fake tone only for hardware configurations that do not provide a tone
+ If this selection is set to TRUE, TIME will generate a "fake" tone signal by calling
+ the same API function as would be called upon detection of the "real" tone signal.
+ Enable the fake tone only for hardware configurations that do not provide a tone
signal.
\verbatim
@@ -294,7 +294,7 @@
Hypothetical hardware configuration number one (described above) would enable the fake tone signal.
\sa #CFE_MISSION_TIME_CFG_FAKE_TONE
-
+
Next: \ref cfetimeugtoneorder
Prev: \ref cfetimeugformsel
Up To: \ref cfetimeugconfig
@@ -305,10 +305,10 @@
Tone and data order is defined in the mission configuration header file.
- This selection defines which comes first - the tone or the time at the
- tone data. Does the time data describe the tone that already occurred,
- or the tone that has not yet occurred? This decision may be driven by
- the hardware design but can also be arbitrary. Enable one, and only one,
+ This selection defines which comes first - the tone or the time at the
+ tone data. Does the time data describe the tone that already occurred,
+ or the tone that has not yet occurred? This decision may be driven by
+ the hardware design but can also be arbitrary. Enable one, and only one,
of the following:
\verbatim
@@ -316,12 +316,12 @@
#define CFE_MISSION_TIME_AT_TONE_WILL_BE
\endverbatim
- Hypothetical hardware configuration number three (described \ref cfetimeugconfig above) would
+ Hypothetical hardware configuration number three (described \ref cfetimeugconfig above) would
enable "time at the tone was".
\sa #CFE_MISSION_TIME_AT_TONE_WAS, #CFE_MISSION_TIME_AT_TONE_WILL_BE
-
+
Next: \ref cfetimeugtonewindow
Prev: \ref cfetimeugfaketone
Up To: \ref cfetimeugconfig
@@ -332,8 +332,8 @@
The tone and data window is defined in the mission configuration header file.
- In concert with the definition of tone and data order, this selection defines
- the valid window in time for the second of the pair to follow the first.
+ In concert with the definition of tone and data order, this selection defines
+ the valid window in time for the second of the pair to follow the first.
Both must be defined, units are micro-seconds.
\verbatim
@@ -341,13 +341,13 @@
#define CFE_MISSION_TIME_MAX_ELAPSED 100000
\endverbatim
- Hypothetical hardware configuration number three (described above) might use
- these values which describe a window that begins immediately after the tone
+ Hypothetical hardware configuration number three (described above) might use
+ these values which describe a window that begins immediately after the tone
and lasts for one tenth of a second.
\sa #CFE_MISSION_TIME_MIN_ELAPSED, #CFE_MISSION_TIME_MAX_ELAPSED
-
+
Next: \ref cfetimeugserver
Prev: \ref cfetimeugtoneorder
Up To: \ref cfetimeugconfig
@@ -356,12 +356,12 @@
/**
\page cfetimeugserver Specifying Time Server/Client
- Configure TIME as a client only when the target system has multiple processors
- running separate instantiations of the cFE. One instantiation must be configured
- as the server and the remainder configured as clients. If the target system has
+ Configure TIME as a client only when the target system has multiple processors
+ running separate instantiations of the cFE. One instantiation must be configured
+ as the server and the remainder configured as clients. If the target system has
only one processor running the cFE, then TIME must be configured as a server.
- Enable one, and only one, of the following definitions in the platform configuration
+ Enable one, and only one, of the following definitions in the platform configuration
header file:
\verbatim
@@ -370,7 +370,7 @@
\endverbatim
or
-
+
\verbatim
#define CFE_PLATFORM_TIME_CFG_SERVER FALSE
#define CFE_PLATFORM_TIME_CFG_CLIENT TRUE
@@ -378,7 +378,7 @@
\sa #CFE_PLATFORM_TIME_CFG_SERVER, #CFE_PLATFORM_TIME_CFG_CLIENT
-
+
Next: \ref cfetimeugendian
Prev: \ref cfetimeugtonewindow
Up To: \ref cfetimeugconfig
@@ -387,7 +387,7 @@
/**
\page cfetimeugendian Specifying Time Tone Byte Order
- By default, the CFE time tone message is a payload of integers in
+ By default, the CFE time tone message is a payload of integers in
platform-endian order (containing the tone's timestamp, the leap seconds,
and state information.) In some configurations, it may be better to
have the payload produced in big-endian order--particularly in mixed-endian
@@ -408,14 +408,14 @@
/**
\page cfetimeugvirtualmet Virtual MET
- This configuration option refers to whether the MET is local to this instantiation
+ This configuration option refers to whether the MET is local to this instantiation
of TIME. If the MET is not local then TIME must be configured as using a virtual MET.
- Therefore, all TIME clients must be configured as using a virtual MET. If the MET was
- local to any TIME client, then that instantiation of TIME would have to be the server.
+ Therefore, all TIME clients must be configured as using a virtual MET. If the MET was
+ local to any TIME client, then that instantiation of TIME would have to be the server.
+
+ TIME servers must be configured as using a virtual MET
- TIME servers must be configured as using a virtual MET
-
Next: \ref cfetimeugsource
Prev: \ref cfetimeugendian
@@ -425,15 +425,15 @@
/**
\page cfetimeugsource Specifying Time Source
- TIME configuration provides the ability to specify where the source for time data
- is originating - either internal or external. In hypothetical system one, the MET
- is internal. In system two, TIME cannot directly read the MET, therefore time data
+ TIME configuration provides the ability to specify where the source for time data
+ is originating - either internal or external. In hypothetical system one, the MET
+ is internal. In system two, TIME cannot directly read the MET, therefore time data
must be received from an external source.
- This selection also enables a command interface to switch between internal and
- external input. When commanded to use internal time data, TIME will ignore the
- external data. However, TIME will continue to use the API function as the trigger
- to generate a "time at the tone" command packet regardless of the internal/external
+ This selection also enables a command interface to switch between internal and
+ external input. When commanded to use internal time data, TIME will ignore the
+ external data. However, TIME will continue to use the API function as the trigger
+ to generate a "time at the tone" command packet regardless of the internal/external
command selection.
Set the following definition to TRUE only for TIME servers using an external time data source.
@@ -442,16 +442,16 @@
#define CFE_PLATFORM_TIME_CFG_SOURCE TRUE
\endverbatim
- The remainder of this section pertains only to TIME servers configured to accept
+ The remainder of this section pertains only to TIME servers configured to accept
external time data.
- When configured to accept external time data, TIME requires an additional definition
- for the type of external data (GPS, MET, spacecraft time, etc.). This selection
- will enable an API function specific to the selected data type. Regardless of how
- the time data is received, the receiver need only pass the data to the appropriate
+ When configured to accept external time data, TIME requires an additional definition
+ for the type of external data (GPS, MET, spacecraft time, etc.). This selection
+ will enable an API function specific to the selected data type. Regardless of how
+ the time data is received, the receiver need only pass the data to the appropriate
API function.
- TIME servers using an external time data source must set one, and only one, of
+ TIME servers using an external time data source must set one, and only one, of
the following to TRUE, for example:
\verbatim
@@ -460,14 +460,14 @@
#define CFE_PLATFORM_TIME_CFG_SRC_TIME FALSE
\endverbatim
- configuration definitions for the particular source.
+ configuration definitions for the particular source.
- If the cfe_platform_cfg.h file contains "#define CFE_PLATFORM_TIME_CFG_SOURCE TRUE" then time is
- configured to allow switching between internal and external time sources
- (see #CFE_TIME_SET_SOURCE_CC). If this configuration parameter is set to FALSE then
+ If the cfe_platform_cfg.h file contains "#define CFE_PLATFORM_TIME_CFG_SOURCE TRUE" then time is
+ configured to allow switching between internal and external time sources
+ (see #CFE_TIME_SET_SOURCE_CC). If this configuration parameter is set to FALSE then
the command to set the source will be rejected.
- If this configuration parameter is set to TRUE then ONE and ONLY ONE of the following configuration
+ If this configuration parameter is set to TRUE then ONE and ONLY ONE of the following configuration
parameters must also be set TRUE in order to specify the external time source, for example:
\verbatim
@@ -476,15 +476,15 @@
#define CFE_PLATFORM_TIME_CFG_SRC_TIME FALSE
\endverbatim
- Note that Internal MET source depends on available hardware. It may be the local
+ Note that Internal MET source depends on available hardware. It may be the local
count of tone signals, the contents of a hardware register or an OS specific time function.
- Note also that when configured to use an external time source, commands to set the
+ Note also that when configured to use an external time source, commands to set the
time will be overwritten.
\sa #CFE_PLATFORM_TIME_CFG_SRC_MET, #CFE_PLATFORM_TIME_CFG_SRC_GPS, #CFE_PLATFORM_TIME_CFG_SRC_TIME
-
+
Next: \ref cfetimeugsignal
Prev: \ref cfetimeugvirtualmet
Up To: \ref cfetimeugconfig
@@ -493,8 +493,8 @@
/**
\page cfetimeugsignal Specifying Time Signal
- Some hardware configurations support a primary and redundant tone signal selection.
- Setting the following configuration definition to TRUE will result in enabling a TIME
+ Some hardware configurations support a primary and redundant tone signal selection.
+ Setting the following configuration definition to TRUE will result in enabling a TIME
command to select the active tone signal.
\verbatim
@@ -504,7 +504,7 @@
Note: this feature requires additional custom software to make the physical signal switch.
\sa #CFE_PLATFORM_TIME_CFG_SIGNAL
-
+
Next: \ref cfetimeugparadigm
Prev: \ref cfetimeugsource
Up To: \ref cfetimeugconfig
@@ -516,45 +516,45 @@
In order for the cFE Time Services to work for a particular mission, the methods of
obtaining time, distributing time and translating time must follow some standard
paradigms used in previous missions. The following describes this expected context:
-
- Mission dependent hardware provides the Tone. When this Tone message is received,
- TIME latches the local time based on the local clock. Note that in lab environments,
- a simulated Tone capability exists which uses an SB message. Mission dependent
- hardware also provides the "time at the tone" message based on the hardware latched
- time and the reference times stored by TIME Server. The TIME Client then updates
- its local reference time based on the local hardware latched time at the Tone and
- the provided Time-at-Tone message packet when certain checks (such as the Validity bit
+
+ Mission dependent hardware provides the Tone. When this Tone message is received,
+ TIME latches the local time based on the local clock. Note that in lab environments,
+ a simulated Tone capability exists which uses an SB message. Mission dependent
+ hardware also provides the "time at the tone" message based on the hardware latched
+ time and the reference times stored by TIME Server. The TIME Client then updates
+ its local reference time based on the local hardware latched time at the Tone and
+ the provided Time-at-Tone message packet when certain checks (such as the Validity bit
being set) pass.
- When used in an environment that includes multiple processors, each running a separate
- instantiation of cFE software, the presumption is that TIME will be distributed in a
- client/server relationship. In this model, one processor will have TIME configured
- as the server and the other processors as clients. The TIME server will maintain the
- various time components and publish a "time at the tone" message to provide synchronized
- time to the TIME clients. Environments that have only a single instance of TIME must be
+ When used in an environment that includes multiple processors, each running a separate
+ instantiation of cFE software, the presumption is that TIME will be distributed in a
+ client/server relationship. In this model, one processor will have TIME configured
+ as the server and the other processors as clients. The TIME server will maintain the
+ various time components and publish a "time at the tone" message to provide synchronized
+ time to the TIME clients. Environments that have only a single instance of TIME must be
configured as a TIME server.
- In all configurations, the final step in calculating the time "right now" for any
+ In all configurations, the final step in calculating the time "right now" for any
instantiation of TIME is to use a local processor clock to measure the "time since the tone".
- The specific MET hardware properties will determine whether the MET value can be modified.
- However, the cFE design is such that there should never be a need to purposefully change or
+ The specific MET hardware properties will determine whether the MET value can be modified.
+ However, the cFE design is such that there should never be a need to purposefully change or
reset the MET.
- Regardless of the physical hardware implementation for the MET (elapsed seconds,
- elapsed ticks, etc.), cFE TIME will convert the hardware MET value into a System Time
- Format structure for time calculations and will report the converted value in telemetry.
+ Regardless of the physical hardware implementation for the MET (elapsed seconds,
+ elapsed ticks, etc.), cFE TIME will convert the hardware MET value into a System Time
+ Format structure for time calculations and will report the converted value in telemetry.
cFE TIME will also maintain and report the STCF in a System Time Format structure.
- cFE TIME has no knowledge of the current epoch; it is up to the user to keep time on the
- spacecraft correlated to an epoch. An exception might appear to be the epoch definition
- required in the cFE mission configuration definition file. However, this definition is for
- use only by the API functions that convert spacecraft time and file system time, and the
- API function that prints spacecraft time as a date and time text string. The cFE "get time"
+ cFE TIME has no knowledge of the current epoch; it is up to the user to keep time on the
+ spacecraft correlated to an epoch. An exception might appear to be the epoch definition
+ required in the cFE mission configuration definition file. However, this definition is for
+ use only by the API functions that convert spacecraft time and file system time, and the
+ API function that prints spacecraft time as a date and time text string. The cFE "get time"
functions are independent of the ground epoch.
- The mission configuration parameters, #CFE_MISSION_TIME_CFG_DEFAULT_TAI and #CFE_MISSION_TIME_CFG_DEFAULT_UTC
- specify the default time format. Applications are encouraged to use the #CFE_TIME_GetTime API,
+ The mission configuration parameters, #CFE_MISSION_TIME_CFG_DEFAULT_TAI and #CFE_MISSION_TIME_CFG_DEFAULT_UTC
+ specify the default time format. Applications are encouraged to use the #CFE_TIME_GetTime API,
which returns time in the format specified by this configuration parameter.
@@ -567,8 +567,8 @@
/**
\page cfetimeugflywheeling Flywheeling
- Flywheeling occurs when TIME is not getting a valid tone signal or external "time at the tone"
- message. While this has minimal impact on internal operations, it can result in the drifting
+ Flywheeling occurs when TIME is not getting a valid tone signal or external "time at the tone"
+ message. While this has minimal impact on internal operations, it can result in the drifting
apart of times being stored by different spacecraft systems.
Flywheeling occurs when at least one of the following conditions is true:
@@ -590,25 +590,25 @@
/**
\page cfetimeugstate Time State
- Clock state is a combination of factors, most significantly whether the spacecraft time has
- been accurately set and whether Time Service is operating in FLYWHEEL mode. A ground
+ Clock state is a combination of factors, most significantly whether the spacecraft time has
+ been accurately set and whether Time Service is operating in FLYWHEEL mode. A ground
command is provided to set the state to reflect when the ground has determined the spacecraft
- time is now correct, or that time is no longer correct. This information will be distributed
- to Time Clients, and in turn, to any interested sub-systems. If time has not been set then TIME
- services reports the state of time as invalid, regardless of whether time is flywheeling or not.
- Also, this command may be used to force a Time Server or Time Client into FLYWHEEL mode.
- Use of FLYWHEEL mode is mainly for debug purposes although, in extreme circumstances, it
- may be of value to force Time Service not to rely on normal time updates. Note that when
- commanded into FLYWHEEL mode, the Time Service will remain so until receipt of another
- "set state" command setting the state into a mode other than FLYWHEEL. Note also that
- setting the clock state to VALID or INVALID on a Time Client that is currently getting
- time updates from the Time Server will have very limited effect. As soon as the Time
- Client receives the next time update, the VALID/INVALID selection will be set to that of
- the Time Server. However, setting a Time Client to FLYWHEEL cannot be overridden by the
- Time Server since the Time Client will ignore time updates from the Time Server while in
+ time is now correct, or that time is no longer correct. This information will be distributed
+ to Time Clients, and in turn, to any interested sub-systems. If time has not been set then TIME
+ services reports the state of time as invalid, regardless of whether time is flywheeling or not.
+ Also, this command may be used to force a Time Server or Time Client into FLYWHEEL mode.
+ Use of FLYWHEEL mode is mainly for debug purposes although, in extreme circumstances, it
+ may be of value to force Time Service not to rely on normal time updates. Note that when
+ commanded into FLYWHEEL mode, the Time Service will remain so until receipt of another
+ "set state" command setting the state into a mode other than FLYWHEEL. Note also that
+ setting the clock state to VALID or INVALID on a Time Client that is currently getting
+ time updates from the Time Server will have very limited effect. As soon as the Time
+ Client receives the next time update, the VALID/INVALID selection will be set to that of
+ the Time Server. However, setting a Time Client to FLYWHEEL cannot be overridden by the
+ Time Server since the Time Client will ignore time updates from the Time Server while in
FLYWHEEL mode.
-
-
+
+
Next: \ref cfetimeuginit
Prev: \ref cfetimeugflywheeling
Up To: \ref cfetimeovr
@@ -618,17 +618,17 @@
/**
\page cfetimeuginit Initialization
- No action is required by the ground to initialize the TIME software; however, time
+ No action is required by the ground to initialize the TIME software; however, time
variables in the TIME Server must be set by command to allow correct time to propagate.
-
+
For a description of what happens during each type of reset, see below:
-
+
- \subpage cfetimeugpoweron
- \subpage cfetimeugprocessor
-
-
+
+
Next: \ref cfetimeugpoweron
Prev: \ref cfetimeugstate
Up To: \ref cfetimeovr
@@ -638,10 +638,10 @@
/**
\page cfetimeugpoweron Power-On Reset
- TIME initializes all counters in housekeeping telemetry, sets the Validity
+ TIME initializes all counters in housekeeping telemetry, sets the Validity
state to Invalid, and initializes the STCF, Leap Seconds, and 1 Hz Adjustment to zero.
-
-
+
+
Next: \ref cfetimeugprocessor
Up To: \ref cfetimeuginit
**/
@@ -659,10 +659,10 @@
- Current Time Client Delay (if applicable)
- Note that since it is virtually impossible for TIME services to validate the
- actual data that is saved across a processor reset, a signature pattern is
- written to the preserved area. On a processor reset, TIME queries that
- signature to make sure that it matches what is expected. If the signature
+ Note that since it is virtually impossible for TIME services to validate the
+ actual data that is saved across a processor reset, a signature pattern is
+ written to the preserved area. On a processor reset, TIME queries that
+ signature to make sure that it matches what is expected. If the signature
does not match, then TIME is initialized as if a cFE power-on reset occurred.
Next: \ref cfetimeugnormal
@@ -676,13 +676,13 @@
The following sections describe the operator's resposibilities for maintaining
time under nominal conditions:
-
+
- \subpage cfetimeugclientops
- \subpage cfetimeugserverops
-
-
+
+
Next: \ref cfetimeugclientops
Prev: \ref cfetimeuginit
Up To: \ref cfetimeovr
@@ -693,11 +693,11 @@
\page cfetimeugclientops Client
Under normal operation, TIME Client systems do not require any attention from the ground,
- however TIME clients do provide commands to set the persistent latency between the server
- and client. Latency can be either added or subtracted to the current TIME client time
+ however TIME clients do provide commands to set the persistent latency between the server
+ and client. Latency can be either added or subtracted to the current TIME client time
calculation to account for the latency.
-
-
+
+
Next: \ref cfetimeugserverops
Up To: \ref cfetimeugnormal
**/
@@ -709,14 +709,14 @@
TIME Servers require maintenance by the operations team to ensure the spacecraft is maintaining
a time that can be successfully correlated to other entities. The following sections describe
the commands that the operations team can use to help maintain a proper time reference:
-
+
- \subpage cfetimeugsettime
- \subpage cfetimeugadjust
- \subpage cfetimeugsetmet
-
-
+
+
Next: \ref cfetimeugsettime
Prev: \ref cfetimeugclientops
Up To: \ref cfetimeugnormal
@@ -726,28 +726,28 @@
/**
\page cfetimeugsettime Setting Time
- The Time Server provides commands to set time. The new time value represents the
- desired offset from mission-defined time epoch and takes effect immediately upon
- execution of this command. Time Service will calculate a new STCF value based
- on the current MET and the desired new time using one of the following:
+ The Time Server provides commands to set time. The new time value represents the
+ desired offset from mission-defined time epoch and takes effect immediately upon
+ execution of this command. Time Service will calculate a new STCF value based
+ on the current MET and the desired new time using one of the following:
If Time Service is configured to compute current time as TAI:
-
+
\verbatim
- STCF = new time - current MET
- current time = current MET + STCF
+ STCF = new time - current MET
+ current time = current MET + STCF
\endverbatim
-
+
If Time Service is configured to compute current time as UTC:
-
+
\verbatim
STCF = ((new time) - (current MET)) + Leap Seconds
current time = ((current MET) + STCF) - Leap Seconds
\endverbatim
-
+
\sa #CFE_TIME_SET_TIME_CC
-
-
+
+
Next: \ref cfetimeugadjust
Up To: \ref cfetimeugserverops
**/
@@ -756,29 +756,29 @@
/**
\page cfetimeugadjust Adjusting Time
- The TIME Server includes commands to set the STCF, Leap Seconds,
+ The TIME Server includes commands to set the STCF, Leap Seconds,
and Validity state. The STCF should be set implicity using the
#CFE_TIME_SET_TIME_CC or explicitly using #CFE_TIME_SET_STCF_CC.
TIME provides the ability to command a one time adjustment
(#CFE_TIME_ADD_ADJUST_CC and #CFE_TIME_SUB_ADJUST_CC)
to the current STCF. In addition there is a 1Hz adjustment
(#CFE_TIME_ADD_1HZ_ADJUSTMENT_CC and #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC)
- that can be made to the STCF to compensate for oscillator drift.
- Mission specific ground correlation should be used to assist in
- determining the proper values to use. The Leap Seconds should be
+ that can be made to the STCF to compensate for oscillator drift.
+ Mission specific ground correlation should be used to assist in
+ determining the proper values to use. The Leap Seconds should be
set to the current TAI-UTC. Note that the International Earth
- Rotation and Reference Systems Service Bulletin C, which defines
- the current difference, reports it as UTC-TAI, and thus that value
- must be negated. The Leap Seconds value will always be a positive
- number. The Validity state does not have to be set to invalid to
- change the STCF or Leap Seconds, and should be set to valid at
- any time that the TIME Server time reference should be synchronized
+ Rotation and Reference Systems Service Bulletin C, which defines
+ the current difference, reports it as UTC-TAI, and thus that value
+ must be negated. The Leap Seconds value will always be a positive
+ number. The Validity state does not have to be set to invalid to
+ change the STCF or Leap Seconds, and should be set to valid at
+ any time that the TIME Server time reference should be synchronized
to by the other systems.
-
- \sa #CFE_TIME_ADD_ADJUST_CC, #CFE_TIME_SUB_ADJUST_CC, #CFE_TIME_SET_STCF_CC,
+
+ \sa #CFE_TIME_ADD_ADJUST_CC, #CFE_TIME_SUB_ADJUST_CC, #CFE_TIME_SET_STCF_CC,
#CFE_TIME_ADD_1HZ_ADJUSTMENT_CC, #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC, #CFE_TIME_SET_LEAP_SECONDS_CC
-
-
+
+
Next: \ref cfetimeugsetmet
Prev: \ref cfetimeugsettime
Up To: \ref cfetimeugserverops
@@ -788,19 +788,19 @@
/**
\page cfetimeugsetmet Setting MET
- The TIME Server provides the capability to set the MET. Note that the
- MET (as implemented for cFE Time Service) is a logical representation
- and not a physical timer. Thus, setting the MET is not dependent on
- whether the hardware supports a MET register that can be written to.
- Note also that Time Service "assumes" that during normal operation,
- the MET is synchronized to the tone signal. Therefore, unless operating
- in FLYWHEEL mode, the sub-seconds portion of the MET will be set to zero
- at the next tone signal interrupt. The new MET takes effect immediately
+ The TIME Server provides the capability to set the MET. Note that the
+ MET (as implemented for cFE Time Service) is a logical representation
+ and not a physical timer. Thus, setting the MET is not dependent on
+ whether the hardware supports a MET register that can be written to.
+ Note also that Time Service "assumes" that during normal operation,
+ the MET is synchronized to the tone signal. Therefore, unless operating
+ in FLYWHEEL mode, the sub-seconds portion of the MET will be set to zero
+ at the next tone signal interrupt. The new MET takes effect immediately
upon execution of this command.
-
+
\sa #CFE_TIME_SET_MET_CC
-
-
+
+
Next: \ref cfetimeugfaq
Prev: \ref cfetimeugadjust
Up To: \ref cfetimeugserverops
@@ -812,20 +812,20 @@
-
-
+
+
Prev: \ref cfetimeugnormal
Up To: \ref cfetimeovr
**/
-/**
+/**
** \page cfetimecmds cFE Time Services Commands
**
-** The following is a list of commands that are processed by the cFE Time Services Task.
+** The following is a list of commands that are processed by the cFE Time Services Task.
**/
/**
diff --git a/docs/src/cfe_xref.dox b/docs/src/cfe_xref.dox
index abee13ef4..9469fe59b 100644
--- a/docs/src/cfe_xref.dox
+++ b/docs/src/cfe_xref.dox
@@ -12,7 +12,7 @@
** \page cfecmdmnems cFE Command Mnemonic Cross Reference
**
** The following cross reference maps the cFE command codes to Command Mnemonics.
-** To learn about the details of a particular command, click on its associated
+** To learn about the details of a particular command, click on its associated
** command code.
**
**/
diff --git a/docs/src/cfs_versions.dox b/docs/src/cfs_versions.dox
index f7b1a061d..ddd7593a1 100644
--- a/docs/src/cfs_versions.dox
+++ b/docs/src/cfs_versions.dox
@@ -19,7 +19,7 @@
The REVISION number shall be incremented on changes that benefit from unique identification such as bug fixes or major documentation updates.
The Revision number may also be updated if there are other changes contained within a release that make it desirable for applications to distinguish one release from another.
- WARNING: The revision number is set to the number 99 in development builds. To distinguish between development builds refer to the BUILD_NUMBER and BUILD_BASELINE detailed in the section "Identifying Development Builds".
+ WARNING: The revision number is set to the number 99 in development builds. To distinguish between development builds refer to the BUILD_NUMBER and BUILD_BASELINE detailed in the section "Identifying Development Builds".
The Major, Minor, and Revision numbers are provided in this header file as part of the API
definition; this macro must expand to a simple integer value, so that it can be used in simple if directives by the macro preprocessor.
diff --git a/docs/src/ddd_main.dox b/docs/src/ddd_main.dox
index 0fe1b4769..fabe2707f 100644
--- a/docs/src/ddd_main.dox
+++ b/docs/src/ddd_main.dox
@@ -47,7 +47,7 @@
\subpage cfetlmmnems
\subpage cfeapi
-
+
Other Core Flight Executive Reference Material
- \subpage cfeappdevguide
diff --git a/docs/src/main.dox b/docs/src/main.dox
index d606c38db..9ecc545cb 100644
--- a/docs/src/main.dox
+++ b/docs/src/main.dox
@@ -62,22 +62,22 @@
/**
\page cfebackground Background
- The Core Flight Executive (cFE) is an application development and run-time environment. The cFE
- provides a set of core services including Software Bus (messaging), Time, Event (Alerts), Executive
- (startup and runtime), and Table services. The cFE defines an application programming interface (API)
+ The Core Flight Executive (cFE) is an application development and run-time environment. The cFE
+ provides a set of core services including Software Bus (messaging), Time, Event (Alerts), Executive
+ (startup and runtime), and Table services. The cFE defines an application programming interface (API)
for each service which serves as the basis for application development.
-
- The cFE Software Bus service provides a publish and subscribe messaging system that allows applications
- to easily plug and play into the system. Applications subscribe to cFE services at runtime, making
- system modifications easy. Facilitating rapid prototyping, new applications can be compiled, linked, loaded,
- and started without requiring the entire system to be rebuilt.
+
+ The cFE Software Bus service provides a publish and subscribe messaging system that allows applications
+ to easily plug and play into the system. Applications subscribe to cFE services at runtime, making
+ system modifications easy. Facilitating rapid prototyping, new applications can be compiled, linked, loaded,
+ and started without requiring the entire system to be rebuilt.
\image html CFSPubSub.jpg
-
- Each service comes complete with a built in application that allows users to interface with each service. To
- support reuse and project independence, the cFE contains a configurable set of requirements and code. The configurable
- parameters allow the cFE to be tailored for each environment including desk-top and closed loop simulation environments.
- This provides the ability to run and test software applications on a developer's desktop and then deploy that same software
+
+ Each service comes complete with a built in application that allows users to interface with each service. To
+ support reuse and project independence, the cFE contains a configurable set of requirements and code. The configurable
+ parameters allow the cFE to be tailored for each environment including desk-top and closed loop simulation environments.
+ This provides the ability to run and test software applications on a developer's desktop and then deploy that same software
without changes to the embedded system. In addition the cFE includes the following software development tools:
- Unit Test Framework (UTF) for unit testing applications developed via the cFE
@@ -85,59 +85,59 @@
- Table Builder
- Command and Telemetry utilities
- The cFE is one of the components of the Core Flight System (cFS), a platform and project independent reusable
- software framework and set of reusable software applications. There are three key aspects to the cFS architecture:
- a dynamic run-time environment, layered software, and a component based design. The combination of these key aspects
- along with an implementation targeted to the embedded software domain makes it suitable for reuse on any number of
- NASA flight projects and/or embedded software systems.
+ The cFE is one of the components of the Core Flight System (cFS), a platform and project independent reusable
+ software framework and set of reusable software applications. There are three key aspects to the cFS architecture:
+ a dynamic run-time environment, layered software, and a component based design. The combination of these key aspects
+ along with an implementation targeted to the embedded software domain makes it suitable for reuse on any number of
+ NASA flight projects and/or embedded software systems.
- The pivotal design feature, abstracting the software architecture from the hardware and forming the basis of reuse,
- is component layering. Each layer of the architecture "hides" its implementation and technology details from the other
- layers by defining and using standard Application Programming Interfaces (APIs). The internals of a layer can be changed
- without affecting other layers' internals and components.
+ The pivotal design feature, abstracting the software architecture from the hardware and forming the basis of reuse,
+ is component layering. Each layer of the architecture "hides" its implementation and technology details from the other
+ layers by defining and using standard Application Programming Interfaces (APIs). The internals of a layer can be changed
+ without affecting other layers' internals and components.
\image html CFSLayers.jpg
- The layers include an OS Abstraction Layer (OSAL), Platform Support Package (PSP) layer, core Flight Executive (cFE) layer,
- and an Application layer. The cFE layer runs on top of the PSP and OSAL layers. The cFE comes complete with a build
- environment, deployment guide, API reference guide, and provides a sample PSP. The OSAL is available open source and
- once integrated into the cFE build environment, developers will be ready to build and run the system and start developing
+ The layers include an OS Abstraction Layer (OSAL), Platform Support Package (PSP) layer, core Flight Executive (cFE) layer,
+ and an Application layer. The cFE layer runs on top of the PSP and OSAL layers. The cFE comes complete with a build
+ environment, deployment guide, API reference guide, and provides a sample PSP. The OSAL is available open source and
+ once integrated into the cFE build environment, developers will be ready to build and run the system and start developing
their mission/project specific applications that easily plug and play into the system.
-
+
Core Flight Executive (cFE) Goals
- The main long term goal of the cFE is to form the basis for a platform and project
- independent reusable software framework. The cFE with the OSAL allow the development
- of portable embedded system software that is independent of a particular Real Time
- Operating System and hardware platform. A secondary long term goal is to create a
- standardized, product-line approach for development of embedded aerospace flight
+ The main long term goal of the cFE is to form the basis for a platform and project
+ independent reusable software framework. The cFE with the OSAL allow the development
+ of portable embedded system software that is independent of a particular Real Time
+ Operating System and hardware platform. A secondary long term goal is to create a
+ standardized, product-line approach for development of embedded aerospace flight
software.
Functional and Community Goals
- The cFE allows embedded system software to be developed and tested on desktop workstations
- and ported to the target platform without changing a single line of code, providing a shorter
- development and debug time. The cFE is an enabler of software collaboration amongst all users
- promoting the growth of the application and library layers where new applications, libraries,
+ The cFE allows embedded system software to be developed and tested on desktop workstations
+ and ported to the target platform without changing a single line of code, providing a shorter
+ development and debug time. The cFE is an enabler of software collaboration amongst all users
+ promoting the growth of the application and library layers where new applications, libraries,
tools, and lessons learned can be contributed and shared.
- It is important for application developers to realize the long term and functional
- goals of the cFE. With a standard set of services providing a standard API, all
- applications developed with the cFE have an opportunity to become useful on
- future missions through code reuse. In order to achieve this goal,
- applications must be written with care to ensure that their code does not
- have dependencies on specific hardware, software or compilers. The cFE and
- the underlying generic operating system API (OS API) have been designed to
- insulate the cFE Application developer from hardware and software dependencies.
- The developer, however, must make the effort to identify the proper methods
- through the cFE and OS API to satisfy their software requirements and not
- be tempted to take a "short-cut" and accomplish their goal with a direct
+ It is important for application developers to realize the long term and functional
+ goals of the cFE. With a standard set of services providing a standard API, all
+ applications developed with the cFE have an opportunity to become useful on
+ future missions through code reuse. In order to achieve this goal,
+ applications must be written with care to ensure that their code does not
+ have dependencies on specific hardware, software or compilers. The cFE and
+ the underlying generic operating system API (OS API) have been designed to
+ insulate the cFE Application developer from hardware and software dependencies.
+ The developer, however, must make the effort to identify the proper methods
+ through the cFE and OS API to satisfy their software requirements and not
+ be tempted to take a "short-cut" and accomplish their goal with a direct
hardware or operating system software interface.
**/
/**
\page cfeappdocs Applicable Documents
-
+
Document Title
@@ -163,13 +163,13 @@
/**
\page cfedependencies Dependencies
- The Core Flight Executive (cFE) is required to be built with the Operating System Abstraction Layer (OSAL) and Platform Support Package (PSP)
- componenets of the Core Flight System (cFS). It is always recommended to build with the latest versions of each of the components as
+ The Core Flight Executive (cFE) is required to be built with the Operating System Abstraction Layer (OSAL) and Platform Support Package (PSP)
+ componenets of the Core Flight System (cFS). It is always recommended to build with the latest versions of each of the components as
backward compatability may not be supported.
-
- Several internal data structures within the cFE use the "char" data type. This data type is typically 1 byte in storage size with a value
- range -128 to 127 or 0 to 255. The size of the "char" data type and whether or not the type is signed or unsigned can change across
- platforms. The cFE assumes use of the "char" data type as an 8-bit type.
+
+ Several internal data structures within the cFE use the "char" data type. This data type is typically 1 byte in storage size with a value
+ range -128 to 127 or 0 to 255. The size of the "char" data type and whether or not the type is signed or unsigned can change across
+ platforms. The cFE assumes use of the "char" data type as an 8-bit type.
**/
diff --git a/docs/src/osal_fs.dox b/docs/src/osal_fs.dox
index fd8b2de7d..6a8b8cf29 100644
--- a/docs/src/osal_fs.dox
+++ b/docs/src/osal_fs.dox
@@ -6,7 +6,7 @@
volume view regardless of the underlying system type. For example, vxWorks
uses MS-DOS style volume names and directories where a vxWorks RAM disk might
have the volume “RAM:0”. With this File System API, volumes are represented
- as Unix-style paths where each volume is mounted on the root file system:
+ as Unix-style paths where each volume is mounted on the root file system:
- RAM:0/file1.dat becomes /mnt/ram/file1.dat
@@ -36,7 +36,7 @@
directory “.”. In the example of “/tmp” all of the directories created
for the volumes would be under “/tmp” on the Linux file system. For a real
disk device in Linux, such as a RAM disk, this field is the device
- name “/dev/ram0”.
+ name “/dev/ram0”.
- Volume Type: This field defines the type of volume. The types are:
FS_BASED which uses the existing file system, RAM_DISK which uses a
RAM_DISK device in vxWorks, RTEMS, or Linux, FLASH_DISK_FORMAT which uses
@@ -45,7 +45,7 @@
before it’s use, EEPROM which is for an EEPROM or PROM based system.
- Volatile Flag: This flag indicates that the volume or disk is a volatile
disk (RAM disk ) or a non-volatile disk, that retains its contents when
- the system is rebooted. This should be set to TRUE or FALSE.
+ the system is rebooted. This should be set to TRUE or FALSE.
- Free Flag: This is an internal flag that should be set to FALSE or zero.
- Is Mounted Flag: This is an internal flag that should be set to FALSE
or zero. Note that a “pre-mounted” FS_BASED path can be set up by setting
@@ -60,7 +60,7 @@
**/
/**
-\page osalfsfd File Descriptors In Osal
+\page osalfsfd File Descriptors In Osal
The OSAL uses abstracted file descriptors. This means that the file descriptors
passed back from the OS_open and OS_creat calls will only work with other OSAL OS_*
@@ -72,7 +72,7 @@ instance, the path of the file that the file descriptor points to can be easily
retrieved. Also, the OSAL task ID of the task that opened the file can also be
retrieved easily. Both of these pieces of information are very useful when trying
to determine statistics for a task, or the entire system. This information can all
- be retrieved with a single API, OS_FDGetInfo.
+ be retrieved with a single API, OS_FDGetInfo.
All of possible file system calls are not implemented. "Special" files requiring OS
specific control/operations are by nature not portable. Abstraction in this case is
@@ -83,7 +83,7 @@ instance, the path of the file that the file descriptor points to can be easily
There are some small drawbacks with the OSAL file descriptors. Because the related
information is kept in a table, there is a define called OS_MAX_NUM_OPEN_FILES that
defines the maximum number of file descriptors available. This is a configuration
-parameter, and can be changed to fit your needs.
+parameter, and can be changed to fit your needs.
Also, if you open or create a file not using the OSAL calls (OS_open or OS_creat)
then none of the other OS_* calls that accept a file descriptor as a parameter will
From dc3ab6e157478f28d2a93eea82e19b52cc1cb5dc Mon Sep 17 00:00:00 2001
From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com>
Date: Mon, 15 Mar 2021 18:25:21 -0400
Subject: [PATCH 5/7] Fix #1130, Clean trailing whitespace: XML
---
modules/core_api/eds/base_types.xml | 34 +-
modules/core_api/eds/ccsds_spacepacket.xml | 68 +--
modules/core_api/eds/cfe_fs.xml | 16 +-
modules/core_api/eds/config.xml | 12 +-
modules/core_private/eds/base_types.xml | 34 +-
modules/core_private/eds/config.xml | 12 +-
modules/es/eds/cfe_es.xml | 560 ++++++++++-----------
modules/evs/eds/cfe_evs.xml | 26 +-
modules/sb/eds/cfe_sb.xml | 60 +--
modules/tbl/eds/cfe_tbl.xml | 34 +-
modules/time/eds/cfe_time.xml | 110 ++--
11 files changed, 483 insertions(+), 483 deletions(-)
diff --git a/modules/core_api/eds/base_types.xml b/modules/core_api/eds/base_types.xml
index 55d7c7679..9f510458c 100644
--- a/modules/core_api/eds/base_types.xml
+++ b/modules/core_api/eds/base_types.xml
@@ -19,12 +19,12 @@
See the License for the specific language governing permissions and
limitations under the License.
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes stardard data types used throughout the Core Flight System
-
+
-->
@@ -35,7 +35,7 @@
-
+
@@ -85,7 +85,7 @@
-
+
@@ -99,12 +99,12 @@
double
-
+
-
-
-
+
-
+
diff --git a/modules/core_api/eds/ccsds_spacepacket.xml b/modules/core_api/eds/ccsds_spacepacket.xml
index 4599eced7..8f89d41d7 100644
--- a/modules/core_api/eds/ccsds_spacepacket.xml
+++ b/modules/core_api/eds/ccsds_spacepacket.xml
@@ -18,14 +18,14 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes objects as defined by CCSDS book 133 Space Packet Protocol
and utilized by the Core Fligh System (cFS)
-
+
-->
@@ -37,7 +37,7 @@
-
+
@@ -46,35 +46,35 @@
-
+
-
+
-
+
-
+
-
+
Command codes in CFE range are 7 bits (0-127). The most signficant bit (codes 128-255) are reserved.
@@ -84,21 +84,21 @@
-
+
-
-
+ -->
The Primary message header that is present in all CCSDS Space Protocol packets
@@ -113,7 +113,7 @@
-
+
@@ -123,7 +123,7 @@
-
+
@@ -137,14 +137,14 @@
-
+
-
+
The APID qualifier header extension that is present in CCSDS version 2
@@ -157,11 +157,11 @@
-
-
+ -->
The APID qualified primary header that is present in all CCSDS Space Protocol version 2 packets
@@ -173,7 +173,7 @@
-
+
The secondary message header that is present in all cFE command messages
@@ -183,7 +183,7 @@
-
+
The secondary message header that is present in all cFE telemetry messages
@@ -193,13 +193,13 @@
-
+
-
+
@@ -217,15 +217,15 @@
-
+
-
-
+
+
-
+
diff --git a/modules/core_api/eds/cfe_fs.xml b/modules/core_api/eds/cfe_fs.xml
index 99d107b4e..da85a5912 100644
--- a/modules/core_api/eds/cfe_fs.xml
+++ b/modules/core_api/eds/cfe_fs.xml
@@ -19,13 +19,13 @@
See the License for the specific language governing permissions and
limitations under the License.
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes all interface objects for the File Services (CFE_FS)
- core application
-
+ core application
+
-->
@@ -143,7 +143,7 @@
-
+
@@ -159,7 +159,7 @@
-
+
diff --git a/modules/core_api/eds/config.xml b/modules/core_api/eds/config.xml
index 1635b02e4..6c2dbd824 100644
--- a/modules/core_api/eds/config.xml
+++ b/modules/core_api/eds/config.xml
@@ -19,11 +19,11 @@
See the License for the specific language governing permissions and
limitations under the License.
- Purpose:
+ Purpose:
Assign values to basic configuration parameters of the Core Flight
System (cFS). The CFS EDS toolchain uses values defined here to
- as substitutions for the ${} syntax in EDS files.
-
+ as substitutions for the ${} syntax in EDS files.
+
-->
@@ -33,17 +33,17 @@
-
+
-
+
-
+
diff --git a/modules/core_private/eds/base_types.xml b/modules/core_private/eds/base_types.xml
index 55d7c7679..9f510458c 100644
--- a/modules/core_private/eds/base_types.xml
+++ b/modules/core_private/eds/base_types.xml
@@ -19,12 +19,12 @@
See the License for the specific language governing permissions and
limitations under the License.
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes stardard data types used throughout the Core Flight System
-
+
-->
@@ -35,7 +35,7 @@
-
+
@@ -85,7 +85,7 @@
-
+
@@ -99,12 +99,12 @@
double
-
+
-
-
-
+
-
+
diff --git a/modules/core_private/eds/config.xml b/modules/core_private/eds/config.xml
index 1635b02e4..6c2dbd824 100644
--- a/modules/core_private/eds/config.xml
+++ b/modules/core_private/eds/config.xml
@@ -19,11 +19,11 @@
See the License for the specific language governing permissions and
limitations under the License.
- Purpose:
+ Purpose:
Assign values to basic configuration parameters of the Core Flight
System (cFS). The CFS EDS toolchain uses values defined here to
- as substitutions for the ${} syntax in EDS files.
-
+ as substitutions for the ${} syntax in EDS files.
+
-->
@@ -33,17 +33,17 @@
-
+
-
+
-
+
diff --git a/modules/es/eds/cfe_es.xml b/modules/es/eds/cfe_es.xml
index 5fbe33fee..517e1e778 100644
--- a/modules/es/eds/cfe_es.xml
+++ b/modules/es/eds/cfe_es.xml
@@ -19,18 +19,18 @@
See the License for the specific language governing permissions and
limitations under the License.
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes all interface objects for the Executive Services (CFE_ES)
- core application
-
+ core application
+
-->
-
+
@@ -38,7 +38,7 @@
-
+
@@ -54,7 +54,7 @@
-
+
@@ -69,7 +69,7 @@
-
+
@@ -77,11 +77,11 @@
-
+
These values are used with the CFE_ES_WaitForSystemState() API call to synchronize application startup.
-
+
@note These are defined in order so that relational comparisons e.g. if (STATEA < STATEB) are possible
@@ -95,12 +95,12 @@
-
+
The normal progression of APP states:
UNDEFINED -> EARLY_INIT -> LATE_INIT -> RUNNING -> WAITING -> STOPPED
-
+
@note These are defined in order so that relational comparisons e.g. if (STATEA < STATEB) are possible
@@ -114,18 +114,18 @@
-
-
+
+
-
+
-
+
CFE_ES_AppInfo_t is a structure that is used to provide
@@ -240,7 +240,7 @@
-
+
@@ -248,13 +248,13 @@
-
+
-
+
@@ -284,7 +284,7 @@
-
+
For command details, see #CFE_ES_RESTART_CC
@@ -293,7 +293,7 @@
-
+
For command details, see #CFE_ES_SHELL_CMD_CC
@@ -303,13 +303,13 @@
-
+
-
+
For command details, see #CFE_ES_OVERWRITE_SYSLOG_CC
@@ -323,7 +323,7 @@
-
+
For command details, see #CFE_ES_START_APP_CC.
@@ -342,7 +342,7 @@
-
+
For command details, see #CFE_ES_STOP_APP_CC, #CFE_ES_RESTART_APP_CC, #CFE_ES_QUERY_ONE_CC
@@ -351,7 +351,7 @@
-
+
For command details, see #CFE_ES_RELOAD_APP_CC
@@ -361,7 +361,7 @@
-
+
For command details, see #CFE_ES_SET_MAX_PR_COUNT_CC
@@ -370,7 +370,7 @@
-
+
For command details, see #CFE_ES_DELETE_CDS_CC
@@ -379,7 +379,7 @@
-
+
For command details, see #CFE_ES_PERF_STARTDATA_CC
@@ -388,7 +388,7 @@
-
+
For command details, see #CFE_ES_PERF_STOPDATA_CC
@@ -397,7 +397,7 @@
-
+
For command details, see #CFE_ES_PERF_SETFILTERMASK_CC
@@ -407,7 +407,7 @@
-
+
For command details, see #CFE_ES_PERF_SETTRIGMASK_CC
@@ -417,7 +417,7 @@
-
+
\brief Telemeter Memory Pool Statistics Command.
@@ -428,7 +428,7 @@
-
+
For command details, see #CFE_ES_DUMP_CDS_REG_CC
@@ -437,13 +437,13 @@
-
+
-
+
@@ -454,7 +454,7 @@
-
+
@@ -649,18 +649,18 @@
-
+
- \brief ASCII text string containing output from OS Shell
+ \brief ASCII text string containing output from OS Shell
that was received in response to an OS Shell Command
-
+
@@ -687,16 +687,16 @@
-
+
\cfeescmd Executive Services No-Op
\par Description
-
- This command performs no other function than to increment the
- command execution counter. The command may be used to verify
+
+ This command performs no other function than to increment the
+ command execution counter. The command may be used to verify
general aliveness of the Executive Services task.
\cfecmdmnemonic \ES_NOOP
@@ -704,19 +704,19 @@
#CFE_ES_NoArgsCmd_t
\par Command Verification
-
- Successful execution of this command may be verified with the
+
+ Successful execution of this command may be verified with the
following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_NOOP_INF_EID informational event message will
+ - The #CFE_ES_NOOP_INF_EID informational event message will
be generated
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- the #CFE_ES_LEN_ERR_EID error event message will be generated
@@ -734,8 +734,8 @@
\cfeescmd Executive Services Reset Counters
\par Description
-
- This command resets the following counters within the Executive
+
+ This command resets the following counters within the Executive
Services housekeeping telemetry:
- Command Execution Counter
- Command Error Counter
@@ -745,28 +745,28 @@
#CFE_ES_NoArgsCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_RESET_INF_EID informational event message will be
+ - The #CFE_ES_RESET_INF_EID informational event message will be
generated
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- the #CFE_ES_LEN_ERR_EID error event message will be generated
\par Criticality
-
- This command is not inherently dangerous. However, it is
- possible for ground systems and on-board safing procedures
- to be designed such that they react to changes in the counter
+
+ This command is not inherently dangerous. However, it is
+ possible for ground systems and on-board safing procedures
+ to be designed such that they react to changes in the counter
values that are reset by this command.
\sa #CFE_ES_RESET_PR_COUNT_CC
@@ -781,15 +781,15 @@
\cfeescmd Executive Services Processor / Power-On Reset
\par Description
-
+
This command restarts the cFE in one of two modes. The Power-On Reset
will cause the cFE to restart as though the power were first applied
to the processor. The Processor Reset will attempt to retain the contents
of the volatile disk and the contents of the Critical Data Store.
- NOTE: If a requested Processor Reset should cause the
+ NOTE: If a requested Processor Reset should cause the
Processor Reset Counter (\b \c \ES_PROCRESETCNT)
to exceed OR EQUAL the limit #CFE_ES_MAX_PROCESSOR_RESETS (which is reported in
- housekeeping telemetry as \b \c \ES_MAXPROCRESETS),
+ housekeeping telemetry as \b \c \ES_MAXPROCRESETS),
the command is \b AUTOMATICALLY upgraded to a Power-On Reset.
\cfecmdmnemonic \ES_RESET
@@ -797,8 +797,8 @@
#CFE_ES_RestartCmd_t
\par Command Verification
-
- Successful execution of this command (as a Processor Reset)
+
+ Successful execution of this command (as a Processor Reset)
may be verified with the following telemetry:
- \b \c \ES_PROCRESETCNT - processor reset counter will increment
- New entries in the Exception Reset Log and System Log can be found
@@ -809,18 +809,18 @@
command execution.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The \link #CFE_ES_RestartCmd_t.RestartType Restart Type \endlink was
- not a recognized value.
-
+ not a recognized value.
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- the #CFE_ES_BOOT_ERR_EID error event message will be generated
\par Criticality
-
+
This command is, by definition, dangerous. Significant loss of
data will occur. All processes and the cFE itself will be stopped
and restarted. With the Power-On reset option, all data on the
@@ -842,12 +842,12 @@
\cfeescmd Executive Services O/S Shell Command
\par Description
-
+
This command passes an ASCII string as a command line to the
underlying realtime operating system shell. Any response to
the command is both written to the shell command output file
and sent as a series of shell command output telemetry packets.
-
+
If the shell command output filename argument is empty, then
#CFE_ES_DEFAULT_SHELL_FILENAME will be used as the filename.
\cfecmdmnemonic \ES_SHELL
@@ -856,16 +856,16 @@
#CFE_ES_ShellCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_SHELL_INF_EID informational event message will be
+ - The #CFE_ES_SHELL_INF_EID informational event message will be
generated
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- Failure to create the shell command output file
@@ -874,14 +874,14 @@
- There was an error while performing a #OS_lseek on the shell command output file
- There was an error while redirecting the shell command response to the
shell command output file
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- the #CFE_ES_SHELL_ERR_EID error event message will be generated
- Additional information on the error should be found in the System Log
\par Criticality
-
+
This command should be used with caution. Interfering with the
operation of the underlying realtime operating system can cause
significant problems.
@@ -899,8 +899,8 @@
\cfeescmd Load and Start an Application
\par Description
-
- This command starts the specified application with the
+
+ This command starts the specified application with the
specified start address, stack size, etc options.
\cfecmdmnemonic \ES_STARTAPP
@@ -908,16 +908,16 @@
#CFE_ES_StartAppCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_START_INF_EID informational event message will be
+ - The #CFE_ES_START_INF_EID informational event message will be
generated
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The specified application filename string is either a NULL string
@@ -929,14 +929,14 @@
- The specified exception action is neither #CFE_ES_ExceptionAction_RESTART_APP (0) or
#CFE_ES_ExceptionAction_PROC_RESTART (1)
- The Operating System was unable to load the specified application file
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
This command is not inherently dangerous although system resources
could be taxed beyond their limits with the starting of erroneous
or invalid applications.
@@ -956,12 +956,12 @@
\cfeescmd Stop and Unload Application
\par Description
-
+
This command halts and removes the specified Application
from the system. \b NOTE: This command should never be used
on the Command Ingest application. This would prevent further
commands from entering the system. If Command Ingest needs to
- be stopped and restarted, use #CFE_ES_RESTART_APP_CC or
+ be stopped and restarted, use #CFE_ES_RESTART_APP_CC or
#CFE_ES_RELOAD_APP_CC.
\cfecmdmnemonic \ES_STOPAPP
@@ -969,35 +969,35 @@
#CFE_ES_AppNameCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_STOP_DBG_EID debug event message will be
+ - The #CFE_ES_STOP_DBG_EID debug event message will be
generated. NOTE: This event message only identifies that the
stop has been started, not that is has completed.
- Once the stop has successfully completed, the list of Applications
- and Tasks created in response to the \b \c \ES_WRITEAPPINFO2FILE,
- \b \c \ES_WRITETASKINFO2FILE should no longer contain the
+ and Tasks created in response to the \b \c \ES_WRITEAPPINFO2FILE,
+ \b \c \ES_WRITETASKINFO2FILE should no longer contain the
specified application.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The specified application name is not recognized as an active application
- The specified application is one of the cFE's Core applications (ES, EVS, SB, TBL, TIME)
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued forall error
+ - A command specific error event message is issued forall error
cases
- Additional information on the reason for command failure may be found
in the System Log
\par Criticality
-
+
This command is not inherently dangerous, however the removal of certain
applications (e.g. - Spacecraft Attitude and Control) may have a detrimental effect
on the spacecraft.
@@ -1017,7 +1017,7 @@
\cfeescmd Stops and Restarts an Application
\par Description
-
+
This command halts and restarts the specified Application.
This command does \b NOT reload the application from the onboard
filesystem.
@@ -1027,31 +1027,31 @@
#CFE_ES_AppNameCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_RESTART_APP_DBG_EID debug event message will be
+ - The #CFE_ES_RESTART_APP_DBG_EID debug event message will be
generated. NOTE: This event message only identifies that the
act of stopping the application has begun, not that is has completed.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The specified application name is not recognized as an active application
- The specified application is one of the cFE's Core applications (ES, EVS, SB, TBL, TIME)
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
- Additional information on the reason for command failure may be found
in the System Log
\par Criticality
-
+
This command is not inherently dangerous, however the restarting of certain
applications (e.g. - Spacecraft Attitude and Control) may have a detrimental effect
on the spacecraft.
@@ -1071,10 +1071,10 @@
\cfeescmd Stops, Unloads, Loads from a File and Restarts an Application
\par Description
-
+
This command halts and removes the specified Application
from the system. Then it immediately loads the Application from
- the command specified file and restarts it. This command is
+ the command specified file and restarts it. This command is
especially useful for restarting a Command Ingest Application
since once it has been stopped, no further commands can come in
to restart it.
@@ -1084,31 +1084,31 @@
#CFE_ES_AppReloadCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_RELOAD_APP_DBG_EID debug event message will be
+ - The #CFE_ES_RELOAD_APP_DBG_EID debug event message will be
generated. NOTE: This event message only identifies that the
act of stopping the application has begun, not that is has completed.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The specified application name is not recognized as an active application
- The specified application is one of the cFE's Core applications (ES, EVS, SB, TBL, TIME)
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
- Additional information on the reason for command failure may be found
in the System Log
\par Criticality
-
+
This command is not inherently dangerous, however the restarting of certain
applications (e.g. - Spacecraft Attitude and Control) may have a detrimental effect
on the spacecraft.
@@ -1128,7 +1128,7 @@
\cfeescmd Request Executive Services Information on a Specified Application
\par Description
-
+
This command takes the information kept by Executive Services on the
specified application and telemeters it to the ground.
\cfecmdmnemonic \ES_QUERYAPP
@@ -1137,25 +1137,25 @@
#CFE_ES_AppNameCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_ONE_APP_EID debug event message will be
+ - The #CFE_ES_ONE_APP_EID debug event message will be
generated. NOTE: This event message only identifies that the
act of stopping the application has begun, not that is has completed.
- Receipt of the #CFE_ES_APP_TLM_t telemetry packet
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The specified application name is not recognized as an active application
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
@@ -1176,7 +1176,7 @@
\cfeescmd Writes all Executive Services Information on All Applications to a File
\par Description
-
+
This command takes the information kept by Executive Services on all of the
registered applications and writes it to the specified file.
\cfecmdmnemonic \ES_WRITEAPPINFO2FILE
@@ -1185,33 +1185,33 @@
#CFE_ES_QueryAllCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_ALL_APPS_EID debug event message will be
+ - The #CFE_ES_ALL_APPS_EID debug event message will be
generated.
- The file specified in the command (or the default specified
- by the #CFE_ES_DEFAULT_APP_LOG_FILE configuration parameter) will be
+ by the #CFE_ES_DEFAULT_APP_LOG_FILE configuration parameter) will be
updated with the lastest information.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- An Error occurs while trying to write to the file
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
- This command is not inherently dangerous. It will create a new
- file in the file system (or overwrite an existing one) and could,
- if performed repeatedly without sufficient file management by the
+
+ This command is not inherently dangerous. It will create a new
+ file in the file system (or overwrite an existing one) and could,
+ if performed repeatedly without sufficient file management by the
operator, fill the file system.
\sa #CFE_ES_QUERY_ONE_CC, #CFE_ES_QUERY_ALL_TASKS_CC
@@ -1229,7 +1229,7 @@
\cfeescmd Clear Executive Services System Log
\par Description
-
+
This command clears the contents of the Executive Services System Log.
\cfecmdmnemonic \ES_CLEARSYSLOG
@@ -1237,28 +1237,28 @@
#CFE_ES_NoArgsCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_SYSLOG1_INF_EID informational event message will be
+ - The #CFE_ES_SYSLOG1_INF_EID informational event message will be
generated.
- \b \c \ES_SYSLOGBYTEUSED - System Log Bytes Used will go to zero
- \b \c \ES_SYSLOGENTRIES - Number of System Log Entries will go to zero
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
This command is not dangerous. However, any previously logged data
will be lost.
@@ -1275,7 +1275,7 @@
\cfeescmd Writes contents of Executive Services System Log to a File
\par Description
-
+
This command causes the contents of the Executive Services System Log
to be written to a log file.
\cfecmdmnemonic \ES_WRITESYSLOG2FILE
@@ -1284,33 +1284,33 @@
#CFE_ES_WriteSyslogCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_SYSLOG2_EID debug event message will be
+ - The #CFE_ES_SYSLOG2_EID debug event message will be
generated.
- The file specified in the command (or the default specified
- by the #CFE_ES_DEFAULT_SYSLOG_FILE configuration parameter) will be
+ by the #CFE_ES_DEFAULT_SYSLOG_FILE configuration parameter) will be
updated with the lastest information.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- An Error occurs while trying to write to the file
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
- This command is not inherently dangerous. It will create a new
- file in the file system (or overwrite an existing one) and could,
- if performed repeatedly without sufficient file management by the
+
+ This command is not inherently dangerous. It will create a new
+ file in the file system (or overwrite an existing one) and could,
+ if performed repeatedly without sufficient file management by the
operator, fill the file system.
\sa #CFE_ES_CLEAR_SYSLOG_CC, #CFE_ES_CLEAR_ERLOG_CC, #CFE_ES_WRITE_ERLOG_CC,
@@ -1329,7 +1329,7 @@
\cfeescmd Clears the contents of the Exeception and Reset Log
\par Description
-
+
This command causes the contents of the Executive Services Exception
and Reset Log to be cleared.
\cfecmdmnemonic \ES_CLEARERLOG
@@ -1338,27 +1338,27 @@
#CFE_ES_NoArgsCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_ERLOG1_INF_EID informational event message will be
+ - The #CFE_ES_ERLOG1_INF_EID informational event message will be
generated.
- \b \c \ES_ERLOGINDEX - Index into Exception Reset Log goes to zero
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
This command is not dangerous. However, any previously logged data
will be lost.
@@ -1374,7 +1374,7 @@
\cfeescmd Writes Exeception and Reset Log to a File
\par Description
-
+
This command causes the contents of the Executive Services Exception
and Reset Log to be written to the specified file.
\cfecmdmnemonic \ES_WRITEERLOG2FILE
@@ -1383,33 +1383,33 @@
#CFE_ES_WriteERlogCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_ERLOG2_EID debug event message will be
+ - The #CFE_ES_ERLOG2_EID debug event message will be
generated.
- The file specified in the command (or the default specified
- by the #CFE_ES_DEFAULT_ER_LOG_FILE configuration parameter) will be
+ by the #CFE_ES_DEFAULT_ER_LOG_FILE configuration parameter) will be
updated with the lastest information.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- An Error occurs while trying to write to the file
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
- This command is not inherently dangerous. It will create a new
- file in the file system (or overwrite an existing one) and could,
- if performed repeatedly without sufficient file management by the
+
+ This command is not inherently dangerous. It will create a new
+ file in the file system (or overwrite an existing one) and could,
+ if performed repeatedly without sufficient file management by the
operator, fill the file system.
\sa #CFE_ES_CLEAR_SYSLOG_CC, #CFE_ES_WRITE_SYSLOG_CC, #CFE_ES_CLEAR_ERLOG_CC
@@ -1427,7 +1427,7 @@
\cfeescmd Start Performance Analyzer
\par Description
-
+
This command causes the Performance Analyzer to begin collecting data using the specified trigger mode.
\cfecmdmnemonic \ES_STARTLADATA
@@ -1435,37 +1435,37 @@
#CFE_ES_PerfStartCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- \b \c \ES_PERFSTATE - Current performance analyzer state will change to
either WAITING FOR TRIGGER or, if conditions are appropriate fast enough,
TRIGGERED.
- - \b \c \ES_PERFMODE - Performance Analyzer Mode will change to the commanded trigger mode (TRIGGER START,
+ - \b \c \ES_PERFMODE - Performance Analyzer Mode will change to the commanded trigger mode (TRIGGER START,
TRIGGER CENTER, or TRIGGER END).
- \b \c \ES_PERFTRIGCNT - Performance Trigger Count will go to zero
- \b \c \ES_PERFDATASTART - Data Start Index will go to zero
- \b \c \ES_PERFDATAEND - Data End Index will go to zero
- \b \c \ES_PERFDATACNT - Performance Data Counter will go to zero
- - The #CFE_ES_PERF_STARTCMD_EID debug event message will be
+ - The #CFE_ES_PERF_STARTCMD_EID debug event message will be
generated.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- A previous #CFE_ES_PERF_STOPDATA_CC command has not completely finished.
- An invalid trigger mode is requested.
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
This command is not inherently dangerous but may cause a small increase in CPU
utilization as the performance analyzer data is collected.
@@ -1484,7 +1484,7 @@
\cfeescmd Stop Performance Analyzer
\par Description
-
+
This command stops the Performance Analyzer from collecting any more data.
\cfecmdmnemonic \ES_STOPLADATA
@@ -1492,34 +1492,34 @@
#CFE_ES_PerfStopCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- \b \c \ES_PERFSTATE - Current performance analyzer state will change to
- IDLE.
- - The #CFE_ES_PERF_STOPCMD_EID debug event message will be
+ IDLE.
+ - The #CFE_ES_PERF_STOPCMD_EID debug event message will be
generated.
- The file specified in the command (or the default specified
- by the #CFE_ES_DEFAULT_PERF_DUMP_FILENAME configuration parameter) will be
+ by the #CFE_ES_DEFAULT_PERF_DUMP_FILENAME configuration parameter) will be
updated with the lastest information.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- A previous Stop Performance Analyzer command is still in process
- An error occurred while spawning the child task responsible for
dumping the Performance Analyzer data to a file
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
This command is not inherently dangerous. An additional low priority child
task will be spawned, however, to dump the performance analyzer data to a file.
@@ -1538,7 +1538,7 @@
\cfeescmd Set Performance Analyzer's Filter Masks
\par Description
-
+
This command sets the Performance Analyzer's Filter Masks.
\cfecmdmnemonic \ES_LAFILTERMASK
@@ -1546,29 +1546,29 @@
#CFE_ES_SetPerfFilterMaskCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- \B \C \ES_PERFFLTRMASK - the current performance filter mask
value(s) should reflect the commanded value
- - The #CFE_ES_PERF_FILTMSKCMD_EID debug event message will be
+ - The #CFE_ES_PERF_FILTMSKCMD_EID debug event message will be
generated.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The Filter Mask ID number is out of range
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
Changing the filter masks may cause a small change in the Performance
Analyzer's CPU utilization.
@@ -1594,29 +1594,29 @@
#CFE_ES_PerfSetTrigMaskCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- \b \c \ES_PERFTRIGMASK - the current performance trigger mask
value(s) should reflect the commanded value
- - The #CFE_ES_PERF_TRIGMSKCMD_EID debug event message will be
+ - The #CFE_ES_PERF_TRIGMSKCMD_EID debug event message will be
generated.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The Trigger Mask ID number is out of range
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
Changing the trigger masks may cause a small change in the Performance
Analyzer's CPU utilization.
@@ -1635,7 +1635,7 @@
\cfeescmd Set Executive Services System Log Mode to Discard/Overwrite
\par Description
-
+
This command allows the user to configure the Executive Services
to either discard new System Log messages when it is full or to
overwrite the oldest messages.
@@ -1645,29 +1645,29 @@
#CFE_ES_OverWriteSysLogCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- \b \c \ES_SYSLOGMODE - Current System Log Mode should reflect
the commanded value
- - The #CFE_ES_SYSLOGMODE_EID debug event message will be
+ - The #CFE_ES_SYSLOGMODE_EID debug event message will be
generated.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The desired mode is neither #CFE_ES_LogMode_OVERWRITE or #CFE_ES_LogMode_DISCARD
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
None. (It should be noted that "Overwrite" mode would allow a message
identifying the cause of a problem to be lost by a subsequent flood of
additional messages).
@@ -1687,9 +1687,9 @@
\cfeescmd Resets the Processor Reset Counter to Zero
\par Description
-
+
This command allows the user to reset the Processor Reset Counter to zero.
- The Processor Reset Counter counts the number of Processor Resets that
+ The Processor Reset Counter counts the number of Processor Resets that
have occurred so as to identify when a Processor Reset should automatically
be upgraded to a full Power-On Reset.
\cfecmdmnemonic \ES_RESETPRCNT
@@ -1698,27 +1698,27 @@
#CFE_ES_NoArgsCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- \b \c \ES_PROCRESETCNT - Current number of processor resets will go to zero
- - The #CFE_ES_RESET_PR_COUNT_EID informational event message will be
+ - The #CFE_ES_RESET_PR_COUNT_EID informational event message will be
generated.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
This command is not critical. The only impact would be that the system
would have to have more processor resets before an automatic power-on reset
occurred.
@@ -1735,7 +1735,7 @@
\cfeescmd Configure the Maximum Number of Processor Resets before a Power-On Reset
\par Description
-
+
This command allows the user to specify the number of Processor Resets that
are allowed before the next Processor Reset is upgraded to a Power-On Reset.
\cfecmdmnemonic \ES_SETMAXPRCNT
@@ -1744,28 +1744,28 @@
#CFE_ES_SetMaxPRCountCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - \b \c \ES_MAXPROCRESETS - Current maximum number of processor resets
+ - \b \c \ES_MAXPROCRESETS - Current maximum number of processor resets
before an automatic power-on reset will go to the command specified value.
- - The #CFE_ES_SET_MAX_PR_COUNT_EID informational event message will be
+ - The #CFE_ES_SET_MAX_PR_COUNT_EID informational event message will be
generated.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
If the operator were to set the Maximum Processor Reset Count to too high a value,
the processor would require an inordinate number of consecutive processor resets
before an automatic power-on reset would occur. This could potentially leave the
@@ -1787,7 +1787,7 @@
\cfeescmd Delete Critical Data Store
\par Description
-
+
This command allows the user to delete a Critical Data Store that was created
by an Application that is now no longer executing.
\cfecmdmnemonic \ES_DELETECDS
@@ -1796,32 +1796,32 @@
#CFE_ES_DeleteCDSCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_CDS_DELETED_INFO_EID informational event message will be
+ - The #CFE_ES_CDS_DELETED_INFO_EID informational event message will be
generated.
- The specified CDS should no longer appear in a CDS Registry dump generated
upon receipt of the #CFE_ES_DUMP_CDS_REG_CC command
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The specified CDS is the CDS portion of a Critical Table. See #CFE_TBL_DELETE_CDS_CC.
- The specified CDS is not found in the CDS Registry
- The specified CDS is associated with an Application that is still active
- An error occurred while accessing the CDS memory (see the System Log for more details)
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
This command is not critical because it is not possible to delete a CDS that is
associated with an active application. However, deleting a CDS does eliminate
any "history" that an application may be wishing to keep.
@@ -1841,7 +1841,7 @@
\cfeescmd Telemeter Memory Pool Statistics
\par Description
-
+
This command allows the user to obtain a snapshot of the statistics maintained
for a specified memory pool.
\cfecmdmnemonic \ES_SendMemPoolStats
@@ -1850,31 +1850,31 @@
#CFE_ES_SendMemPoolStatsCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_TLM_POOL_STATS_INFO_EID debug event message will be
+ - The #CFE_ES_TLM_POOL_STATS_INFO_EID debug event message will be
generated.
- The \link #CFE_ES_MEMSTATS_TLM_t Memory Pool Statistics Telemetry Packet \endlink
is produced
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- The specified handle is not associated with a known memory pool
- The specified handle caused a processor exception because it improperly
identified a segment of memory
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
+
An incorrect Memory Pool Handle value can cause a system crash.
Extreme care should be taken to ensure the memory handle value
used in the command is correct.
@@ -1892,7 +1892,7 @@
\cfeescmd Dump Critical Data Store Registry to a File
\par Description
-
+
This command allows the user to dump the Critical Data Store
Registry to an onboard file.
\cfecmdmnemonic \ES_DumpCDSRegistry
@@ -1901,32 +1901,32 @@
#CFE_ES_DumpCDSRegistryCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_CDS_REG_DUMP_INF_EID debug event message will be
+ - The #CFE_ES_CDS_REG_DUMP_INF_EID debug event message will be
generated.
- The file specified in the command (or the default specified
- by the #CFE_ES_DEFAULT_CDS_REG_DUMP_FILE configuration parameter) will be
+ by the #CFE_ES_DEFAULT_CDS_REG_DUMP_FILE configuration parameter) will be
updated with the lastest information.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- Error occurred while trying to create the dump file
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
- This command is not inherently dangerous. It will create a new
- file in the file system (or overwrite an existing one) and could,
- if performed repeatedly without sufficient file management by the
+
+ This command is not inherently dangerous. It will create a new
+ file in the file system (or overwrite an existing one) and could,
+ if performed repeatedly without sufficient file management by the
operator, fill the file system.
\sa #CFE_ES_DELETE_CDS_CC, #CFE_TBL_DELETE_CDS_CC
@@ -1944,7 +1944,7 @@
\cfeescmd Writes a list of All Executive Services Tasks to a File
\par Description
-
+
This command takes the information kept by Executive Services on all of the
registered tasks and writes it to the specified file.
\cfecmdmnemonic \ES_WRITETASKINFO2FILE
@@ -1953,33 +1953,33 @@
#CFE_ES_QueryAllTasksCmd_t
\par Command Verification
-
+
Successful execution of this command may be verified with
the following telemetry:
- - \b \c \ES_CMDPC - command execution counter will
+ - \b \c \ES_CMDPC - command execution counter will
increment
- - The #CFE_ES_TASKINFO_EID debug event message will be
+ - The #CFE_ES_TASKINFO_EID debug event message will be
generated.
- The file specified in the command (or the default specified
- by the #CFE_ES_DEFAULT_TASK_LOG_FILE configuration parameter) will be
+ by the #CFE_ES_DEFAULT_TASK_LOG_FILE configuration parameter) will be
updated with the lastest information.
\par Error Conditions
-
+
This command may fail for the following reason(s):
- The command packet length is incorrect
- An Error occurs while trying to write to the file
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- - A command specific error event message is issued for all error
+ - A command specific error event message is issued for all error
cases
\par Criticality
-
- This command is not inherently dangerous. It will create a new
- file in the file system (or overwrite an existing one) and could,
- if performed repeatedly without sufficient file management by the
+
+ This command is not inherently dangerous. It will create a new
+ file in the file system (or overwrite an existing one) and could,
+ if performed repeatedly without sufficient file management by the
operator, fill the file system.
\sa #CFE_ES_QUERY_ALL_CC, CFE_ES_QUERY_ONE_CC
@@ -1991,9 +1991,9 @@
-
+
-
+
@@ -2039,7 +2039,7 @@
-
+
@@ -2050,6 +2050,6 @@
-
+
diff --git a/modules/evs/eds/cfe_evs.xml b/modules/evs/eds/cfe_evs.xml
index da8d92a6f..1ebc1f262 100644
--- a/modules/evs/eds/cfe_evs.xml
+++ b/modules/evs/eds/cfe_evs.xml
@@ -19,18 +19,18 @@
See the License for the specific language governing permissions and
limitations under the License.
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes all interface objects for the Event Services (CFE_EVS)
- core application
-
+ core application
+
-->
-
+
@@ -38,7 +38,7 @@
-
+
@@ -46,7 +46,7 @@
-
+
@@ -56,7 +56,7 @@
-
+
@@ -73,7 +73,7 @@
-
+
@@ -1275,7 +1275,7 @@
-
+
@@ -1320,7 +1320,7 @@
-
+
diff --git a/modules/sb/eds/cfe_sb.xml b/modules/sb/eds/cfe_sb.xml
index d9f122e02..57f1a939d 100644
--- a/modules/sb/eds/cfe_sb.xml
+++ b/modules/sb/eds/cfe_sb.xml
@@ -19,13 +19,13 @@
See the License for the specific language governing permissions and
limitations under the License.
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes all interface objects for the Software Bus (CFE_SB)
- core application
-
+ core application
+
-->
@@ -206,7 +206,7 @@
-
+
@@ -380,9 +380,9 @@
-
@@ -873,9 +873,9 @@
-
+
-
+
Basic message routing service over the CFE software bus. Messages are routed based on the Application ID field
@@ -891,10 +891,10 @@
-
+
- This represents the access interface used for passing message datagrams
+ This represents the access interface used for passing message datagrams
to and from the message transfer service (MTS). It operates using publish/subscribe
semantics, where messages are sent and received using an abstract idenifier referred
to as a software bus message ID. This essentially acts as a filter on the underlying
@@ -913,20 +913,20 @@
-
-
+
+
Higher level interface to publish a message via the CFE software bus. cFS applications may define their
- own application-specific interface of this type to indicate the message(s) it will publish via
+ own application-specific interface of this type to indicate the message(s) it will publish via
the software bus. This is typically the various types of telemetry that the application generates.
@@ -948,13 +948,13 @@
-
+
Interface to listen for a message from the CFE software bus. cFS application data sheets may derive their
- own application-specific interface from this base to indicate the type of message(s) it will subscribe to
- via the software bus. This is typically the various telecommand messages that the application supports.
-
+ own application-specific interface from this base to indicate the type of message(s) it will subscribe to
+ via the software bus. This is typically the various telecommand messages that the application supports.
+
This is a receive-only interface; the Telemetry interface provides the equivalent send function.
@@ -977,14 +977,14 @@
-
+
-
+
@@ -993,7 +993,7 @@
-
+
@@ -1002,7 +1002,7 @@
-
+
@@ -1011,7 +1011,7 @@
-
+
@@ -1072,6 +1072,6 @@
-
+
diff --git a/modules/tbl/eds/cfe_tbl.xml b/modules/tbl/eds/cfe_tbl.xml
index 0791b5b09..df2670c18 100644
--- a/modules/tbl/eds/cfe_tbl.xml
+++ b/modules/tbl/eds/cfe_tbl.xml
@@ -18,19 +18,19 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes all interface objects for the Table Services (CFE_TBL)
- core application
-
+ core application
+
-->
-
+
@@ -38,7 +38,7 @@
-
+
@@ -79,7 +79,7 @@
#CFE_TBL_BufferSelect_INACTIVE=Inactive Table,
#CFE_TBL_BufferSelect_ACTIVE=Active Table
-
+
Selects either the "Inactive" (#CFE_TBL_BufferSelect_INACTIVE) buffer or the
"Active" (#CFE_TBL_BufferSelect_ACTIVE) buffer to be dumped
@@ -355,13 +355,13 @@
+ sent to OTHER apps. It is not one of the commands that TBL receives -->
-
+
@@ -479,7 +479,7 @@
- The table image file was unable to be opened. Either the file does
not exist at the specified location, the filename is in error, or
the file system has been corrupted.
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \TBL_CMDEC - command error counter will increment
- Command specific error event messages are issued for all error cases
@@ -569,7 +569,7 @@
- \b \c \TBL_LASTVALCRC - calculated data integrity value will be updated
- The #CFE_TBL_VAL_REQ_MADE_INF_EID debug event message (indicating the
application is being notified of a validation request)
-
+
If the specified table has an associated validation function, then the
following telemetry will also change:
- Either \b \c \TBL_VALSUCCESSCTR OR \b \c \TBL_VALFAILEDCTR will increment
@@ -677,7 +677,7 @@
- Error occurred during write operation to file. Possible
causes might be insufficient space in the file system
or the filename or file path is improperly specified.
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \TBL_CMDEC - command error counter will increment
- An Error specific event message
@@ -831,7 +831,7 @@
-
+
@@ -876,6 +876,6 @@
-
+
diff --git a/modules/time/eds/cfe_time.xml b/modules/time/eds/cfe_time.xml
index bc3c03019..c146b6bd7 100644
--- a/modules/time/eds/cfe_time.xml
+++ b/modules/time/eds/cfe_time.xml
@@ -19,13 +19,13 @@
See the License for the specific language governing permissions and
limitations under the License.
- This document adheres to the Electronic Data Sheet (EDS) XML schema
- as prescribed in CCSDS book 876.0.
-
- Purpose:
+ This document adheres to the Electronic Data Sheet (EDS) XML schema
+ as prescribed in CCSDS book 876.0.
+
+ Purpose:
This describes all interface objects for the Time Services (CFE_TIME)
- core application
-
+ core application
+
-->
@@ -64,24 +64,24 @@
- The spacecraft time has not been set since the last clock
+ The spacecraft time has not been set since the last clock
reset. Times returned by clock routines have no relationship
to any ground-based time reference.
-
+
- The spacecraft time has been set at least once since the last
- clock reset, and it is synchronized with the primary on-board
+ The spacecraft time has been set at least once since the last
+ clock reset, and it is synchronized with the primary on-board
time base. Times returned by clock routines can be trusted.
-
+
- The spacecraft time has been set at least once since the last
- clock reset, but it is not currently synchronized with the
- primary on-board time base. Times returned by clock routines
- are a "best guess" based on a non-optimal oscillator.
+ The spacecraft time has been set at least once since the last
+ clock reset, but it is not currently synchronized with the
+ primary on-board time base. Times returned by clock routines
+ are a "best guess" based on a non-optimal oscillator.
@@ -94,7 +94,7 @@
-
+
@@ -102,7 +102,7 @@
-
+
@@ -110,7 +110,7 @@
-
+
@@ -118,7 +118,7 @@
-
+
@@ -126,7 +126,7 @@
-
+
\par Description
@@ -589,7 +589,7 @@
via configuration parameters, this command provides a common method
for switching between the local processor clock and an external
source for time data.
-
+
When commanded to accept external time data (GPS, MET, spacecraft
time, etc.), the Time Server will enable input via an API function
specific to the configuration definitions for the particular source.
@@ -597,7 +597,7 @@
the external data. However, the Time Server will continue to use the
API function as the trigger to generate a "time at the tone" command
packet regardless of the internal/external command selection.
-
+
Notes:
- Operating in FLYWHEEL mode is not considered a choice related
to clock source, but rather an element of the clock state. See below
@@ -621,7 +621,7 @@
- Invalid Source selection
(a value other than #CFE_TIME_SourceSelect_INTERNAL or #CFE_TIME_SourceSelect_EXTERNAL was specified)
- Time source selection not allowed on this platform
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - Command Error counter will increment
- Error specific event message (either #CFE_TIME_SOURCE_CFG_EID or #CFE_TIME_SOURCE_ERR_EID)
@@ -648,18 +648,18 @@
of clock state. Clock state is a combination of factors, most significantly
whether the spacecraft time has been accurately set, and whether Time Service
is operating in FLYWHEEL mode.
-
+
This command may be used to notify the Time Server that spacecraft time is
now correct, or that time is no longer correct. This information will be
distributed to Time Clients, and in turn, to any interested sub-systems.
-
+
Also, this command may be used to force a Time Server or Time Client into
FLYWHEEL mode. Use of FLYWHEEL mode is mainly for debug purposes although
in extreme circumstances, it may be of value to force Time Service not to rely
on normal time updates. Note that when commanded into FLYWHEEL mode, the Time
Service will remain so until receipt of another "set state" command setting the
state into a mode other than FLYWHEEL.
-
+
Note also that setting the clock state to VALID or INVALID on a Time Client that
is currently getting time updates from the Time Server will have very limited
effect. As soon as the Time Client receives the next time update, the VALID/INVALID
@@ -683,7 +683,7 @@
- Invalid State selection
(a value other than #CFE_TIME_ClockState_INVALID, #CFE_TIME_ClockState_VALID or #CFE_TIME_ClockState_FLYWHEEL was specified)
- Time source selection not allowed on this platform
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - Command Error counter will increment
- Error specific event message (#CFE_TIME_STATE_ERR_EID)
@@ -733,7 +733,7 @@
\par Error Conditions
- An invalid number of microseconds was specified (must be less than 1 million)
- Platorm receiving the command is not a Time Client
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event messages will be issued (#CFE_TIME_DELAY_CFG_EID or #CFE_TIME_DELAY_ERR_EID)
@@ -762,7 +762,7 @@
calculation for Time Clients, so this command has no meaning for Time Servers. Each Time
Client can have a unique latency setting. The latency value is a positive number of seconds
and microseconds that represent the deviation from the time maintained by the Time Server.
-
+
Note that it is unimaginable that the seconds value will ever be anything but zero.
\cfecmdmnemonic \TIME_SUBCLOCKLAT
@@ -780,7 +780,7 @@
\par Error Conditions
- An invalid number of microseconds was specified (must be less than 1 million)
- Platorm receiving the command is not a Time Client
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event messages will be issued (#CFE_TIME_DELAY_CFG_EID or #CFE_TIME_DELAY_ERR_EID)
@@ -811,11 +811,11 @@
this command. Time Service will calculate a new STCF value
based on the current MET and the desired new time using one
of the following:
-
+
If Time Service is configured to compute current time as TAI
- STCF = (new time) - (current MET)
- (current time) = (current MET) + STCF
-
+
If Time Service is configured to compute current time as UTC
- STCF = ((new time) - (current MET)) + (Leap Seconds)
- (current time) = ((curent MET) + STCF) - (Leap Seconds)
@@ -835,7 +835,7 @@
\par Error Conditions
- An invalid number of microseconds was specified (must be less than 1 million)
- Platorm receiving the command is not a Time Server
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event messages will be issued (#CFE_TIME_TIME_CFG_EID or #CFE_TIME_TIME_ERR_EID)
@@ -860,15 +860,15 @@
\par Description
This command sets the Mission Elapsed Timer (MET) to the specified value.
-
+
Note that the MET (as implemented for cFE Time Service) is a logical representation
and not a physical timer. Thus, setting the MET is not dependent on whether the
hardware supports a MET register that can be written to.
-
+
Note also that Time Service "assumes" that during normal operation, the MET is
synchronized to the tone signal. Therefore, unless operating in FLYWHEEL mode,
the sub-seconds portion of the MET will be set to zero at the next tone signal interrupt.
-
+
The new MET takes effect immediately upon execution of this command.
\cfecmdmnemonic \TIME_SETCLOCKMET
@@ -886,7 +886,7 @@
\par Error Conditions
- An invalid number of microseconds was specified (must be less than 1 million)
- Platorm receiving the command is not a Time Server
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event messages will be issued (#CFE_TIME_MET_CFG_EID or #CFE_TIME_MET_ERR_EID)
@@ -931,7 +931,7 @@
\par Error Conditions
- An invalid number of microseconds was specified (must be less than 1 million)
- Platorm receiving the command is not a Time Server
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event messages will be issued (#CFE_TIME_STCF_CFG_EID or #CFE_TIME_STCF_ERR_EID)
@@ -974,7 +974,7 @@
\par Error Conditions
- Platorm receiving the command is not a Time Server
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event messages will be issued (#CFE_TIME_LEAPS_CFG_EID)
@@ -1017,7 +1017,7 @@
\par Error Conditions
- An invalid number of microseconds was specified (must be less than 1 million)
- Platorm receiving the command is not a Time Server
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event messages will be issued (#CFE_TIME_DELTA_ERR_EID or #CFE_TIME_DELTA_CFG_EID)
@@ -1059,7 +1059,7 @@
\par Error Conditions
- An invalid number of microseconds was specified (must be less than 1 million)
- Platorm receiving the command is not a Time Server
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event messages will be issued (#CFE_TIME_DELTA_ERR_EID or #CFE_TIME_DELTA_CFG_EID)
@@ -1087,14 +1087,14 @@
rather than micro-seconds as an input argument. This change occurred
after the determination was made that one micro-second is too large an
increment for a constant 1Hz adjustment.
-
+
This command continuously adjusts the Spacecraft Time Correlation Factor (STCF)
every second, by adding the specified value. The adjustment to the STCF is
applied in the Time Service local 1Hz interrupt handler. As the local 1Hz
interrupt is not synchronized to the tone signal, one cannot say when the
adjustment will occur, other than once a second, at about the same time
relative to the tone.
-
+
There was some debate about whether the maximum 1Hz clock drift correction
factor would ever need to exceed some small fraction of a second. But, the
decision was made to provide the capability to make 1Hz adjustments greater
@@ -1115,7 +1115,7 @@
\par Error Conditions
- Platorm receiving the command is not a Time Server
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event message will be issued (#CFE_TIME_1HZ_CFG_EID)
@@ -1143,14 +1143,14 @@
rather than micro-seconds as an input argument. This change occurred
after the determination was made that one micro-second is too large an
increment for a constant 1Hz adjustment.
-
+
This command continuously adjusts the Spacecraft Time Correlation Factor (STCF)
every second, by subtracting the specified value. The adjustment to the STCF
is applied in the Time Service local 1Hz interrupt handler. As the local 1Hz
interrupt is not synchronized to the tone signal, one cannot say when the
adjustment will occur, other than once a second, at about the same time
relative to the tone.
-
+
There was some debate about whether the maximum 1Hz clock drift correction
factor would ever need to exceed some small fraction of a second. But, the
decision was made to provide the capability to make 1Hz adjustments greater
@@ -1171,7 +1171,7 @@
\par Error Conditions
- Platorm receiving the command is not a Time Server
-
+
Evidence of Failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - command error counter will increment
- Error specific event message will be issued (#CFE_TIME_1HZ_CFG_EID)
@@ -1200,7 +1200,7 @@
choice is the selection of primary or redundant tone signal. The selection
may be available to both the Time Server and Time Clients, depending on
hardware configuration.
-
+
Notes:
- This command is only valid when the #CFE_PLATFORM_TIME_CFG_SIGNAL configuration
parameter in the cfe_platform_cfg.h file has been set to true.
@@ -1223,7 +1223,7 @@
- Invalid Signal selection
(a value other than #CFE_TIME_ToneSignalSelect_PRIMARY or #CFE_TIME_ToneSignalSelect_REDUNDANT was specified)
- Multiple Tone Signal Sources not available on this platform
-
+
Evidence of failure may be found in the following telemetry:
- \b \c \TIME_CMDEC - Command Error counter will increment
- Error specific event message (either #CFE_TIME_SIGNAL_CFG_EID or #CFE_TIME_SIGNAL_ERR_EID)
@@ -1246,21 +1246,21 @@
-
+
-
+
-
+
-
+
@@ -1303,7 +1303,7 @@
-
+
@@ -1335,6 +1335,6 @@
-
+
From f257ae542f1c1cb8f477ca563318cc5c3134c556 Mon Sep 17 00:00:00 2001
From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com>
Date: Mon, 15 Mar 2021 18:26:15 -0400
Subject: [PATCH 6/7] Fix #1130, Clean trailing whitespace: Other
Excludes .md, .pdf, and .doc
---
.travis.yml | 2 +-
cmake/sample_defs/cpu1_cfe_es_startup.scr | 8 +-
docs/Makefile | 3 +-
docs/cFE_FunctionalRequirements.csv | 196 +++++++++++-----------
4 files changed, 104 insertions(+), 105 deletions(-)
diff --git a/.travis.yml b/.travis.yml
index 8b098f179..5ed0addd0 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -26,4 +26,4 @@ script:
cat cppcheck_flight_cfe.txt
exit -1
fi
-
+
diff --git a/cmake/sample_defs/cpu1_cfe_es_startup.scr b/cmake/sample_defs/cpu1_cfe_es_startup.scr
index d0510376a..990942c52 100644
--- a/cmake/sample_defs/cpu1_cfe_es_startup.scr
+++ b/cmake/sample_defs/cpu1_cfe_es_startup.scr
@@ -14,13 +14,13 @@ CFE_APP, sch_lab, SCH_Lab_AppMain, SCH_LAB_APP, 80, 16384, 0x0, 0;
! 7. Load Address -- This is the Optional Load Address for the App or Library. Currently not implemented
! so keep it at 0x0.
! 8. Exception Action -- This is the Action the cFE should take if the App has an exception.
-! 0 = Just restart the Application
+! 0 = Just restart the Application
! Non-Zero = Do a cFE Processor Reset
!
! Other Notes:
! 1. The software will not try to parse anything after the first '!' character it sees. That
! is the End of File marker.
-! 2. Common Application file extensions:
+! 2. Common Application file extensions:
! Linux = .so ( ci.so )
! OS X = .bundle ( ci.bundle )
! Cygwin = .dll ( ci.dll )
@@ -28,6 +28,6 @@ CFE_APP, sch_lab, SCH_Lab_AppMain, SCH_LAB_APP, 80, 16384, 0x0, 0;
! RTEMS with S-record Loader = .s3r ( ci.s3r )
! RTEMS with CEXP Loader = .o ( ci.o )
! 3. The filename field (2) no longer requires a fully-qualified filename; the path and extension
-! may be omitted. If omitted, the standard virtual path (/cf) and a platform-specific default
+! may be omitted. If omitted, the standard virtual path (/cf) and a platform-specific default
! extension will be used, which is derived from the build system.
-
+
diff --git a/docs/Makefile b/docs/Makefile
index 577cdbca0..8d43eb2d5 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -11,10 +11,9 @@ PANDOC_PDF_OPTS := -s -V documentclass=article -V geometry:margin=0.75in --smart
# PANDOC_PDF_OPTS := -s -V documentclass=article -V geometry:margin=0.75in --toc --toc-depth=2
%.pdf: %.md Makefile
- pandoc $(PANDOC_FMT_OPTS) $(PANDOC_PDF_OPTS) $(PANDOC_EXTRA_OPTS) -o $@ $<
+ pandoc $(PANDOC_FMT_OPTS) $(PANDOC_PDF_OPTS) $(PANDOC_EXTRA_OPTS) -o $@ $<
# For version description documents (and possibly others) use -N for numbered sections
$(wildcard cFE*version_description.pdf): PANDOC_EXTRA_OPTS = -N
all: $(MD_FILES:.md=.pdf)
-
diff --git a/docs/cFE_FunctionalRequirements.csv b/docs/cFE_FunctionalRequirements.csv
index 72dce9752..8793bb771 100644
--- a/docs/cFE_FunctionalRequirements.csv
+++ b/docs/cFE_FunctionalRequirements.csv
@@ -22,11 +22,11 @@ ES: Zero Command Counters,cES1004,"Upon receipt of a Command, the cFE shall set
ES: Start Application,cES1005,"Upon receipt of a Command, the cFE shall create the Command specified Application by defining the Application in the System Resources Definition using information from the Command specified file, and beginning execution of the Application.",A basic feature of the cFE is to be able to dynamically (while the cFE is running) start applications. This requirement allows for an application to be created and started from one of the cFE file systems.
ES: Start Application - Command Contents,cES1005.1,"The Command shall include the following parameters:
-- Application Path/Filename
-- Application Entry Point
-- Application Name
-- Application Priority
-- Application Stack Size
+- Application Path/Filename
+- Application Entry Point
+- Application Name
+- Application Priority
+- Application Stack Size
- Exception Action (restart application or perform processor reset)",
ES: Start Application - Location,cES1005.2,The Command specified cFE Application file shall be in any valid cFE file system including the volatile file system and the non-volatile file system.,"The command itself does not care about where the cFE Application comes from, it is specified In the path."
ES: Start Application - Reject Undefined,cES1005.3,"If the Command specified Application is undefined then the cFE shall reject the Command, increment the invalid command counter and generate an event message.",Can't start an undefined application.
@@ -43,32 +43,32 @@ ES: Reload Application - Reject On Missing File,cES1008.2,"If the specified cFE
ES: Reload Application - Delete On Non-Parameter Error,cES1008.3,"If the cFE Application Reload fails due to a non-parameter error, then the cFE shall delete the Application, increment the invalid Command counter, and generate an event message.","If the Application is already stopped and there is an error restarting it, then the cFE application will be deleted. Should the old Application be restarted? Need to be able to reset the cFE in the event that there is a critical problem. As a result of the Power On Reset, all code and data are re-initialized and the cFE is returned to a default power-on state. This reset is initiated through a common interface."
ES: Power On Reset,cES1009,"Upon receipt of a Command, the cFE shall perform a Power On Reset of the Core Flight Executive.","On a flight processor or other embedded processor this command results in rebooting the processor board through the Boot Software. On a desktop system this command will result in the restarting of the cFE, but not the operating system. Note: If the cFE implementation includes more than one cFE core images, it is the responsibility of the Boot Software to select which cFE image is booted."
ES: Processor Reset,cES1010,"Upon receipt of a Command, the cFE shall perform a Processor Reset of the Core Flight Executive.",Need to be able to restart the cFE in the event that there is a problem with the Real Time OS or cFE Core software. Note that restarting the cFE will result in a restart of all of the cFE applications.
-ES: Application Status Message,cES1011,"Upon receipt of a Command, the cFE shall generate a message that contains a summary of the Command specified Application's properties and state as defined in the Systems Resources Definition including:
+ES: Application Status Message,cES1011,"Upon receipt of a Command, the cFE shall generate a message that contains a summary of the Command specified Application's properties and state as defined in the Systems Resources Definition including:
-- cFE Application Name
-- cFE Application Filename
-- cFE Application Entry Point
-- cFE Application Priority
-- cFE Application Stack Size
-- cFE Application Memory Start Address
-- cFE Application Memory Size
+- cFE Application Name
+- cFE Application Filename
+- cFE Application Entry Point
+- cFE Application Priority
+- cFE Application Stack Size
+- cFE Application Memory Start Address
+- cFE Application Memory Size
- cFE Application Child Task Count","In order to support remote Application management then the Application's properties and current state need to be externally observable. Because the ground interface is with Applications rather than Tasks, Task information should be included as well."
ES: Application Status Record To File,cES1012,"Upon receipt of a Command, the cFE shall generate a Command specified file that contains all properties and states of all cFE Applications that are defined in the Systems Resources Definition.",May want information about all applications and tasks defined in the Systems Resources Definition in order to diagnose a problem.
ES: Application Status Record To File - Default Filename,cES1012.1,"If a file is not specified, the cFE shall use the `` filename.",Want to specify a default if the user does not want to specify a new filename.
ES: System Log,cES1014,The cFE shall maintain an Executive Services System Log which contains a series of ASCII text strings describing significant events or errors.,"Examples of ES System Log information includes: ""Created new cFE Application: StoredCommand.app"" or ""Could Not Create OS Queue"" or ""File not found error: /eebank1/StoredCommand.app"" This requirement states that the cFE needs to maintain this information. There is a separate requirement for the creation of a file to transfer the information to the ground. Note that the information can also be obtained with a raw memory read."
ES: System Log - Timestamps,cES1014.1,Each entry in the Executive Services System Log shall be time tagged with the time that the event happened.,Need to be able to determine when the event occurred.
-ES: System Log - Calculate Usage,cES1014.2,"The cFE shall calculate the number of bytes used and number of entries in
+ES: System Log - Calculate Usage,cES1014.2,"The cFE shall calculate the number of bytes used and number of entries in
Executive Services System Log.","Ground operations need indication of how full the System Log is so that they can clear it, if necessary, in order to make room for new entries (or at least write it to a file to preserve it)."
ES: System Log - Overwrite On Full,cES1014.2.1,If the Executive Services System Log is full and the System Log Mode is set to OVERWRITE then the cFE shall write all new entries from the top of the log.,Want to provide the capability to continuously record all new System Messages.
ES: System Log - Discard On Full,cES1014.2.2,If the Executive Services Syste Log is full and the System Log Mode is set to DISCARD then the cFE shall discard all new entries.,Want to provide capability to stop writing to the System Log in order to preserve to Log which may contain important anomalous messages.
ES: System Log - Clear On Command,cES1015,"Upon receipt of a Command, the cFE shall clear the Executive Services System Log.",Want to be able to clear the Executive Services System Log Buffer so that only the new information is saved.
ES: System Log - Write To File,cES1016,"Upon receipt of a Command, the cFE shall copy the information contained in the Executive Services System Log into a Command specified file.",We did not want to count on a file system for storing the ES System errors in the event that there was a problem with the file system or the file system was not mounted yet. We did want to provide an easy ground interface for getting the data to the ground
ES: System Log - Default Filename,cES1016.1,"If a file is not specified, the cFE shall use the `` filename.",Want to provide a default in the event a user does not want to have to specify one.
-ES: Exception and Reset Log,cES1017,"The cFE shall maintain an Executive Services Exception and Reset Log which will log critical system data for exceptions and resets including:
+ES: Exception and Reset Log,cES1017,"The cFE shall maintain an Executive Services Exception and Reset Log which will log critical system data for exceptions and resets including:
-- A time stamp
-- Processor Context information
-- Critical system variables
+- A time stamp
+- Processor Context information
+- Critical system variables
- ASCII string stating the reason for the reset","Want to be able to save state information prior to a restart (processor, power-on, application, task etc) to help with diagnosing problems. There is a separate requirement for the creation of a file to transfer the information to the ground."
ES: Exception and Reset Log - Clear On Command,cES1018,"Upon receipt of a Command, the cFE shall clear the Executive Services Exception and Reset Log.",Want to be able to clear the Executive Services Exception and Reset Log so that only the new information is saved.
ES: Exception and Reset Log - Write To File,cES1019,"Upon receipt of a Command, the cFE shall copy the information contained in the Executive Services Exception and Reset Log Buffer into a Command specified file.","The cFE Exception and Reset Log contains a large amount of data, and is variable in size. It is easier to dump the contents to a file."
@@ -183,16 +183,16 @@ ES: Processor Reset Process Non-Volatile Startup File,cES1519,If the system star
ES: Processor Reset Process Non-Volatile Startup File - Start Apps,cES1519.1,The cFE shall create and start cFE Applications according to the entry in the cFE Startup File.,The cFE supports loading and creating new cFE Applications during system startup.
ES: Processor Reset Process Non-Volatile Startup File - Init Libs,cES1519.2,The cFE shall create and initialize Shared Libraries according to the entry in the cFE Startup File.,The cFE supports loading and initializing cFE Shared Libraries during system startup.
ES: Processor Reset Exception and Reset Log Entry,cES1520,"Upon a Processor Reset, the cFE shall make an entry in the Executive Services Exception and Reset Log recording the Processor Reset.",The purpose of the Executive Services Exception and Reset Log is to log all resets and all exceptions that occur.
-ES: Processor Reset Preservation List,cES1521,"Upon a Processor Reset, the cFE shall preserve the following:
+ES: Processor Reset Preservation List,cES1521,"Upon a Processor Reset, the cFE shall preserve the following:
-- Boot Source
-- Reset Type
-- Reset Subtype
-- Reset Reason
-- Number of Processor Resets
-- Maximum Processor Resets
-- Number of entries in System Log
-- Size of System Log
+- Boot Source
+- Reset Type
+- Reset Subtype
+- Reset Reason
+- Number of Processor Resets
+- Maximum Processor Resets
+- Number of entries in System Log
+- Size of System Log
- Number of bytes used in the System Log",The purpose of the Executive Services Exception and Reset Log is to log all resets and all exceptions that occur.
ES: Processor Reset Set System Log Mode,cES1522,"Upon a Processor Reset, the cFE shall set the System Log Mode to `` default mode.","Typically want to preserve the System Events that may have captured the cause of the processor reset, but system can be configured as desired."
ES: Power On Reset Set System Log Mode,cES1523,"Upon a Power-On Reset, the cFE shall set the System Log Mode to `` default mode.","Typically want to overwrite the System Events during normal operations to store the most recent events, but system can be configured as desired."
@@ -207,18 +207,18 @@ EVS: Set Event Format Mode,cEVS3001,"Upon receipt of Command, the cFE shall set
EVS: NOOP Event,cEVS3002,Upon receipt of Command the cFE shall generate a NO-OP event message.,This command is useful as a general sub-system aliveness test.
EVS: Zero Counters,cEVS3003,"Upon receipt of Command the cFE shall set the following counters to zero in Event Services telemetry:
-- Valid Command Counter
-- Invalid Command Counter
-- Event Message Sent Counter
-- Event Message Truncation Counter
+- Valid Command Counter
+- Invalid Command Counter
+- Event Message Sent Counter
+- Event Message Truncation Counter
- Unregistered Application Send Counter",This command is a common feature in heritage sub-system software design.
-EVS: Write Application Data File,cEVS3004,"Upon receipt of Command, the cFE shall write the following information to the Command specified cFE EVS Application Data file for each registered Application:
+EVS: Write Application Data File,cEVS3004,"Upon receipt of Command, the cFE shall write the following information to the Command specified cFE EVS Application Data file for each registered Application:
-- Application Event Message Sent Counter
-- Application Event Service Enable Status
-- Application Event Type Enable Statuses (one for each Event Type)
-- Application Event IDs (for events to be filtered)
-- Application Binary Filter Masks (one per registered Event ID)
+- Application Event Message Sent Counter
+- Application Event Service Enable Status
+- Application Event Type Enable Statuses (one for each Event Type)
+- Application Event IDs (for events to be filtered)
+- Application Binary Filter Masks (one per registered Event ID)
- Application Binary Filter Counters (one per registered Event ID)","Visibility of Application information is essential for FSW diagnostics, testing and maintenance."
EVS: Write Application Data File - Default Filename,cEVS3004.1,"If a file is not specified, the cFE shall use the `` filename.",Want to provide a default in the event that a user does not want to specify.
EVS: Valid Command Counter,cEVS3005,"Upon receipt of valid command, the cFE shall increment the valid command counter.",The ground needs the capability to verify that the command was received and accepted by the cFE. Details of valid commands are documented in the cFE User's Guide.
@@ -235,20 +235,20 @@ EVS: Write Local Event Log To File,cEVS3015,"_(OPTIONAL)_ Upon receipt of Comman
EVS: Write Local Event Log To File - Default Filename,cEVS3015.1,"If a file is not specified, the cFE shall use the `` filename.",Want to provide a default in the event that a user does not want to specify one.
EVS: Write Local Event Log Order,cEVS3016,_(OPTIONAL)_ The cFE shall write each Event Message from the earliest logged message to the most recently logged message.,"Ground operators like to see the progression of events in the order that they occurred. In a scenario when a time correction has been made, the earliest logged may not necessarily mean the oldest time stamp. This type of playback may not be desirable for Event Logs of considerable size. It is worthwhile for cFE users to keep Event Logs relatively small."
EVS: Control Message Port Routing,cEVS3017,"Upon receipt of Command the cFE shall enable/disable, as specified in the Command, the routing of all future Event Messages to the Command specified Event Message Port.","Event Message Output Ports may not be available or needed; therefore the ability to configure sending to an Event Message Port is useful."
-EVS: Housekeeping Message,cEVS3018,"Upon receipt of a Message, the cFE shall generate a housekeeping message that includes the following Event Services items:
+EVS: Housekeeping Message,cEVS3018,"Upon receipt of a Message, the cFE shall generate a housekeeping message that includes the following Event Services items:
- Valid Command Counter
-- Invalid Command Counter
+- Invalid Command Counter
- SB Event Format Mode
-- Event Message Sent Counter
-- Event Message Truncation Counter
-- Unregistered Application Send Counter
-- Event Message Output Port Enable Statuses
-- _(OPTIONAL)_ Local Event Log Full Flag
-- _(OPTIONAL)_ Local Event Log Overflow Counter
-- _(OPTIONAL)_ Logging Mode
+- Event Message Sent Counter
+- Event Message Truncation Counter
+- Unregistered Application Send Counter
+- Event Message Output Port Enable Statuses
+- _(OPTIONAL)_ Local Event Log Full Flag
+- _(OPTIONAL)_ Local Event Log Overflow Counter
+- _(OPTIONAL)_ Logging Mode
- For each registered Application:
- o Application Event Message Sent Counter
+ o Application Event Message Sent Counter
o Application Event Service Enable Status",Generate housekeeping message for system awareness and management.
EVS: Add Event Filter,cEVS3019,Upon receipt of Command the cFE shall add the specified Event Filter for the specified cFE Application and Event ID.,Want to provide the ability for filters to be added at runtime. Original implentation did not provide this capability which resulted in modifications to Applications for those events that were not registered (i.e. forgotten).
EVS: Add Event Filter - Reject Already Filtered ,cEVS3019.1,"If the Event ID is already registered for filtering, the cFE shall reject the command and generate an event message.",Filter is done on a per Event ID basis.
@@ -259,28 +259,28 @@ EVS: Register App,cEVS3100,"Upon receipt of Request, the cFE shall register an A
EVS: Register App - Create Filter Counter,cEVS3100.1,"Upon receipt of Request to register an Application for event service, the cFE shall create one Application Binary Filter Counter per registered Event ID.",Supports the cFE's Binary Filtering Algorithm.
EVS: Register App - Create Sent Message Counter,cEVS3100.2,"Upon receipt of Request to register an Application for event service, the cFE shall create an Application Event Message Sent Counter.",Supports the cFE's dynamic Application model.
EVS: Register App - Default Event Enable Status,cEVS3100.3,"Upon receipt of Request to register an Application for event service, the cFE shall use the `` Application Event Type Enable Statuses for each event.","By default each platform should have a standard configuration for each event message type (eg. DEBUGs disable. INFO, ERROR and CRITICAL events DISABLED) that should be applied to all events. Commands are available to modify the settings."
-EVS: Unregister App,cEVS3101,"Upon receipt of Request, the cFE shall un-register an Application from using event services, deleting the following Application data:
+EVS: Unregister App,cEVS3101,"Upon receipt of Request, the cFE shall un-register an Application from using event services, deleting the following Application data:
-- Application Event Message Sent Counter
-- Application Event Service Enable Status
-- Application Event Type Enable Statuses (one for each Event Type)
-- Application Filtered Event IDs
-- Application Binary Filter Masks (one per registered Event ID)
+- Application Event Message Sent Counter
+- Application Event Service Enable Status
+- Application Event Type Enable Statuses (one for each Event Type)
+- Application Filtered Event IDs
+- Application Binary Filter Masks (one per registered Event ID)
- Application Binary Filter Counters (one per registered Event ID)",Supports the cFE's dynamic Application model allowing applications to clean up after themselves.
EVS: Message Types,cEVS3102,The cFE shall support the following Event Message Types: Debug Informational Error Critical.,Supports cFE event services.
-EVS: Create Message,cEVS3103,"Upon receipt of a Request to send an Event Message, the cFE shall create a Short or Long Event Message, as specified by the SB Event Format Mode, ONLY if the following cFE conditions are met:
+EVS: Create Message,cEVS3103,"Upon receipt of a Request to send an Event Message, the cFE shall create a Short or Long Event Message, as specified by the SB Event Format Mode, ONLY if the following cFE conditions are met:
-1. The requesting Application's Event Service Enable Status is Enabled.
-2. The requesting Application's registered message filtering algorithm indicates the message should be sent.
+1. The requesting Application's Event Service Enable Status is Enabled.
+2. The requesting Application's registered message filtering algorithm indicates the message should be sent.
3. The requesting Application's Event Type Enable Status is Enabled for the Event Type of the request-specified Event Message.",Supports cFE event services.
EVS: Create Message - Unregistered App,cEVS3103.1,If the requesting Application has been determined to be unregistered the cFE shall increment the Unregistered Application Send Counter and send an event message.,Provides ground operators the ability to see when unregistered applications are using event services.
-EVS: Create Message - Data Types,cEVS3103.2,"The cFE shall support the following data types within an applications Request specified Event Data:
+EVS: Create Message - Data Types,cEVS3103.2,"The cFE shall support the following data types within an applications Request specified Event Data:
-- Signed Character
-- Unsigned Character
-- Short Integer
-- Unsigned Short Integer
-- Long Integer
+- Signed Character
+- Unsigned Character
+- Short Integer
+- Unsigned Short Integer
+- Long Integer
- Unsigned Long Integer",Not all processors supported under the cFE will allow floating point or real types.
EVS: Create Message - Increment Filter Counter,cEVS3103.3,"If the request specified Event ID has been registered for binary event filtering, the cFE shall increment the request specified Application's Binary Filter Counter for the request-specified Event ID.",Support binary event filtering algorithm.
EVS: Create Message - Increment Filter Counter - Retain Maximum Value,cEVS3103.3.1,"If the Binary Filter Counter has reached its maximum `` value, the cFE shall retain the maximum value (i.e. do not rollover to zero).",Preventing a counter rollover to zero eliminates the case when a user may think no events have occurred when in fact many events have occurred.
@@ -307,29 +307,29 @@ EVS: Preserve Event Log Reset Mode On Processor Reset,cEVS3207,"_(OPTIONAL)_ Upo
EVS: Preserve Log Full State On Processor Reset,cEVS3208,"_(OPTIONAL)_ Upon a Processor Reset, the cFE shall preserve the Local Event Log Full state.",Retain the cFE state across Processor Resets.
EVS: Preserve Log Overflow Counter On Processor Reset,cEVS3210,"_(OPTIONAL)_ Upon a Processor Reset, the cFE shall preserve the Local Event Log Overflow Counter.",Retain the cFE state across Processor Resets.
SB: NOOP Event,cSB4000,"Upon receipt of a Command, the cFE shall generate a NO-OP event message.",This command is useful as a general sub-system aliveness test.
-SB: Zero Counters,cSB4001,"Upon receipt of Command the cFE shall set to zero the following counters in housekeeping telemetry:
+SB: Zero Counters,cSB4001,"Upon receipt of Command the cFE shall set to zero the following counters in housekeeping telemetry:
-- Valid command counter
-- Invalid command counter
-- No subscriptions counter
-- Message send error counter
-- Message receive error counter
-- Create Pipe error counter
-- Subscribe error counter
-- Pipe Overflow error counter
+- Valid command counter
+- Invalid command counter
+- No subscriptions counter
+- Message send error counter
+- Message receive error counter
+- Create Pipe error counter
+- Subscribe error counter
+- Pipe Overflow error counter
- MsdID-to-pipe limit error counter",Providing a clear counter command eliminates the need for operators or onboard scripts to keep track of the last value of the counter.
SB: Statistics Message,cSB4002,"Upon receipt of a Command, the cFE shall send an SB Message containing the SB statistics.","Visibility of the SB statistics is essential for FSW diagnostics, testing, and maintenance."
SB: Save Routing To File,cSB4003,"Upon receipt of a Command, the cFE shall save the SB routing information to the Command specified file.","Visibility of the SB routing information is essential for FSW diagnostics, testing, and maintenance."
SB: Save Routing To File - Default Filename,cSB4003.1,"If a file is not specified, the cFE shall use the `` Filename.",Want to provide a default in the event that a user does not want to specify one.
SB: Control Message Route To Pipe,cSB4004,"Upon receipt of a Command, the cFE shall enable or disable routing the command specified message to the command specified pipe.","Supports testing and maintenance. In testing, it may be desirable to enable/disable routing a message to a diagnostic application."
-SB: Housekeeping Message,cSB4005,"Upon receipt of a Message, the cFE shall generate a housekeeping message that includes the following Software Bus items:
+SB: Housekeeping Message,cSB4005,"Upon receipt of a Message, the cFE shall generate a housekeeping message that includes the following Software Bus items:
-- Valid command counter
-- Invalid command counter
-- No subscriptions counter
-- Message send error counter
-- Message receive error counter
-- Pipe overflow error counter
+- Valid command counter
+- Invalid command counter
+- No subscriptions counter
+- Message send error counter
+- Message receive error counter
+- Pipe overflow error counter
- MsgId-to-pipe limit error counter",Generate housekeeping message for system awareness and management.
SB: Save Pipe Info To File,cSB4007,"Upon receipt of a Command, the cFE shall save the Pipe information to the Command specified a file.","This gives detailed information about each pipe such as owner of the pipe, queue depth and send errors which can be used for diagnostics purposes."
SB: Save Pipe Info To File - Default Filename,cSB4007.1,"If a file is not specified, the cFE shall use the `` filename.",Want to provide a default in the event that a user does not want to specify one.
@@ -414,13 +414,13 @@ TBL: Write Table Registry To File,cTBL6005,Upon receipt of Command the cFE shall
TBL: Write Table Registry To File - Default File Name,cTBL6005.1,"If a file is not specified, the cFE shall use the `` filename.",Want to provide a default in the event that a user does not want to specify one.
TBL: Table Registry Message,cTBL6006,Upon receipt of Command the cFE shall telemeter the contents of the Table Registry associated with a Command specified Table.,"Operations personnel may wish to see the attributes (double or single-buffered, dump-only, etc), a history of what file(s) was/were last loaded into the Active Table Image, what time the load(s) occurred, etc."
TBL: NOOP Event,cTBL6007,Upon receipt of Command the cFE shall generate a NO-OP event message.,This command is useful as a general sub-system aliveness test.
-TBL: Zero Counters,cTBL6008,"Upon receipt of Command the cFE shall set the following counters reported in telemetry to zero:
+TBL: Zero Counters,cTBL6008,"Upon receipt of Command the cFE shall set the following counters reported in telemetry to zero:
-- Valid Command Counter
-- Invalid Command Counter
-- Number of Validation Requests
-- Number of successful Table Validations
-- Number of Unsuccessful Validations
+- Valid Command Counter
+- Invalid Command Counter
+- Number of Validation Requests
+- Number of successful Table Validations
+- Number of Unsuccessful Validations
- Number of Completed Validations",This command is a common feature in heritage sub-system software design.
TBL: Valid Command Counter,cTBL6009,"Upon receipt of valid command, the cFE shall increment the valid command counter.",The ground needs the capability to verify that the command was received a accepted by the cFE. Details of valid commands are documented in the cFE User's Guide.
TBL: Invalid Command Counter,cTBL6010,"Upon receipt of an invalid command, the cFE shall in increment the invalid command counter.",The ground needs an indicator if a command is rejected by the cFE. Details of what makes a command invalid are documented in the cFE User's Guide.
@@ -461,16 +461,16 @@ TBL: Provide Data Address - Modified Notification,cTBL6305.2,"If a Table has bee
TBL: Unlock,cTBL6306,"Upon receipt of Request, the cFE shall unlock the contents of the Request specified Table.","The Table Service must wait for an Application to be done with the contents of the Table before considering modifying its contents. This ensures data integrity while the Application accesses the Table contents. More than one Application can access a Table. Therefore, a reference count will be necessary to ensure that all access is complete before a Table can be modified."
TBL: Update With Pending Load,cTBL6308,"Upon receipt of Request, the cFE shall update the request specified Table if a load is pending and it is unlocked.",This gives control to the Application as to when the table update occurs.
TB: Update With Pending Load - Locked,cTBL6308.1,"If a Table is locked when an update Request is made, an appropriate error code shall be returned to the calling Application and the update shall not occur.",The Application should be made aware that the table is not being updated because it is locked.
-TBL: Provide Table Info,cTBL6309,"Upon receipt of Request, the cFE shall provide the following information to the calling Application for the specified Table:
+TBL: Provide Table Info,cTBL6309,"Upon receipt of Request, the cFE shall provide the following information to the calling Application for the specified Table:
-- Size of the table
-- Number of Users the access to the table (sharing)
-- Filename of the last file used to modify the table
-- File creation time of last file used to modify the table
+- Size of the table
+- Number of Users the access to the table (sharing)
+- Filename of the last file used to modify the table
+- File creation time of last file used to modify the table
- Time of last modification
-- Flag indicating if the Table has been initialized
-- Flag indicating if the Table is dump only
-- Flag indicating if the Table has a dedicated buffer
+- Flag indicating if the Table has been initialized
+- Flag indicating if the Table is dump only
+- Flag indicating if the Table has a dedicated buffer
- Flag indicating if the table is maintained in the Critical Data Store",Applications such as Checksum need to obtain info such as size of the table. The API is a more generic solution.
TBL: Pending Action Status,cTBL6310,"Upon receipt of Request the cFE shall indicate if the specified table has a validation, update, or dump pending.","Applications must periodically check to see if they need to perform updates, validations or dumps."
TBL: Provide Data Addresses,cTBL6311,"Upon receipt of Request, the cFE shall provide the calling Application with the addresses of the data for the tables requested if more than one table is needed.",Applications may need to work with more than one table at a time.
@@ -507,13 +507,13 @@ TIME: Valid Command Counter,cTIME2003,"Upon receipt of valid command, the cFE sh
TIME: Invalid Command Counter,cTIME2004,"Upon receipt of an invalid command, the cFE shall in increment the invalid command counter.",The ground needs an indicator if a command is rejected by the cFE. Details of what makes a command invalid are documented in the cFE User's Guide.
TIME: Set Leap Seconds,cTIME2005,Upon receipt of Command the cFE shall set the number of Leap Seconds to the Command-specified value.,The decision to introduce a leap second in UTC is the responsibility of the International Earth Rotation Service (IERS). The count of Leap Seconds has been incremented about every 500 days since 1972. It is therefore likely that a mission will need to update.
TIME: Set STCF,cTIME2006,Upon receipt of Command the cFE shall set the STCF to the Command specified value.,"The cFE must be provided with the appropriate correlation factor, that when combined with the current MET and Leap Seconds values, will result in current time. Historically this command has been referred to as 'jam loading' time."
-TIME: Update STCF Given Current Time,cTIME2007,Upon receipt of Command the cFE shall compute a new value for STCF using the Command-specified value as current time.,"This command provides a useful alternative to setting the STCF
-explicitly, as the command does not require knowledge of the current MET value. If the default time format is TAI then the new value for STCF is the
+TIME: Update STCF Given Current Time,cTIME2007,Upon receipt of Command the cFE shall compute a new value for STCF using the Command-specified value as current time.,"This command provides a useful alternative to setting the STCF
+explicitly, as the command does not require knowledge of the current MET value. If the default time format is TAI then the new value for STCF is the
Command-specified time value less MET."
TIME: Delta Adjust STCF,cTIME2009,Upon receipt of Command the cFE shall make a continuous 1Hz delta adjustment to the STCF by the Command-specified value.,"Upon receipt of a Command to make a 'continuous' adjustment to the STCF, the cFE shall adjust the STCF each second by the Command-specified value. The commanded value is signed so a positive or negative adjustment may be made."
TIME: Switch Tone Signal Source,cTIME2010,Upon receipt of Command the cFE shall switch to the Command-specified Tone Signal source.,"The behavior of this command is hardware specific, but provides the capability to command Tone Signal source selection if implemented at the hardware level."
TIME: Diagnostic Message,cTIME2011,Upon receipt of Command the cFE shall generate a Software Bus message that includes time diagnostic information.,"When testing or debugging the time application, more details about time services are required."
-TIME: External Time Update Mode,cTIME2012,"Upon receipt of Command the cFE Time Services shall set the External Time Update Mode to the specified value, either use or ignore Tone Signal and Data when updating time.",Historically referred to as forced flywheeling. This provides an easy way to test local time calculations and compare against external time or force internal timekeeping operationally.
+TIME: External Time Update Mode,cTIME2012,"Upon receipt of Command the cFE Time Services shall set the External Time Update Mode to the specified value, either use or ignore Tone Signal and Data when updating time.",Historically referred to as forced flywheeling. This provides an easy way to test local time calculations and compare against external time or force internal timekeeping operationally.
TIME: External Time Update Mode - Ignore Updates,cTIME2012.1,The cFE shall propagate time internally when set to ignore external time updates.,"Ignore external time updates and update time internally when configured to do so. Will still accept Tone Signal and Data, but won't update timekeeping based on the externally provided timing information."
TIME: External Time Update Mode - Use Updates,cTIME2012.2,The cFE shall update timekeeping when a Tone Signal and Data pair have been received when set to use external time updates.,"Use external time updates to update timekeeping values when configured to do so. Timekeeping in this context is intentionally vague since it depends on system mode, configuration and hardware implementation. This requirement just covers using the external data, not how exactly it is used."
TIME: Add To SCTF,cTIME2013,Upon receipt of Command the cFE shall add the Command specified value to SCTF.,One time (aka jump) value added to SCTF supports time adjustment for time servers or time clients that are set to ignore external Tone updates.
@@ -549,19 +549,19 @@ TIME: Get Clock State Flags,cTIME2320,"Upon receipt of a Request, the cFE shall
TIME: Convert MET to Spacecraft Time,cTIME2321,"Upon receipt of a Request, the cFE shall convert the provided MET to spacecraft time.",Converts the provided MET to spacecraft time based on current configuration of the system.
TIME: Trigger 1Hz Cycle Processing,cTIME2322,"Upon receipt of a Request, the cFE shall trigger the 1 Hz processing cycle.","Allows API triggered 1 Hz processing to support synchronization. Actually processing depends on configuration such as registered synchronization callbacks, virtualized MET, etc so it's left as generic language in this requirement."
TIME: Trigger Tone Signal Processing,cTIME2323,"Upon receipt of a Request, the cFE shall trigger the Tone Signal processing cycle.","Allows API triggered Tone Signal processing to support synchronization. Actually processing depends on configuration such as registered synchronization callbacks, virtualized MET, etc so it's left as generic language in this requirement."
-TIME: Power On Reset Default Values,cTIME2500,"Upon a Power-on Reset the cFE shall set the following time elements to their `` default values:
+TIME: Power On Reset Default Values,cTIME2500,"Upon a Power-on Reset the cFE shall set the following time elements to their `` default values:
- Time Status Data
- STCF
- Leap Seconds","At power on, the presumption is that the MET h/w register has been reset. It is common to set the STCF and Leap Seconds at startup such that time is computed to a known and recognizable value."
-TIME: Processor Reset CDS Values,cTIME2501,"Upon a Processor Reset the cFE shall acquire the following time elements from the `` Critical Data Store:
+TIME: Processor Reset CDS Values,cTIME2501,"Upon a Processor Reset the cFE shall acquire the following time elements from the `` Critical Data Store:
- Time Status Data
- STCF
- Leap Seconds","Time is a critical system resource and every effort should be made to preserve it. Following a processor reset, the presumption is that the MET h/w register is unaffected and that previously 'good' values for STCF and Leap Seconds can still be used to correct."
TIME: Processor Reset Verify CDS,cTIME2502,Upon a Processor Reset the cFE shall verify the Critical Data Store used to store time values.,"Verification of potentially damaged stored data is a standard practice. Note that because time can be any value, verification potentially involves using a pattern."
TIME: Processor Reset Verify CDS - Initialize On Failure,cTIME2502.1,"If the critical data store is not valid, all of the time elements shall be initialized in the same fashion as following a power-on reset.",If the CDS can't be trusted then need to initialize to default values.
-TIME: CDS Elements,cTIME2700,"During normal operation, the cFE shall preserve the following time elements in the `` Critical Data Store:
+TIME: CDS Elements,cTIME2700,"During normal operation, the cFE shall preserve the following time elements in the `` Critical Data Store:
- Time Status Data
- STCF
From 9aee2c5235549b2daabde2267f7ec7032b3cc681 Mon Sep 17 00:00:00 2001
From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com>
Date: Tue, 16 Mar 2021 15:07:52 -0400
Subject: [PATCH 7/7] Bump to v6.8.0-rc1+dev41
---
README.md | 6 ++++++
modules/core_api/fsw/inc/cfe_version.h | 2 +-
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 3f38113a4..baad5e009 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,12 @@ The detailed cFE user's guide can be viewed at
+
### Development Build: v6.8.0-rc1+dev402
- HOTFIX 20210312, updates to work with older CMake
diff --git a/modules/core_api/fsw/inc/cfe_version.h b/modules/core_api/fsw/inc/cfe_version.h
index 29de9ac86..ccd34295d 100644
--- a/modules/core_api/fsw/inc/cfe_version.h
+++ b/modules/core_api/fsw/inc/cfe_version.h
@@ -32,7 +32,7 @@
*/
/* Development Build Macro Definitions */
-#define CFE_BUILD_NUMBER 402 /*!< Development Build: Number of commits since baseline */
+#define CFE_BUILD_NUMBER 412 /*!< Development Build: Number of commits since baseline */
#define CFE_BUILD_BASELINE \
"v6.8.0-rc1" /*!< Development Build: git tag that is the base for the current development \
*/
| |