Core Flight Executive Users Guide

Generated by Doxygen 1.8.17

 i

1 Core Flight Executive Documentation 1

1.1 Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1.1 Core Flight Executive (cFE) Goals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Applicable Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3 Version Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.1 Version Number Semantics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.2 How and Where Defined . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3.3 Identifying Development Builds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.4 Templates for the short and long version string . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.4 Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.5 Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.6 cFE Executive Services Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.6.1 Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.6.2 Software Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.6.3 Reset Types and Subtypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.6.4 Exception and Reset (ER) Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.6.5 Application and Child Task Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.6.6 Starting an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.6.7 Stopping an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.6.8 Restarting an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.6.9 Reloading an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.6.10 Listing Current Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.6.11 Listing Current Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.6.12 Loading Common Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.6.13 Basic File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.6.14 Performance Data Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.6.15 Critical Data Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.6.16 Memory Pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.6.17 System Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.6.18 Version Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.6.19 Frequently Asked Questions about Executive Services . . . . . . . . . . . . . . . . . . . . . . . 18
1.7 cFE Executive Services Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.8 cFE Executive Services Telemetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.9 cFE Executive Services Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.10 cFE Event Services Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.10.1 Event Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
1.10.2 Local Event Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.10.3 Event Message Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
1.10.4 Event Message Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Generated by Doxygen
ii

1.10.5 EVS Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

1.10.6 EVS Counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
1.10.7 Resetting EVS Counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.10.8 Effects of a Processor Reset on EVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
1.10.9 EVS squelching of misbehaving apps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
1.10.10 Frequently Asked Questions about Event Services . . . . . . . . . . . . . . . . . . . . . . . . 31
1.11 cFE Event Services Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
1.12 cFE Event Services Telemetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.13 cFE Event Services Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.14 cFE Software Bus Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
1.14.1 Software Bus Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
1.14.2 Autonomous Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
1.14.3 Operation of the SB Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
1.14.4 Frequently Asked Questions about Software Bus . . . . . . . . . . . . . . . . . . . . . . . . . . 41
1.15 cFE Software Bus Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
1.16 cFE Software Bus Telemetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.17 cFE Software Bus Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.18 cFE Table Services Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.18.1 Managing Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.18.2 cFE Table Types and Table Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.18.3 Table Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
1.18.4 Table Services Telemetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
1.18.5 Effects of Processor Reset on Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
1.18.6 Frequently Asked Questions about Table Services . . . . . . . . . . . . . . . . . . . . . . . . . 49
1.19 cFE Table Services Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.20 cFE Table Services Telemetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
1.21 cFE Table Services Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
1.22 cFE Time Services Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
1.22.1 Time Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
1.22.2 Time Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
1.22.3 Time Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.22.4 Time Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
1.22.5 Time Format Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.22.6 Enabling Fake Tone Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.22.7 Selecting Tone and Data Ordering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
1.22.8 Specifying Tone and Data Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
1.22.9 Specifying Time Server/Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
1.22.10 Specifying Time Tone Byte Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
1.22.11 Virtual MET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Generated by Doxygen
 iii

1.22.12 Specifying Time Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

1.22.13 Specifying Time Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
1.22.14 Time Services Paradigm(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
1.22.15 Flywheeling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
1.22.16 Time State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
1.22.17 Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
1.22.18 Power-On Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.22.19 Processor Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
1.22.20 Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
1.22.21 Power-On Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
1.22.22 Processor Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
1.22.23 Normal Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
1.22.24 Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
1.22.25 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
1.22.26 Setting Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
1.22.27 Adjusting Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
1.22.28 Setting MET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
1.22.29 Frequently Asked Questions about Time Services . . . . . . . . . . . . . . . . . . . . . . . . . 72
1.23 cFE Time Services Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
1.24 cFE Time Services Telemetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
1.25 cFE Time Services Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
1.26 cFE Event Message Cross Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
1.27 cFE Command Mnemonic Cross Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
1.28 cFE Telemetry Mnemonic Cross Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

2 Glossary of Terms 90

3 cFE Application Programmer's Interface (API) Reference 91

3.1 Executive Services API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
3.2 Events Services API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
3.3 File Services API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
3.4 Message API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
3.5 Resource ID API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
3.6 Software Bus Services API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
3.7 Table Services API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
3.8 Time Services API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

4 Osal API Documentation 98

4.1 OSAL Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
4.2 File System Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Generated by Doxygen
iv

4.3 File Descriptors In Osal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

4.4 Timer Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

5 cFE Mission Configuration Parameters 101

6 Module Index 102

6.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

7 Data Structure Index 104

7.1 Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

8 File Index 114

8.1 File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

9 Module Documentation 118

9.1 cFE Return Code Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
9.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
9.1.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
9.2 cFE Resource ID APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
9.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
9.2.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
9.3 cFE Entry/Exit APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
9.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
9.3.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
9.4 cFE Application Control APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
9.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
9.4.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
9.5 cFE Application Behavior APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
9.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
9.5.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
9.6 cFE Information APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
9.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
9.6.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
9.7 cFE Child Task APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
9.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
9.7.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
9.8 cFE Miscellaneous APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
9.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
9.8.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
9.9 cFE Critical Data Store APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
9.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Generated by Doxygen
 v

9.9.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

9.10 cFE Memory Manager APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
9.10.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
9.10.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
9.11 cFE Performance Monitor APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
9.11.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
9.11.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
9.11.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
9.12 cFE Generic Counter APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
9.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
9.12.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
9.13 cFE Registration APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
9.13.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
9.13.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
9.14 cFE Send Event APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
9.14.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
9.14.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
9.15 cFE Reset Event Filter APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
9.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
9.15.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
9.16 cFE File Header Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
9.16.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
9.16.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
9.17 cFE File Utility APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
9.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
9.17.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
9.18 cFE Generic Message APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
9.18.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
9.18.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
9.19 cFE Message Primary Header APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
9.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
9.19.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
9.20 cFE Message Extended Header APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
9.20.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
9.20.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
9.21 cFE Message Secondary Header APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
9.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
9.21.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
9.22 cFE Message Id APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Generated by Doxygen
vi

9.22.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

9.22.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
9.23 cFE Message Integrity APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
9.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
9.23.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
9.24 cFE Pipe Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
9.24.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
9.24.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
9.25 cFE Message Subscription Control APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
9.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
9.25.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
9.26 cFE Send/Receive Message APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
9.26.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
9.26.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
9.27 cFE Zero Copy APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
9.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
9.27.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
9.28 cFE Message Characteristics APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
9.28.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
9.28.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
9.29 cFE Message ID APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
9.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
9.29.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
9.30 cFE SB Pipe options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
9.30.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
9.30.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
9.31 cFE Registration APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
9.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
9.31.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
9.32 cFE Manage Table Content APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
9.32.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
9.32.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
9.33 cFE Access Table Content APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
9.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
9.33.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
9.34 cFE Get Table Information APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
9.34.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
9.34.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
9.35 cFE Table Type Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Generated by Doxygen
 vii

9.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

9.35.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
9.36 cFE Get Current Time APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
9.36.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
9.36.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
9.37 cFE Get Time Information APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
9.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
9.37.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
9.38 cFE Time Arithmetic APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
9.38.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
9.38.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
9.39 cFE Time Conversion APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
9.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
9.39.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
9.40 cFE External Time Source APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
9.40.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
9.40.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
9.41 cFE Miscellaneous Time APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
9.41.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
9.41.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
9.42 cFE Resource ID base values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
9.42.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
9.42.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
9.43 cFE Clock State Flag Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
9.43.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
9.43.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
9.44 OSAL Semaphore State Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
9.44.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
9.44.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
9.45 OSAL Binary Semaphore APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
9.45.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
9.45.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
9.46 OSAL BSP low level access APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
9.46.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
9.46.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
9.47 OSAL Real Time Clock APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
9.47.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
9.47.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
9.48 OSAL Core Operation APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

Generated by Doxygen
viii

9.48.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

9.48.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
9.49 OSAL Condition Variable APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
9.49.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
9.49.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
9.50 OSAL Counting Semaphore APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
9.50.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
9.50.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
9.51 OSAL Directory APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
9.51.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
9.51.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
9.52 OSAL Return Code Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
9.52.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
9.52.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
9.53 OSAL Error Info APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
9.53.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
9.53.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
9.54 OSAL File Access Option Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
9.54.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
9.54.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
9.55 OSAL Reference Point For Seek Offset Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
9.55.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
9.55.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
9.56 OSAL Standard File APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
9.56.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
9.56.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
9.57 OSAL File System Level APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
9.57.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
9.57.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
9.58 OSAL Heap APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
9.58.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
9.58.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
9.59 OSAL Object Type Defines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
9.59.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
9.59.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
9.60 OSAL Object ID Utility APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
9.60.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
9.60.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
9.61 OSAL Dynamic Loader and Symbol APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

Generated by Doxygen
 ix

9.61.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

9.61.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
9.62 OSAL Mutex APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
9.62.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
9.62.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
9.63 OSAL Network ID APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
9.63.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
9.63.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
9.64 OSAL Printf APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
9.64.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
9.64.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
9.65 OSAL Message Queue APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
9.65.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
9.65.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
9.66 OSAL Select APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
9.66.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
9.66.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
9.67 OSAL Shell APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
9.67.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
9.67.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
9.68 OSAL Socket Address APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
9.68.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
9.68.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
9.69 OSAL Socket Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
9.69.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
9.69.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
9.70 OSAL Task APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
9.70.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
9.70.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
9.71 OSAL Time Base APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
9.71.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
9.71.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
9.72 OSAL Timer APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
9.72.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
9.72.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419

10 Data Structure Documentation 425

10.1 CCSDS_ExtendedHeader Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
10.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

Generated by Doxygen
x

10.1.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

10.2 CCSDS_PrimaryHeader Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
10.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
10.2.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
10.3 CFE_ES_AppInfo Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
10.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
10.3.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
10.4 CFE_ES_AppNameCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
10.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
10.4.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
10.5 CFE_ES_AppReloadCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
10.5.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
10.5.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
10.6 CFE_ES_BlockStats Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
10.6.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
10.6.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
10.7 CFE_ES_CDSRegDumpRec Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
10.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
10.7.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
10.8 CFE_ES_ClearERLogCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
10.8.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
10.8.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
10.9 CFE_ES_ClearSysLogCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
10.9.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
10.9.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
10.10 CFE_ES_DeleteCDSCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
10.10.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
10.10.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
10.11 CFE_ES_DeleteCDSCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
10.11.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
10.11.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
10.12 CFE_ES_DumpCDSRegistryCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
10.12.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
10.12.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
10.13 CFE_ES_DumpCDSRegistryCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 436
10.13.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
10.13.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
10.14 CFE_ES_FileNameCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
10.14.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

Generated by Doxygen
 xi

10.14.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

10.15 CFE_ES_FileNameCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
10.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
10.15.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
10.16 CFE_ES_HousekeepingTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
10.16.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
10.16.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
10.17 CFE_ES_HousekeepingTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 438
10.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
10.17.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
10.18 CFE_ES_MemPoolStats Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
10.18.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
10.18.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
10.19 CFE_ES_MemStatsTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
10.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
10.19.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
10.20 CFE_ES_NoopCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
10.20.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
10.20.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
10.21 CFE_ES_OneAppTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
10.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
10.21.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
10.22 CFE_ES_OneAppTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
10.22.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
10.22.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
10.23 CFE_ES_OverWriteSysLogCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
10.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
10.23.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
10.24 CFE_ES_OverWriteSysLogCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 450
10.24.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
10.24.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
10.25 CFE_ES_PoolAlign Union Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
10.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
10.25.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
10.26 CFE_ES_PoolStatsTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
10.26.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
10.26.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
10.27 CFE_ES_QueryAllCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
10.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

Generated by Doxygen
xii

10.27.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

10.28 CFE_ES_QueryAllTasksCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
10.28.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
10.28.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
10.29 CFE_ES_QueryOneCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
10.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
10.29.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
10.30 CFE_ES_ReloadAppCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
10.30.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
10.30.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
10.31 CFE_ES_ResetCountersCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
10.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
10.31.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
10.32 CFE_ES_ResetPRCountCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
10.32.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
10.32.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
10.33 CFE_ES_RestartAppCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
10.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
10.33.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
10.34 CFE_ES_RestartCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
10.34.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
10.34.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
10.35 CFE_ES_RestartCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
10.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
10.35.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
10.36 CFE_ES_SendHkCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
10.36.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
10.36.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
10.37 CFE_ES_SendMemPoolStatsCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
10.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
10.37.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
10.38 CFE_ES_SendMemPoolStatsCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 458
10.38.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
10.38.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
10.39 CFE_ES_SetMaxPRCountCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
10.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
10.39.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
10.40 CFE_ES_SetMaxPRCountCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 459
10.40.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

Generated by Doxygen
 xiii

10.40.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

10.41 CFE_ES_SetPerfFilterMaskCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
10.41.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
10.41.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
10.42 CFE_ES_SetPerfFilterMaskCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 460
10.42.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
10.42.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
10.43 CFE_ES_SetPerfTriggerMaskCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
10.43.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
10.43.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
10.44 CFE_ES_SetPerfTrigMaskCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 462
10.44.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
10.44.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
10.45 CFE_ES_StartApp Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
10.45.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
10.45.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
10.46 CFE_ES_StartAppCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
10.46.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
10.46.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
10.47 CFE_ES_StartPerfCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
10.47.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
10.47.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
10.48 CFE_ES_StartPerfDataCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
10.48.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
10.48.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
10.49 CFE_ES_StopAppCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
10.49.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
10.49.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
10.50 CFE_ES_StopPerfCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
10.50.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
10.50.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
10.51 CFE_ES_StopPerfDataCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
10.51.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
10.51.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
10.52 CFE_ES_TaskInfo Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
10.52.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
10.52.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
10.53 CFE_ES_WriteERLogCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
10.53.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468

Generated by Doxygen
xiv

10.53.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

10.54 CFE_ES_WriteSysLogCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
10.54.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
10.54.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
10.55 CFE_EVS_AddEventFilterCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
10.55.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
10.55.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
10.56 CFE_EVS_AppDataCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
10.56.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
10.56.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
10.57 CFE_EVS_AppNameBitMaskCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 471
10.57.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
10.57.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
10.58 CFE_EVS_AppNameCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
10.58.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
10.58.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
10.59 CFE_EVS_AppNameEventIDCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 472
10.59.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
10.59.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
10.60 CFE_EVS_AppNameEventIDMaskCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . 472
10.60.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
10.60.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
10.61 CFE_EVS_AppTlmData Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
10.61.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
10.61.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
10.62 CFE_EVS_BinFilter Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
10.62.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
10.62.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
10.63 CFE_EVS_BitMaskCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
10.63.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
10.63.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
10.64 CFE_EVS_ClearLogCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
10.64.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
10.64.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
10.65 CFE_EVS_DeleteEventFilterCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
10.65.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
10.65.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
10.66 CFE_EVS_DisableAppEventsCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
10.66.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

Generated by Doxygen
 xv

10.66.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477

10.67 CFE_EVS_DisableAppEventTypeCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 477
10.67.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
10.67.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
10.68 CFE_EVS_DisableEventTypeCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
10.68.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
10.68.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
10.69 CFE_EVS_DisablePortsCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
10.69.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
10.69.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
10.70 CFE_EVS_EnableAppEventsCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
10.70.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
10.70.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
10.71 CFE_EVS_EnableAppEventTypeCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 479
10.71.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
10.71.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
10.72 CFE_EVS_EnableEventTypeCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
10.72.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
10.72.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
10.73 CFE_EVS_EnablePortsCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
10.73.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
10.73.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
10.74 CFE_EVS_HousekeepingTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
10.74.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
10.74.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
10.75 CFE_EVS_HousekeepingTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . 482
10.75.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
10.75.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
10.76 CFE_EVS_LogFileCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
10.76.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
10.76.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
10.77 CFE_EVS_LongEventTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
10.77.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
10.77.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
10.78 CFE_EVS_LongEventTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
10.78.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
10.78.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
10.79 CFE_EVS_NoopCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
10.79.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

Generated by Doxygen
xvi

10.79.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

10.80 CFE_EVS_PacketID Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
10.80.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
10.80.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
10.81 CFE_EVS_ResetAllFiltersCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
10.81.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
10.81.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
10.82 CFE_EVS_ResetAppCounterCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
10.82.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
10.82.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
10.83 CFE_EVS_ResetCountersCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
10.83.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
10.83.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
10.84 CFE_EVS_ResetFilterCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
10.84.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
10.84.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
10.85 CFE_EVS_SendHkCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
10.85.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
10.85.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
10.86 CFE_EVS_SetEventFormatCode_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 491
10.86.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
10.86.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
10.87 CFE_EVS_SetEventFormatModeCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 492
10.87.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
10.87.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
10.88 CFE_EVS_SetFilterCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
10.88.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
10.88.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
10.89 CFE_EVS_SetLogMode_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
10.89.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
10.89.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
10.90 CFE_EVS_SetLogModeCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
10.90.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
10.90.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
10.91 CFE_EVS_ShortEventTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
10.91.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
10.91.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
10.92 CFE_EVS_ShortEventTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
10.92.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

Generated by Doxygen
 xvii

10.92.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

10.93 CFE_EVS_WriteAppDataFileCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
10.93.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
10.93.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
10.94 CFE_EVS_WriteLogDataFileCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
10.94.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
10.94.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
10.95 CFE_FS_FileWriteMetaData Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
10.95.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
10.95.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
10.96 CFE_FS_Header Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
10.96.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
10.96.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
10.97 CFE_SB_AllSubscriptionsTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
10.97.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
10.97.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
10.98 CFE_SB_AllSubscriptionsTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . 500
10.98.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
10.98.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
10.99 CFE_SB_DisableRouteCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
10.99.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
10.99.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
10.100 CFE_SB_DisableSubReportingCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 501
10.100.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
10.100.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
10.101 CFE_SB_EnableRouteCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
10.101.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
10.101.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
10.102 CFE_SB_EnableSubReportingCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 502
10.102.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
10.102.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
10.103 CFE_SB_HousekeepingTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
10.103.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
10.103.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
10.104 CFE_SB_HousekeepingTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . 503
10.104.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
10.104.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
10.105 CFE_SB_Msg Union Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
10.105.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

Generated by Doxygen
xviii

10.105.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507

10.106 CFE_SB_MsgId_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
10.106.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
10.106.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
10.107 CFE_SB_MsgMapFileEntry Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
10.107.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
10.107.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
10.108 CFE_SB_NoopCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
10.108.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
10.108.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
10.109 CFE_SB_PipeDepthStats Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
10.109.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
10.109.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
10.110 CFE_SB_PipeInfoEntry Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
10.110.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
10.110.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
10.111 CFE_SB_Qos_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
10.111.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
10.111.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
10.112 CFE_SB_ResetCountersCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
10.112.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
10.112.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
10.113 CFE_SB_RouteCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
10.113.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
10.113.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
10.114 CFE_SB_RoutingFileEntry Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
10.114.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
10.114.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
10.115 CFE_SB_SendHkCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
10.115.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
10.115.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
10.116 CFE_SB_SendPrevSubsCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
10.116.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
10.116.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
10.117 CFE_SB_SendSbStatsCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
10.117.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
10.117.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
10.118 CFE_SB_SingleSubscriptionTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
10.118.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516

Generated by Doxygen
 xix

10.118.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517

10.119 CFE_SB_SingleSubscriptionTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 517
10.119.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
10.119.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
10.120 CFE_SB_StatsTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
10.120.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
10.120.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
10.121 CFE_SB_StatsTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
10.121.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
10.121.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
10.122 CFE_SB_SubEntries Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
10.122.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
10.122.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
10.123 CFE_SB_WriteFileInfoCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 523
10.123.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
10.123.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
10.124 CFE_SB_WriteMapInfoCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
10.124.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
10.124.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
10.125 CFE_SB_WritePipeInfoCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
10.125.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
10.125.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
10.126 CFE_SB_WriteRoutingInfoCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
10.126.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
10.126.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
10.127 CFE_TBL_AbortLoadCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
10.127.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
10.127.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
10.128 CFE_TBL_AbortLoadCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 525
10.128.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
10.128.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
10.129 CFE_TBL_ActivateCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
10.129.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
10.129.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
10.130 CFE_TBL_ActivateCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
10.130.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
10.130.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
10.131 CFE_TBL_DelCDSCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
10.131.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

Generated by Doxygen
xx

10.131.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

10.132 CFE_TBL_DeleteCDSCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
10.132.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
10.132.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
10.133 CFE_TBL_DumpCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
10.133.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
10.133.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
10.134 CFE_TBL_DumpCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
10.134.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
10.134.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
10.135 CFE_TBL_DumpRegistryCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
10.135.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
10.135.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
10.136 CFE_TBL_DumpRegistryCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 530
10.136.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
10.136.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
10.137 CFE_TBL_File_Hdr Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
10.137.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
10.137.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
10.138 CFE_TBL_FileDef Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
10.138.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
10.138.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
10.139 CFE_TBL_HousekeepingTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
10.139.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
10.139.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
10.140 CFE_TBL_HousekeepingTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . 534
10.140.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
10.140.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
10.141 CFE_TBL_Info Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
10.141.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
10.141.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
10.142 CFE_TBL_LoadCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
10.142.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
10.142.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
10.143 CFE_TBL_LoadCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
10.143.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
10.143.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
10.144 CFE_TBL_NoopCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
10.144.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541

Generated by Doxygen
 xxi

10.144.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541

10.145 CFE_TBL_NotifyCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
10.145.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
10.145.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
10.146 CFE_TBL_NotifyCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
10.146.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
10.146.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
10.147 CFE_TBL_ResetCountersCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
10.147.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
10.147.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
10.148 CFE_TBL_SendHkCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
10.148.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
10.148.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
10.149 CFE_TBL_SendRegistryCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
10.149.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
10.149.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
10.150 CFE_TBL_SendRegistryCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . 544
10.150.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
10.150.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
10.151 CFE_TBL_TableRegistryTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
10.151.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
10.151.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
10.152 CFE_TBL_TblRegPacket_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
10.152.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
10.152.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546
10.153 CFE_TBL_ValidateCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
10.153.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
10.153.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
10.154 CFE_TBL_ValidateCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
10.154.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
10.154.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
10.155 CFE_TIME_AddAdjustCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
10.155.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
10.155.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
10.156 CFE_TIME_AddDelayCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
10.156.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
10.156.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
10.157 CFE_TIME_AddOneHzAdjustmentCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 551
10.157.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551

Generated by Doxygen
xxii

10.157.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551

10.158 CFE_TIME_DiagnosticTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
10.158.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
10.158.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
10.159 CFE_TIME_DiagnosticTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 552
10.159.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
10.159.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
10.160 CFE_TIME_FakeToneCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
10.160.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
10.160.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
10.161 CFE_TIME_HousekeepingTlm Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
10.161.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
10.161.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
10.162 CFE_TIME_HousekeepingTlm_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 561
10.162.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
10.162.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
10.163 CFE_TIME_LeapsCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
10.163.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
10.163.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
10.164 CFE_TIME_NoopCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
10.164.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
10.164.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
10.165 CFE_TIME_OneHzAdjustmentCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . 565
10.165.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
10.165.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
10.166 CFE_TIME_OneHzCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
10.166.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
10.166.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
10.167 CFE_TIME_ResetCountersCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
10.167.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
10.167.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
10.168 CFE_TIME_SendDiagnosticCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
10.168.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
10.168.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
10.169 CFE_TIME_SendHkCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
10.169.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
10.169.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
10.170 CFE_TIME_SetLeapSecondsCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
10.170.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567

Generated by Doxygen
 xxiii

10.170.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567

10.171 CFE_TIME_SetMETCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
10.171.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
10.171.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
10.172 CFE_TIME_SetSignalCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
10.172.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
10.172.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
10.173 CFE_TIME_SetSourceCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
10.173.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
10.173.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
10.174 CFE_TIME_SetStateCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
10.174.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
10.174.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
10.175 CFE_TIME_SetSTCFCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
10.175.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
10.175.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
10.176 CFE_TIME_SetTimeCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
10.176.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
10.176.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
10.177 CFE_TIME_SignalCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
10.177.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
10.177.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
10.178 CFE_TIME_SourceCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
10.178.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
10.178.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
10.179 CFE_TIME_StateCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
10.179.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
10.179.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
10.180 CFE_TIME_SubAdjustCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
10.180.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
10.180.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
10.181 CFE_TIME_SubDelayCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
10.181.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
10.181.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
10.182 CFE_TIME_SubOneHzAdjustmentCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . 574
10.182.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
10.182.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
10.183 CFE_TIME_SysTime Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
10.183.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575

Generated by Doxygen
xxiv

10.183.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575

10.184 CFE_TIME_TimeCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
10.184.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
10.184.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
10.185 CFE_TIME_ToneDataCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
10.185.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
10.185.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
10.186 CFE_TIME_ToneDataCmd_Payload Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 577
10.186.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
10.186.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
10.187 CFE_TIME_ToneSignalCmd Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
10.187.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
10.187.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
10.188 OS_bin_sem_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
10.188.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
10.188.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578
10.189 OS_condvar_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
10.189.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
10.189.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
10.190 OS_count_sem_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
10.190.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
10.190.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
10.191 os_dirent_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
10.191.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
10.191.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
10.192 OS_FdSet Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
10.192.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
10.192.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
10.193 OS_file_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
10.193.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
10.193.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
10.194 os_fsinfo_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
10.194.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
10.194.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
10.195 os_fstat_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
10.195.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
10.195.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
10.196 OS_heap_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
10.196.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583

Generated by Doxygen
 xxv

10.196.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583

10.197 OS_module_address_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
10.197.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
10.197.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
10.198 OS_module_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
10.198.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
10.198.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
10.199 OS_mut_sem_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
10.199.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
10.199.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
10.200 OS_queue_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
10.200.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
10.200.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
10.201 OS_SockAddr_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
10.201.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
10.201.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
10.202 OS_SockAddrData_t Union Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
10.202.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
10.202.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
10.203 OS_socket_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
10.203.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
10.203.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
10.204 OS_static_symbol_record_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
10.204.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
10.204.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
10.205 OS_statvfs_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
10.205.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
10.205.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
10.206 OS_task_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
10.206.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
10.206.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 590
10.207 OS_time_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
10.207.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
10.207.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
10.208 OS_timebase_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
10.208.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
10.208.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
10.209 OS_timer_prop_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
10.209.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593

Generated by Doxygen
xxvi

10.209.2 Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593

11 File Documentation 593

11.1 build/osal_public_api/inc/osconfig.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
11.1.1 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
11.2 example_mission_cfg.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
11.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
11.2.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
11.3 example_platform_cfg.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
11.3.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
11.3.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
11.4 sample_perfids.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
11.4.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
11.4.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
11.5 cfe/docs/src/cfe_api.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.6 cfe/docs/src/cfe_es.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.7 cfe/docs/src/cfe_evs.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.8 cfe/docs/src/cfe_frontpage.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.9 cfe/docs/src/cfe_glossary.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.10 cfe/docs/src/cfe_sb.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.11 cfe/docs/src/cfe_tbl.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.12 cfe/docs/src/cfe_time.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.13 cfe/docs/src/cfe_xref.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.14 cfe/docs/src/cfs_versions.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.15 cfe/modules/core_api/config/default_cfe_core_api_base_msgids.h File Reference . . . . . . . . . . . . 656
11.15.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.15.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
11.16 cfe/modules/core_api/config/default_cfe_core_api_interface_cfg.h File Reference . . . . . . . . . . . . 658
11.16.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
11.16.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
11.17 cfe/modules/core_api/config/default_cfe_mission_cfg.h File Reference . . . . . . . . . . . . . . . . . . 660
11.17.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
11.18 cfe/modules/core_api/config/default_cfe_msgids.h File Reference . . . . . . . . . . . . . . . . . . . . . 660
11.18.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
11.19 cfe/modules/core_api/fsw/inc/cfe.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
11.19.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
11.20 cfe/modules/core_api/fsw/inc/cfe_config.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 661
11.20.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
11.20.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662

Generated by Doxygen
 xxvii

11.21 cfe/modules/core_api/fsw/inc/cfe_config_api_typedefs.h File Reference . . . . . . . . . . . . . . . . . . 664

11.21.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
11.21.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
11.21.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
11.22 cfe/modules/core_api/fsw/inc/cfe_endian.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 665
11.22.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
11.22.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
11.23 cfe/modules/core_api/fsw/inc/cfe_error.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 666
11.23.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
11.23.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
11.23.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
11.23.4 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
11.24 cfe/modules/core_api/fsw/inc/cfe_es.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
11.24.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
11.24.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
11.25 cfe/modules/core_api/fsw/inc/cfe_es_api_typedefs.h File Reference . . . . . . . . . . . . . . . . . . . 678
11.25.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
11.25.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
11.25.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
11.25.4 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
11.26 cfe/modules/core_api/fsw/inc/cfe_evs.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 683
11.26.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
11.26.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684
11.27 cfe/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h File Reference . . . . . . . . . . . . . . . . . . . 684
11.27.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
11.27.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685
11.27.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
11.28 cfe/modules/core_api/fsw/inc/cfe_fs.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
11.28.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
11.29 cfe/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h File Reference . . . . . . . . . . . . . . . . . . . . 687
11.29.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
11.29.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
11.29.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
11.30 cfe/modules/core_api/fsw/inc/cfe_msg.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 690
11.30.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
11.31 cfe/modules/core_api/fsw/inc/cfe_msg_api_typedefs.h File Reference . . . . . . . . . . . . . . . . . . 692
11.31.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
11.31.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693
11.31.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694

Generated by Doxygen
xxviii

11.31.4 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695

11.32 cfe/modules/core_api/fsw/inc/cfe_resourceid.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 696
11.32.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
11.32.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
11.32.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 698
11.33 cfe/modules/core_api/fsw/inc/cfe_resourceid_api_typedefs.h File Reference . . . . . . . . . . . . . . . 703
11.33.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
11.33.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
11.34 cfe/modules/core_api/fsw/inc/cfe_sb.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
11.34.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
11.34.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
11.35 cfe/modules/core_api/fsw/inc/cfe_sb_api_typedefs.h File Reference . . . . . . . . . . . . . . . . . . . 706
11.35.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
11.35.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
11.35.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
11.36 cfe/modules/core_api/fsw/inc/cfe_tbl.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
11.36.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
11.37 cfe/modules/core_api/fsw/inc/cfe_tbl_api_typedefs.h File Reference . . . . . . . . . . . . . . . . . . . 710
11.37.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
11.37.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
11.37.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
11.37.4 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
11.38 cfe/modules/core_api/fsw/inc/cfe_tbl_filedef.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 713
11.38.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
11.38.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
11.38.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
11.39 cfe/modules/core_api/fsw/inc/cfe_time.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 714
11.39.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715
11.39.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
11.40 cfe/modules/core_api/fsw/inc/cfe_time_api_typedefs.h File Reference . . . . . . . . . . . . . . . . . . 716
11.40.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
11.40.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716
11.40.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
11.40.4 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
11.41 cfe/modules/core_api/fsw/inc/cfe_version.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 718
11.41.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
11.41.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 718
11.42 cfe/modules/es/config/default_cfe_es_extern_typedefs.h File Reference . . . . . . . . . . . . . . . . . 720
11.42.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722

Generated by Doxygen
 xxix

11.42.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722

11.42.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
11.42.4 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
11.43 cfe/modules/es/config/default_cfe_es_fcncodes.h File Reference . . . . . . . . . . . . . . . . . . . . . 728
11.43.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
11.43.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
11.44 cfe/modules/es/config/default_cfe_es_interface_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 749
11.44.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
11.44.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
11.45 cfe/modules/es/config/default_cfe_es_internal_cfg.h File Reference . . . . . . . . . . . . . . . . . . . . 752
11.45.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
11.45.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 754
11.46 cfe/modules/es/config/default_cfe_es_mission_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 772
11.46.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
11.47 cfe/modules/es/config/default_cfe_es_msg.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 772
11.47.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
11.48 cfe/modules/es/config/default_cfe_es_msgdefs.h File Reference . . . . . . . . . . . . . . . . . . . . . 773
11.48.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
11.48.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
11.48.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
11.49 cfe/modules/es/config/default_cfe_es_msgids.h File Reference . . . . . . . . . . . . . . . . . . . . . . 777
11.49.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
11.49.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
11.50 cfe/modules/es/config/default_cfe_es_msgstruct.h File Reference . . . . . . . . . . . . . . . . . . . . . 778
11.50.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
11.50.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
11.51 cfe/modules/es/config/default_cfe_es_platform_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 782
11.51.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
11.52 cfe/modules/es/config/default_cfe_es_topicids.h File Reference . . . . . . . . . . . . . . . . . . . . . . 782
11.52.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
11.52.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
11.53 cfe/modules/es/fsw/inc/cfe_es_eventids.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 783
11.53.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
11.53.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
11.54 cfe/modules/evs/config/default_cfe_evs_extern_typedefs.h File Reference . . . . . . . . . . . . . . . . 808
11.54.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
11.54.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
11.54.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
11.55 cfe/modules/evs/config/default_cfe_evs_fcncodes.h File Reference . . . . . . . . . . . . . . . . . . . . 811

Generated by Doxygen
xxx

11.55.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812

11.55.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
11.56 cfe/modules/evs/config/default_cfe_evs_interface_cfg.h File Reference . . . . . . . . . . . . . . . . . . 829
11.56.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
11.56.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
11.57 cfe/modules/evs/config/default_cfe_evs_internal_cfg.h File Reference . . . . . . . . . . . . . . . . . . 830
11.57.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
11.57.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
11.58 cfe/modules/evs/config/default_cfe_evs_mission_cfg.h File Reference . . . . . . . . . . . . . . . . . . 834
11.58.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
11.59 cfe/modules/evs/config/default_cfe_evs_msg.h File Reference . . . . . . . . . . . . . . . . . . . . . . 834
11.59.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
11.60 cfe/modules/evs/config/default_cfe_evs_msgdefs.h File Reference . . . . . . . . . . . . . . . . . . . . 835
11.60.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
11.60.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
11.60.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
11.61 cfe/modules/evs/config/default_cfe_evs_msgids.h File Reference . . . . . . . . . . . . . . . . . . . . . 838
11.61.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
11.61.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
11.62 cfe/modules/evs/config/default_cfe_evs_msgstruct.h File Reference . . . . . . . . . . . . . . . . . . . 839
11.62.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
11.62.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
11.63 cfe/modules/evs/config/default_cfe_evs_platform_cfg.h File Reference . . . . . . . . . . . . . . . . . . 842
11.63.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
11.64 cfe/modules/evs/config/default_cfe_evs_topicids.h File Reference . . . . . . . . . . . . . . . . . . . . . 843
11.64.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
11.64.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
11.65 cfe/modules/evs/fsw/inc/cfe_evs_eventids.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 844
11.65.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
11.65.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
11.66 cfe/modules/fs/config/default_cfe_fs_extern_typedefs.h File Reference . . . . . . . . . . . . . . . . . . 856
11.66.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
11.67 cfe/modules/fs/config/default_cfe_fs_filedef.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 856
11.67.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
11.67.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
11.67.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
11.68 cfe/modules/fs/config/default_cfe_fs_interface_cfg.h File Reference . . . . . . . . . . . . . . . . . . . . 858
11.68.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
11.68.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858

Generated by Doxygen
 xxxi

11.69 cfe/modules/fs/config/default_cfe_fs_mission_cfg.h File Reference . . . . . . . . . . . . . . . . . . . . 858

11.69.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
11.70 cfe/modules/msg/fsw/inc/ccsds_hdr.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
11.70.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
11.70.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
11.71 cfe/modules/resourceid/fsw/inc/cfe_core_resourceid_basevalues.h File Reference . . . . . . . . . . . . 859
11.71.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
11.72 cfe/modules/resourceid/fsw/inc/cfe_resourceid_basevalue.h File Reference . . . . . . . . . . . . . . . . 860
11.72.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
11.72.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
11.73 cfe/modules/sb/config/default_cfe_sb_extern_typedefs.h File Reference . . . . . . . . . . . . . . . . . 861
11.73.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
11.73.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
11.73.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
11.73.4 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
11.74 cfe/modules/sb/config/default_cfe_sb_fcncodes.h File Reference . . . . . . . . . . . . . . . . . . . . . 863
11.74.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
11.74.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
11.75 cfe/modules/sb/config/default_cfe_sb_interface_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 872
11.75.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
11.75.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 872
11.76 cfe/modules/sb/config/default_cfe_sb_internal_cfg.h File Reference . . . . . . . . . . . . . . . . . . . . 873
11.76.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
11.76.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 874
11.77 cfe/modules/sb/config/default_cfe_sb_mission_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 881
11.77.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
11.78 cfe/modules/sb/config/default_cfe_sb_msg.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 882
11.78.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
11.79 cfe/modules/sb/config/default_cfe_sb_msgdefs.h File Reference . . . . . . . . . . . . . . . . . . . . . 882
11.79.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
11.79.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
11.80 cfe/modules/sb/config/default_cfe_sb_msgids.h File Reference . . . . . . . . . . . . . . . . . . . . . . 884
11.80.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
11.80.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
11.81 cfe/modules/sb/config/default_cfe_sb_msgstruct.h File Reference . . . . . . . . . . . . . . . . . . . . . 886
11.81.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 886
11.81.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
11.82 cfe/modules/sb/config/default_cfe_sb_platform_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 888
11.82.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888

Generated by Doxygen
xxxii

11.83 cfe/modules/sb/config/default_cfe_sb_topicids.h File Reference . . . . . . . . . . . . . . . . . . . . . . 888

11.83.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
11.83.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 888
11.84 cfe/modules/sb/fsw/inc/cfe_sb_eventids.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 889
11.84.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
11.84.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
11.85 cfe/modules/tbl/config/default_cfe_tbl_extern_typedefs.h File Reference . . . . . . . . . . . . . . . . . 909
11.85.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
11.85.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
11.85.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909
11.86 cfe/modules/tbl/config/default_cfe_tbl_fcncodes.h File Reference . . . . . . . . . . . . . . . . . . . . . 910
11.86.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
11.86.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
11.87 cfe/modules/tbl/config/default_cfe_tbl_interface_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 919
11.87.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
11.87.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
11.88 cfe/modules/tbl/config/default_cfe_tbl_internal_cfg.h File Reference . . . . . . . . . . . . . . . . . . . . 920
11.88.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
11.88.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
11.89 cfe/modules/tbl/config/default_cfe_tbl_mission_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 926
11.89.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
11.90 cfe/modules/tbl/config/default_cfe_tbl_msg.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 926
11.90.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
11.91 cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h File Reference . . . . . . . . . . . . . . . . . . . . . 927
11.91.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
11.91.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
11.92 cfe/modules/tbl/config/default_cfe_tbl_msgids.h File Reference . . . . . . . . . . . . . . . . . . . . . . 929
11.92.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
11.92.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
11.93 cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h File Reference . . . . . . . . . . . . . . . . . . . . . 930
11.93.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
11.93.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
11.94 cfe/modules/tbl/config/default_cfe_tbl_platform_cfg.h File Reference . . . . . . . . . . . . . . . . . . . 932
11.94.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
11.95 cfe/modules/tbl/config/default_cfe_tbl_topicids.h File Reference . . . . . . . . . . . . . . . . . . . . . . 932
11.95.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
11.95.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
11.96 cfe/modules/tbl/fsw/inc/cfe_tbl_eventids.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 933
11.96.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936

Generated by Doxygen
 xxxiii

11.96.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936

11.97 cfe/modules/time/config/default_cfe_time_extern_typedefs.h File Reference . . . . . . . . . . . . . . . 953
11.97.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
11.97.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
11.97.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
11.98 cfe/modules/time/config/default_cfe_time_fcncodes.h File Reference . . . . . . . . . . . . . . . . . . . 958
11.98.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
11.98.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
11.99 cfe/modules/time/config/default_cfe_time_interface_cfg.h File Reference . . . . . . . . . . . . . . . . . 974
11.99.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
11.99.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
11.100 cfe/modules/time/config/default_cfe_time_internal_cfg.h File Reference . . . . . . . . . . . . . . . . . 978
11.100.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
11.100.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
11.101 cfe/modules/time/config/default_cfe_time_mission_cfg.h File Reference . . . . . . . . . . . . . . . . . 983
11.101.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
11.102 cfe/modules/time/config/default_cfe_time_msg.h File Reference . . . . . . . . . . . . . . . . . . . . . 984
11.102.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
11.103 cfe/modules/time/config/default_cfe_time_msgdefs.h File Reference . . . . . . . . . . . . . . . . . . . 984
11.103.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986
11.103.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986
11.104 cfe/modules/time/config/default_cfe_time_msgids.h File Reference . . . . . . . . . . . . . . . . . . . 986
11.104.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
11.104.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
11.105 cfe/modules/time/config/default_cfe_time_msgstruct.h File Reference . . . . . . . . . . . . . . . . . . 988
11.105.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
11.105.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
11.106 cfe/modules/time/config/default_cfe_time_platform_cfg.h File Reference . . . . . . . . . . . . . . . . . 991
11.106.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
11.107 cfe/modules/time/config/default_cfe_time_topicids.h File Reference . . . . . . . . . . . . . . . . . . . 991
11.107.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
11.107.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
11.108 cfe/modules/time/fsw/inc/cfe_time_eventids.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 993
11.108.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
11.108.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
11.109 osal/docs/src/osal_frontpage.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 003
11.110 osal/docs/src/osal_fs.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 003
11.111 osal/docs/src/osal_timer.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 003
11.112 osal/src/os/inc/common_types.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 003

Generated by Doxygen
xxxiv

11.112.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 004

11.112.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 005
11.112.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 005
11.112.4 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 007
11.113 osal/src/os/inc/osapi-binsem.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 008
11.113.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 009
11.114 osal/src/os/inc/osapi-bsp.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 009
11.114.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 009
11.115 osal/src/os/inc/osapi-clock.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 009
11.115.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 010
11.115.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 011
11.116 osal/src/os/inc/osapi-common.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 011
11.116.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 012
11.116.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 012
11.116.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 012
11.117 osal/src/os/inc/osapi-condvar.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 013
11.117.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 014
11.118 osal/src/os/inc/osapi-constants.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 014
11.118.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 014
11.118.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 014
11.119 osal/src/os/inc/osapi-countsem.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 015
11.119.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 015
11.120 osal/src/os/inc/osapi-dir.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 015
11.120.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 016
11.120.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 016
11.121 osal/src/os/inc/osapi-error.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 016
11.121.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 018
11.121.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 019
11.121.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 019
11.122 osal/src/os/inc/osapi-file.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 019
11.122.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 021
11.122.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 021
11.122.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 022
11.123 osal/src/os/inc/osapi-filesys.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 022
11.123.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 023
11.123.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 023
11.124 osal/src/os/inc/osapi-heap.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 024
11.124.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 024
11.125 osal/src/os/inc/osapi-idmap.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 024

Generated by Doxygen
 xxxv

11.125.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 025

11.125.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 025
11.126 osal/src/os/inc/osapi-macros.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 026
11.126.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 026
11.126.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 026
11.127 osal/src/os/inc/osapi-module.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 027
11.127.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 028
11.127.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 028
11.128 osal/src/os/inc/osapi-mutex.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 029
11.128.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 029
11.129 osal/src/os/inc/osapi-network.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 029
11.129.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 030
11.130 osal/src/os/inc/osapi-printf.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 030
11.130.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 030
11.131 osal/src/os/inc/osapi-queue.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 030
11.131.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 031
11.132 osal/src/os/inc/osapi-select.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 031
11.132.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 031
11.132.2 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 031
11.133 osal/src/os/inc/osapi-shell.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 032
11.133.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 032
11.134 osal/src/os/inc/osapi-sockets.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 032
11.134.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 034
11.134.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 034
11.134.3 Enumeration Type Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 034
11.135 osal/src/os/inc/osapi-task.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 035
11.135.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 036
11.135.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 036
11.135.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 036
11.135.4 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 037
11.136 osal/src/os/inc/osapi-timebase.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 037
11.136.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 037
11.136.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 038
11.137 osal/src/os/inc/osapi-timer.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 038
11.137.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 038
11.137.2 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 038
11.138 osal/src/os/inc/osapi-version.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 039
11.138.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 039
11.138.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 040

Generated by Doxygen
1 Core Flight Executive Documentation 1

11.138.3 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 041

11.139 osal/src/os/inc/osapi.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 042
11.139.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 043
11.140 psp/fsw/inc/cfe_psp.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 043
11.140.1 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 047
11.140.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 050
11.141 psp/fsw/inc/cfe_psp_error.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 070
11.141.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 071
11.141.2 Macro Definition Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 071
11.141.3 Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 073
11.141.4 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1. 073

Index 1075

1 Core Flight Executive Documentation

• General Information and Concepts

– Background
– Applicable Documents
– Version Numbers
– Dependencies
– Acronyms
– Glossary of Terms

• Executive Services (ES)

– cFE Executive Services Overview

– cFE Executive Services Commands
– cFE Executive Services Telemetry
– ES Event Message Reference
– cFE Executive Services Configuration Parameters

• Events Services (EVS)

– cFE Event Services Overview

– cFE Event Services Commands
– cFE Event Services Telemetry
– EVS Event Message Reference
– cFE Event Services Configuration Parameters

• Software Bus Services (SB)

– cFE Software Bus Overview

– cFE Software Bus Commands

Generated by Doxygen
2

– cFE Software Bus Telemetry

– SB Event Message Reference
– cFE Software Bus Configuration Parameters

• Table Services (TBL)

– cFE Table Services Overview

– cFE Table Services Commands
– cFE Table Services Telemetry
– TBL Event Message Reference
– cFE Table Services Configuration Parameters

• Time Services (TIME)

– cFE Time Services Overview

– cFE Time Services Commands
– cFE Time Services Telemetry
– TIME Event Message Reference
– cFE Time Services Configuration Parameters

• cFE Event Message Cross Reference

• cFE Command Mnemonic Cross Reference

• cFE Telemetry Mnemonic Cross Reference

• cFE Application Programmer's Interface (API) Reference

1.1 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) 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.

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

• Software Timing Analyzer that provides visibility into the real-time performance of embedded systems software

• Table Builder

Generated by Doxygen
1.2 Applicable Documents 3

• 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 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 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.

1.1.1 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 software.

1.1.1.1 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, 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 hardware or operating system software interface.

1.2 Applicable Documents

Generated by Doxygen
4

Document Title Link

cFE System (L4) Requirements Document cfe/docs/'cfe requirements.docx'
cFE Functional (L5) Requirements Document cfe/docs/cFE_FunctionalRequirements.csv
cFE Application Developers Guide cfe/docs/'cFE Application Developers Guide.md'
cFE User's Guide (includes API) Autogenerated from code, provided with releases in cFE repository
OS Abstraction Layer (OSAL) API Autogenerated from code, provided with releases in OSAL repository

1.3 Version Numbers

1.3.1 Version Number Semantics

The version number is a sequence of four numbers, generally separated by dots when written. These are, in order, the
Major number, the Minor number, the Revision number, and the Mission Revision number.

It is important to note that version numbers are only updated upon official releases of tagged versions, NOT on devel-
opment builds. We aim to follow the Semantic Versioning v2.0 specification with our versioning.

The MAJOR number is incremented on release to indicate when there is a change to an API that may cause existing,
correctly-written cFS components to stop working. It may also be incremented for a release that contains changes
deemed to be of similar impact, even if there are no actual changes to the API.

The MINOR number is incremented on release to indicate the addition of features to the API which do not break the
existing code. It may also be incremented for a release that contains changes deemed to be of similar impact, even if
there are no actual updates to the API.

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".

The Mission Rev Version number is set to zero in all official releases, and is reserved for the mission use.

1.3.2 How and Where Defined

The version numbers are provided as simple macros defined in the cfe_version.h header file as part of the API definition;
these macros must expand to simple integer values, so that they can be used in simple if directives by the macro
preprocessor.

Note the Mission Rev number is provided for missions to be able to identify unique changes they have made to
the released software (via clone and own). Specicifally, the values 1-254 are reserved for mission use to denote
patches/customizations while 0 and 0xFF are reserved for cFS open-source development use (pending resolution of
nasa/cFS#440).

Generated by Doxygen
1.4 Dependencies 5

1.3.3 Identifying Development Builds

In order to distinguish between development versions, we also provide a BUILD_NUMBER.

The BUILD_NUMBER reflects the number of commits since the BUILD_BASELINE, a baseline git tag, for each partic-
ular component. The BUILD_NUMBER integer monotonically increases for a given baseline. The BUILD_BASELINE
identifies the current development cycle and is a git tag with format vMAJOR.MINOR.REVISION. The Codename used
in the version string also refers to the current development cycle. When a new baseline tag and codename are created,
the BUILD_NUMBER resets to zero and begins increasing from a new baseline.

1.3.4 Templates for the short and long version string

See cfe_version.h for the standard layout and definition of version information. The apps and repositories follow the
same pattern by replacing the CFE_ prefix with the appropriate name; for example, osal uses OS_, psp uses CFE_P←-
SP_IMPL, and so on.

Suggested pattern for development:

• CFSCOMPONENT_SRC_VERSION: REFERENCE_GIT_TAG"+dev"BUILD_NUMBER

– Example: "v6.8.0-rc1+dev123"

• CFSCOMPONENT_VERSION_STRING: "CFSCOMPONENT DEVELOPMENT BUILD "CFSCOMPONENT_S←-

RC_VERSION" (Codename: CFSCONSTELLATION), Last Official Release: MAJOR.MINOR.REVISION"

– Example: "cFE DEVELOPMENT BUILD v6.8.0-rc1+dev123 (Codename: Bootes), Last Official Release: cfe
v6.7.0"

Suggested pattern for official releases:

• CFSCOMPONENT_SRC_VERSION: OFFICIAL_GIT_TAG

– Example: "v7.0.0"

• COMPONENT_VERSION_STRING: "CFSCOMPONENT OFFICIAL RELEASE "CFSCOMPONENT_SRC_VE←-

RSION" (Codename: CFSCONSTELLATION)"

– Example: "cFE OFFICIAL RELEASE v7.0.0 (Codename: Caelum)"

1.4 Dependencies

The Core Flight Executive (cFE) is required to be built with the Operating System Abstraction Layer (OSAL) and Platform
Support Package (PSP) components of the Core Flight System (cFS). It is always recommended to build with the latest
versions of each of the components as backward compatibility 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.

1.5 Acronyms

Generated by Doxygen
6

Acronym Description
AC Attitude Control
ACE Attitude Control Electronics
ACS Attitude Control System
API Application Programming Interface
APID CCSDS Application ID
App Application
CCSDS Consultative Committee for Space Data Systems
CDH, C&DH Command and Data Handling
cFE core Flight Executive
cFS core Flight System
CM Configuration Management
CMD Command
CPU Central Processing Unit
EDAC Error Detection and Correction
EEPROM Electrically Erasable Programmable Read-Only Memory
ES Executive Services
EVS Event Services
FC Function Code
FDC Failure Detection and Correction
FSW Flight Software
HW, H/W Hardware
ICD Interface Control Document
MET Mission Elapsed Time
MID Message ID
OS Operating System
OSAL Operating System Abstraction Layer
PID Pipeline ID
PKT Packet
PSP Platform Support Package
RAM Random-Access Memory
SB Software Bus
SDO Solar Dynamics Observatory
ST5 Space Technology Five
STCF Spacecraft Time Correlation Factor
SW, S/W Software
TAI International Atomic Time
TBD To Be Determined
TBL Table Services
TID Task ID
TIME Time Services
TLM Telemetry
UTC Coordinated Universal Time

Generated by Doxygen
1.6 cFE Executive Services Overview 7

1.6 cFE Executive Services Overview

Executive Services (ES) is one of the five core Flight Executive components. ES is the primary interface to the underlying
Operating System, providing a high level interface to system control facilities. The ES component is responsible for
starting up and restarting the cFE, starting up, shutting down, and restarting cFE Applications, logging errors and
performance data, and providing a persistent memory store for cFE Applications.

The interfaces to the ES task include the Ground Interface (commands and telemetry) and the Application Programmer
Interfaces (APIs). The ES task interfaces to the OS through the OS Abstraction Layer (OSAL) and platform through the
Platform Support Package (PSP).

The functionality provided by the ES task include Software Reset, Application and Child Task Management, Basic File
System, Performance Data Collection, Critical Data Store, Memory Pool, System Log, Shell Command.

For additional detail on Executive Services, see the following sections:

• Terminology

• Software Reset

– Reset Types and Subtypes

– Exception and Reset (ER) Log

• Application and Child Task Management

– Starting an Application

– Stopping an Application

– Restarting an Application

– Reloading an Application

– Listing Current Applications

– Listing Current Tasks

– Loading Common Libraries

• Basic File System

• Performance Data Collection

• Critical Data Store

Generated by Doxygen
8

• Memory Pool

• System Log

• Version Identification

• Frequently Asked Questions about Executive Services

1.6.1 Terminology

The following sections describe terminology that is very relevant to understanding the Executive Services:

• "Application" and "cFE Application"

• "Task"

• "Startup Script"

1.6.1.1 "Application" and "cFE Application"

Application

The term 'Application' as defined in the Glossary of Terms is a set of data and functions that is treated as a single entity
by the cFE. cFE resources are allocated on a per-Application basis. Applications are made up of a Main Task and zero
or more Child Tasks.

cFE Application

A 'cFE Application' is an application that is external to the cFE and designed to interface to the cFE through the APIs.
It is created through an entry in the "Startup Script" (with the 'Object Type' field set to CFE_APP) or by way of the
CFE_ES_START_APP_CC ground command.

When referring to one of the five applications internal to the cFE (ES, EVS, SB, TIME or TBL), the term 'Service' or 'Core
Application' is typically used.

A listing of cFE applications can be acquired by using the CFE_ES_QUERY_ALL_CC ground command. This listing
will include the cFE internal applications as well as cFE applications that are loaded and running.

Generated by Doxygen
1.6 cFE Executive Services Overview 9

1.6.1.2 "Task" A Task is a thread of execution in the operating system, often associated with a cFE Application.
Each cFE Application has a Main task providing its CPU context, stack and other OS resources. In addition, each cFE
Application can create multiple Child Tasks which are closely associated with the Parent Task and cFE Application.

In a traditional Real Time Operating System such as vxWorks, the cFE Application Main task and child tasks end up
being mapped to these OS tasks in the same shared memory space. For example, a Stored Command cFE Application
that consists of a cFE Main Task and 10 Relative Time Sequence Child Tasks would have 11 tasks on a vxWorks system.
The only association between these tasks exists in the cFE.

In a memory protected process oriented Operating System, the intention is to have a cFE Application implemented as
a memory protected process with its own virtual address space. In this Process Model, each cFE Child Task would be
a thread in the parent Process, much like a Unix process with multiple threads. In this model, the Stored Command
example with a cFE Main Task and 10 Relative Time Sequence Child Tasks would consist of a Unix Process and 10
pthreads, all under the same virtual address space.

1.6.1.3 "Startup Script" The startup script is a text file, written by the user that contains a list of entries (one entry for
each application) and is used by the ES application for automating the startup of applications. For a processor reset, ES
checks for the CFE_PLATFORM_ES_VOLATILE_STARTUP_FILE first, and if it doesn't exist or for a power on reset ES
uses the file passed in to CFE_ES_Main (typically CFE_PLATFORM_ES_NONVOL_STARTUP_FILE but dependent
on the PSP).

The fields in a single entry include:

Object Type CFE_APP for an Application, or CFE_LIB for a library.

Path/Filename This is a cFE Virtual filename, not a vxWorks device/pathname
Entry Point This is the name of the "main" function for App.
CFE Name The cFE name for the APP or Library
Priority This is the Priority of the App, not used for a Library
Stack Size This is the Stack size for the App, not used for a Library
Load Address This is the Optional Load Address for the App or Library. It is currently not implemented so it
should always be 0x0.
Exception Action This is the Action the cFE should take if the Application has an exception.

• 0 = Do a cFE Processor Reset

• Non-Zero = Just restart the Application

Immediately after the cFE completes its initialization, the ES Application first looks for the volatile startup
script. The location in the file system is defined by the cFE platform configuration parameter named
CFE_PLATFORM_ES_VOLATILE_STARTUP_FILE. This configuration parameter contains a path as well as a
filename. If the file is found, ES begins to startup the applications that are listed in the file. If ES does not find the file, it
attempts to open the CFE_PLATFORM_ES_NONVOL_STARTUP_FILE.

If ES finds the volatile startup script, the attempt to open the nonvolatile startup script is bypassed.

Any errors encountered in the startup script processing are written to the System Log. The System Log may also contain
positive acknowledge messages regarding the startup script processing.

The startup script delivered with the cFE (cfe_es_startup.scr) also has some detailed information about the
fields and the settings.

Generated by Doxygen
10

1.6.2 Software Reset

The ES Software Reset provides a command to reset the cFE as well as resetting individual applications. Because
applications are dependent on the cFE services, it is not possible to reset the cFE without affecting the applications.
Therefore, a command to reset the cFE will also reset every application that is running at the time the command is
received.

Also include is the Exception and Reset (ER) Log, which has a command for dumping or clearing the log and telemetry
to show the number of entries in the log. In addition to the ER log, the user may find information about the most recent
reset in the ES task housekeeping telemetry.

The ES Software Reset also provides a command to set the maximum number of processor resets before ES issues
a power-on reset. There is a corresponding 'processor resets' counter in ES housekeeping telemetry that may be
reset through another ES command.

1.6.3 Reset Types and Subtypes

The Reset Type is sent to the ground in the ES housekeeping packet and tells how the current running version of the
cFE was invoked. The possible Reset Types expected in the telemetry field are CFE_PSP_RST_TYPE_POWERON and
CFE_PSP_RST_TYPE_PROCESSOR. There is a third Reset Type defined in the ES code as CFE_ES_APP_RESTART
which applies only to restarting an individual application and is covered in more detail in the section titled Application
and Child Task.

The Reset Subtype is also sent in the ES housekeeping packet and gives more detail about the type of re-
set that started the execution of the current running version of the cFE. The possible Reset Subtypes are
CFE_PSP_RST_SUBTYPE_POWER_CYCLE, CFE_PSP_RST_SUBTYPE_PUSH_BUTTON, CFE_PSP_RST_SUBTYPE_HW_SPECIA
CFE_PSP_RST_SUBTYPE_HW_WATCHDOG, CFE_PSP_RST_SUBTYPE_RESET_COMMAND, CFE_PSP_RST_SUBTYPE_EXCEP
CFE_PSP_RST_SUBTYPE_UNDEFINED_RESET, CFE_PSP_RST_SUBTYPE_HWDEBUG_RESET, CFE_PSP_RST_SUBTYPE_BAN

1.6.4 Exception and Reset (ER) Log

The Exception and Reset Log contains detailed information about past resets and exceptions. To view the informa-
tion the CFE_ES_WRITE_ER_LOG_CC command must be sent. This command will write the log to a binary file.
The path and filename may be specified in the command. If the filename command field contains an empty string,
the configuration parameter CFE_PLATFORM_ES_DEFAULT_ER_LOG_FILE is used to specify the path and file-
name. Use the ground system to get the file and display the contents. There is also a command to clear the ER
log, CFE_ES_CLEAR_ER_LOG_CC.

The size of the ER log is defined by the platform configuration parameter CFE_PLATFORM_ES_ER_LOG_ENTRIES
This log is preserved after a processor reset and held in the ES reset area.

A count of the number of entries in the log is present in the ES housekeeping telemetry. This count can be used with
the configuration parameter CFE_PLATFORM_ES_ER_LOG_ENTRIES to calculate the fullness of the log.

The information contained in a single log entry is defined by the structure CFE_ES_ERLog_t.

Generated by Doxygen
1.6 cFE Executive Services Overview 11

1.6.5 Application and Child Task Management

The ES Application and Child Task Management provides the user with full control over starting and stopping applica-
tions as well as querying information regarding applications, tasks and library routines.

There is no command to start or stop a child task. Child tasks can be controlled (started, stopped or deleted) only by
the parent application through an API call.

This provides a way for the user to load a set of library routines, (via the startup script) without starting a corresponding
task. See the section related to library routines for more detail.

The ES task maintains a counter for the number of registered applications, number of registered child tasks and the
number of registered libraries in the ES housekeeping data.

1.6.6 Starting an Application

There are two ways to start an application, through the ground command CFE_ES_START_APP_CC or through the
startup script. In either case, the object file must be loaded on board before the command is sent or before the startup
script is executed. The startup script contains a list of applications and library routines to load and start immediately
after the cFE finishes its startup sequence. The parameters in the command, match the elements of an entry in the
startup script.

The format of the Start Application command, is defined in the structure CFE_ES_StartAppCmd_t. The members of the
structure include, application name, entry point, filename, stack size, load address, exception action and priority.

If the command fails for any reason, an error event will be sent stating the reason for the failure. There may be additional
information in the system log that can be viewed by sending the ES command to dump the system log.

After starting an application, the ES task sends an informational event message displaying the application name, file-
name of the object and the application ID. The new application will then show up in the query list downloaded in response
to the CFE_ES_QUERY_ALL_CC command.

1.6.7 Stopping an Application

Stopping an application can be done through the ground command CFE_ES_STOP_APP_CC. This command will
terminate the application execution and all child tasks created by the application, free the system resources that it
allocated and delete the corresponding object file.

The process of stopping an application is done in a controlled manner when the application is properly using the return
code from the call to the CFE_ES_RunLoop. When the application properly uses this function, the ES task starts a
timer and (via the return code) tells the application to exit at its own convenience. This gives the application time to
free its own resources and do any cleanup that may be required before terminating itself by calling CFE_ES_ExitApp.
If the timer expires and the application still exists, then ES must 'kill' the application. When the application is killed, ES
attempts to cleanup the applications resources as best it could. In this case there is no guarantee that all the system
resources are properly released.

The format of the Stop Application command, is defined in the structure CFE_ES_StopAppCmd_t. The only parameter
in the command is an application name.

If the command fails for any reason, an error event will be sent stating the reason for the failure. There may be additional
information in the system log that can be viewed by sending the ES command to dump the system log.

After stopping an application, the ES task sends a debug message stating the name of the application. After executing
the command, the application (or any resources it allocated) should no longer be listed in any cFE tables or files.

Generated by Doxygen
12

1.6.8 Restarting an Application

The CFE_ES_RESTART_APP_CC command is used to restart an application using the same file name as the last
start.

This command checks for file existence, the application is running, and the application is not a core app. If valid, the
application restart is requested.

When requested, ES stops the application, unloads the object file, loads the object file using the previous file name,
and restarts an application using the parameters defined when the application was previously started, either through the
startup script or by way of the CFE_ES_START_APP_CC command.

1.6.9 Reloading an Application

The CFE_ES_RELOAD_APP_CC command is used to reload an application using a new file name.

This command performs the same actions as CFE_ES_RESTART_APP_CC only using the new file.

1.6.10 Listing Current Applications

There are two options for receiving information about applications, the CFE_ES_QUERY_ONE_CC command can be
used to get details about a single application. This command takes an application name as its only parameter and the
application information is sent as a software bus packet that can be telemetered to the ground.

Or the CFE_ES_QUERY_ALL_CC command can be used to get information about all the applications that are currently
registered with ES. This command writes the application data to a file and has a one parameter which specifies the path
and filename of the output file.

For either command, the following Application information is made available:

• Application ID - The Application ID assigned by the cFE to the Application

• Type Identifier - Identifies whether the Application is a CORE App or an EXTERNAL App

• Name - The Application Name

• Entry Point - The symbolic name for the entry point into the Application

• Filename - The name of the file the Application was loaded from

• Stack Size - The number of bytes allocated for the Application's stack

• Load Address - The starting address of memory where the Application was loaded

Generated by Doxygen
1.6 cFE Executive Services Overview 13

• Load Size - The size, in bytes, of the Application when loaded into memory

• Start Address - The physical address that maps to the Entry Point

• Exception Action - A flag that identifies whether the Processor should undergo a Restart or whether just the
Application should restart upon an exception condition within the Application

• Priority - The assigned priority for the Application

• Main Task ID - The Task ID assigned to the main task associated with the Application

• Main Task Name - The name of the main task associated with the Application

• Number of Child Tasks - The number of child tasks spawned by the main task

For a description of the format in which this data is dumped, see CFE_ES_AppInfo_t.

1.6.11 Listing Current Tasks

The CFE_ES_QUERY_ALL_TASKS_CC command is used to get a list of child tasks that are currently registered with
ES. The following information is provided for each registered task:

• Task ID - The Task ID associated with the specified task

• Task Name - The name of the Task

• Application ID - The ID for the Application the Task is associated with

• Application Name - The name of the Application the Task is associated with

1.6.12 Loading Common Libraries

Library routines may be loaded only through the startup script. There is an option that allows a library routine initialization
function to be executed after the library is loaded. Refer to the cFE Application Developers Guide for more information
regarding Library Routines and startup scripts. The startup script delivered with the cFE (cfe_es_startup.scr)
also has some detailed information about library routines.

1.6.13 Basic File System

ES provides minimal functionality to initialize, read, and write cfe File headers.

Generated by Doxygen
14

1.6.14 Performance Data Collection

The Performance Data Collection provides precise timing information for each software application similar to how a logic
analyzer can trigger and filter data.

API calls are inserted by the development team at key points in the code. The basic operation is to start the data
collection, wait some amount of time, then send the command to stop the data collection. When the stop command
is received, the ES task writes all the data from the buffer to a file. The file can then be imported to analysis tools
for viewing. The size of the buffer is configurable through the CFE_PLATFORM_ES_PERF_DATA_BUFFER_SIZE
platform configuration parameter.

Additional information follows:

• Performance Data Collection Trigger Masks

• Starting to Collect Performance Data

• Stopping the Collection of Performance Data

• Viewing the Collection of Performance Data

1.6.14.1 Performance Data Collection Trigger Masks The trigger mask is used to control precisely when to start
collecting the data. There is a bit in the trigger mask for every marker used in the code. After a start command is
received, the trigger mask is read and dictates when to begin storing data in the buffer.

If the trigger mask is set to all zeros, then the collection will begin immediately after the start command and continue
until a stop command is received. In this case the buffer behaves in a 'circular' manner.

1.6.14.2 Starting to Collect Performance Data The CFE_ES_START_PERF_DATA_CC command is used to start
the data collection process. The ES task sends a debug event when the command is received. It is not possible to start
a collection if the buffer-to-file write is in process from an earlier collection. There is an ES telemetry point that can be
used to ensure there is not a buffer-to-file write in progress. This ES telemetry point is called 'Perf Data to Write' and
begins counting down from 'Data Count' to zero. If this counter is zero, it is ok to send the start command. If any errors
are encountered when the start command is received, the details will be displayed in an error event message.

1.6.14.3 Stopping the Collection of Performance Data The CFE_ES_STOP_PERF_DATA_CC command is

used to stop the data collection process and write the buffer data to a file. The path and filename may be
specified in the command. If the filename command field contains an empty string, the configuration parameter
CFE_PLATFORM_ES_DEFAULT_PERF_DUMP_FILENAME is used to specify the path and filename. The number
of entries written to the file is determined by the 'data count' variable, which is sent in the ES housekeeping telemetry
packet. To ensure cpu hogging does not occur during the write process, ES creates a low priority child task to perform
the file write operation. This child task will write a number of entries, then sleep for a short time to give tasks of lower
priority a chance to run. The number of entries between delays, and the delay time is displayed in the debug event at
the time the stop command is received.

Generated by Doxygen
1.6 cFE Executive Services Overview 15

1.6.14.4 Viewing the Collection of Performance Data To view the performance data, the file created as a result of
the stop command must be transferred to the ground and imported into a viewing tool. See https://github.←-
com/nasa/perfutils-java as an example.

1.6.15 Critical Data Store

Some missions are required, for health, safety and mission success criteria, to survive Processor Resets. These mission
requirements frequently flow down to Attitude Control and/or Command and Data Handling requirements that force an
Application developer to design a mechanism for retaining software state information through a Processor Reset. The
cFE provides the Critical Data Store to assist the developer in meeting these requirements.

The Critical Data Store is an area of memory that is not cleared during a Processor Reset. In addition, the contents
of memory are validated when accessed with a Data Integrity Value that helps to ensure the contents have not been
corrupted. Each processor platform, through the design of its Board Support Package, can implement this area of
memory in a number of ways to ensure the contents survive a Processor Reset. Applications can allocate a section of
this memory for their use in a way similar to the cFE Table Services Overview.

When an Application registers a Critical Data Store (CDS), the Executive Services allocates a section of the Critical Data
Store memory for the application's use and assigns the Application specified name to the memory area. The operator
can find and learn the characteristics of these Critical Data Stores by using the Dump CDS Registry Command. This
command will dump the contents of the CDS Registry maintained by the Executive Services into a file that can be
downlinked and examined by the operator.

The CDS Registry dump will identify the following information for each registered CDS:

• Handle - the numeric identifier used by an Application to access the contents of the CDS

• Size - the number of bytes allocated to the specified CDS

• Table Flag - a flag that indicates whether the CDS is associated with a Critical Tables (when non-zero) or not
(when equal to zero).

• Name - a processor specific name that uniquely identifies the CDS. The name comes in two parts, "AppName.←-
CDSName". AppName identifies which Application registered the CDS. CDSName is the name the Application
assigned to the CDS.

The format of the CDS Registry Dump File is a cFE Standard File header (see CFE_FS_Header_t) followed by one or
more CDS Registry Dump File Records (see CFE_ES_CDSRegDumpRec_t).

1.6.16 Memory Pool

Refer to the cFE Application Developers Guide for additional information.

Applications that are designed for generic missions, frequently have to wait until run-time before allocating memory for
buffers, data records, etc.

The cFE provides a memory allocation algorithm that may be used by an application to manage its block of memory.
The user provides a pointer to its memory block and a list of block sizes and the cFE provides 'get' and 'put' API's to the
user for managing its memory pool.

Run-time memory allocation in an embedded system can be risky because of the potential problem of memory frag-
mentation. Memory fragmentation is also referred to as External Fragmentation and is defined in the wikipedia as:

Generated by Doxygen
16

External fragmentation is the phenomenon in which free storage becomes divided

into many small pieces over time. It is a weakness of certain storage
allocation algorithms, occurring when an application allocates and deallocates
("frees") regions of storage of varying sizes, and the allocation algorithm
responds by leaving the allocated and deallocated regions interspersed. The
result is that, although free storage is available, it is effectively unusable
because it is divided into pieces that are too small to satisfy the demands of
the application. The term "external" refers to the fact that the unusable
storage is outside the allocated regions.

To help prevent this from happening, the cFE has integrated a memory allocation algorithm that is designed to create
blocks at run-time, based on the size of the blocks requested. After a reset, there are no blocks created, the memory
pool is said to be unconfigured. As requests for memory blocks are made, the memory pool first tries to use blocks that
have been created but are no longer in use. If it cannot find an available block, it will create a new one. The created
blocks remain until a reset occurs.

This algorithm is recommended when the size of the requests and the peak rate of requests can be pre-determined. It
is highly recommended that adequate margin is designed into the pool size. The memory pool should never get close
to being fully configured (i.e. not enough memory to create a new block). If the memory does become fully configured,
requests for new size blocks will fail, regardless of whether the created blocks are in-use or not. The margin on the
memory pool can be monitored by viewing the 'free bytes' member of the memory pool statistics. The memory pool
statistics are dumped only when commanded by way of the ES command CFE_ES_SEND_MEM_POOL_STATS_CC.

A user of the ES memory pool begins by tailoring the memory pool for the particular use, by defining a list of block sizes
and allocating a block of memory. These block size definitions simply give the memory pool a set of sizes to choose
from. They do not configure the memory pool in any way and they do not affect the size of the pool. The cFE defines a
default set of block sizes in the cfe_platform_cfg.h file.

If the default block sizes are used, the application will create the pool using the simpler CFE_ES_PoolCreate API. This
API takes a pointer to the first byte of the memory pool (allocated by the application) and a size parameter. The API
returns a handle to be used for the get and put requests.

If the defaults are not sufficient, the user must define the block sizes and use the CFE_ES_PoolCreateEx API.

After receiving a positive response from the PoolCreate API, the memory pool is ready to accept requests, but
at this point it is completely unconfigured (meaning there are no blocks created). The first valid request (via
CFE_ES_GetPoolBuf API) after creating the pool will always cause the memory pool to create a block and return a
pointer to the new block. The size of the block depends on the size definitions mentioned earlier. If there is not an exact
match between the requested and defined sizes, then the memory pool will create and return the smallest block that
meets the following criteria: is a defined size and large enough to hold the request.

If another request for that size comes in before the first block was released through the CFE_ES_PutPoolBuf A←-
PI, then the memory pool will create a second block of that size and return a pointer to the second block. If both
blocks were then released through the CFE_ES_PutPoolBuf API and the memory pool statistics were dumped via the
CFE_ES_SEND_MEM_POOL_STATS_CC command, the number of blocks created would be two. The number of 'free
bytes' in the pool would be the size of the pool minus the sum of the following items:

• the size of the two blocks created (even though they are not 'in-use').

• a buffer descriptor for each of the two blocks created (2 ∗ 12 bytes)

• a 168 byte pool descriptor Refer to the cFE Applications Developers Guide for more details.

Generated by Doxygen
1.6 cFE Executive Services Overview 17

This allocation algorithm does have its limits. There are certain conditions that can place the memory pool in an
undesired state. For instance, if a burst of get requests were received for the same block size, the memory pool may
create a large number of blocks of that size. If this is a one-time burst, the memory pool would be configured with
this large number of blocks that may no longer be needed. This scenario would use up the 'free bytes' margin in an
undesired way. It should be noted that once the blocks are created, they cannot be deleted by any means other than a
processor or power-on reset. It is highly recommended that the memory pool statistics be carefully monitored to ensure
that the 'free-bytes' margin is sufficient (which is typically dictated by mission requirements).

An operator can obtain information about an Application's Memory Pool by using the Telemeter Memory Pool Statistics Command.

This command will cause Executive Services to extract pertinent statistics from the data used to manage the Memory
Pool and telemeter them to the ground in the Memory Pool Statistics Telemetry Packet.

In order to obtain the statistics associated with a memory pool, the operator MUST have the correct Memory Handle
as reported by the Application who owns the Memory Pool. It should be noted that an inappropriate Memory Pool
Handle can (and likely will) cause the system software to crash! Within the cFE itself, there are three cFE Core
Applications that make use of the Executive Services Memory Pool API. These are Software Bus (SB), Event Services
(EVS) and Table Services (TBL). Each of these cFE Core Applications report their memory pool handles in telemetry.

The Memory Pool Statistics Telemetry Packet contains the following information:

• Memory Pool Handle - the handle, as provided by the operator in the Telemeter Memory Pool Statistics Command.
This repeating of the handle in telemetry ensures the operator knows which Memory Pool Statistics are being
viewed

• Pool Size - The total size of the memory pool (in bytes)

• Number Blocks Requested - The total number of memory blocks requested for allocation

• Number of Errors - The total number of errors encountered when a block was released

• Number of Free Bytes - The total number of bytes in the Memory Pool that have never been allocated to a
Memory Block

• Block Statistics - For each specified size of memory block (of which there are CFE_MISSION_ES_POOL_MAX_BUCKETS),
the following statistics are kept

– Block Size - The size, in bytes, of all blocks of this type

– Number of Blocks Allocated - The number of this sized block which are currently allocated and in use

– Number of Blocks Free - The number of this size block which have been in use previously but are no
longer being used

Generated by Doxygen
18

1.6.17 System Log

The System Log is an array of bytes that contains back-to-back printf type messages from applications. The cFE internal
applications use this log when errors are encountered during initialization before the Event Manager is fully initialized.
To view the information the CFE_ES_WRITE_SYS_LOG_CC command must be sent. This command will write the log
to a binary file. The path and filename may be specified in the command. If the filename command field contains an
empty string, the configuration parameter CFE_PLATFORM_ES_DEFAULT_SYSLOG_FILE is used to specify the path
and filename. Use the ground system to get the file and display the contents. The CFE_ES_CLEAR_SYS_LOG_CC is
used to clear the System log.

The size of the System log is defined by the platform configuration parameter CFE_PLATFORM_ES_SYSTEM_LOG_SIZE.
This log is preserved after a processor reset and held in the ES reset area.

A count of the number of entries in the log is present in the ES housekeeping telemetry.

1.6.18 Version Identification

Version information is reported at startup, and upon receipt of a No-op command

1.6.19 Frequently Asked Questions about Executive Services

None submitted

1.7 cFE Executive Services Commands

Upon receipt of any command, the Executive Services application will confirm that the message length embedded within
the header (from CFE_MSG_GetSize()) matches the expected length of that message, based on the size of the C
structure defining that command. If there is any discrepancy between the expected and actual message size, ES will
generate the CFE_ES_LEN_ERR_EID event, increment the command error counter ($sc_$cpu_ES_CMDEC), and the
command will not be accepted for processing.

The following is a list of commands that are processed by the cFE Executive Services Task.

Global CFE_ES_CLEAR_ER_LOG_CC
Clears the contents of the Exception and Reset Log

Global CFE_ES_CLEAR_SYS_LOG_CC
Clear Executive Services System Log

Global CFE_ES_DELETE_CDS_CC
Delete Critical Data Store

Global CFE_ES_DUMP_CDS_REGISTRY_CC
Dump Critical Data Store Registry to a File

Global CFE_ES_NOOP_CC
Executive Services No-Op

Generated by Doxygen
1.7 cFE Executive Services Commands 19

Global CFE_ES_OVER_WRITE_SYS_LOG_CC
Set Executive Services System Log Mode to Discard/Overwrite

Global CFE_ES_QUERY_ALL_CC
Writes all Executive Services Information on all loaded modules to a File

Global CFE_ES_QUERY_ALL_TASKS_CC
Writes a list of All Executive Services Tasks to a File

Global CFE_ES_QUERY_ONE_CC
Request Executive Services Information on a specified module

Global CFE_ES_RELOAD_APP_CC
Stops, Unloads, Loads from the command specified File and Restarts an Application

Global CFE_ES_RESET_COUNTERS_CC
Executive Services Reset Counters

Global CFE_ES_RESET_PR_COUNT_CC
Resets the Processor Reset Counter to Zero

Global CFE_ES_RESTART_APP_CC
Stops, Unloads, Loads using the previous File name, and Restarts an Application

Global CFE_ES_RESTART_CC
Executive Services Processor / Power-On Reset

Global CFE_ES_SEND_MEM_POOL_STATS_CC
Telemeter Memory Pool Statistics

Global CFE_ES_SET_MAX_PR_COUNT_CC
Configure the Maximum Number of Processor Resets before a Power-On Reset

Global CFE_ES_SET_PERF_FILTER_MASK_CC
Set Performance Analyzer's Filter Masks

Global CFE_ES_SET_PERF_TRIGGER_MASK_CC
Set Performance Analyzer's Trigger Masks

Global CFE_ES_START_APP_CC
Load and Start an Application

Global CFE_ES_START_PERF_DATA_CC
Start Performance Analyzer

Global CFE_ES_STOP_APP_CC
Stop and Unload Application

Global CFE_ES_STOP_PERF_DATA_CC
Stop Performance Analyzer and write data file

Global CFE_ES_WRITE_ER_LOG_CC
Writes Exception and Reset Log to a File

Global CFE_ES_WRITE_SYS_LOG_CC
Writes contents of Executive Services System Log to a File

Generated by Doxygen
20

1.8 cFE Executive Services Telemetry

The following are telemetry packets generated by the cFE Executive Services Task.

Global CFE_ES_HousekeepingTlm_Payload_t
Executive Services Housekeeping Packet
Global CFE_ES_HousekeepingTlm_Payload_t
Executive Services Housekeeping Packet
Global CFE_ES_HousekeepingTlm_t
Executive Services Housekeeping Packet
Global CFE_ES_HousekeepingTlm_t
Executive Services Housekeeping Packet

Global CFE_ES_MemStatsTlm_t
Memory Pool Statistics Packet

Global CFE_ES_MemStatsTlm_t
Memory Pool Statistics Packet
Global CFE_ES_OneAppTlm_Payload_t
Single Application Information Packet
Global CFE_ES_OneAppTlm_Payload_t
Single Application Information Packet
Global CFE_ES_OneAppTlm_t
Single Application Information Packet
Global CFE_ES_OneAppTlm_t
Single Application Information Packet
Global CFE_ES_PoolStatsTlm_Payload_t
Memory Pool Statistics Packet
Global CFE_ES_PoolStatsTlm_Payload_t
Memory Pool Statistics Packet

1.9 cFE Executive Services Configuration Parameters

The following are configuration parameters used to configure the cFE Executive Services either for each platform or for
a mission as a whole.

Global CFE_MISSION_ES_CDS_MAX_FULL_NAME_LEN
Maximum Length of Full CDS Name in messages
Maximum Length of Full CDS Name in messages

Global CFE_MISSION_ES_CDS_MAX_NAME_LENGTH
Maximum Length of CDS Name
Maximum Length of CDS Name

Generated by Doxygen
1.9 cFE Executive Services Configuration Parameters 21

Global CFE_MISSION_ES_DEFAULT_CRC
Mission Default CRC algorithm
Mission Default CRC algorithm

Global CFE_MISSION_ES_MAX_APPLICATIONS
Mission Max Apps in a message
Mission Max Apps in a message

Global CFE_MISSION_ES_PERF_MAX_IDS
Define Max Number of Performance IDs for messages
Define Max Number of Performance IDs for messages

Global CFE_MISSION_ES_POOL_MAX_BUCKETS
Maximum number of block sizes in pool structures
Maximum number of block sizes in pool structures

Global CFE_PLATFORM_CORE_MAX_STARTUP_MSEC
CFE core application startup timeout

Global CFE_PLATFORM_ES_APP_KILL_TIMEOUT
Define ES Application Kill Timeout
Define ES Application Kill Timeout

Global CFE_PLATFORM_ES_APP_SCAN_RATE
Define ES Application Control Scan Rate
Define ES Application Control Scan Rate

Global CFE_PLATFORM_ES_CDS_MAX_NUM_ENTRIES
Define Maximum Number of Registered CDS Blocks
Define Maximum Number of Registered CDS Blocks

Global CFE_PLATFORM_ES_CDS_MEM_BLOCK_SIZE_01
Define ES Critical Data Store Memory Pool Block Sizes
Define ES Critical Data Store Memory Pool Block Sizes

Global CFE_PLATFORM_ES_CDS_SIZE
Define Critical Data Store Size
Define Critical Data Store Size

Global CFE_PLATFORM_ES_DEFAULT_APP_LOG_FILE
Default Application Information Filename
Default Application Information Filename

Global CFE_PLATFORM_ES_DEFAULT_CDS_REG_DUMP_FILE
Default Critical Data Store Registry Filename
Default Critical Data Store Registry Filename

Global CFE_PLATFORM_ES_DEFAULT_ER_LOG_FILE
Default Exception and Reset (ER) Log Filename
Default Exception and Reset (ER) Log Filename

Global CFE_PLATFORM_ES_DEFAULT_PERF_DUMP_FILENAME
Default Performance Data Filename
Default Performance Data Filename

Generated by Doxygen
22

Global CFE_PLATFORM_ES_DEFAULT_POR_SYSLOG_MODE
Define Default System Log Mode following Power On Reset
Define Default System Log Mode following Power On Reset
Global CFE_PLATFORM_ES_DEFAULT_PR_SYSLOG_MODE
Define Default System Log Mode following Processor Reset
Define Default System Log Mode following Processor Reset
Global CFE_PLATFORM_ES_DEFAULT_STACK_SIZE
Define Default Stack Size for an Application
Define Default Stack Size for an Application
Global CFE_PLATFORM_ES_DEFAULT_SYSLOG_FILE
Default System Log Filename
Default System Log Filename
Global CFE_PLATFORM_ES_DEFAULT_TASK_LOG_FILE
Default Application Information Filename
Default Application Information Filename
Global CFE_PLATFORM_ES_ER_LOG_ENTRIES
Define Max Number of ER (Exception and Reset) log entries
Define Max Number of ER (Exception and Reset) log entries
Global CFE_PLATFORM_ES_ER_LOG_MAX_CONTEXT_SIZE
Maximum size of CPU Context in ES Error Log
Maximum size of CPU Context in ES Error Log
Global CFE_PLATFORM_ES_MAX_APPLICATIONS
Define Max Number of Applications
Define Max Number of Applications
Global CFE_PLATFORM_ES_MAX_GEN_COUNTERS
Define Max Number of Generic Counters
Define Max Number of Generic Counters
Global CFE_PLATFORM_ES_MAX_LIBRARIES
Define Max Number of Shared libraries
Define Max Number of Shared libraries
Global CFE_PLATFORM_ES_MAX_MEMORY_POOLS
Maximum number of memory pools
Maximum number of memory pools
Global CFE_PLATFORM_ES_MAX_PROCESSOR_RESETS
Define Number of Processor Resets Before a Power On Reset
Define Number of Processor Resets Before a Power On Reset
Global CFE_PLATFORM_ES_MEM_BLOCK_SIZE_01
Define Default ES Memory Pool Block Sizes
Define Default ES Memory Pool Block Sizes
Global CFE_PLATFORM_ES_MEMPOOL_ALIGN_SIZE_MIN
Define Memory Pool Alignment Size
Define Memory Pool Alignment Size

Generated by Doxygen
1.9 cFE Executive Services Configuration Parameters 23

Global CFE_PLATFORM_ES_NONVOL_DISK_MOUNT_STRING
Default virtual path for persistent storage
Default virtual path for persistent storage
Global CFE_PLATFORM_ES_NONVOL_STARTUP_FILE
ES Nonvolatile Startup Filename
ES Nonvolatile Startup Filename
Global CFE_PLATFORM_ES_OBJECT_TABLE_SIZE
Define Number of entries in the ES Object table
Define Number of entries in the ES Object table
Global CFE_PLATFORM_ES_PERF_CHILD_MS_DELAY
Define Performance Analyzer Child Task Delay
Define Performance Analyzer Child Task Delay
Global CFE_PLATFORM_ES_PERF_CHILD_PRIORITY
Define Performance Analyzer Child Task Priority
Define Performance Analyzer Child Task Priority
Global CFE_PLATFORM_ES_PERF_CHILD_STACK_SIZE
Define Performance Analyzer Child Task Stack Size
Define Performance Analyzer Child Task Stack Size
Global CFE_PLATFORM_ES_PERF_DATA_BUFFER_SIZE
Define Max Size of Performance Data Buffer
Define Max Size of Performance Data Buffer
Global CFE_PLATFORM_ES_PERF_ENTRIES_BTWN_DLYS
Define Performance Analyzer Child Task Number of Entries Between Delay
Define Performance Analyzer Child Task Number of Entries Between Delay
Global CFE_PLATFORM_ES_PERF_FILTMASK_ALL
Define Filter Mask Setting for Enabling All Performance Entries
Define Filter Mask Setting for Enabling All Performance Entries
Global CFE_PLATFORM_ES_PERF_FILTMASK_INIT
Define Default Filter Mask Setting for Performance Data Buffer
Define Default Filter Mask Setting for Performance Data Buffer
Global CFE_PLATFORM_ES_PERF_FILTMASK_NONE
Define Filter Mask Setting for Disabling All Performance Entries
Define Filter Mask Setting for Disabling All Performance Entries
Global CFE_PLATFORM_ES_PERF_TRIGMASK_ALL
Define Filter Trigger Setting for Enabling All Performance Entries
Define Filter Trigger Setting for Enabling All Performance Entries
Global CFE_PLATFORM_ES_PERF_TRIGMASK_INIT
Define Default Filter Trigger Setting for Performance Data Buffer
Define Default Filter Trigger Setting for Performance Data Buffer
Global CFE_PLATFORM_ES_PERF_TRIGMASK_NONE
Define Default Filter Trigger Setting for Disabling All Performance Entries
Define Default Filter Trigger Setting for Disabling All Performance Entries

Generated by Doxygen
24

Global CFE_PLATFORM_ES_POOL_MAX_BUCKETS
Maximum number of block sizes in pool structures
Maximum number of block sizes in pool structures
Global CFE_PLATFORM_ES_RAM_DISK_MOUNT_STRING
Default virtual path for volatile storage
Default virtual path for volatile storage
Global CFE_PLATFORM_ES_RAM_DISK_NUM_SECTORS
ES Ram Disk Number of Sectors
ES Ram Disk Number of Sectors
Global CFE_PLATFORM_ES_RAM_DISK_PERCENT_RESERVED
Percentage of Ram Disk Reserved for Decompressing Apps
Percentage of Ram Disk Reserved for Decompressing Apps
Global CFE_PLATFORM_ES_RAM_DISK_SECTOR_SIZE
ES Ram Disk Sector Size
ES Ram Disk Sector Size
Global CFE_PLATFORM_ES_START_TASK_PRIORITY
Define ES Task Priority
Define ES Task Priority
Global CFE_PLATFORM_ES_START_TASK_STACK_SIZE
Define ES Task Stack Size
Define ES Task Stack Size
Global CFE_PLATFORM_ES_STARTUP_SCRIPT_TIMEOUT_MSEC
Startup script timeout
Startup script timeout
Global CFE_PLATFORM_ES_STARTUP_SYNC_POLL_MSEC
Poll timer for startup sync delay
Poll timer for startup sync delay
Global CFE_PLATFORM_ES_SYSTEM_LOG_SIZE
Define Size of the cFE System Log.
Define Size of the cFE System Log.
Global CFE_PLATFORM_ES_USER_RESERVED_SIZE
Define User Reserved Memory Size
Define User Reserved Memory Size
Global CFE_PLATFORM_ES_VOLATILE_STARTUP_FILE
ES Volatile Startup Filename
ES Volatile Startup Filename
Global CFE_PLATFORM_EVS_START_TASK_PRIORITY
Define EVS Task Priority
Define EVS Task Priority
Global CFE_PLATFORM_EVS_START_TASK_STACK_SIZE
Define EVS Task Stack Size
Define EVS Task Stack Size

Generated by Doxygen
1.10 cFE Event Services Overview 25

Global CFE_PLATFORM_SB_MEM_BLOCK_SIZE_01
Define SB Memory Pool Block Sizes
Define SB Memory Pool Block Sizes
Global CFE_PLATFORM_SB_START_TASK_PRIORITY
Define SB Task Priority
Define SB Task Priority
Global CFE_PLATFORM_SB_START_TASK_STACK_SIZE
Define SB Task Stack Size
Define SB Task Stack Size
Global CFE_PLATFORM_TBL_START_TASK_PRIORITY
Define TBL Task Priority
Define TBL Task Priority
Global CFE_PLATFORM_TBL_START_TASK_STACK_SIZE
Define TBL Task Stack Size
Define TBL Task Stack Size

1.10 cFE Event Services Overview

Event Services (EVS) provides centralized control for the processing of event messages originating from the EVS
task itself, other cFE core applications (ES, SB, TIME, and TBL), and from cFE applications. Event messages are
asynchronous messages that are used to inform the operator of a significant event from within the context of a registered
application or core service. EVS provides various ways to filter event messages in order to manage event message
generation.

Note for messages outside the context of a registered application (for example early in app initialization or if registration
fails) CFE_ES_WriteToSysLog can be used for reporting.

For more information on cFE Event Services, see the following sections:

• Event Message Format

• Local Event Log

• Event Message Control

• Event Message Filtering

• EVS Registry

• EVS Counters

• Resetting EVS Counters

Generated by Doxygen
26

• Effects of a Processor Reset on EVS

• EVS squelching of misbehaving apps

• Frequently Asked Questions about Event Services

1.10.1 Event Message Format

Event messages are software bus messages that contain the following fields:

• Timestamp

• Event Type

• Spacecraft ID

• Processor ID

• Application Name

• Event ID

• Message

The Timestamp corresponds to when the event was generated, in spacecraft time. The Event Type is one of the
following: DEBUG, INFO, ERROR or CRITICAL. The Spacecraft ID and Processor ID identify the spacecraft and pro-
cessor from which the event was generated. Note that the Spacecraft ID is defined in the cfe_mission_cfg.h file; The
Processor ID is defined in the appropriate cfe_platform_cfg.h file. The Application Name refers to the Application that
issued the event message as specified on application startup (either startup script or app start command). The Event
ID is an Application unique number that identifies the event. The Message is an ASCII text string describing the event.
Event messages may have parameters associated with the event message. EVS formats the parameters such that they
are part of the ASCII text string that make up the event message.

In order to accommodate missions that have limited telemetry bandwidth, EVS can be configured such that the ASCII
text string part of the event message is omitted, thus reducing the size of each event message. This is referred to as
Short Format; Event messages including the ASCII text string are referred to as Long Format. The default setting is
specified in the cfe_platform_cfg.h file. EVS also provides commands in order to set the mode (short or long).

Since the design of the cFE's Software Bus is based on run-time registration, no predetermined message routing is
defined, hence it is not truly correct to say that events are generated as telemetry. Technically, EVS generates events
in the form of software bus messages. Applications such as Telemetry Output and Data Storage can then subscribe to
these messages making them telemetry. For the purposes of this document, any references to telemetry assumes that
a telemetry application subscribes to the EVS event software bus message and routes it to the ground as telemetry.

Generated by Doxygen
1.10 cFE Event Services Overview 27

Note that short format event messages on the Software Bus have different message lengths than long form messages
and do not include any part of the long format message string.

The EVS can be configured via ground command to send event messages out one or more message ports. These
message ports may include ports such as debug, console, and UART. Messages sent out of the message ports will be
in ASCII text format. This is generally used for lab purposes. Note that the event mode (short or long) does affect the
event message content sent out these message ports.

1.10.2 Local Event Log

In addition to generating a software bus message, EVS logs the event message to a Local Event Log. Note that this is an
optional feature that must be enabled via the cfe_platform_cfg.h file. The Local Event Log resides on the same processor
as the EVS which is used to store events without relying on an external bus. In multi-processor cFE configurations the
Local Event Buffer preserves event messages during non-deterministic processor initialization sequences and during
failure scenarios. In order to obtain the contents of the Local Event Log, a command must be sent to write the contents
of the buffer to a file which can then be sent to the ground via a file transfer mechanism. Note that event messages
stored in the EVS Local Event Log are always long format messages and are not affected by the event mode (short or
long).

EVS provides a command in order to clear the Local Event Log .

1.10.2.1 Local Event Log Mode EVS can be configured to control the Local Event Log to either discard or overwrite
the contents of the log when it becomes full. If the mode is set to overwrite, the log is treated like a circular buffer,
overwriting the oldest event message contained in the log first. This control is configured by default in the cfe_←-
platform_cfg.h file but can be modified by a command .

1.10.3 Event Message Control

In order for an application to be serviced by EVS, it must be registered with EVS. EVS provides various commands in
order to control the event messages that are generated as software bus messages.

1.10.3.1 Event Message Control - By Type The highest level of event message control that EVS provides is the
ability to enable and disable event message types. As mentioned above, there are four event types. They are:

1. DEBUG

2. INFORMATION

3. ERROR

4. CRITICAL

When commands are sent to enable or disable a particular type of event message, ALL event messages of the spec-
ified type are affected. Typically, event messages of type DEBUG are disabled on-orbit. Note that EVS provides the
capability to affect multiple types within one command using a bit mask. Note also that the configuration parameter
CFE_PLATFORM_EVS_DEFAULT_TYPE_FLAG in the cfe_platform_cfg.h file specifies which event message types
are enabled/disabled by default.

Generated by Doxygen
28

1.10.3.2 Event Message Control - By Application Commands are available to enable and disable the generation
of event messages for a particular application. The result is that ALL event messages for the specified Application are
affected (i.e. enabled or disabled).

1.10.3.3 Event Message Control - By Event Type for an Application EVS also provides the capability to enable
/ disable an event type for a particular application. Note that EVS provides the capability to affect multiple event types
within one command using a bit mask.

1.10.3.4 Event Message Control - Individual Events There are two ways to control the generation of individual
events depending on whether the application's event message has been registered with EVS or not.

1.10.3.4.1 Modifying a registered event message filter When an application registers with EVS, the application
has the option of specifying the events that it wants to register for filtering along with the Event Message Filtering
(only the Binary Filtering Scheme exists currently). Note that applications are limited in the number of events that
they can register for filtering (see CFE_PLATFORM_EVS_MAX_EVENT_FILTERS in cfe_platform_cfg.h for the mis-
sion defined limit). The filtering method uses a mask to determine if the message is forwarded to the software bus,
making it available in telemetry (see Event Message Filtering for a description on filtering). Commands are available to
modify the filter mask for any registered event.
An on-orbit mission, for example, might be experiencing a problem resulting in an application's event message being re-
peatedly issued, flooding the downlink. If the event message for the application is registered with EVS, then a command
can be issued to set the event message filter to the specified value in order to prevent flooding of the downlink.

1.10.3.4.2 Adding/Removing an event message for filtering Commands are also available to add filtering for those
events that are not registered for filtering. Once an event is registered for filtering , the filter can be modified (see above)
or removed .
An on-orbit mission, for example, might be experiencing a problem resulting in an event message being repeatedly
issued, flooding the downlink. If the event message was not registered with EVS for filtering then the ground can add (i.e.
register) the offending application's event for filtering (much like an application registers the event during initialization).
EVS also supports the ability to remove (i.e. unregister) an application's event message. Once it is removed, the event
will no longer be filtered. Note that commands issued to disable events by event type, by application or by event type for
an application are still valid and could affect this particular event.

1.10.4 Event Message Filtering

EVS uses a hexadecimal bit mask that controls how often a message is filtered. An event's filter mask is bit-wise ANDed
with the event's event counter. There is one event counter for each event ID. If the result of the ANDing is zero then the
message is sent.
Filter masks can be set so that one out of 1, 2, 4, 8 events are sent. Some examples of masks that use this pattern are:
(0x0000, Every one), (0x0001, One of every 2), (0x0003, One of every 4), and (0x0007, One of every 8.
Filter masks can also be set so that only the first n events are sent. For example, the mask 0xFFFF generates one event
message and then stops. Note that when the filter counter is reset to zero by command, this will restart the counting
and enable n more events to be sent.
Event messages will be filtered until CFE_EVS_MAX_FILTER_COUNT events of the filtered event ID from the applica-
tion have been received. After this, the filtering will become locked (no more of that event will be received by the ground)
until the filter is either reset or deleted by ground command. This is to prevent the counter from rolling over, which would
cause some filters to behave improperly. An event message will be sent when this maximum count is reached.
The following shows an example of how filtering works using a filter mask of x'0001', resulting in sending every other
event:

Generated by Doxygen
1.10 cFE Event Services Overview 29

packet x packet X+1 packet X+2 packet X+3 packet X+4 ...
Event ID counter x'0000' x'0001' x'0002' x'0003' x'0004'
Event Filter mask x'0001' x'0001' x'0001' x'0001' x'0001'
Bitwise AND results x'0000' x'0001' x'0000' x'0001' x'0000'
Send event? Yes No Yes No Yes

In this example, the ground uses a filter mask of x'FFFE' resulting in the first two events being sent and then no more.

packet x packet X+1 packet X+2 packet X+3 packet X+4 ...
Event ID counter x'0000' x'0001' x'0002' x'0003' x'0004'
Event Filter mask x'FFFE' x'FFFE' x'FFFE' x'FFFE' x'FFFE'
Bitwise AND results x'0000' x'0000' x'0002' x'0002' x'0004'
Send event? Yes Yes No No No

See cfe_evs.h for predefined macro values which can be used for masks.

1.10.5 EVS Registry

EVS maintains information on each registered application and all events registered for an application.

The registry contains the following information for each Registered Application:

• Active Flag - If equal to FALSE (0), all events from this Application are Filtered

• Event Count - Total number of events issued by this Application. Note that this value stop incrementing at 65535.

The following information for each Filtered Event (up to CFE_PLATFORM_EVS_MAX_EVENT_FILTERS)←-

:

• Event ID - Event ID for event whose filter has been defined

• Mask - Binary Filter mask value (see Event Message Filtering for an explanation)

• Count - Current number of times this Event ID has been issued by this Application

1.10.6 EVS Counters

There are 2 types of counters in EVS housekeeping telemetry:

• Total events sent counter

Generated by Doxygen
30

• Number of events sent for each Application

The difference is that the first one is the sum of all of the event messages sent. Both of these represent events that are
actually sent (by EVS to the software bus). If an event message is filtered or disabled, neither counter is incremented.

There are other counters available that show how many event messages were generated by an App, however, these
are only available for those events that are registered for filtering hence if you have a message that is not registered
for filtering and the message type (e.g. DEBUG) is disabled then you won't know if the event was ever issued by an
application. These counters are available by sending a command to write the EVS Application Data and transferring
the file to the ground.

1.10.7 Resetting EVS Counters

As far as reset commands, there are 4 commands available:

1. Reset the total events sent counter

2. Reset the events sent counter for a particular Application - e.g. reset the LC application events counter

3. Reset all of the event counters for a particular registered event for a particular Application - e.g. Reset event
counter for Event ID 5 for the LC Application.

4. Reset all of the event counters for ALL registered events for a particular App - e.g. Reset all registered event
counters for LC.

Note that there is currently no way to reset ALL of the events sent counters for all of the Apps with one command.

1.10.8 Effects of a Processor Reset on EVS

On a processor reset, the EVS Registry is cleared such that applications must re-register with EVS in order to use EVS
services. All counters are also cleared with the exceptions of those listed below.

On a processor reset, the following EVS data is preserved (if the cFE is configured to include an Local Event Log):

• Local Event Log if the Local Event Log Mode is configured to Discard (1). If the Local Event Log Mode is
configured to Overwrite (0), the contents of the log may be overwritten depending on the size and contents of the
log prior to the reset.

• Local Event Log Full Flag

• Local Event Log overflow counter

The Local Event Log Mode (overwrite/discard) is set to the configured value specified in the cfe_platform_cfg.h file. The
default value is Discard (1). Discard mode will guarantee the contents of the event log are preserved over a processor
restart.

This provides the ground with the capability to write the Local Event Log to a file and transfer it to the ground in order to
help debug a reset.

Generated by Doxygen
1.10 cFE Event Services Overview 31

1.10.9 EVS squelching of misbehaving apps

Event squelching is an optional feature for suppressing excessive events from misbehaving apps. It is
enabled by setting CFE_PLATFORM_EVS_MAX_APP_EVENT_BURST to a nonzero positive value, and
CFE_PLATFORM_EVS_APP_EVENTS_PER_SEC equal to or less than that value.

CFE_PLATFORM_EVS_MAX_APP_EVENT_BURST controls the maximum events that can be sent at a given moment,
and CFE_PLATFORM_EVS_APP_EVENTS_PER_SEC is the sustained event throughput per second.

The suppression mechanism initializes with CFE_PLATFORM_EVS_MAX_APP_EVENT_BURST ∗ 1000 credits. Each

event costs 1000 credits. Credits are restored at a rate of CFE_PLATFORM_EVS_APP_EVENTS_PER_SEC ∗ 1000
up to a maximum balance of CFE_PLATFORM_EVS_MAX_APP_EVENT_BURST∗1000, and the maximum "debt" is
-CFE_PLATFORM_EVS_MAX_APP_EVENT_BURST ∗ 1000. When the credit count crosses from positive to negative,
a squelched event message is emitted and events are supppressed, until the credit count becomes positive again.

Figure EVS-1 is a notional state diagram of the event squelching mechanism.

Figure 1 Figure EVS-1: EVS Squelching State Diagram

1.10.10 Frequently Asked Questions about Event Services

(Q) My telemetry stream is being flooded with the same event message. How do I make it stop?

The most direct way to stop an event message from flooding your downlink stream is to send a command to EVS
to filter the offending event (see Event Message Control or $sc_$cpu_EVS_SetBinFltrMask ). In order to stop the event

Generated by Doxygen
32

message from being sent, a bit mask of '0xFFFF' should be used. If the event is not currently registered for filtering,
the event message must be added using the command $sc_$cpu_EVS_AddEvtFltr .

(Q) I filtered an event message and would now like to see it again. What do I do in order to see those events
again?

If the event message that you are interested is registered with EVS for filtering, then you have 2 options:

1. You can use the $sc_$cpu_EVS_SetBinFltrMask command using a bit mask of '0x0000' which will result in
getting all of the events for that Event Id

2. You can remove the registration of that event with EVS (see $sc_$cpu_EVS_DelEvtFltr ).
Note that option (1) is the preferred method.

(Q) What is the purpose of DEBUG event messages?

Event message of type "DEBUG" are primarily used during flight software development in order to provide infor-
mation that is most likely not needed on orbit. Some commands send debug event messages as verification that a
command request was received. When writing the EVS local event log to a file, for example, an event message of type
DEBUG is issued. On orbit, this event message is probably not needed. Instead, the command counter is used for
command verification.

(Q) How do I find out which events are registered for filtering?

EVS provides a command ($sc_$cpu_EVS_WriteAppData2File ) which generates a file containing all of the appli-
cations that have registered with EVS and all of the filters that are registered for each application. Note that EVS merely
generates the file. The file must be transferred to the ground in order to view it.

(Q) Why do I see event messages in my console window?

By default, the events are configured to transmit out a "port" that shows event messages in the console

(Q) What is the difference between event services and the ES System Log

Events are within the context of an App or cFE Service (requires registration with ES). The system log can be
written to outside of the Application or cFE Service context, for example during application startup to report errors
before registration.

1.11 cFE Event Services Commands

Upon receipt of any command, the Event Services application will confirm that the message length embedded within
the header (from CFE_MSG_GetSize()) matches the expected length of that message, based on the size of the C
structure defining that command. If there is any discrepancy between the expected and actual message size, EVS will
generate the CFE_EVS_LEN_ERR_EID event, increment the command error counter ($sc_$cpu_EVS_CMDEC), and
the command will not be accepted for processing.

The following is a list of commands that are processed by the cFE Event Services Task.

Global CFE_EVS_ADD_EVENT_FILTER_CC
Add Application Event Filter

Generated by Doxygen
1.11 cFE Event Services Commands 33

Global CFE_EVS_CLEAR_LOG_CC
Clear Event Log

Global CFE_EVS_DELETE_EVENT_FILTER_CC
Delete Application Event Filter

Global CFE_EVS_DISABLE_APP_EVENT_TYPE_CC
Disable Application Event Type

Global CFE_EVS_DISABLE_APP_EVENTS_CC
Disable Event Services for an Application

Global CFE_EVS_DISABLE_EVENT_TYPE_CC
Disable Event Type

Global CFE_EVS_DISABLE_PORTS_CC
Disable Event Services Output Ports

Global CFE_EVS_ENABLE_APP_EVENT_TYPE_CC
Enable Application Event Type

Global CFE_EVS_ENABLE_APP_EVENTS_CC
Enable Event Services for an Application

Global CFE_EVS_ENABLE_EVENT_TYPE_CC
Enable Event Type

Global CFE_EVS_ENABLE_PORTS_CC
Enable Event Services Output Ports

Global CFE_EVS_NOOP_CC
Event Services No-Op

Global CFE_EVS_RESET_ALL_FILTERS_CC
Reset All Event Filters for an Application

Global CFE_EVS_RESET_APP_COUNTER_CC
Reset Application Event Counters

Global CFE_EVS_RESET_COUNTERS_CC
Event Services Reset Counters

Global CFE_EVS_RESET_FILTER_CC
Reset an Event Filter for an Application

Global CFE_EVS_SET_EVENT_FORMAT_MODE_CC
Set Event Format Mode

Global CFE_EVS_SET_FILTER_CC
Set Application Event Filter

Global CFE_EVS_SET_LOG_MODE_CC
Set Logging Mode

Global CFE_EVS_WRITE_APP_DATA_FILE_CC
Write Event Services Application Information to File

Global CFE_EVS_WRITE_LOG_DATA_FILE_CC
Write Event Log to File

Generated by Doxygen
34

1.12 cFE Event Services Telemetry

The following are telemetry packets generated by the cFE Event Services Task.

Global CFE_EVS_HousekeepingTlm_Payload_t
Event Services Housekeeping Telemetry Packet
Global CFE_EVS_HousekeepingTlm_Payload_t
Event Services Housekeeping Telemetry Packet
Global CFE_EVS_LongEventTlm_Payload_t
Event Message Telemetry Packet (Long format)
Global CFE_EVS_LongEventTlm_Payload_t
Event Message Telemetry Packet (Long format)
Global CFE_EVS_ShortEventTlm_Payload_t
Event Message Telemetry Packet (Short format)
Global CFE_EVS_ShortEventTlm_Payload_t
Event Message Telemetry Packet (Short format)

1.13 cFE Event Services Configuration Parameters

The following are configuration parameters used to configure the cFE Event Services either for each platform or for a
mission as a whole.

Global CFE_MISSION_EVS_MAX_MESSAGE_LENGTH
Maximum Event Message Length
Maximum Event Message Length

Global CFE_PLATFORM_EVS_APP_EVENTS_PER_SEC
Sustained number of event messages per second per app before squelching
Sustained number of event messages per second per app before squelching

Global CFE_PLATFORM_EVS_DEFAULT_APP_DATA_FILE
Default EVS Application Data Filename
Default EVS Application Data Filename

Global CFE_PLATFORM_EVS_DEFAULT_LOG_FILE
Default Event Log Filename
Default Event Log Filename

Global CFE_PLATFORM_EVS_DEFAULT_LOG_MODE
Default EVS Local Event Log Mode
Default EVS Local Event Log Mode

Global CFE_PLATFORM_EVS_DEFAULT_MSG_FORMAT_MODE
Default EVS Message Format Mode
Default EVS Message Format Mode

Generated by Doxygen
1.14 cFE Software Bus Overview 35

Global CFE_PLATFORM_EVS_DEFAULT_TYPE_FLAG
Default EVS Event Type Filter Mask
Default EVS Event Type Filter Mask

Global CFE_PLATFORM_EVS_LOG_MAX
Maximum Number of Events in EVS Local Event Log
Maximum Number of Events in EVS Local Event Log

Global CFE_PLATFORM_EVS_MAX_APP_EVENT_BURST
Maximum number of event before squelching
Maximum number of event before squelching

Global CFE_PLATFORM_EVS_MAX_EVENT_FILTERS
Define Maximum Number of Event Filters per Application
Define Maximum Number of Event Filters per Application

Global CFE_PLATFORM_EVS_PORT_DEFAULT
Default EVS Output Port State
Default EVS Output Port State

1.14 cFE Software Bus Overview

The Software Bus (SB) handles communication between software tasks on a processor. All tasks communicate with
each other, with hardware devices, and with the ground by sending command and telemetry messages. The software
bus provides an application programming interface (API) to other tasks for sending and receiving messages. This API is
independent of the underlying operating system so that tasks can use the same interface regardless of which processor
they reside on. Refer to the cFE Application Programmer's Interface (API) Reference for detailed information about the
API functions.

The software bus is used internally by the flight software, and normally does not require attention from the ground.
However, because of the scalability and the dynamic nature of the software bus, it is strongly recommended that each
project carefully review the SB statistics and SB memory pool to be sure adequate margin is met on the configurable
items.

The cFE software bus uses a dynamic protocol and builds its routing table at run-time through the SB subscribe API's.
Also the cFE software bus pipes are created at run-time through the CFE_SB_CreatePipe API. Because the routing is
established, and pipes are created at run-time, it is necessary to have a clear view of the routing details on command.
The cFE software bus allows the user to dump the routing table, the pipe table, the message map and the statistics
packet. Each of these items are described in detail in the corresponding section of this document.

• Software Bus Terminology

• Autonomous Actions

• Operation of the SB Software

• Frequently Asked Questions about Software Bus

Generated by Doxygen
36

1.14.1 Software Bus Terminology

In order to fully understand the Software Bus, it is imperative that the basic terms used to describe its features are also
understood. Below are the critical terms that help identify what the Software Bus accomplishes for each Application:

• Messages

• Pipes

• Subscriptions

• Memory

1.14.1.1 Messages The sole purpose of the software bus is to provide applications a way to send messages to each
other. The term message and the term packet are used interchangeably throughout this document. A message is a
combined set of bytes with a predefined format that is used as the basis of communication on a spacecraft. All com-
mands, telemetry, and other data that are passed between the ground and the spacecraft, and between subsystems
of the spacecraft, are considered to be messages. The most common message format is CCSDS (Consultative Com-
mittee for Space Data Systems) in CCSDS Space Packet Protocol, but can be customized by replacing the
message module.

There are two general types of messages - commands (or command packets) and telemetry (or telemetry packets).
Command packets are sent to a particular software task from the ground (or another task). Telemetry packets are sent
from a particular software task to the ground (or other tasks).

The concept of a message identifier is utilized to provide abstraction from header implementation, often abbreviated as
message ID, MsgId, or MID. Header and message identifier values should not be accessed directly to avoid implemen-
tation specific dependencies.

Telemetry packets typically contain a timestamp that indicates when the packet was produced. Command packets
typically contain a command code that identifies the particular type of command.

The message module provides APIs for 'setting' and 'getting' the fields in the header of the message. The message
module was separated from software bus to enable users to customize message headers without requiring clone and
own of the entire cfe repository. To customize, remove the built in msg module from the build and replace with custom
implementation. See sample target definitions folder for examples.

Following the header is the user defined message data.

1.14.1.2 Pipes The destinations to which messages are sent are called pipes. These are queues that can hold mes-
sages until they are read out and processed by a task. Each pipe is created at run-time through the CFE_SB_CreatePipe
API. The pipe name and the pipe depth are given as arguments in the API. The pipe identifier (or PipeId) is given back
to the caller after the API is executed. Each pipe can be read by only one task, but a task may read more than one pipe.
Only the pipe owner is allowed to subscribe to messages on the pipe.

The Pipe IDs are specific to a particular processor (that is, the same ID number may refer to a different pipe on
each processor). The pipe information for all pipes that have been created, may be requested at anytime by send-
ing the 'Write Pipe Info' SB command . The software bus also provides a set of figures regarding capacity, current
utilization and high water marks relevant to pipes. This information may be requested by sending the command to
dump the SB statistics packet .

Generated by Doxygen
1.14 cFE Software Bus Overview 37

1.14.1.3 Subscriptions A subscription is a run-time request for a particular message to be sent to a particular pipe.
If the caller of the subscribe API is not the owner of the pipe, the request is rejected and an error event is sent. The
application that creates the pipe is considered the owner of the pipe. The pipe specified in the subscription is sometimes
referred to as the destination of the message. There are a maximum number of destinations for a particular message.
This value is specified by the platform configuration parameter CFE_PLATFORM_SB_MAX_DEST_PER_PKT.

As subscriptions are received, the destinations are added to the head of a linked list. During the sending of a message,
the list is traversed beginning at the head of the list. Therefore the message will first be sent to the last subscriber. If
an application has timing constraints and needs to receive a message in the shortest possible time, the developer may
consider holding off its subscription until other applications have subscribed to the message.

The message limit specifies the maximum number of messages (with the specified Message ID) that are allowed on the
specified pipe at any time. This limit is specified by the application at the time of the subscription. If the application uses
the CFE_SB_Subscribe API, a message limit default value of four is used. If this default value is not sufficient, the caller
would use the CFE_SB_SubscribeEx API that allows the message limit to be specified.

The software bus also provides the user with an option to unsubscribe to a message. The unsubscribe API takes two
parameters, Message ID and Pipe ID. Only the owner of a pipe may unsubscribe to messages on that pipe.

1.14.1.4 Memory The software bus statically allocates a block of memory for message buffers and subscription
blocks. The size of this memory block is defined by the platform configuration parameter CFE_PLATFORM_SB_BUF_MEMORY_BYTES.
The memory is managed by the cFE ES memory pool and is used only by the software bus. The ES memory pool allows
an application to define the block sizes for the pool at compile time. These sizes are defined by the platform configuration
parameters prefixed with CFE_SB_MEM_BLOCK_SIZE (for example, CFE_PLATFORM_SB_MEM_BLOCK_SIZE_01).
It is recommended that a project tailor these values for the mission, based on the software bus packet sizes.

At the time a message is sent, two buffers are allocated from the pool. One for a buffer descriptor (CFE_SB_BufferD_t)
and one for the size of the packet. Both buffers are returned to the pool when the message has been received by all
recipients. More precisely, if there is one recipient for a message, the message buffers will be released on the following
call to CFE_SB_ReceiveBuffer for the pipe that received the buffer.

Also when subscriptions are received through the subscribe API's, the software bus allocates a subscription block (C←-
FE_SB_DestinationD_t) from the pool. The subscription blocks are returned to the pool if and when the subscription is
nullified through a CFE_SB_Unsubscribe call.

The software bus provides a set of figures regarding memory capacity, current memory utilization and high wa-
ter marks relevant to the SB memory pool. This information may be requested by sending the command to
dump the SB statistics packet. In addition, the current memory utilization value and the 'unmarked memory' value
(CFE_PLATFORM_SB_BUF_MEMORY_BYTES minus peak memory in use) are sent in software bus housekeeping
telemetry. The unmarked memory value should be monitored regularly to ensure that the value (in bytes) does not
continue to decline or approach zero. If this value were to approach zero, there is a possibility that memory requests
would fail which may inhibit the sending of a message. The current memory utilization value should also be monitored
to ensure the system contains no memory leaks. The value (in bytes) should remain stable under nominal conditions.
Refer to the ES users guide for more information regarding the ES Memory Pool.

1.14.2 Autonomous Actions

The software bus is primarily a set of library routines that are called by other software tasks to send and receive packets.
The software bus does not perform any operations autonomously, except for sending event messages if errors are
detected during the transfer of packets.

As do other tasks, the SB task sends out housekeeping telemetry when requested through the 'Send Housekeeping
Data' command.

Generated by Doxygen
38

1.14.3 Operation of the SB Software

• Initialization

• All Resets

• Message Routing

• Packet Sequence Values

• Message Limit Error

• Pipe Overflow Error

• SB Event Filtering

• Diagnostic Data

• Control of Packet Routing

• Quality of Service

• Known Problem

1.14.3.1 Initialization No action is required by the ground to initialize the software bus. The software bus initializes
internal data structures and tables the same way regardless of the type of reset.

1.14.3.2 All Resets The software bus does not preserve any information across a reset of any kind. The software bus
initializes internal data structures and tables the same way regardless of the type of reset. The routing is reestablished
as the system initializes. It is normal procedure for each task of the system to create the pipe or pipes it needs and do
all of its subscriptions during task initialization.

After any reset the following statements are true:

• The routing table is cleared and does not contain any routes.

• All subscriptions are lost and must be regenerated.

• The pipe table contains no data, all pipes must be recreated.

• Any packets in transit at the time of the reset are lost.

• The sequence counters for telemetry packets will begin again with a value of one.

Generated by Doxygen
1.14 cFE Software Bus Overview 39

1.14.3.3 Message Routing In the software bus, all messages are processed in a similar way. The software bus uses
the Message ID and the packet length fields (contained in the header) for routing the message to the destination pipe.
If either of these two fields do not pass validation, the software bus generates an error event and aborts the delivery
process. The software bus performs some validation checks by simply checking message header values against mission
or platform configuration parameters. Messages originating from various tasks or instruments are routed to one or more
pipes, where they wait until read by a task. The routing configuration for each message is established when applications
call one of the SB subscribe APIs. The subscribe APIs take a Message ID and a Pipe ID as parameters. The routing for
each packet is stored in SB memory and may be requested at any time by sending the 'Send Routing Info' command.
The software bus also provides a set of figures regarding capacity, current utilization and high water marks relevant to
the routing. This information may be requested by sending the command to dump the SB statistics packet.

1.14.3.4 Packet Sequence Values The sequence count behavior depends on if the message is a command type or
telemetry type.

The sequence counter for command messages is not altered by the software bus.

For a telemetry message, the behavior is controlled via API input parameters when sending. When enabled, the software
bus will populate the packet sequence counter using an internal counter that gets initialized upon the first subscription
to the message (first message will have a packet sequence counter value of 1). From that point on each send request
will increment the counter by one, regardless of the number of destinations or if there is an active subscription.

After a rollover condition the sequence counter will be a value of zero for one instance. The sequence counter is
incremented after all the checks have passed prior to the actual sending of the message. This includes the parameter
checks and the memory allocation check.

When disabled, the original message will not be altered. This method of message delivery is recommended for situations
where the sender did not generate the packet, such as a network interface application passing a packet from a remote
system to the local software bus.

1.14.3.5 Message Limit Error Before placing a message on a pipe, the software bus checks the message limit to
ensure the maximum number of packets in transit to the destination is not exceeded. If placing the message on the pipe
would exceed the message limit, then the action of sending to that pipe is aborted and the 'Message Limit Error' event is
sent. This condition will typically occur when an application that receives the packets does not respond quickly enough,
or if the sender of the packets produces them too quickly.

This condition occurs often during development and during integration, for example when a remote processor gets reset
or a 1553 cable becomes disconnected. Because of the common occurrences, the event may have filtering associated
with it. Any filtering for this event would be performed by the cFE Event Services (EVS). Filtering for SB events may be
specified in the cFE platform configuration file or may be commanded after the system initializes.

If this error occurs during nominal conditions, it could be an indication that the 'message limit' is not set
correctly. The message limit is given at the time of the subscription and given as a parameter in the
subscribe API. With the CFE_SB_Subscribe API, the SB uses a default message limit value specified by
CFE_PLATFORM_SB_DEFAULT_MSG_LIMIT. This constant is currently set to a value of four. If the default value is
insufficient, the message limit value can be specified in the CFE_SB_SubscribeEx API.

A related failure is the pipe overflow condition, which can occur if the total number of packets (of all kinds) sent to a
particular pipe is too large.

1.14.3.6 Pipe Overflow Error Another common error that occurs during the send process is the pipe overflow error.
This condition occurs if the total number of packets (of all kinds) sent to a particular pipe is too large. If this error occurs
too frequently, it may be an indication that the pipe depth is not set correctly. The pipe depth is given at the time the pipe
is created as a parameter in the CFE_SB_CreatePipe API.

Generated by Doxygen
40

1.14.3.7 SB Event Filtering Most filtering for SB events is performed by the cFE Event Services (EVS). Filtering for
SB events may be specified in the cFE platform configuration file or may be commanded after the system initializes.
There is no SB event log that limits the number of events based on the capacity of the log, as in the heritage software
bus.

There is one case in which events are filtered by the software bus instead of event services. This occurs when the
software bus needs to suppress events so that a fatal recursive event condition does not transpire. Because error
cases encountered when sending a message generate an event, and events cause a message to be sent a calling
sequence could cause a stack overflow if the recursion is not properly terminated. The cFE software bus detects this
condition and properly terminates the recursion. This is done by using a set of flags (one flag per event in the Send
API) which determine whether an API has relinquished its stack. If the software bus needs to send an event that may
cause recursion, the flag is set and the event is sent. If sending the event would cause the same event again, the event
call will be bypassed, terminating the recursion. The result is that the user will see only one event instead of the many
events that would normally occur without the protection. The heritage software bus did not have this condition because
it stored events in the software bus event log and another thread would read them out at a later time.

1.14.3.8 Diagnostic Data The cFE software bus provides a set of commands to dump SB diagnostic data to help
troubleshoot problems or check configuration settings. These commands allow the user to view the routing table, the
pipe table or the message map. The message map is a lookup table used during a send operation to give fast access
to the routing table index that corresponds to the message being sent.

The software bus also provides a statistics packet that can be used to tune the configuration parameters. This informa-
tion is sent to the ground in the form of an SB packet when the corresponding command is received. The cFE limits
the number of system pipes, unique Message IDs, buffer memory, messages on a pipe and subscriptions per Message
ID. These limits are configurable through cFE platform and mission configuration parameters. The statistics packet was
designed to let the project verify that these user settings provide the necessary margin to meet requirements.

The SB statistics information shows 'Currently In Use' figures, 'High Water Mark' figures and 'Max Allowed' figures for
the following: buffer memory, messages on each pipe (pipe depth stats), System Pipes, Unique Message IDs and total
subscriptions.

Depending on the task-scheduling implementation details of the operating system, it is possible to see the peak mes-
sages on a pipe occasionally exceed the depth of the pipe. The "Peak Messages In Use" parameter is included in the
SB statistics packet under the pipe depth stats.

1.14.3.9 Control of Packet Routing The software bus allows the ground to disable and enable the sending of pack-
ets of a specified Message ID to a specified pipe. All destinations that are needed for normal operation are enabled by
default. Modifying the routing of packets may be required for the following reasons:

• In flight, one can enable diagnostic packets to see them on the ground.

• During testing, one can disable a destination to simulate an anomaly.

1.14.3.10 Quality of Service The software bus has a parameter in the CFE_SB_SubscribeEx API named Quality,
which means Quality of Service (QOS) for off-board routing and is of the type CFE_SB_Qos_t. This structure has two
members named priority and reliability. The Quality parameter is currently unused by the software bus. It is a placeholder
to be used with the future software bus capability of inter-processor communication. Although currently the software bus
does not implement quality of service.

A default quality of services is provided via the CFE_SB_DEFAULT_QOS macro.

Generated by Doxygen
1.14 cFE Software Bus Overview 41

1.14.3.11 Known Problem The software bus may perform unexpectedly under an unlikely corner-case scenario.
This scenario was revealed in a stress test. The stress test was designed to deplete the Software Bus memory pool by
having a high priority application continuously send 1000 byte packets to a lower priority application until the memory
pool code returned an error code and sent the following event. "CFE_ES:getPoolBuf err:Request won't fit in remaining
memory" At this point the higher priority sending application would stop executing. This would allow the lower priority
receiving application to begin receiving the 1000 byte packets. After the receiving app processed all of the packets,
the memory was restored to the memory pool as expected. The SB memory-in-use telemetry was zero because there
were no software bus packets in transit. At this point any attempt to send a new-sized packet on the software bus was
be rejected. The ES memory pool stated that the ". . . Request won't fit in remaining memory" even though there was
currently no memory in use.

The simplest way to prevent this behavior is to ensure that there is margin when sizing the SB mem-
ory pool. To check the margin, monitor the "Peak Memory in Use" vs. the configuration parameter
CFE_PLATFORM_SB_BUF_MEMORY_BYTES which indicates the amount allocated.

1.14.4 Frequently Asked Questions about Software Bus

(Q) How is the memory pool handle (sent in SB housekeeping telemetry) intended to be used?

The memory pool handle is used to analyze the SB memory pool statistics. The cFE ES command
(CFE_ES_SEND_MEM_POOL_STATS_CC) to dump the memory pool statistics takes the pool handle as a pa-
rameter. These statistics tell how the SB memory pool is configured and gives details on margin. An improperly
configured SB memory pool may inhibit communication. This may occur if there is not enough margin to create a block
of the size needed for a transfer. Refer to the ES memory pool users guide for more details. Memory Pool

(Q) When sending a message, what message header fields are critical for routing the message?

To route the message properly, the software bus uses only the Message ID and packet length fields from the header
of the message. If the packet length field is incorrect, then the buffer allocation for the message will also be incorrect.
This may appear to the receiver as a truncated message or a message with unknown data added to the end of the
message.

(Q) How many copies of the message are performed in a typical message delivery?

There is a single copy of the message performed when sending a message (from the callers memory space) us-
ing 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 and send via CFE_SB_TransmitBuffer. This is equivalent to the previous zero copy
implementation. The CFE_SB_ReceiveBuffer API gives the user back a pointer to the buffer. When working with the
buffers, the additional complexity to be aware of is the buffer is only available to the app from the request to send (on the
sending side), or from the receive until the next receive on the same pipe on the receiving side. If the data is required
outside that scope, the app needs a local copy.

(Q) When does the software bus free the buffer during a typical message delivery process? Or how long is the
message, and the pointer to the buffer in the CFE_SB_ReceiveBuffer valid?

After receiving a buffer by calling CFE_SB_ReceiveBuffer, the buffer received is valid until the next call to
CFE_SB_ReceiveBuffer with the same Pipe Id. If the caller needs the message longer than the next call to
CFE_SB_ReceiveBuffer, the caller must copy the message to its memory space.

(Q) The first parameter in the CFE_SB_ReceiveBuffer API is a pointer to a pointer which can get confusing.
How can I be sure that the correct address is given for this parameter.

Generated by Doxygen
42

Typically a caller declares a ptr of type CFE_SB_Buffer_t (i.e. CFE_SB_Buffer_t ∗Ptr) then gives the address of
that pointer (&Ptr) as this parameter. After a successful call to CFE_SB_ReceiveBuffer, Ptr will point to the first byte of
the software bus buffer. This should be used as a read-only pointer. In systems with an MMU, writes to this pointer may
cause a memory protection fault.

(Q) Why am I not seeing expected Message Limit error events or Pipe Overflow events?

It is possible the events are being filtered by cFE Event Services. The filtering for this event may be specified in
the platform configuration file or it may have been commanded after the system initializes.
There is a corresponding counter for each of these conditions. First verify that the condition is happening by viewing the
counter in SB HK telemetry. If the condition is happening, you can view the SB filter information through the EVS App
Data Main page by clicking the 'go to' button for SB. The event Id for these events can be learned through a previous
event or from the cfe_sb_eventids.h file.

(Q) Why does the SB provide event filtering through the platform configuration file?

To give the user the ability to filter events before an EVS command can be sent. During system initialization, there are
many conditions occurring that can cause a flood of SB events such as No Subscribers, Pipe Overflow and MsgId to
Pipe errors. This gives the user a way to limit these events.

(Q) Why does SB have so many debug event messages?

The SB debug messages are positive acknowledgments that an action (like receiving a cmd, creating a pipe or
subscribing to a message) has occurred. They are intended to help isolate system problems. For instance, if an
expected response to a command is not happening, it may be possible to repeat the scenario with the debug event
turned on to verify that the command was successfully received.

(Q) How is the QOS parameter in the CFE_SB_SubscribeEx used by the software bus?

The QOS parameter is currently unused by the software bus. It is a placeholder to be used with the future soft-
ware bus capability of inter-processor communication. Setting the QOS as CFE_SB_DEFAULT_QOS will ensure
seamless integration when the software bus is expanded to support inter-processor communication.

(Q) Can I confirm my software bus buffer was delivered?

There is no built in mechanism for confirming delivery (it could span systems). This could be accomplished by
generating a response message from the receiver.

1.15 cFE Software Bus Commands

Upon receipt of any command, the Software Bus application will confirm that the message length embedded within
the header (from CFE_MSG_GetSize()) matches the expected length of that message, based on the size of the C
structure defining that command. If there is any discrepancy between the expected and actual message size, SB will
generate the CFE_SB_LEN_ERR_EID event, increment the command error counter ($sc_$cpu_SB_CMDEC), and the
command will not be accepted for processing.

The following is a list of commands that are processed by the cFE Software Bus Task.

Global CFE_SB_DISABLE_ROUTE_CC
Disable Software Bus Route

Generated by Doxygen
1.16 cFE Software Bus Telemetry 43

Global CFE_SB_DISABLE_SUB_REPORTING_CC
Disable Subscription Reporting Command
Global CFE_SB_ENABLE_ROUTE_CC
Enable Software Bus Route
Global CFE_SB_ENABLE_SUB_REPORTING_CC
Enable Subscription Reporting Command
Global CFE_SB_NOOP_CC
Software Bus No-Op
Global CFE_SB_RESET_COUNTERS_CC
Software Bus Reset Counters
Global CFE_SB_SEND_PREV_SUBS_CC
Send Previous Subscriptions Command
Global CFE_SB_SEND_SB_STATS_CC
Send Software Bus Statistics
Global CFE_SB_WRITE_MAP_INFO_CC
Write Map Info to a File
Global CFE_SB_WRITE_PIPE_INFO_CC
Write Pipe Info to a File
Global CFE_SB_WRITE_ROUTING_INFO_CC
Write Software Bus Routing Info to a File

1.16 cFE Software Bus Telemetry

The following are telemetry packets generated by the cFE Software Bus Task.

Global CFE_SB_AllSubscriptionsTlm_Payload_t
SB Previous Subscriptions Packet
Global CFE_SB_AllSubscriptionsTlm_Payload_t
SB Previous Subscriptions Packet
Global CFE_SB_HousekeepingTlm_Payload_t
Software Bus task housekeeping Packet
Global CFE_SB_HousekeepingTlm_Payload_t
Software Bus task housekeeping Packet
Global CFE_SB_SingleSubscriptionTlm_Payload_t
SB Subscription Report Packet
Global CFE_SB_SingleSubscriptionTlm_Payload_t
SB Subscription Report Packet
Global CFE_SB_StatsTlm_Payload_t
SB Statistics Telemetry Packet
Global CFE_SB_StatsTlm_Payload_t
SB Statistics Telemetry Packet

Generated by Doxygen
44

1.17 cFE Software Bus Configuration Parameters

The following are configuration parameters used to configure the cFE Software Bus either for each platform or for a
mission as a whole.

Global CFE_MISSION_SB_MAX_PIPES
Maximum Number of pipes that SB command/telemetry messages may hold
Maximum Number of pipes that SB command/telemetry messages may hold
Global CFE_MISSION_SB_MAX_SB_MSG_SIZE
Maximum SB Message Size
Maximum SB Message Size
Global CFE_PLATFORM_ENDIAN
Platform Endian Indicator
Global CFE_PLATFORM_SB_BUF_MEMORY_BYTES
Size of the SB buffer memory pool
Size of the SB buffer memory pool
Global CFE_PLATFORM_SB_DEFAULT_MAP_FILENAME
Default Message Map Filename
Default Message Map Filename
Global CFE_PLATFORM_SB_DEFAULT_MSG_LIMIT
Default Subscription Message Limit
Default Subscription Message Limit
Global CFE_PLATFORM_SB_DEFAULT_PIPE_FILENAME
Default Pipe Information Filename
Default Pipe Information Filename
Global CFE_PLATFORM_SB_DEFAULT_ROUTING_FILENAME
Default Routing Information Filename
Default Routing Information Filename
Global CFE_PLATFORM_SB_FILTERED_EVENT1
SB Event Filtering
SB Event Filtering
Global CFE_PLATFORM_SB_HIGHEST_VALID_MSGID
Highest Valid Message Id
Highest Valid Message Id
Global CFE_PLATFORM_SB_MAX_DEST_PER_PKT
Maximum Number of unique local destinations a single MsgId can have
Maximum Number of unique local destinations a single MsgId can have
Global CFE_PLATFORM_SB_MAX_MSG_IDS
Maximum Number of Unique Message IDs SB Routing Table can hold
Maximum Number of Unique Message IDs SB Routing Table can hold
Global CFE_PLATFORM_SB_MAX_PIPES
Maximum Number of Unique Pipes SB Routing Table can hold
Maximum Number of Unique Pipes SB Routing Table can hold

Generated by Doxygen
1.18 cFE Table Services Overview 45

1.18 cFE Table Services Overview

Applications often organize sets of their parameters into logical units called tables. These are typically constant param-
eters that can change the behavior of a flight software algorithm and are only intended to be modified by operations
personnel. Examples of this would be attitude control gains, sensor scalefactors, telemetry filter settings, etc.

Table Services (TBL) provides a centralized control of flight software tables. Operations personnel would interact with
TBL in order to dump the contents of current tables, load new table images, verify the contents of a table image and
manage Critical tables.

None of the cFE core applications (EVS, SB, ES, TIME, or TBL) use tables, and it is possible to build cFE without Table
Services if not needed or an alternative parameter management mechanism is to be utilized.

For additional detail on Tables and how to manage them, see the following sections:

• Managing Tables

• cFE Table Types and Table Options

• Table Registry

• Table Services Telemetry

• Effects of Processor Reset on Tables

• Frequently Asked Questions about Table Services

1.18.1 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 of the table.

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 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.

A table can have one of two different types and a number of different options. These are discussed further in later
sections. An operator should understand the chosen type and selected options for a particular table before attempting
to modify a table's contents.

To understand the methods of maintaining a table, it is important that the terminology be clear. A table has two images:
"Active" and "Inactive". The Active table is the one that a cFE Application is currently accessing when it executes. The

Generated by Doxygen
46

Inactive table is a copy of the Active table that an operator (or on-board process such as a stored command processor)
can manipulate and change to have a newly desired set of data.
To create an Inactive table image on board, the operator would be required to perform a "Load" to the table. Loads are
table images stored in on-board files. The Load can contain either a complete table image or just a part of a table image.
If the Load contains just a portion, the Inactive image is first initialized with the contents of the Active image and then
the portion identified in the Load file is written on top of the Active image. After the initial Load, an operator can continue
to manipulate the Inactive table image with additional partial table load images. This allows the operator to reconfigure
the contents of multiple portions of the table before deciding to "Validate" and/or "Activate" it.
Some cFE Applications provide special functions that will examine a table image to determine if the contents are logically
sound. This function is referred to as the "Validation Function." When a cFE Application assigns a Validation Function
to a table during the table registration process, it is then requiring that a Validation be performed before the table can be
Activated. When an operator requests a Validation of a table image, they are sending a request to the owning Application
to execute the associated Validation Function on that image. The results of this function are then reported in telemetry.
If the Validation is successful, the operator is free to perform a table Activation. If the Validation fails, the operator would
be required to make additional changes to the Inactive table image and attempt another Validation before commanding
an Activation.
To change an Inactive table image into the Active table image, an operator must Activate a table. When an operator
sends the table Activation command, they are notifying the table's owning Application that a new table image is available.
It is then up to the Application to determine when is the best time to perform the "Update" of the table. When an
Application performs an Update, the contents of the Inactive table image become the Active table image.

1.18.2 cFE Table Types and Table Options

A cFE Application Developer has several choices when creating a cFE Application. There are two basic types of tables:
single buffered and double buffered. In addition to these two basic types there are a small variety of options possible
with each table. These options control special characteristics of the table such as whether it is dump-only, critical or
whether it has an application defined location in memory.
Each choice has its advantages and disadvantages. The developer chooses the appropriate type based upon the
requirements of the application. Anyone operating a particular cFE Application must understand the nature of the type
and options selected for a particular table before they can successfully understand how to perform updates, validations,
etc.
For more information on the different types of tables available, see the following sections:

• Table Types

– Single Buffered Tables

– Double Buffered Tables

• Table Options

– Tables with Validation Functions

– Critical Tables

– User Defined Address Tables

– Dump Only Tables

Generated by Doxygen
1.18 cFE Table Services Overview 47

1.18.2.1 Single Buffered Tables The default table type for a cFE Application to use is a single buffered table. The
principle advantage of a single buffered table is that it can share one of several shared table buffers for uploaded and
pending table images. Since many cFE Applications have relatively small tables that are not changed at time critical
moments or are not changed very often during a mission, single buffered tables represent the most memory resource
efficient method of being managed.

The number of single buffered tables that can have inactive table images being manipulated at one time is specified by
a TBL Services configuration parameter (CFE_PLATFORM_TBL_MAX_SIMULTANEOUS_LOADS) found in the cfe←-
_platform_cfg.h file associated with the processor in question. This parameter identifies the number of shared table
buffers that are available.

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 Critical Tables), dump-only (see Dump Only Tables) and/or have a
user-defined address (see User Defined Address Tables).

1.18.2.2 Double Buffered Tables Under certain conditions, a cFE Application Developer may choose to use a dou-
ble buffered table type within their application. Double buffered tables retain a dedicated inactive image of the 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.

1.18.2.3 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.

1.18.2.4 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.

Generated by Doxygen
48

1.18.2.5 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.

1.18.2.6 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 telemetry 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.

1.18.3 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

• The size, in bytes, of the table

• Pointers to the start addresses of the Table's image buffers, Active and Inactive (if appropriate)

• A pointer to the start address of a Validation Function

• A flag indicating whether a table image has been loaded into an Inactive buffer

• A flag indicating whether the table is Critical and its associated CDS Handle if it is

• A flag indicating whether the table has ever been loaded (initialized)

• A flag indicating whether the table is Dump Only

• A flag indicating whether the table has an Update Pending

• A flag indicating whether the table is double buffered or not

• The System Time when the Table was last Updated

• 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

Generated by Doxygen
1.18 cFE Table Services Overview 49

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 for a single table to be sent via a telemetry
packet.

The API function CFE_TBL_Register() returns either CFE_SUCCESS or CFE_TBL_INFO_RECOVERED_TBL to indi-

cate that the table was successfully registered. The difference is whether the table data was recovered from CDS as
part of the registration. There are several error return values that describe why the function 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.

1.18.4 Table Services Telemetry

Table Services produces two different telemetry packets. The first packet, referred to as the Table Services Housekeep-
ing 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.

1.18.5 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.

1.18.6 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.

(Q) I tried to validate a table and received the following event message that said the event failed:

MyApp validation failed for Inactive 'MyApp.MyTable', Status=0x####

What happened?

The event message indicates the application who owns the table has discovered a problem with the contents of
the image. The code number following the 'Status' keyword is defined by the Application. The documentation for the
specified Application should be referred to in order to identify the exact nature of the problem.

(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.

Generated by Doxygen
50

1. 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.

2. The file needs to be loaded into the onboard processor's filesystem using whichever file transfer protocol is used
for that mission.

3. The Load Command is sent next to tell Table Services to load the table image file into the Inactive Table Image
Buffer for the table identified in the file.

4. The Validate Command is then sent to validate the contents of the inactive table image. This will ensure the file
was not corrupted or improperly defined. The results of the validation are reported in Table Services Housekeep-
ing 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.

5. Upon successful validation, the operator then sends the Activate Command. 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 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 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 SAME buffer.

Therefore, the most likely scenarios that would lead to a needed abort are as follows:

1. Operator loads a table and realizes immediately that the load is not wanted.

2. 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.

3. 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.

Generated by Doxygen
1.19 cFE Table Services Commands 51

1.19 cFE Table Services Commands

Upon receipt of any command, the Table Services application will confirm that the message length embedded within
the header (from CFE_MSG_GetSize()) matches the expected length of that message, based on the size of the C
structure defining that command. If there is any discrepancy between the expected and actual message size, TBL will
generate the CFE_TBL_LEN_ERR_EID event, increment the command error counter ($sc_$cpu_TBL_CMDEC), and
the command will not be accepted for processing.

The following is a list of commands that are processed by the cFE Table Services Task.

Global CFE_TBL_ABORT_LOAD_CC
Abort Table Load
Global CFE_TBL_ACTIVATE_CC
Activate Table
Global CFE_TBL_DELETE_CDS_CC
Delete Critical Table from Critical Data Store
Global CFE_TBL_DUMP_CC
Dump Table
Global CFE_TBL_DUMP_REGISTRY_CC
Dump Table Registry
Global CFE_TBL_LOAD_CC
Load Table
Global CFE_TBL_NOOP_CC
Table No-Op
Global CFE_TBL_RESET_COUNTERS_CC
Table Reset Counters
Global CFE_TBL_SEND_REGISTRY_CC
Telemeter One Table Registry Entry
Global CFE_TBL_VALIDATE_CC
Validate Table

1.20 cFE Table Services Telemetry

The following are telemetry packets generated by the cFE Table Services Task.

Global CFE_TBL_HousekeepingTlm_Payload_t
Table Services Housekeeping Packet
Global CFE_TBL_HousekeepingTlm_Payload_t
Table Services Housekeeping Packet
Global CFE_TBL_TblRegPacket_Payload_t
Table Registry Info Packet
Global CFE_TBL_TblRegPacket_Payload_t
Table Registry Info Packet

Generated by Doxygen
52

1.21 cFE Table Services Configuration Parameters

The following are configuration parameters used to configure the cFE Table Services either for each platform or for a
mission as a whole.

Global CFE_MISSION_TBL_MAX_FULL_NAME_LEN
Maximum Length of Full Table Name in messages
Maximum Length of Full Table Name in messages

Global CFE_MISSION_TBL_MAX_NAME_LENGTH
Maximum Table Name Length
Maximum Table Name Length

Global CFE_PLATFORM_TBL_BUF_MEMORY_BYTES
Size of Table Services Table Memory Pool
Size of Table Services Table Memory Pool

Global CFE_PLATFORM_TBL_DEFAULT_REG_DUMP_FILE
Default Filename for a Table Registry Dump
Default Filename for a Table Registry Dump

Global CFE_PLATFORM_TBL_MAX_CRITICAL_TABLES
Maximum Number of Critical Tables that can be Registered
Maximum Number of Critical Tables that can be Registered

Global CFE_PLATFORM_TBL_MAX_DBL_TABLE_SIZE
Maximum Size Allowed for a Double Buffered Table
Maximum Size Allowed for a Double Buffered Table

Global CFE_PLATFORM_TBL_MAX_NUM_HANDLES
Maximum Number of Table Handles
Maximum Number of Table Handles

Global CFE_PLATFORM_TBL_MAX_NUM_TABLES
Maximum Number of Tables Allowed to be Registered
Maximum Number of Tables Allowed to be Registered

Global CFE_PLATFORM_TBL_MAX_NUM_VALIDATIONS
Maximum Number of Simultaneous Table Validations
Maximum Number of Simultaneous Table Validations

Global CFE_PLATFORM_TBL_MAX_SIMULTANEOUS_LOADS
Maximum Number of Simultaneous Loads to Support
Maximum Number of Simultaneous Loads to Support

Global CFE_PLATFORM_TBL_MAX_SNGL_TABLE_SIZE
Maximum Size Allowed for a Single Buffered Table
Maximum Size Allowed for a Single Buffered Table

Global CFE_PLATFORM_TBL_VALID_PRID_1
Processor ID values used for table load validation
Processor ID values used for table load validation

Generated by Doxygen
1.22 cFE Time Services Overview 53

Global CFE_PLATFORM_TBL_VALID_PRID_COUNT
Number of Processor ID's specified for validation
Number of Processor ID's specified for validation

Global CFE_PLATFORM_TBL_VALID_SCID_1
Spacecraft ID values used for table load validation
Spacecraft ID values used for table load validation

Global CFE_PLATFORM_TBL_VALID_SCID_COUNT
Number of Spacecraft ID's specified for validation
Number of Spacecraft ID's specified for validation

1.22 cFE Time Services Overview

The cFE Time Service (TIME) is one of the cFE core services. TIME provides time correlation, distribution and synchro-
nization 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).

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:

• Time Components

• Time Structure

• Time Formats

• Time Configuration

– Time Format Selection

– Enabling Fake Tone Signal

– Selecting Tone and Data Ordering

– Specifying Tone and Data Window

– Specifying Time Server/Client

Generated by Doxygen
54

– Specifying Time Tone Byte Order

– Virtual MET

– Specifying Time Source

– Specifying Time Signal

• Time Services Paradigm(s)

• Flywheeling

• Time State

• Initialization

– Power-On Reset

– Processor Reset

• Initialization

– Power-On Reset

– Processor Reset

• Normal Operation

– Client

– Server

* Setting Time

* Adjusting Time

* Setting MET

• Frequently Asked Questions about Time Services

Generated by Doxygen
1.22 cFE Time Services Overview 55

1.22.1 Time Components

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 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 (G←-
PS 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
to facilitate this measurement.

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.

1.22.2 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 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 Software bus messages, but this is dependent on the underlying
definition.

The system time structure is defined as follows:

typedef struct {
uint32 Seconds; /* Number of seconds */
uint32 Subseconds; /* Number of 2^(-32) subseconds */
} CFE_TIME_SysTime_t;

Generated by Doxygen
56

1.22.3 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:

TAI = MET + STCF

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:

UTC = TAI - Leap Seconds.

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:

UTC = MET + STCF - Leap Seconds

1.22.4 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 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 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 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 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 data packet containing the MET value corresponding to the tone. T←-
IME 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 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 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:

Generated by Doxygen
1.22 cFE Time Services Overview 57

• Time Format Selection

• Enabling Fake Tone Signal

• Selecting Tone and Data Ordering

• Specifying Tone and Data Window

• Specifying Time Server/Client

• Specifying Time Tone Byte Order

• Virtual MET

• Specifying Time Source

• Specifying Time Signal

1.22.4.1 Time Format Selection 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 one, of
the following time format definitions:

#define CFE_MISSION_TIME_CFG_DEFAULT_TAI TRUE

#define CFE_MISSION_TIME_CFG_DEFAULT_UTC FALSE

or

#define CFE_MISSION_TIME_CFG_DEFAULT_TAI FALSE

#define CFE_MISSION_TIME_CFG_DEFAULT_UTC TRUE

The choice of time format is a mission specific decision and is not directly affected by the hardware configuration.

See also

CFE_MISSION_TIME_CFG_DEFAULT_TAI, CFE_MISSION_TIME_CFG_DEFAULT_UTC

Generated by Doxygen
58

1.22.4.2 Enabling Fake Tone Signal 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 signal.

#define CFE_MISSION_TIME_CFG_FAKE_TONE TRUE

Hypothetical hardware configuration number one (described above) would enable the fake tone signal.

See also

CFE_MISSION_TIME_CFG_FAKE_TONE

1.22.4.3 Selecting Tone and Data Ordering 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, of the following:

#define CFE_MISSION_TIME_AT_TONE_WAS
#define CFE_MISSION_TIME_AT_TONE_WILL_BE

Hypothetical hardware configuration number three (described Time Configuration above) would enable "time at the tone
was".

See also

CFE_MISSION_TIME_AT_TONE_WAS, CFE_MISSION_TIME_AT_TONE_WILL_BE

1.22.4.4 Specifying Tone and Data Window 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. Both must be defined, units are micro-seconds.

#define CFE_MISSION_TIME_MIN_ELAPSED 0
#define CFE_MISSION_TIME_MAX_ELAPSED 100000

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.

See also

CFE_MISSION_TIME_MIN_ELAPSED, CFE_MISSION_TIME_MAX_ELAPSED

Generated by Doxygen
1.22 cFE Time Services Overview 59

1.22.4.5 Specifying Time Server/Client Configure TIME as a client only when the target system has multiple pro-
cessors 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 header file:

#define CFE_PLATFORM_TIME_CFG_SERVER TRUE

#define CFE_PLATFORM_TIME_CFG_CLIENT FALSE

or

#define CFE_PLATFORM_TIME_CFG_SERVER FALSE

#define CFE_PLATFORM_TIME_CFG_CLIENT TRUE

See also

CFE_PLATFORM_TIME_CFG_SERVER, CFE_PLATFORM_TIME_CFG_CLIENT

1.22.4.6 Specifying Time Tone Byte Order 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 configura-
tions, it may be better to have the payload produced in big-endian order–particularly in mixed-endian environments.

In order to force the tone message to be in big-endian order, you must define the following:

#define CFE_PLATFORM_TIME_CFG_BIGENDIAN

1.22.4.7 Virtual MET 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.

TIME servers must be configured as using a virtual MET

1.22.4.8 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 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 command selection.

Set the following definition to TRUE only for TIME servers using an external time data source.

#define CFE_PLATFORM_TIME_CFG_SOURCE TRUE

Generated by Doxygen
60

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 API function.

TIME servers using an external time data source must set one, and only one, of the following to TRUE, for example:

#define CFE_PLATFORM_TIME_CFG_SRC_MET TRUE

#define CFE_PLATFORM_TIME_CFG_SRC_GPS FALSE
#define CFE_PLATFORM_TIME_CFG_SRC_TIME FALSE

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 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 parameters must
also be set TRUE in order to specify the external time source, for example:

#define CFE_PLATFORM_TIME_CFG_SRC_MET TRUE

#define CFE_PLATFORM_TIME_CFG_SRC_GPS FALSE
#define CFE_PLATFORM_TIME_CFG_SRC_TIME FALSE

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 time will be overwritten.

See also

CFE_PLATFORM_TIME_CFG_SRC_MET, CFE_PLATFORM_TIME_CFG_SRC_GPS, CFE_PLATFORM_TIME_CFG_SRC_TIME

1.22.4.9 Specifying Time Signal Some hardware configurations support a primary and redundant tone signal se-
lection. Setting the following configuration definition to TRUE will result in enabling a TIME command to select the active
tone signal.

#define CFE_PLATFORM_TIME_CFG_SIGNAL TRUE

Note: this feature requires additional custom software to make the physical signal switch.

See also

CFE_PLATFORM_TIME_CFG_SIGNAL

Generated by Doxygen
1.22 cFE Time Services Overview 61

1.22.5 Time Format Selection

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 one, of
the following time format definitions:

#define CFE_MISSION_TIME_CFG_DEFAULT_TAI TRUE

#define CFE_MISSION_TIME_CFG_DEFAULT_UTC FALSE

or

#define CFE_MISSION_TIME_CFG_DEFAULT_TAI FALSE

#define CFE_MISSION_TIME_CFG_DEFAULT_UTC TRUE

The choice of time format is a mission specific decision and is not directly affected by the hardware configuration.

See also

CFE_MISSION_TIME_CFG_DEFAULT_TAI, CFE_MISSION_TIME_CFG_DEFAULT_UTC

1.22.6 Enabling Fake Tone Signal

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 signal.

#define CFE_MISSION_TIME_CFG_FAKE_TONE TRUE

Hypothetical hardware configuration number one (described above) would enable the fake tone signal.

See also

CFE_MISSION_TIME_CFG_FAKE_TONE

1.22.7 Selecting Tone and Data Ordering

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, of the following:

#define CFE_MISSION_TIME_AT_TONE_WAS
#define CFE_MISSION_TIME_AT_TONE_WILL_BE

Hypothetical hardware configuration number three (described Time Configuration above) would enable "time at the tone
was".

See also

CFE_MISSION_TIME_AT_TONE_WAS, CFE_MISSION_TIME_AT_TONE_WILL_BE

Generated by Doxygen
62

1.22.8 Specifying Tone and Data Window

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. Both must be defined, units are micro-seconds.

#define CFE_MISSION_TIME_MIN_ELAPSED 0
#define CFE_MISSION_TIME_MAX_ELAPSED 100000

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.

See also

CFE_MISSION_TIME_MIN_ELAPSED, CFE_MISSION_TIME_MAX_ELAPSED

1.22.9 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 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 header file:

#define CFE_PLATFORM_TIME_CFG_SERVER TRUE

#define CFE_PLATFORM_TIME_CFG_CLIENT FALSE

or

#define CFE_PLATFORM_TIME_CFG_SERVER FALSE

#define CFE_PLATFORM_TIME_CFG_CLIENT TRUE

See also

CFE_PLATFORM_TIME_CFG_SERVER, CFE_PLATFORM_TIME_CFG_CLIENT

1.22.10 Specifying Time Tone Byte Order

By default, the CFE time tone message is a payload of integers in platform-endian order (containing the tone's times-
tamp, 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 environments.

In order to force the tone message to be in big-endian order, you must define the following:

#define CFE_PLATFORM_TIME_CFG_BIGENDIAN

Generated by Doxygen
1.22 cFE Time Services Overview 63

1.22.11 Virtual MET

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.

TIME servers must be configured as using a virtual MET

1.22.12 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
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 command selection.

Set the following definition to TRUE only for TIME servers using an external time data source.

#define CFE_PLATFORM_TIME_CFG_SOURCE TRUE

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 API function.

TIME servers using an external time data source must set one, and only one, of the following to TRUE, for example:

#define CFE_PLATFORM_TIME_CFG_SRC_MET TRUE

#define CFE_PLATFORM_TIME_CFG_SRC_GPS FALSE
#define CFE_PLATFORM_TIME_CFG_SRC_TIME FALSE

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 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 parameters must
also be set TRUE in order to specify the external time source, for example:

#define CFE_PLATFORM_TIME_CFG_SRC_MET TRUE

#define CFE_PLATFORM_TIME_CFG_SRC_GPS FALSE
#define CFE_PLATFORM_TIME_CFG_SRC_TIME FALSE

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 time will be overwritten.

See also

CFE_PLATFORM_TIME_CFG_SRC_MET, CFE_PLATFORM_TIME_CFG_SRC_GPS, CFE_PLATFORM_TIME_CFG_SRC_TIME

Generated by Doxygen
64

1.22.13 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 command to select the active tone signal.

#define CFE_PLATFORM_TIME_CFG_SIGNAL TRUE

Note: this feature requires additional custom software to make the physical signal switch.

See also

CFE_PLATFORM_TIME_CFG_SIGNAL

1.22.14 Time Services Paradigm(s)

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 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 configured as a TIME server.

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 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. 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" 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, which returns time in
the format specified by this configuration parameter.

Generated by Doxygen
1.22 cFE Time Services Overview 65

1.22.15 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 apart of times being stored by different spacecraft
systems.

Flywheeling occurs when at least one of the following conditions is true:

• loss of tone signal

• loss of "time at the tone" data packet

• signal and packet not within valid window

• commanded into fly-wheel mode

If the TIME server is in Flywheel mode then the TIME client is also in flywheel mode.

1.22.16 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 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 INV←-
ALID 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.

1.22.17 Initialization

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:

• Power-On Reset

• Processor Reset

Generated by Doxygen
66

1.22.17.1 Power-On Reset 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.

1.22.17.2 Processor Reset In the event of a processor reset, the following time values are preserved:

• MET

• STCF

• Leap Seconds

• Clock Signal Selection

• 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 does not match, then TIME is initialized as if a cFE power-on
reset occurred.

1.22.18 Power-On Reset

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.

1.22.19 Processor Reset

In the event of a processor reset, the following time values are preserved:

• MET

• STCF

• Leap Seconds

• Clock Signal Selection

• 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 does not match, then TIME is initialized as if a cFE power-on
reset occurred.

Generated by Doxygen
1.22 cFE Time Services Overview 67

1.22.20 Initialization

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:

• Power-On Reset

• Processor Reset

1.22.20.1 Power-On Reset 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.

1.22.20.2 Processor Reset In the event of a processor reset, the following time values are preserved:

• MET

• STCF

• Leap Seconds

• Clock Signal Selection

• 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 does not match, then TIME is initialized as if a cFE power-on
reset occurred.

1.22.21 Power-On Reset

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.

Generated by Doxygen
68

1.22.22 Processor Reset

In the event of a processor reset, the following time values are preserved:

• MET

• STCF

• Leap Seconds

• Clock Signal Selection

• 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 does not match, then TIME is initialized as if a cFE power-on
reset occurred.

1.22.23 Normal Operation

The following sections describe the operator's responsibilities for maintaining time under nominal conditions:

• Client

• Server

1.22.23.1 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 calculation to account for the latency.

1.22.23.2 Server 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:

• Setting Time

• Adjusting Time

• Setting MET

Generated by Doxygen
1.22 cFE Time Services Overview 69

1.22.23.2.1 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:

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 = ((current MET) + STCF) - Leap Seconds

See also

CFE_TIME_SET_TIME_CC

1.22.23.2.2 Adjusting Time The TIME Server includes commands to set the STCF, Leap Seconds, and
Validity state. The STCF should be set implicitly 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_ONE_HZ_ADJUSTMEN
and CFE_TIME_SUB_ONE_HZ_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 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 to by the other systems.

See also

CFE_TIME_ADD_ADJUST_CC, CFE_TIME_SUB_ADJUST_CC, CFE_TIME_SET_STCF_CC, CFE_TIME_ADD_ONE_HZ_ADJUS

CFE_TIME_SUB_ONE_HZ_ADJUSTMENT_CC, CFE_TIME_SET_LEAP_SECONDS_CC

1.22.23.2.3 Setting MET The TIME Server provides the capability to set the MET. Note that the MET (as imple-
mented for cFE Time Service) is a logical representation and not a physical timer. Thus, setting the MET is not depen-
dent 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.

See also

CFE_TIME_SET_MET_CC

Generated by Doxygen
70

1.22.24 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 calculation to account for the latency.

1.22.25 Server

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:

• Setting Time

• Adjusting Time

• Setting MET

1.22.25.0.1 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:

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 = ((current MET) + STCF) - Leap Seconds

See also

CFE_TIME_SET_TIME_CC

Generated by Doxygen
1.22 cFE Time Services Overview 71

1.22.25.0.2 Adjusting Time The TIME Server includes commands to set the STCF, Leap Seconds, and
Validity state. The STCF should be set implicitly 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_ONE_HZ_ADJUSTMEN
and CFE_TIME_SUB_ONE_HZ_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 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 to by the other systems.

See also

CFE_TIME_ADD_ADJUST_CC, CFE_TIME_SUB_ADJUST_CC, CFE_TIME_SET_STCF_CC, CFE_TIME_ADD_ONE_HZ_ADJUS

CFE_TIME_SUB_ONE_HZ_ADJUSTMENT_CC, CFE_TIME_SET_LEAP_SECONDS_CC

1.22.25.0.3 Setting MET The TIME Server provides the capability to set the MET. Note that the MET (as imple-
mented for cFE Time Service) is a logical representation and not a physical timer. Thus, setting the MET is not depen-
dent 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.

See also

CFE_TIME_SET_MET_CC

1.22.26 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:

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 = ((current MET) + STCF) - Leap Seconds

See also

CFE_TIME_SET_TIME_CC

Generated by Doxygen
72

1.22.27 Adjusting Time

The TIME Server includes commands to set the STCF, Leap Seconds, and Validity state. The STCF should be
set implicitly 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_ONE_HZ_ADJUSTMENT_CC and
CFE_TIME_SUB_ONE_HZ_ADJUSTMENT_CC) that can be made to the STCF to compensate for oscillator drift. Mis-
sion 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 to by
the other systems.

See also

CFE_TIME_ADD_ADJUST_CC, CFE_TIME_SUB_ADJUST_CC, CFE_TIME_SET_STCF_CC, CFE_TIME_ADD_ONE_HZ_ADJUS

CFE_TIME_SUB_ONE_HZ_ADJUSTMENT_CC, CFE_TIME_SET_LEAP_SECONDS_CC

1.22.28 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 upon execution of
this command.

See also

CFE_TIME_SET_MET_CC

1.22.29 Frequently Asked Questions about Time Services

None submitted

1.23 cFE Time Services Commands

Upon receipt of any command, the Time Services application will confirm that the message length embedded within
the header (from CFE_MSG_GetSize()) matches the expected length of that message, based on the size of the C
structure defining that command. If there is any discrepancy between the expected and actual message size, TIME will
generate the CFE_TIME_LEN_ERR_EID event, increment the command error counter ($sc_$cpu_TIME_CMDEC), and
the command will not be accepted for processing.

The following is a list of commands that are processed by the cFE Time Services Task.

Global CFE_TIME_ADD_ADJUST_CC
Add Delta to Spacecraft Time Correlation Factor

Generated by Doxygen
1.24 cFE Time Services Telemetry 73

Global CFE_TIME_ADD_DELAY_CC
Add Time to Tone Time Delay
Global CFE_TIME_ADD_ONE_HZ_ADJUSTMENT_CC
Add Delta to Spacecraft Time Correlation Factor each 1Hz
Global CFE_TIME_NOOP_CC
Time No-Op
Global CFE_TIME_RESET_COUNTERS_CC
Time Reset Counters
Global CFE_TIME_SEND_DIAGNOSTIC_CC
Request TIME Diagnostic Telemetry
Global CFE_TIME_SET_LEAP_SECONDS_CC
Set Leap Seconds
Global CFE_TIME_SET_MET_CC
Set Mission Elapsed Time
Global CFE_TIME_SET_SIGNAL_CC
Set Tone Signal Source
Global CFE_TIME_SET_SOURCE_CC
Set Time Source
Global CFE_TIME_SET_STATE_CC
Set Time State
Global CFE_TIME_SET_STCF_CC
Set Spacecraft Time Correlation Factor
Global CFE_TIME_SET_TIME_CC
Set Spacecraft Time
Global CFE_TIME_SUB_ADJUST_CC
Subtract Delta from Spacecraft Time Correlation Factor
Global CFE_TIME_SUB_DELAY_CC
Subtract Time from Tone Time Delay
Global CFE_TIME_SUB_ONE_HZ_ADJUSTMENT_CC
Subtract Delta from Spacecraft Time Correlation Factor each 1Hz

1.24 cFE Time Services Telemetry

The following are telemetry packets generated by the cFE Time Services Task.

Global CFE_TIME_DiagnosticTlm_Payload_t
Time Services Diagnostics Packet
Global CFE_TIME_DiagnosticTlm_Payload_t
Time Services Diagnostics Packet
Global CFE_TIME_HousekeepingTlm_Payload_t
Time Services Housekeeping Packet
Global CFE_TIME_HousekeepingTlm_Payload_t
Time Services Housekeeping Packet

Generated by Doxygen
74

1.25 cFE Time Services Configuration Parameters

The following are configuration parameters used to configure the cFE Time Services either for each platform or for a
mission as a whole.

Global CFE_MISSION_TIME_AT_TONE_WAS
Default Time and Tone Order
Default Time and Tone Order

Global CFE_MISSION_TIME_CFG_DEFAULT_TAI
Default Time Format
Default Time Format

Global CFE_MISSION_TIME_CFG_FAKE_TONE
Default Time Format
Default Time Format

Global CFE_MISSION_TIME_DEF_MET_SECS
Default Time Values
Default Time Values

Global CFE_MISSION_TIME_EPOCH_YEAR
Default EPOCH Values
Default EPOCH Values

Global CFE_MISSION_TIME_FS_FACTOR
Time File System Factor
Time File System Factor

Global CFE_MISSION_TIME_MIN_ELAPSED
Min and Max Time Elapsed
Min and Max Time Elapsed

Global CFE_PLATFORM_TIME_CFG_LATCH_FLY
Define Periodic Time to Update Local Clock Tone Latch
Define Periodic Time to Update Local Clock Tone Latch

Global CFE_PLATFORM_TIME_CFG_SERVER
Time Server or Time Client Selection
Time Server or Time Client Selection

Global CFE_PLATFORM_TIME_CFG_SIGNAL
Include or Exclude the Primary/Redundant Tone Selection Cmd
Include or Exclude the Primary/Redundant Tone Selection Cmd

Global CFE_PLATFORM_TIME_CFG_SOURCE
Include or Exclude the Internal/External Time Source Selection Cmd
Include or Exclude the Internal/External Time Source Selection Cmd

Global CFE_PLATFORM_TIME_CFG_SRC_MET
Choose the External Time Source for Server only
Choose the External Time Source for Server only

Generated by Doxygen
1.26 cFE Event Message Cross Reference 75

Global CFE_PLATFORM_TIME_CFG_START_FLY
Define Time to Start Flywheel Since Last Tone
Define Time to Start Flywheel Since Last Tone

Global CFE_PLATFORM_TIME_CFG_TONE_LIMIT
Define Timing Limits From One Tone To The Next
Define Timing Limits From One Tone To The Next

Global CFE_PLATFORM_TIME_CFG_VIRTUAL
Time Tone In Big-Endian Order
Local MET or Virtual MET Selection for Time Servers
Time Tone In Big-Endian Order
Local MET or Virtual MET Selection for Time Servers

Global CFE_PLATFORM_TIME_MAX_DELTA_SECS
Define the Max Delta Limits for Time Servers using an Ext Time Source
Define the Max Delta Limits for Time Servers using an Ext Time Source

Global CFE_PLATFORM_TIME_MAX_LOCAL_SECS
Define the Local Clock Rollover Value in seconds and subseconds
Define the Local Clock Rollover Value in seconds and subseconds

Global CFE_PLATFORM_TIME_START_TASK_PRIORITY
Define TIME Task Priorities
Define TIME Task Priorities

Global CFE_PLATFORM_TIME_START_TASK_STACK_SIZE
Define TIME Task Stack Sizes
Define TIME Task Stack Sizes

1.26 cFE Event Message Cross Reference

The following cross reference maps the text associated with each cFE Event Message to its Event Message Identifier.
A user can search this page for the text of the message they wish to learn more about and then click on the associated
Event Message Identifier to obtain more information.

1.27 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 command code.

Global CFE_ES_CLEAR_ER_LOG_CC
$sc_$cpu_ES_ClearERLog

Global CFE_ES_CLEAR_SYS_LOG_CC
$sc_$cpu_ES_ClearSysLog

Global CFE_ES_DELETE_CDS_CC
$sc_$cpu_ES_DeleteCDS

Global CFE_ES_DUMP_CDS_REGISTRY_CC
$sc_$cpu_ES_WriteCDS2File

Generated by Doxygen
76

Global CFE_ES_NOOP_CC
$sc_$cpu_ES_NOOP
Global CFE_ES_OVER_WRITE_SYS_LOG_CC
$sc_$cpu_ES_OverwriteSysLogMode
Global CFE_ES_QUERY_ALL_CC
$sc_$cpu_ES_WriteAppInfo2File
Global CFE_ES_QUERY_ALL_TASKS_CC
$sc_$cpu_ES_WriteTaskInfo2File
Global CFE_ES_QUERY_ONE_CC
$sc_$cpu_ES_QueryApp
Global CFE_ES_RELOAD_APP_CC
$sc_$cpu_ES_ReloadApp
Global CFE_ES_RESET_COUNTERS_CC
$sc_$cpu_ES_ResetCtrs
Global CFE_ES_RESET_PR_COUNT_CC
$sc_$cpu_ES_ResetPRCnt
Global CFE_ES_RESTART_APP_CC
$sc_$cpu_ES_ResetApp
Global CFE_ES_RESTART_CC
$sc_$cpu_ES_ProcessorReset, $sc_$cpu_ES_PowerOnReset
Global CFE_ES_SEND_MEM_POOL_STATS_CC
$sc_$cpu_ES_PoolStats
Global CFE_ES_SET_MAX_PR_COUNT_CC
$sc_$cpu_ES_SetMaxPRCnt
Global CFE_ES_SET_PERF_FILTER_MASK_CC
$sc_$cpu_ES_LAFilterMask
Global CFE_ES_SET_PERF_TRIGGER_MASK_CC
$sc_$cpu_ES_LATriggerMask
Global CFE_ES_START_APP_CC
$sc_$cpu_ES_StartApp
Global CFE_ES_START_PERF_DATA_CC
$sc_$cpu_ES_StartLAData
Global CFE_ES_STOP_APP_CC
$sc_$cpu_ES_StopApp
Global CFE_ES_STOP_PERF_DATA_CC
$sc_$cpu_ES_StopLAData
Global CFE_ES_WRITE_ER_LOG_CC
$sc_$cpu_ES_WriteERLog2File
Global CFE_ES_WRITE_SYS_LOG_CC
$sc_$cpu_ES_WriteSysLog2File
Global CFE_EVS_ADD_EVENT_FILTER_CC
$sc_$cpu_EVS_AddEvtFltr

Generated by Doxygen
1.27 cFE Command Mnemonic Cross Reference 77

Global CFE_EVS_CLEAR_LOG_CC
$sc_$cpu_EVS_ClrLog
Global CFE_EVS_DELETE_EVENT_FILTER_CC
$sc_$cpu_EVS_DelEvtFltr
Global CFE_EVS_DISABLE_APP_EVENT_TYPE_CC
$sc_$cpu_EVS_DisAppEvtType, $sc_$cpu_EVS_DisAppEvtTypeMask
Global CFE_EVS_DISABLE_APP_EVENTS_CC
$sc_$cpu_EVS_DisAppEvGen
Global CFE_EVS_DISABLE_EVENT_TYPE_CC
$sc_$cpu_EVS_DisEventType, $sc_$cpu_EVS_DisEventTypeMask
Global CFE_EVS_DISABLE_PORTS_CC
$sc_$cpu_EVS_DisPort, $sc_$cpu_EVS_DisPortMask
Global CFE_EVS_ENABLE_APP_EVENT_TYPE_CC
$sc_$cpu_EVS_EnaAppEvtType, $sc_$cpu_EVS_EnaAppEvtTypeMask
Global CFE_EVS_ENABLE_APP_EVENTS_CC
$sc_$cpu_EVS_EnaAppEvGen
Global CFE_EVS_ENABLE_EVENT_TYPE_CC
$sc_$cpu_EVS_EnaEventType, $sc_$cpu_EVS_EnaEventTypeMask
Global CFE_EVS_ENABLE_PORTS_CC
$sc_$cpu_EVS_EnaPort, $sc_$cpu_EVS_EnaPortMask
Global CFE_EVS_NOOP_CC
$sc_$cpu_EVS_NOOP
Global CFE_EVS_RESET_ALL_FILTERS_CC
$sc_$cpu_EVS_RstAllFltrs
Global CFE_EVS_RESET_APP_COUNTER_CC
$sc_$cpu_EVS_RstAppCtrs
Global CFE_EVS_RESET_COUNTERS_CC
$sc_$cpu_EVS_ResetCtrs
Global CFE_EVS_RESET_FILTER_CC
$sc_$cpu_EVS_RstBinFltrCtr
Global CFE_EVS_SET_EVENT_FORMAT_MODE_CC
$sc_$cpu_EVS_SetEvtFmt
Global CFE_EVS_SET_FILTER_CC
$sc_$cpu_EVS_SetBinFltrMask
Global CFE_EVS_SET_LOG_MODE_CC
$sc_$cpu_EVS_SetLogMode
Global CFE_EVS_WRITE_APP_DATA_FILE_CC
$sc_$cpu_EVS_WriteAppData2File
Global CFE_EVS_WRITE_LOG_DATA_FILE_CC
$sc_$cpu_EVS_WriteLog2File
Global CFE_SB_DISABLE_ROUTE_CC
$sc_$cpu_SB_DisRoute

Generated by Doxygen
78

Global CFE_SB_DISABLE_SUB_REPORTING_CC
$sc_$cpu_SB_DisSubRptg
Global CFE_SB_ENABLE_ROUTE_CC
$sc_$cpu_SB_EnaRoute
Global CFE_SB_ENABLE_SUB_REPORTING_CC
$sc_$cpu_SB_EnaSubRptg
Global CFE_SB_NOOP_CC
$sc_$cpu_SB_NOOP
Global CFE_SB_RESET_COUNTERS_CC
$sc_$cpu_SB_ResetCtrs
Global CFE_SB_SEND_PREV_SUBS_CC
$sc_$cpu_SB_SendPrevSubs
Global CFE_SB_SEND_SB_STATS_CC
$sc_$cpu_SB_DumpStats
Global CFE_SB_WRITE_MAP_INFO_CC
$sc_$cpu_SB_WriteMap2File
Global CFE_SB_WRITE_PIPE_INFO_CC
$sc_$cpu_SB_WritePipe2File
Global CFE_SB_WRITE_ROUTING_INFO_CC
$sc_$cpu_SB_WriteRouting2File
Global CFE_TBL_ABORT_LOAD_CC
$sc_$cpu_TBL_LOADABORT
Global CFE_TBL_ACTIVATE_CC
$sc_$cpu_TBL_ACTIVATE
Global CFE_TBL_DELETE_CDS_CC
$sc_$cpu_TBL_DeleteCDS
Global CFE_TBL_DUMP_CC
$sc_$cpu_TBL_DUMP
Global CFE_TBL_DUMP_REGISTRY_CC
$sc_$cpu_TBL_WriteReg2File
Global CFE_TBL_LOAD_CC
$sc_$cpu_TBL_Load
Global CFE_TBL_NOOP_CC
$sc_$cpu_TBL_NOOP
Global CFE_TBL_RESET_COUNTERS_CC
$sc_$cpu_TBL_ResetCtrs
Global CFE_TBL_SEND_REGISTRY_CC
$sc_$cpu_TBL_TLMReg
Global CFE_TBL_VALIDATE_CC
$sc_$cpu_TBL_VALIDATE
Global CFE_TIME_ADD_ADJUST_CC
$sc_$cpu_TIME_AddSTCFAdj

Generated by Doxygen
1.28 cFE Telemetry Mnemonic Cross Reference 79

Global CFE_TIME_ADD_DELAY_CC
$sc_$cpu_TIME_AddClockLat
Global CFE_TIME_ADD_ONE_HZ_ADJUSTMENT_CC
$sc_$cpu_TIME_Add1HzSTCF
Global CFE_TIME_NOOP_CC
$sc_$cpu_TIME_NOOP
Global CFE_TIME_RESET_COUNTERS_CC
$sc_$cpu_TIME_ResetCtrs
Global CFE_TIME_SEND_DIAGNOSTIC_CC
$sc_$cpu_TIME_RequestDiag
Global CFE_TIME_SET_LEAP_SECONDS_CC
$sc_$cpu_TIME_SetClockLeap
Global CFE_TIME_SET_MET_CC
$sc_$cpu_TIME_SetClockMET
Global CFE_TIME_SET_SIGNAL_CC
$sc_$cpu_TIME_SetSignal
Global CFE_TIME_SET_SOURCE_CC
$sc_$cpu_TIME_SetSource
Global CFE_TIME_SET_STATE_CC
$sc_$cpu_TIME_SetState
Global CFE_TIME_SET_STCF_CC
$sc_$cpu_TIME_SetClockSTCF
Global CFE_TIME_SET_TIME_CC
$sc_$cpu_TIME_SetClock
Global CFE_TIME_SUB_ADJUST_CC
$sc_$cpu_TIME_SubSTCFAdj
Global CFE_TIME_SUB_DELAY_CC
$sc_$cpu_TIME_SubClockLat
Global CFE_TIME_SUB_ONE_HZ_ADJUSTMENT_CC
$sc_$cpu_TIME_Sub1HzSTCF

1.28 cFE Telemetry Mnemonic Cross Reference

The following cross reference maps the cFE telemetry packet members to their associated ground system telemetry
mnemonics.
Global CFE_ES_AppInfo::AddressesAreValid
$sc_$cpu_ES_AddrsValid
Global CFE_ES_AppInfo::BSSAddress
$sc_$cpu_ES_BSSAddress
Global CFE_ES_AppInfo::BSSSize
$sc_$cpu_ES_BSSSize
Global CFE_ES_AppInfo::CodeAddress
$sc_$cpu_ES_CodeAddress

Generated by Doxygen
80

Global CFE_ES_AppInfo::CodeSize
$sc_$cpu_ES_CodeSize
Global CFE_ES_AppInfo::DataAddress
$sc_$cpu_ES_DataAddress
Global CFE_ES_AppInfo::DataSize
$sc_$cpu_ES_DataSize
Global CFE_ES_AppInfo::EntryPoint [CFE_MISSION_MAX_API_LEN]
$sc_$cpu_ES_AppEntryPt[OS_MAX_API_NAME]
Global CFE_ES_AppInfo::ExceptionAction
$sc_$cpu_ES_ExceptnActn
Global CFE_ES_AppInfo::ExecutionCounter
$sc_$cpu_ES_ExecutionCtr
Global CFE_ES_AppInfo::FileName [CFE_MISSION_MAX_PATH_LEN]
$sc_$cpu_ES_AppFilename[OS_MAX_PATH_LEN]
Global CFE_ES_AppInfo::MainTaskId
$sc_$cpu_ES_MainTaskId
Global CFE_ES_AppInfo::MainTaskName [CFE_MISSION_MAX_API_LEN]
$sc_$cpu_ES_MainTaskName[OS_MAX_API_NAME]
Global CFE_ES_AppInfo::Name [CFE_MISSION_MAX_API_LEN]
$sc_$cpu_ES_AppName[OS_MAX_API_NAME]
Global CFE_ES_AppInfo::NumOfChildTasks
$sc_$cpu_ES_ChildTasks
Global CFE_ES_AppInfo::Priority
$sc_$cpu_ES_Priority
Global CFE_ES_AppInfo::ResourceId
$sc_$cpu_ES_AppID
Global CFE_ES_AppInfo::StackSize
$sc_$cpu_ES_StackSize
Global CFE_ES_AppInfo::StartAddress
$sc_$cpu_ES_StartAddr
Global CFE_ES_AppInfo::Type
$sc_$cpu_ES_AppType
Global CFE_ES_HousekeepingTlm_Payload::BootSource
$sc_$cpu_ES_BootSource
Global CFE_ES_HousekeepingTlm_Payload::CFECoreChecksum
$sc_$cpu_ES_CKSUM
Global CFE_ES_HousekeepingTlm_Payload::CFEMajorVersion
$sc_$cpu_ES_CFEMAJORVER
Global CFE_ES_HousekeepingTlm_Payload::CFEMinorVersion
$sc_$cpu_ES_CFEMINORVER
Global CFE_ES_HousekeepingTlm_Payload::CFEMissionRevision
$sc_$cpu_ES_CFEMISSIONREV

Generated by Doxygen
1.28 cFE Telemetry Mnemonic Cross Reference 81

Global CFE_ES_HousekeepingTlm_Payload::CFERevision
$sc_$cpu_ES_CFEREVISION
Global CFE_ES_HousekeepingTlm_Payload::CommandCounter
$sc_$cpu_ES_CMDPC
Global CFE_ES_HousekeepingTlm_Payload::CommandErrorCounter
$sc_$cpu_ES_CMDEC
Global CFE_ES_HousekeepingTlm_Payload::ERLogEntries
$sc_$cpu_ES_ERLOGENTRIES
Global CFE_ES_HousekeepingTlm_Payload::ERLogIndex
$sc_$cpu_ES_ERLOGINDEX
Global CFE_ES_HousekeepingTlm_Payload::HeapBlocksFree
$sc_$cpu_ES_HeapBlocksFree
Global CFE_ES_HousekeepingTlm_Payload::HeapBytesFree
$sc_$cpu_ES_HeapBytesFree
Global CFE_ES_HousekeepingTlm_Payload::HeapMaxBlockSize
$sc_$cpu_ES_HeapMaxBlkSize
Global CFE_ES_HousekeepingTlm_Payload::MaxProcessorResets
$sc_$cpu_ES_MaxProcResets
Global CFE_ES_HousekeepingTlm_Payload::OSALMajorVersion
$sc_$cpu_ES_OSMAJORVER
Global CFE_ES_HousekeepingTlm_Payload::OSALMinorVersion
$sc_$cpu_ES_OSMINORVER
Global CFE_ES_HousekeepingTlm_Payload::OSALMissionRevision
$sc_$cpu_ES_OSMISSIONREV
Global CFE_ES_HousekeepingTlm_Payload::OSALRevision
$sc_$cpu_ES_OSREVISION
Global CFE_ES_HousekeepingTlm_Payload::PerfDataCount
$sc_$cpu_ES_PerfDataCnt
Global CFE_ES_HousekeepingTlm_Payload::PerfDataEnd
$sc_$cpu_ES_PerfDataEnd
Global CFE_ES_HousekeepingTlm_Payload::PerfDataStart
$sc_$cpu_ES_PerfDataStart
Global CFE_ES_HousekeepingTlm_Payload::PerfDataToWrite
$sc_$cpu_ES_PerfData2Write
Global CFE_ES_HousekeepingTlm_Payload::PerfFilterMask [CFE_MISSION_ES_PERF_MAX_IDS/32]
$sc_$cpu_ES_PerfFltrMask[MaskCnt]
Global CFE_ES_HousekeepingTlm_Payload::PerfMode
$sc_$cpu_ES_PerfMode
Global CFE_ES_HousekeepingTlm_Payload::PerfState
$sc_$cpu_ES_PerfState
Global CFE_ES_HousekeepingTlm_Payload::PerfTriggerCount
$sc_$cpu_ES_PerfTrigCnt

Generated by Doxygen
82

Global CFE_ES_HousekeepingTlm_Payload::PerfTriggerMask [CFE_MISSION_ES_PERF_MAX_IDS/32]

$sc_$cpu_ES_PerfTrigMask[MaskCnt]
Global CFE_ES_HousekeepingTlm_Payload::ProcessorResets
$sc_$cpu_ES_ProcResetCnt
Global CFE_ES_HousekeepingTlm_Payload::PSPMajorVersion
$sc_$cpu_ES_PSPMAJORVER
Global CFE_ES_HousekeepingTlm_Payload::PSPMinorVersion
$sc_$cpu_ES_PSPMINORVER
Global CFE_ES_HousekeepingTlm_Payload::PSPMissionRevision
$sc_$cpu_ES_PSPMISSIONREV
Global CFE_ES_HousekeepingTlm_Payload::PSPRevision
$sc_$cpu_ES_PSPREVISION
Global CFE_ES_HousekeepingTlm_Payload::RegisteredCoreApps
$sc_$cpu_ES_RegCoreApps
Global CFE_ES_HousekeepingTlm_Payload::RegisteredExternalApps
$sc_$cpu_ES_RegExtApps
Global CFE_ES_HousekeepingTlm_Payload::RegisteredLibs
$sc_$cpu_ES_RegLibs
Global CFE_ES_HousekeepingTlm_Payload::RegisteredTasks
$sc_$cpu_ES_RegTasks
Global CFE_ES_HousekeepingTlm_Payload::ResetSubtype
$sc_$cpu_ES_ResetSubtype
Global CFE_ES_HousekeepingTlm_Payload::ResetType
$sc_$cpu_ES_ResetType
Global CFE_ES_HousekeepingTlm_Payload::SysLogBytesUsed
$sc_$cpu_ES_SYSLOGBYTEUSED
Global CFE_ES_HousekeepingTlm_Payload::SysLogEntries
$sc_$cpu_ES_SYSLOGENTRIES
Global CFE_ES_HousekeepingTlm_Payload::SysLogMode
$sc_$cpu_ES_SYSLOGMODE
Global CFE_ES_HousekeepingTlm_Payload::SysLogSize
$sc_$cpu_ES_SYSLOGSIZE
Global CFE_ES_MemPoolStats::BlockStats [CFE_MISSION_ES_POOL_MAX_BUCKETS]
$sc_$cpu_ES_BlkStats[BLK_SIZES]
Global CFE_ES_MemPoolStats::CheckErrCtr
$sc_$cpu_ES_BlkErrCTR
Global CFE_ES_MemPoolStats::NumBlocksRequested
$sc_$cpu_ES_BlksREQ
Global CFE_ES_MemPoolStats::NumFreeBytes
$sc_$cpu_ES_FreeBytes
Global CFE_ES_MemPoolStats::PoolSize
$sc_$cpu_ES_PoolSize

Generated by Doxygen
1.28 cFE Telemetry Mnemonic Cross Reference 83

Global CFE_ES_PoolStatsTlm_Payload::PoolHandle
$sc_$cpu_ES_PoolHandle
Global CFE_EVS_AppTlmData::AppEnableStatus
$sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS].APPENASTAT
Global CFE_EVS_AppTlmData::AppID
$sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS].APPID
Global CFE_EVS_AppTlmData::AppMessageSentCounter
$sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS].APPMSGSENTC
Global CFE_EVS_AppTlmData::AppMessageSquelchedCounter
$sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS].SQUELCHEDC
Global CFE_EVS_HousekeepingTlm_Payload::AppData [CFE_MISSION_ES_MAX_APPLICATIONS]
$sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS]
Global CFE_EVS_HousekeepingTlm_Payload::CommandCounter
$sc_$cpu_EVS_CMDPC
Global CFE_EVS_HousekeepingTlm_Payload::CommandErrorCounter
$sc_$cpu_EVS_CMDEC
Global CFE_EVS_HousekeepingTlm_Payload::LogEnabled
$sc_$cpu_EVS_LOGENABLED
Global CFE_EVS_HousekeepingTlm_Payload::LogFullFlag
$sc_$cpu_EVS_LOGFULL
Global CFE_EVS_HousekeepingTlm_Payload::LogMode
$sc_$cpu_EVS_LOGMODE
Global CFE_EVS_HousekeepingTlm_Payload::LogOverflowCounter
$sc_$cpu_EVS_LOGOVERFLOWC
Global CFE_EVS_HousekeepingTlm_Payload::MessageFormatMode
$sc_$cpu_EVS_MSGFMTMODE
Global CFE_EVS_HousekeepingTlm_Payload::MessageSendCounter
$sc_$cpu_EVS_MSGSENTC
Global CFE_EVS_HousekeepingTlm_Payload::MessageTruncCounter
$sc_$cpu_EVS_MSGTRUNC
Global CFE_EVS_HousekeepingTlm_Payload::OutputPort
$sc_$cpu_EVS_OUTPUTPORT
Global CFE_EVS_HousekeepingTlm_Payload::Spare1
$sc_$cpu_EVS_HK_SPARE1
Global CFE_EVS_HousekeepingTlm_Payload::Spare2
$sc_$cpu_EVS_HK_SPARE2
Global CFE_EVS_HousekeepingTlm_Payload::Spare3
$sc_$cpu_EVS_HK_SPARE3
Global CFE_EVS_HousekeepingTlm_Payload::UnregisteredAppCounter
$sc_$cpu_EVS_UNREGAPPC
Global CFE_EVS_LongEventTlm_Payload::Message [CFE_MISSION_EVS_MAX_MESSAGE_LENGTH]
$sc_$cpu_EVS_EVENT[CFE_MISSION_EVS_MAX_MESSAGE_LENGTH]

Generated by Doxygen
84

Global CFE_EVS_LongEventTlm_Payload::Spare1
$sc_$cpu_EVS_SPARE1
Global CFE_EVS_LongEventTlm_Payload::Spare2
$sc_$cpu_EVS_SPARE2
Global CFE_EVS_PacketID::AppName [CFE_MISSION_MAX_API_LEN]
$sc_$cpu_EVS_APPNAME[OS_MAX_API_NAME]
Global CFE_EVS_PacketID::EventID
$sc_$cpu_EVS_EVENTID
Global CFE_EVS_PacketID::EventType
$sc_$cpu_EVS_EVENTTYPE
Global CFE_EVS_PacketID::ProcessorID
$sc_$cpu_EVS_PROCESSORID
Global CFE_EVS_PacketID::SpacecraftID
$sc_$cpu_EVS_SCID
Global CFE_SB_HousekeepingTlm_Payload::CommandCounter
$sc_$cpu_SB_CMDPC
Global CFE_SB_HousekeepingTlm_Payload::CommandErrorCounter
$sc_$cpu_SB_CMDEC
Global CFE_SB_HousekeepingTlm_Payload::CreatePipeErrorCounter
$sc_$cpu_SB_NewPipeEC
Global CFE_SB_HousekeepingTlm_Payload::DuplicateSubscriptionsCounter
$sc_$cpu_SB_DupSubCnt
Global CFE_SB_HousekeepingTlm_Payload::GetPipeIdByNameErrorCounter
$sc_$cpu_SB_GetPipeIDByNameEC
Global CFE_SB_HousekeepingTlm_Payload::InternalErrorCounter
$sc_$cpu_SB_InternalEC
Global CFE_SB_HousekeepingTlm_Payload::MemInUse
$sc_$cpu_SB_MemInUse
Global CFE_SB_HousekeepingTlm_Payload::MemPoolHandle
$sc_$cpu_SB_MemPoolHdl
Global CFE_SB_HousekeepingTlm_Payload::MsgLimitErrorCounter
$sc_$cpu_SB_MsgLimEC
Global CFE_SB_HousekeepingTlm_Payload::MsgReceiveErrorCounter
$sc_$cpu_SB_MsgRecEC
Global CFE_SB_HousekeepingTlm_Payload::MsgSendErrorCounter
$sc_$cpu_SB_MsgSndEC
Global CFE_SB_HousekeepingTlm_Payload::NoSubscribersCounter
$sc_$cpu_SB_NoSubEC
Global CFE_SB_HousekeepingTlm_Payload::PipeOptsErrorCounter
$sc_$cpu_SB_PipeOptsEC
Global CFE_SB_HousekeepingTlm_Payload::PipeOverflowErrorCounter
$sc_$cpu_SB_PipeOvrEC

Generated by Doxygen
1.28 cFE Telemetry Mnemonic Cross Reference 85

Global CFE_SB_HousekeepingTlm_Payload::Spare2Align [1]

$sc_$cpu_SB_Spare2Align[2]
Global CFE_SB_HousekeepingTlm_Payload::SubscribeErrorCounter
$sc_$cpu_SB_SubscrEC
Global CFE_SB_HousekeepingTlm_Payload::UnmarkedMem
$sc_$cpu_SB_UnMarkedMem
Global CFE_SB_PipeDepthStats::CurrentQueueDepth
$sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDINUSE
Global CFE_SB_PipeDepthStats::MaxQueueDepth
$sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDDEPTH
Global CFE_SB_PipeDepthStats::PeakQueueDepth
$sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDPKINUSE
Global CFE_SB_PipeDepthStats::PipeId
$sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDPIPEID
Global CFE_SB_PipeDepthStats::Spare
$sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDSPARE
Global CFE_SB_StatsTlm_Payload::MaxMemAllowed
$sc_$cpu_SB_Stat.SB_SMMBMALW
Global CFE_SB_StatsTlm_Payload::MaxMsgIdsAllowed
$sc_$cpu_SB_Stat.SB_SMMMIDALW
Global CFE_SB_StatsTlm_Payload::MaxPipeDepthAllowed
$sc_$cpu_SB_Stat.SB_SMMPDALW
Global CFE_SB_StatsTlm_Payload::MaxPipesAllowed
$sc_$cpu_SB_Stat.SB_SMMPALW
Global CFE_SB_StatsTlm_Payload::MaxSubscriptionsAllowed
$sc_$cpu_SB_Stat.SB_SMMSALW
Global CFE_SB_StatsTlm_Payload::MemInUse
$sc_$cpu_SB_Stat.SB_SMBMIU
Global CFE_SB_StatsTlm_Payload::MsgIdsInUse
$sc_$cpu_SB_Stat.SB_SMMIDIU
Global CFE_SB_StatsTlm_Payload::PeakMemInUse
$sc_$cpu_SB_Stat.SB_SMPBMIU
Global CFE_SB_StatsTlm_Payload::PeakMsgIdsInUse
$sc_$cpu_SB_Stat.SB_SMPMIDIU
Global CFE_SB_StatsTlm_Payload::PeakPipesInUse
$sc_$cpu_SB_Stat.SB_SMPPIU
Global CFE_SB_StatsTlm_Payload::PeakSBBuffersInUse
$sc_$cpu_SB_Stat.SB_SMPSBBIU
Global CFE_SB_StatsTlm_Payload::PeakSubscriptionsInUse
$sc_$cpu_SB_Stat.SB_SMPSIU
Global CFE_SB_StatsTlm_Payload::PipeDepthStats [CFE_MISSION_SB_MAX_PIPES]
$sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES]

Generated by Doxygen
86

Global CFE_SB_StatsTlm_Payload::PipesInUse
$sc_$cpu_SB_Stat.SB_SMPIU
Global CFE_SB_StatsTlm_Payload::SBBuffersInUse
$sc_$cpu_SB_Stat.SB_SMSBBIU
Global CFE_SB_StatsTlm_Payload::SubscriptionsInUse
$sc_$cpu_SB_Stat.SB_SMSIU
Global CFE_TBL_HousekeepingTlm_Payload::ActiveBuffer
$sc_$cpu_TBL_LastValBuf
Global CFE_TBL_HousekeepingTlm_Payload::ByteAlignPad1
$sc_$cpu_TBL_ByteAlignPad1
Global CFE_TBL_HousekeepingTlm_Payload::CommandCounter
$sc_$cpu_TBL_CMDPC
Global CFE_TBL_HousekeepingTlm_Payload::CommandErrorCounter
$sc_$cpu_TBL_CMDEC
Global CFE_TBL_HousekeepingTlm_Payload::FailedValCounter
$sc_$cpu_TBL_ValFailedCtr
Global CFE_TBL_HousekeepingTlm_Payload::LastFileDumped [CFE_MISSION_MAX_PATH_LEN]
$sc_$cpu_TBL_LastFileDumped[OS_MAX_PATH_LEN]
Global CFE_TBL_HousekeepingTlm_Payload::LastFileLoaded [CFE_MISSION_MAX_PATH_LEN]
$sc_$cpu_TBL_LastFileLoaded[OS_MAX_PATH_LEN]
Global CFE_TBL_HousekeepingTlm_Payload::LastTableLoaded [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]
$sc_$cpu_TBL_LastTableLoaded[CFE_TBL_MAX_FULL_NAME_LEN]
Global CFE_TBL_HousekeepingTlm_Payload::LastUpdatedTable [CFE_MISSION_TBL_MAX_FULL_NAME_L←-
EN]
$sc_$cpu_TBL_LastUpdTblName[CFE_TB_MAX_FULL_NAME_LEN]
Global CFE_TBL_HousekeepingTlm_Payload::LastUpdateTime
$sc_$cpu_TBL_LastUpdTime, $sc_$cpu_TBL_SECONDS, $sc_$cpu_TBL_SUBSECONDS
Global CFE_TBL_HousekeepingTlm_Payload::LastValCrc
$sc_$cpu_TBL_LastValCRC
Global CFE_TBL_HousekeepingTlm_Payload::LastValStatus
$sc_$cpu_TBl_LastValS
Global CFE_TBL_HousekeepingTlm_Payload::LastValTableName [CFE_MISSION_TBL_MAX_FULL_NAME_L←-
EN]
$sc_$cpu_TBL_LastValTblName[CFE_TB_MAX_FULL_NAME_LEN]
Global CFE_TBL_HousekeepingTlm_Payload::MemPoolHandle
$sc_$cpu_TBL_MemPoolHandle
Global CFE_TBL_HousekeepingTlm_Payload::NumFreeSharedBufs
$sc_$cpu_TBL_NumFreeShrBuf
Global CFE_TBL_HousekeepingTlm_Payload::NumLoadPending
$sc_$cpu_TBL_NumUpdatesPend
Global CFE_TBL_HousekeepingTlm_Payload::NumTables
$sc_$cpu_TBL_NumTables

Generated by Doxygen
1.28 cFE Telemetry Mnemonic Cross Reference 87

Global CFE_TBL_HousekeepingTlm_Payload::NumValRequests
$sc_$cpu_TBL_ValReqCtr
Global CFE_TBL_HousekeepingTlm_Payload::SuccessValCounter
$sc_$cpu_TBL_ValSuccessCtr
Global CFE_TBL_HousekeepingTlm_Payload::ValidationCounter
$sc_$cpu_TBL_ValCompltdCtr
Global CFE_TBL_TblRegPacket_Payload::ActiveBufferAddr
$sc_$cpu_TBL_ActBufAdd
Global CFE_TBL_TblRegPacket_Payload::ByteAlign4
$sc_$cpu_TBL_Spare4
Global CFE_TBL_TblRegPacket_Payload::Crc
$sc_$cpu_TBL_CRC
Global CFE_TBL_TblRegPacket_Payload::Critical
$sc_$cpu_TBL_Spare3
Global CFE_TBL_TblRegPacket_Payload::DoubleBuffered
$sc_$cpu_TBL_DblBuffered
Global CFE_TBL_TblRegPacket_Payload::DumpOnly
$sc_$cpu_TBL_DumpOnly
Global CFE_TBL_TblRegPacket_Payload::FileTime
$sc_$cpu_TBL_FILECTIME
Global CFE_TBL_TblRegPacket_Payload::InactiveBufferAddr
$sc_$cpu_TBL_IActBufAdd
Global CFE_TBL_TblRegPacket_Payload::LastFileLoaded [CFE_MISSION_MAX_PATH_LEN]
$sc_$cpu_TBL_LastFileUpd[OS_MAX_PATH_LEN]
Global CFE_TBL_TblRegPacket_Payload::LoadPending
$sc_$cpu_TBL_UpdatePndng
Global CFE_TBL_TblRegPacket_Payload::Name [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]
$sc_$cpu_TBL_Name[CFE_TB_MAX_FULL_NAME_LEN]
Global CFE_TBL_TblRegPacket_Payload::OwnerAppName [CFE_MISSION_MAX_API_LEN]
$sc_$cpu_TBL_OwnerApp[OS_MAX_API_NAME]
Global CFE_TBL_TblRegPacket_Payload::Size
$sc_$cpu_TBL_SIZE
Global CFE_TBL_TblRegPacket_Payload::TableLoadedOnce
$sc_$cpu_TBL_LoadedOnce
Global CFE_TBL_TblRegPacket_Payload::TimeOfLastUpdate
$sc_$cpu_TBL_TimeLastUpd, $sc_$cpu_TBL_TLUSECONDS, $sc_$cpu_TBL_TLUSUBSECONDS
Global CFE_TBL_TblRegPacket_Payload::ValidationFuncPtr
$sc_$cpu_TBL_ValFuncPtr
Global CFE_TIME_DiagnosticTlm_Payload::AtToneDelay
$sc_$cpu_TIME_DLatentS, $sc_$cpu_TIME_DLatentSs
Global CFE_TIME_DiagnosticTlm_Payload::AtToneLatch
$sc_$cpu_TIME_DTValidS, $sc_$cpu_TIME_DTValidSs

Generated by Doxygen
88

Global CFE_TIME_DiagnosticTlm_Payload::AtToneLeapSeconds
$sc_$cpu_TIME_DLeapS

Global CFE_TIME_DiagnosticTlm_Payload::AtToneMET
$sc_$cpu_TIME_DTMETS, $sc_$cpu_TIME_DTMETSs

Global CFE_TIME_DiagnosticTlm_Payload::AtToneSTCF
$sc_$cpu_TIME_DSTCFS, $sc_$cpu_TIME_DSTCFSS

Global CFE_TIME_DiagnosticTlm_Payload::ClockFlyState
$sc_$cpu_TIME_DFlywheel

Global CFE_TIME_DiagnosticTlm_Payload::ClockSetState
$sc_$cpu_TIME_DValid

Global CFE_TIME_DiagnosticTlm_Payload::ClockSignal
$sc_$cpu_TIME_DSignal

Global CFE_TIME_DiagnosticTlm_Payload::ClockSource
$sc_$cpu_TIME_DSource

Global CFE_TIME_DiagnosticTlm_Payload::ClockStateAPI
$sc_$cpu_TIME_DAPIState

Global CFE_TIME_DiagnosticTlm_Payload::ClockStateFlags
$sc_$cpu_TIME_DStateFlags, $sc_$cpu_TIME_DFlagSet, $sc_$cpu_TIME_DFlagFly, $sc_$cpu_TIME_DFlagSrc,
$sc_$cpu_TIME_DFlagPri, $sc_$cpu_TIME_DFlagSfly, $sc_$cpu_TIME_DFlagCfly, $sc_$cpu_TIME_DFlagAdjd,
$sc_$cpu_TIME_DFlag1Hzd, $sc_$cpu_TIME_DFlagClat, $sc_$cpu_TIME_DFlagSorC, $sc_$cpu_TIME_DFlag←-
NIU

Global CFE_TIME_DiagnosticTlm_Payload::CurrentLatch
$sc_$cpu_TIME_DLocalS, $sc_$cpu_TIME_DLocalSs

Global CFE_TIME_DiagnosticTlm_Payload::CurrentMET
$sc_$cpu_TIME_DMETS, $sc_$cpu_TIME_DMETSs

Global CFE_TIME_DiagnosticTlm_Payload::CurrentTAI
$sc_$cpu_TIME_DTAIS, $sc_$cpu_TIME_DTAISS

Global CFE_TIME_DiagnosticTlm_Payload::CurrentUTC
$sc_$cpu_TIME_DUTCS, $sc_$cpu_TIME_DUTCSS

Global CFE_TIME_DiagnosticTlm_Payload::DataStoreStatus
$sc_$cpu_TIME_DataStStat

Global CFE_TIME_DiagnosticTlm_Payload::DelayDirection
$sc_$cpu_TIME_DLatentDir

Global CFE_TIME_DiagnosticTlm_Payload::Forced2Fly
$sc_$cpu_TIME_DCMD2Fly

Global CFE_TIME_DiagnosticTlm_Payload::LocalIntCounter
$sc_$cpu_TIME_D1HzISRCNT

Global CFE_TIME_DiagnosticTlm_Payload::LocalTaskCounter
$sc_$cpu_TIME_D1HzTaskCNT

Global CFE_TIME_DiagnosticTlm_Payload::MaxElapsed
$sc_$cpu_TIME_DMaxWindow

Generated by Doxygen
1.28 cFE Telemetry Mnemonic Cross Reference 89

Global CFE_TIME_DiagnosticTlm_Payload::MaxLocalClock
$sc_$cpu_TIME_DWrapS, $sc_$cpu_TIME_DWrapSs
Global CFE_TIME_DiagnosticTlm_Payload::MinElapsed
$sc_$cpu_TIME_DMinWindow
Global CFE_TIME_DiagnosticTlm_Payload::OneHzAdjust
$sc_$cpu_TIME_D1HzAdjS, $sc_$cpu_TIME_D1HzAdjSs
Global CFE_TIME_DiagnosticTlm_Payload::OneHzDirection
$sc_$cpu_TIME_D1HzAdjDir
Global CFE_TIME_DiagnosticTlm_Payload::OneTimeAdjust
$sc_$cpu_TIME_DAdjustS, $sc_$cpu_TIME_DAdjustSs
Global CFE_TIME_DiagnosticTlm_Payload::OneTimeDirection
$sc_$cpu_TIME_DAdjustDir
Global CFE_TIME_DiagnosticTlm_Payload::ServerFlyState
$sc_$cpu_TIME_DSrvFly
Global CFE_TIME_DiagnosticTlm_Payload::TimeSinceTone
$sc_$cpu_TIME_DElapsedS, $sc_$cpu_TIME_DElapsedSs
Global CFE_TIME_DiagnosticTlm_Payload::ToneDataCounter
$sc_$cpu_TIME_DTatTCNT
Global CFE_TIME_DiagnosticTlm_Payload::ToneDataLatch
$sc_$cpu_TIME_DTDS, $sc_$cpu_TIME_DTDSs
Global CFE_TIME_DiagnosticTlm_Payload::ToneIntCounter
$sc_$cpu_TIME_DTsISRCNT
Global CFE_TIME_DiagnosticTlm_Payload::ToneIntErrorCounter
$sc_$cpu_TIME_DTsISRERR
Global CFE_TIME_DiagnosticTlm_Payload::ToneMatchCounter
$sc_$cpu_TIME_DVerifyCNT
Global CFE_TIME_DiagnosticTlm_Payload::ToneMatchErrorCounter
$sc_$cpu_TIME_DVerifyER
Global CFE_TIME_DiagnosticTlm_Payload::ToneOverLimit
$sc_$cpu_TIME_DMaxSs
Global CFE_TIME_DiagnosticTlm_Payload::ToneSignalCounter
$sc_$cpu_TIME_DTSDetCNT
Global CFE_TIME_DiagnosticTlm_Payload::ToneSignalLatch
$sc_$cpu_TIME_DTTS, $sc_$cpu_TIME_DTTSs
Global CFE_TIME_DiagnosticTlm_Payload::ToneTaskCounter
$sc_$cpu_TIME_DTsTaskCNT
Global CFE_TIME_DiagnosticTlm_Payload::ToneUnderLimit
$sc_$cpu_TIME_DMinSs
Global CFE_TIME_DiagnosticTlm_Payload::VersionCounter
$sc_$cpu_TIME_DVersionCNT
Global CFE_TIME_DiagnosticTlm_Payload::VirtualMET
$sc_$cpu_TIME_DLogicalMET

Generated by Doxygen
90

Global CFE_TIME_HousekeepingTlm_Payload::ClockStateAPI
$sc_$cpu_TIME_DAPIState
Global CFE_TIME_HousekeepingTlm_Payload::ClockStateFlags
$sc_$cpu_TIME_StateFlg, $sc_$cpu_TIME_FlagSet, $sc_$cpu_TIME_FlagFly, $sc_$cpu_TIME_FlagSrc, $sc_←-
$cpu_TIME_FlagPri, $sc_$cpu_TIME_FlagSfly, $sc_$cpu_TIME_FlagCfly, $sc_$cpu_TIME_FlagAdjd, $sc_$cpu←-
_TIME_Flag1Hzd, $sc_$cpu_TIME_FlagClat, $sc_$cpu_TIME_FlagSorC, $sc_$cpu_TIME_FlagNIU
Global CFE_TIME_HousekeepingTlm_Payload::CommandCounter
$sc_$cpu_TIME_CMDPC
Global CFE_TIME_HousekeepingTlm_Payload::CommandErrorCounter
$sc_$cpu_TIME_CMDEC
Global CFE_TIME_HousekeepingTlm_Payload::LeapSeconds
$sc_$cpu_TIME_LeapSecs
Global CFE_TIME_HousekeepingTlm_Payload::Seconds1HzAdj
$sc_$cpu_TIME_1HzAdjSecs
Global CFE_TIME_HousekeepingTlm_Payload::SecondsDelay
$sc_$cpu_TIME_1HzAdjSecs
Global CFE_TIME_HousekeepingTlm_Payload::SecondsMET
$sc_$cpu_TIME_METSecs
Global CFE_TIME_HousekeepingTlm_Payload::SecondsSTCF
$sc_$cpu_TIME_STCFSecs
Global CFE_TIME_HousekeepingTlm_Payload::Subsecs1HzAdj
$sc_$cpu_TIME_1HzAdjSSecs
Global CFE_TIME_HousekeepingTlm_Payload::SubsecsDelay
$sc_$cpu_TIME_1HzAdjSSecs
Global CFE_TIME_HousekeepingTlm_Payload::SubsecsMET
$sc_$cpu_TIME_METSubsecs
Global CFE_TIME_HousekeepingTlm_Payload::SubsecsSTCF
$sc_$cpu_TIME_STCFSubsecs

2 Glossary of Terms

Term Definition
A set of data and functions that is treated as a single entity by the cFE.
Application (or App)
cFE resources are allocated on a per-Application basis. Applications are
made up of a Main Task and zero or more Child Tasks.
A processor unique reference to an Application.
Application ID
NOTE: This is different from a CCSDS Application ID which is re-
ferred to as an "APID."
A set of routines, protocols, and tools for building software applications
Application Programmer's Interface (API)
A collection of user-provided facilities that interface an OS and the cFE
Platform Support Package (PSP)
with a specific hardware platform. The PSP is responsible for hardware
initialization.
A separate thread of execution that is spawned by an Application's Main
Child Task
Task.

Generated by Doxygen
3 cFE Application Programmer's Interface (API) Reference 91

Term Definition
A Software Bus Message defined by the receiving Application. Com-
Command
mands can originate from other onboard Applications or from the
ground.
A runtime environment and a set of services for hosting FSW Applica-
Core Flight Executive (cFE)
tions
A collection of data that is not modified by the OS or cFE following a
Critical Data Store (CDS)
Processor Reset.
A polynomial based method for checking that a data set has remained
Cyclic Redundancy Check
unchanged from one time period to another.
Anyone who is coding a cFE Application.
Developer
Data describing an Event that is supplied to the cFE Event Service. The
Event Data
cFE includes this data in an Event Message.
A numeric value (bit mask) used to determine how frequently to output
Event Filter
an application Event Message defined by its Event ID.
Defines the Event Message Format downlink option: short or long. The
Event Format Mode
short format is used when there is limited telemetry bandwidth and is
binary. The long format is in ASCII and is used for logging to a Local
Event Log and to an Event Message Port.
A numeric literal used to uniquely name an Application event.
Event ID
A numeric literal used to identify the type of an Application
Event Type
event. An event type may be CFE_EVS_EventType_DEBUG,
CFE_EVS_EventType_INFORMATION, CFE_EVS_EventType_ERROR,
or CFE_EVS_EventType_CRITICAL.
A data item used to notify the user and/or an external Application
Event Message
of a significant event. Event Messages include a time-stamp of
when the message was generated, a processor unique identifier, an
Application ID, the Event Type (DEBUG,INFO,ERROR or CRITICAL),
and Event Data. An Event Message can either be real-time or playback
from a Local Event Log.

3 cFE Application Programmer's Interface (API) Reference

3.1 Executive Services API
• cFE Entry/Exit APIs

– CFE_ES_Main - cFE Main Entry Point used by Board Support Package to start cFE
– CFE_ES_ResetCFE - Reset the cFE Core and all cFE Applications.

• cFE Application Control APIs

– CFE_ES_RestartApp - Restart a single cFE Application.

– CFE_ES_ReloadApp - Reload a single cFE Application.
– CFE_ES_DeleteApp - Delete a cFE Application.

• cFE Application Behavior APIs

– CFE_ES_RunLoop - Check for Exit, Restart, or Reload commands.

– CFE_ES_WaitForStartupSync - Allow an Application to Wait for the "OPERATIONAL" global system state.
– CFE_ES_WaitForSystemState - Allow an Application to Wait for a minimum global system state.

Generated by Doxygen
92

– CFE_ES_IncrementTaskCounter - Increments the execution counter for the calling task.

– CFE_ES_ExitApp - Exit a cFE Application.

• cFE Information APIs

– CFE_ES_GetResetType - Return the most recent Reset Type.

– CFE_ES_GetAppID - Get an Application ID for the calling Application.
– CFE_ES_GetTaskID - Get the task ID of the calling context.
– CFE_ES_GetAppIDByName - Get an Application ID associated with a specified Application name.
– CFE_ES_GetLibIDByName - Get a Library ID associated with a specified Library name.
– CFE_ES_GetAppName - Get an Application name for a specified Application ID.
– CFE_ES_GetLibName - Get a Library name for a specified Library ID.
– CFE_ES_GetAppInfo - Get Application Information given a specified App ID.
– CFE_ES_GetTaskInfo - Get Task Information given a specified Task ID.
– CFE_ES_GetLibInfo - Get Library Information given a specified Resource ID.
– CFE_ES_GetModuleInfo - Get Information given a specified Resource ID.

• cFE Child Task APIs

– CFE_ES_CreateChildTask - Creates a new task under an existing Application.

– CFE_ES_GetTaskIDByName - Get a Task ID associated with a specified Task name.
– CFE_ES_GetTaskName - Get a Task name for a specified Task ID.
– CFE_ES_DeleteChildTask - Deletes a task under an existing Application.
– CFE_ES_ExitChildTask - Exits a child task.

• cFE Critical Data Store APIs

– CFE_ES_RegisterCDS - Reserve space (or re-obtain previously reserved space) in the Critical Data Store
(CDS)
– CFE_ES_GetCDSBlockIDByName - Get a CDS Block ID associated with a specified CDS Block name.
– CFE_ES_GetCDSBlockName - Get a Block name for a specified Block ID.
– CFE_ES_CopyToCDS - Save a block of data in the Critical Data Store (CDS)
– CFE_ES_RestoreFromCDS - Recover a block of data from the Critical Data Store (CDS)

• cFE Memory Manager APIs

– CFE_ES_PoolCreate - Initializes a memory pool created by an application while using a semaphore during
processing.
– CFE_ES_PoolCreateEx - Initializes a memory pool created by an application with application specified block
sizes.
– CFE_ES_PoolCreateNoSem - Initializes a memory pool created by an application without using a
semaphore during processing.
– CFE_ES_PoolDelete - Deletes a memory pool that was previously created.
– CFE_ES_GetPoolBuf - Gets a buffer from the memory pool created by CFE_ES_PoolCreate or
CFE_ES_PoolCreateNoSem.
– CFE_ES_PutPoolBuf - Releases a buffer from the memory pool that was previously allocated via
CFE_ES_GetPoolBuf.
– CFE_ES_GetMemPoolStats - Extracts the statistics maintained by the memory pool software.
– CFE_ES_GetPoolBufInfo - Gets info on a buffer previously allocated via CFE_ES_GetPoolBuf.

Generated by Doxygen
3.2 Events Services API 93

• cFE Performance Monitor APIs

– CFE_ES_PerfLogEntry - Entry marker for use with Software Performance Analysis Tool.
– CFE_ES_PerfLogExit - Exit marker for use with Software Performance Analysis Tool.
– CFE_ES_PerfLogAdd - Adds a new entry to the data buffer.

• cFE Generic Counter APIs

– CFE_ES_RegisterGenCounter - Register a generic counter.

– CFE_ES_DeleteGenCounter - Delete a generic counter.
– CFE_ES_IncrementGenCounter - Increments the specified generic counter.
– CFE_ES_SetGenCount - Set the specified generic counter.
– CFE_ES_GetGenCount - Get the specified generic counter count.
– CFE_ES_GetGenCounterIDByName - Get the Id associated with a generic counter name.
– CFE_ES_GetGenCounterName - Get a Counter name for a specified Counter ID.

• cFE Miscellaneous APIs

– CFE_ES_BackgroundWakeup - Wakes up the CFE background task.

– CFE_ES_CalculateCRC - Calculate a CRC on a block of memory.
– CFE_ES_WriteToSysLog - Write a string to the cFE System Log.
– CFE_ES_ProcessAsyncEvent - Notification that an asynchronous event was detected by the underlying
OS/PSP.
– CFE_ES_StatusToString - Convert status to a string.

• cFE Resource ID APIs

– CFE_ES_AppID_ToIndex - Obtain an index value correlating to an ES Application ID.

– CFE_ES_LibID_ToIndex - Obtain an index value correlating to an ES Library ID.
– CFE_ES_TaskID_ToIndex - Obtain an index value correlating to an ES Task ID.
– CFE_ES_CounterID_ToIndex - Obtain an index value correlating to an ES Counter ID.

3.2 Events Services API

• cFE Registration APIs

– CFE_EVS_Register - Register an application for receiving event services.

• cFE Send Event APIs

– CFE_EVS_SendEvent - Generate a software event.

– CFE_EVS_SendEventWithAppID - Generate a software event given the specified Application ID.
– CFE_EVS_SendTimedEvent - Generate a software event with a specific time tag.

• cFE Reset Event Filter APIs

– CFE_EVS_ResetFilter - Resets the calling application's event filter for a single event ID.
– CFE_EVS_ResetAllFilters - Resets all of the calling application's event filters.

Generated by Doxygen
94

3.3 File Services API

• cFE File Header Management APIs

– CFE_FS_ReadHeader - Read the contents of the Standard cFE File Header.

– CFE_FS_InitHeader - Initializes the contents of the Standard cFE File Header.
– CFE_FS_WriteHeader - Write the specified Standard cFE File Header to the specified file.
– CFE_FS_SetTimestamp - Modifies the Time Stamp field in the Standard cFE File Header for the specified
file.

• cFE File Utility APIs

– CFE_FS_GetDefaultMountPoint - Get the default virtual mount point for a file category.
– CFE_FS_GetDefaultExtension - Get the default filename extension for a file category.
– CFE_FS_ParseInputFileNameEx - Parse a filename input from an input buffer into a local buffer.
– CFE_FS_ParseInputFileName - Parse a filename string from the user into a local buffer.
– CFE_FS_ExtractFilenameFromPath - Extracts the filename from a unix style path and filename string.
– CFE_FS_BackgroundFileDumpRequest - Register a background file dump request.
– CFE_FS_BackgroundFileDumpIsPending - Query if a background file write request is currently pending.

3.4 Message API

• cFE Generic Message APIs

– CFE_MSG_Init - Initialize a message.

• cFE Message Primary Header APIs

– CFE_MSG_GetSize - Gets the total size of a message.

– CFE_MSG_SetSize - Sets the total size of a message.
– CFE_MSG_GetType - Gets the message type.
– CFE_MSG_SetType - Sets the message type.
– CFE_MSG_GetHeaderVersion - Gets the message header version.
– CFE_MSG_SetHeaderVersion - Sets the message header version.
– CFE_MSG_GetHasSecondaryHeader - Gets the message secondary header boolean.
– CFE_MSG_SetHasSecondaryHeader - Sets the message secondary header boolean.
– CFE_MSG_GetApId - Gets the message application ID.
– CFE_MSG_SetApId - Sets the message application ID.
– CFE_MSG_GetSegmentationFlag - Gets the message segmentation flag.
– CFE_MSG_SetSegmentationFlag - Sets the message segmentation flag.
– CFE_MSG_GetSequenceCount - Gets the message sequence count.
– CFE_MSG_SetSequenceCount - Sets the message sequence count.
– CFE_MSG_GetNextSequenceCount - Gets the next sequence count value (rolls over if appropriate)

• cFE Message Extended Header APIs

– CFE_MSG_GetEDSVersion - Gets the message EDS version.

– CFE_MSG_SetEDSVersion - Sets the message EDS version.
– CFE_MSG_GetEndian - Gets the message endian.

Generated by Doxygen
3.5 Resource ID API 95

– CFE_MSG_SetEndian - Sets the message endian.

– CFE_MSG_GetPlaybackFlag - Gets the message playback flag.
– CFE_MSG_SetPlaybackFlag - Sets the message playback flag.
– CFE_MSG_GetSubsystem - Gets the message subsystem.
– CFE_MSG_SetSubsystem - Sets the message subsystem.
– CFE_MSG_GetSystem - Gets the message system.
– CFE_MSG_SetSystem - Sets the message system.

• cFE Message Secondary Header APIs

– CFE_MSG_GenerateChecksum - Calculates and sets the checksum of a message.

– CFE_MSG_ValidateChecksum - Validates the checksum of a message.
– CFE_MSG_SetFcnCode - Sets the function code field in a message.
– CFE_MSG_GetFcnCode - Gets the function code field from a message.
– CFE_MSG_GetMsgTime - Gets the time field from a message.
– CFE_MSG_SetMsgTime - Sets the time field in a message.

• cFE Message Id APIs

– CFE_MSG_GetMsgId - Gets the message id from a message.

– CFE_MSG_SetMsgId - Sets the message id bits in a message.
– CFE_MSG_GetTypeFromMsgId - Gets message type using message ID.

3.5 Resource ID API

• cFE Resource Misc APIs

– CFE_ResourceId_ToInteger - Convert a resource ID to an integer.

– CFE_ResourceId_FromInteger - Convert an integer to a resource ID.
– CFE_ResourceId_Equal - Compare two Resource ID values for equality.
– CFE_ResourceId_IsDefined - Check if a resource ID value is defined.
– CFE_ResourceId_GetBase - Get the Base value (type/category) from a resource ID value.
– CFE_ResourceId_GetSerial - Get the Serial Number (sequential ID) from a resource ID value.
– CFE_ResourceId_FindNext - Locate the next resource ID which does not map to an in-use table entry.
– CFE_ResourceId_ToIndex - Internal routine to aid in converting an ES resource ID to an array index.

3.6 Software Bus Services API

• cFE Pipe Management APIs

– CFE_SB_CreatePipe - Creates a new software bus pipe.

– CFE_SB_DeletePipe - Delete a software bus pipe.
– CFE_SB_PipeId_ToIndex - Obtain an index value correlating to an SB Pipe ID.
– CFE_SB_SetPipeOpts - Set options on a pipe.
– CFE_SB_GetPipeOpts - Get options on a pipe.
– CFE_SB_GetPipeName - Get the pipe name for a given id.
– CFE_SB_GetPipeIdByName - Get pipe id by pipe name.

• cFE Message Subscription Control APIs

Generated by Doxygen
96

– CFE_SB_Subscribe - Subscribe to a message on the software bus with default parameters.

– CFE_SB_SubscribeEx - Subscribe to a message on the software bus.
– CFE_SB_SubscribeLocal - Subscribe to a message while keeping the request local to a cpu.
– CFE_SB_Unsubscribe - Remove a subscription to a message on the software bus.
– CFE_SB_UnsubscribeLocal - Remove a subscription to a message on the software bus on the current CPU.

• cFE Send/Receive Message APIs

– CFE_SB_TransmitMsg - Transmit a message.

– CFE_SB_ReceiveBuffer - Receive a message from a software bus pipe.

• cFE Zero Copy APIs

– CFE_SB_AllocateMessageBuffer - Get a buffer pointer to use for "zero copy" SB sends.

– CFE_SB_ReleaseMessageBuffer - Release an unused "zero copy" buffer pointer.
– CFE_SB_TransmitBuffer - Transmit a buffer.

• cFE Message Characteristics APIs

– CFE_SB_SetUserDataLength - Sets the length of user data in a software bus message.

– CFE_SB_TimeStampMsg - Sets the time field in a software bus message with the current spacecraft time.
– CFE_SB_MessageStringSet - Copies a string into a software bus message.
– CFE_SB_GetUserData - Get a pointer to the user data portion of a software bus message.
– CFE_SB_GetUserDataLength - Gets the length of user data in a software bus message.
– CFE_SB_MessageStringGet - Copies a string out of a software bus message.

• cFE Message ID APIs

– CFE_SB_IsValidMsgId - Identifies whether a given CFE_SB_MsgId_t is valid.

– CFE_SB_MsgId_Equal - Identifies whether two CFE_SB_MsgId_t values are equal.
– CFE_SB_MsgIdToValue - Converts a CFE_SB_MsgId_t to a normal integer.
– CFE_SB_ValueToMsgId - Converts a normal integer into a CFE_SB_MsgId_t.

3.7 Table Services API

• cFE Registration APIs

– CFE_TBL_Register - Register a table with cFE to obtain Table Management Services.

– CFE_TBL_Share - Obtain handle of table registered by another application.
– CFE_TBL_Unregister - Unregister a table.

• cFE Manage Table Content APIs

– CFE_TBL_Load - Load a specified table with data from specified source.

– CFE_TBL_Update - Update contents of a specified table, if an update is pending.
– CFE_TBL_Validate - Perform steps to validate the contents of a table image.
– CFE_TBL_Manage - Perform standard operations to maintain a table.
– CFE_TBL_DumpToBuffer - Copies the contents of a Dump Only Table to a shared buffer.
– CFE_TBL_Modified - Notify cFE Table Services that table contents have been modified by the Application.

• cFE Access Table Content APIs

Generated by Doxygen
3.8 Time Services API 97

– CFE_TBL_GetAddress - Obtain the current address of the contents of the specified table.
– CFE_TBL_GetAddresses - Obtain the current addresses of an array of specified tables.
– CFE_TBL_ReleaseAddress - Release previously obtained pointer to the contents of the specified table.
– CFE_TBL_ReleaseAddresses - Release the addresses of an array of specified tables.

• cFE Get Table Information APIs

– CFE_TBL_GetStatus - Obtain current status of pending actions for a table.

– CFE_TBL_GetInfo - Obtain characteristics/information of/about a specified table.
– CFE_TBL_NotifyByMessage - Instruct cFE Table Services to notify Application via message when table
requires management.

3.8 Time Services API

• cFE Get Current Time APIs

– CFE_TIME_GetTime - Get the current spacecraft time.

– CFE_TIME_GetTAI - Get the current TAI (MET + SCTF) time.
– CFE_TIME_GetUTC - Get the current UTC (MET + SCTF - Leap Seconds) time.
– CFE_TIME_GetMET - Get the current value of the Mission Elapsed Time (MET).
– CFE_TIME_GetMETseconds - Get the current seconds count of the mission-elapsed time.
– CFE_TIME_GetMETsubsecs - Get the current sub-seconds count of the mission-elapsed time.

• cFE Get Time Information APIs

– CFE_TIME_GetSTCF - Get the current value of the spacecraft time correction factor (STCF).
– CFE_TIME_GetLeapSeconds - Get the current value of the leap seconds counter.
– CFE_TIME_GetClockState - Get the current state of the spacecraft clock.
– CFE_TIME_GetClockInfo - Provides information about the spacecraft clock.

• cFE Time Arithmetic APIs

– CFE_TIME_Add - Adds two time values.

– CFE_TIME_Subtract - Subtracts two time values.
– CFE_TIME_Compare - Compares two time values.

• cFE Time Conversion APIs

– CFE_TIME_MET2SCTime - Convert specified MET into Spacecraft Time.

– CFE_TIME_Sub2MicroSecs - Converts a sub-seconds count to an equivalent number of microseconds.
– CFE_TIME_Micro2SubSecs - Converts a number of microseconds to an equivalent sub-seconds count.

• cFE External Time Source APIs

– CFE_TIME_ExternalTone - Provides the 1 Hz signal from an external source.

– CFE_TIME_ExternalMET - Provides the Mission Elapsed Time from an external source.
– CFE_TIME_ExternalGPS - Provide the time from an external source that has data common to GPS re-
ceivers.
– CFE_TIME_ExternalTime - Provide the time from an external source that measures time relative to a known
epoch.
– CFE_TIME_RegisterSynchCallback - Registers a callback function that is called whenever time synchro-
nization occurs.

Generated by Doxygen
98

– CFE_TIME_UnregisterSynchCallback - Unregisters a callback function that is called whenever time syn-

chronization occurs.

• cFE Miscellaneous Time APIs

– CFE_TIME_Print - Print a time value as a string.

– CFE_TIME_Local1HzISR - This function is called via a timer callback set up at initialization of the TIME
service.

4 Osal API Documentation

• General Information and Concepts

– OSAL Introduction

• Core

– OSAL Return Code Defines

– OSAL Object Type Defines
– APIs

* OSAL Core Operation APIs

* OSAL Object ID Utility APIs
* OSAL Task APIs
* OSAL Message Queue APIs
* OSAL Heap APIs
* OSAL Error Info APIs
* OSAL Select APIs
* OSAL Printf APIs
* OSAL BSP low level access APIs
* OSAL Real Time Clock APIs
* OSAL Shell APIs
– Common Reference
– Return Code Reference
– Id Map Reference
– Clock Reference
– Task Reference
– Message Queue Reference
– Heap Reference
– Select Reference
– Printf Reference
– BSP Reference
– Shell Reference

• File System

– File System Overview

– File Descriptors In Osal
– OSAL File Access Option Defines
– OSAL Reference Point For Seek Offset Defines

Generated by Doxygen
4.1 OSAL Introduction 99

– APIs
* OSAL Standard File APIs
* OSAL Directory APIs
* OSAL File System Level APIs
– File System Reference
– File Reference
– Directory Reference

• Object File Loader

– APIs
* OSAL Dynamic Loader and Symbol APIs
– File Loader Reference

• Network

– APIs
* OSAL Network ID APIs
* OSAL Socket Address APIs
* OSAL Socket Management APIs
– Network Reference
– Socket Reference

• Timer

– Timer Overview
– APIs
* OSAL Time Base APIs
* OSAL Timer APIs
– Timer Reference
– Time Base Reference

• Semaphore and Mutex

– OSAL Semaphore State Defines

– APIs
* OSAL Binary Semaphore APIs
* OSAL Counting Semaphore APIs
* OSAL Mutex APIs
– Binary Semaphore Reference
– Counting Semaphore Reference
– Mutex Reference

4.1 OSAL Introduction

The goal of this library is to promote the creation of portable and reusable real time embedded system software. Given
the necessary OS abstraction layer implementations, the same embedded software should compile and run on a number
of platforms ranging from spacecraft computer systems to desktop PCs.
The OS Application Program Interfaces (APIs) are broken up into core, file system, loader, network, and timer APIs.
See the related document sections for full descriptions.
Note

The majority of these APIs should be called from a task running in the context of an OSAL application and in gen-
eral should not be called from an ISR. There are a few exceptions, such as the ability to give a binary semaphore
from an ISR.

Generated by Doxygen
100

4.2 File System Overview

The File System API is a thin wrapper around a selection of POSIX file APIs. In addition the File System API presents
a common directory structure and 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:

• RAM:0/file1.dat becomes /mnt/ram/file1.dat

• FL:0/file2.dat becomes /mnt/fl/file2.dat

This abstraction allows the applications to use the same paths regardless of the implementation and it also allows file
systems to be simulated on a desktop system for testing. On a desktop Linux system, the file system abstraction can
be set up to map virtual devices to a regular directory. This is accomplished through the OS_mkfs call, OS_mount call,
and a BSP specific volume table that maps the virtual devices to real devices or underlying file systems.
In order to make this file system volume abstraction work, a “Volume Table” needs to be provided in the Board Support
Package of the application. The table has the following fields:

• Device Name: This is the name of the virtual device that the Application uses. Common names are “ramdisk1”,
“flash1”, or “volatile1” etc. But the name can be any unique string.

• Physical Device Name: This is an implementation specific field. For vxWorks it is not needed and can be left
blank. For a File system based implementation, it is the “mount point” on the root file system where all of the
volume will be mounted. A common place for this on Linux could be a user’s home directory, “/tmp”, or even the
current working 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”.

• 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
a flash disk that is to be formatted before use, FLASH_DISK_INIT which uses a flash disk with an existing format
that is just to be initialized 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.

• 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_B←-
ASED path can be set up by setting this flag to one.

• Volume Name: This is an internal field and should be set to a space character “ “.

• Mount Point Field: This is an internal field and should be set to a space character “ “.

• Block Size Field: This is used to record the block size of the device and does not need to be set by the user.

4.3 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_∗ calls. The reasoning for this is as follows:
Because the OSAL now keeps track of all file descriptors, OSAL specific information can be associated with a specific
file descriptor in an OS independent way. For 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.
All of the possible file system calls are not implemented. "Special" files requiring OS specific control/operations are
by nature not portable. Abstraction in this case is not possible, so the raw OS calls should be used (including

Generated by Doxygen
4.4 Timer Overview 101

open/close/etc). Mixing with OSAL calls is not supported for such cases. OS_TranslatePath is available to support
using open directly by an app and maintain abstraction on the file system.
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.
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 work (the results of doing so are undefined). Therefore, if you open a file
with the underlying OS's open call, you must continue to use the OS's calls until you close the file descriptor. Be aware
that by doing this your software may no longer be OS agnostic.

4.4 Timer Overview

The timer API is a generic interface to the OS timer facilities. It is implemented using the POSIX timers on Linux
and vxWorks and the native timer API on RTEMS. The number of timers supported is controlled by the configuration
parameter OS_MAX_TIMERS.

5 cFE Mission Configuration Parameters

Global CFE_MISSION_ES_CMD_TOPICID
cFE Portable Message Numbers for Commands

Global CFE_MISSION_ES_HK_TLM_TOPICID
cFE Portable Message Numbers for Telemetry

Global CFE_MISSION_EVS_CMD_TOPICID
cFE Portable Message Numbers for Commands

Global CFE_MISSION_EVS_HK_TLM_TOPICID
cFE Portable Message Numbers for Telemetry

Global CFE_MISSION_MAX_API_LEN
cFE Maximum length for API names within data exchange structures
cFE Maximum length for API names within data exchange structures

Global CFE_MISSION_MAX_FILE_LEN
cFE Maximum length for filenames within data exchange structures
cFE Maximum length for filenames within data exchange structures

Global CFE_MISSION_MAX_NUM_FILES
cFE Maximum number of files in a message/data exchange
cFE Maximum number of files in a message/data exchange

Global CFE_MISSION_MAX_PATH_LEN
cFE Maximum length for pathnames within data exchange structures
cFE Maximum length for pathnames within data exchange structures

Global CFE_MISSION_SB_CMD_TOPICID
cFE Portable Message Numbers for Commands

Global CFE_MISSION_SB_HK_TLM_TOPICID
cFE Portable Message Numbers for Telemetry

Global CFE_MISSION_TBL_CMD_TOPICID
cFE Portable Message Numbers for Commands

Generated by Doxygen
102

Global CFE_MISSION_TBL_HK_TLM_TOPICID
cFE Portable Message Numbers for Telemetry

Global CFE_MISSION_TIME_CMD_TOPICID
cFE Portable Message Numbers for Commands

Global CFE_MISSION_TIME_DATA_CMD_TOPICID
cFE Portable Message Numbers for Global Messages

Global CFE_MISSION_TIME_HK_TLM_TOPICID
cFE Portable Message Numbers for Telemetry

6 Module Index
6.1 Modules
Here is a list of all modules:

cFE Return Code Defines 118

cFE Resource ID APIs 141

cFE Entry/Exit APIs 144

cFE Application Control APIs 146

cFE Application Behavior APIs 149

cFE Information APIs 153

cFE Child Task APIs 162

cFE Miscellaneous APIs 166

cFE Critical Data Store APIs 169

cFE Memory Manager APIs 174

cFE Performance Monitor APIs 181

cFE Generic Counter APIs 183

cFE Registration APIs 189

cFE Send Event APIs 191

cFE Reset Event Filter APIs 195

cFE File Header Management APIs 197

cFE File Utility APIs 201

cFE Generic Message APIs 206

cFE Message Primary Header APIs 207

cFE Message Extended Header APIs 216

Generated by Doxygen
6.1 Modules 103

cFE Message Secondary Header APIs 222

cFE Message Id APIs 227

cFE Message Integrity APIs 229

cFE Pipe Management APIs 231

cFE Message Subscription Control APIs 236

cFE Send/Receive Message APIs 241

cFE Zero Copy APIs 244

cFE Message Characteristics APIs 247

cFE Message ID APIs 251

cFE SB Pipe options 256

cFE Registration APIs 257

cFE Manage Table Content APIs 262

cFE Access Table Content APIs 268

cFE Get Table Information APIs 273

cFE Table Type Defines 276

cFE Get Current Time APIs 278

cFE Get Time Information APIs 281

cFE Time Arithmetic APIs 284

cFE Time Conversion APIs 287

cFE External Time Source APIs 289

cFE Miscellaneous Time APIs 294

cFE Resource ID base values 297

cFE Clock State Flag Defines 299

OSAL Semaphore State Defines 301

OSAL Binary Semaphore APIs 302

OSAL BSP low level access APIs 307

OSAL Real Time Clock APIs 308

OSAL Core Operation APIs 319

OSAL Condition Variable APIs 322

OSAL Counting Semaphore APIs 328

Generated by Doxygen
104

OSAL Directory APIs 333

OSAL Return Code Defines 337

OSAL Error Info APIs 344

OSAL File Access Option Defines 346

OSAL Reference Point For Seek Offset Defines 347

OSAL Standard File APIs 348

OSAL File System Level APIs 359

OSAL Heap APIs 367

OSAL Object Type Defines 368

OSAL Object ID Utility APIs 371

OSAL Dynamic Loader and Symbol APIs 376

OSAL Mutex APIs 380

OSAL Network ID APIs 384

OSAL Printf APIs 386

OSAL Message Queue APIs 387

OSAL Select APIs 391

OSAL Shell APIs 395

OSAL Socket Address APIs 396

OSAL Socket Management APIs 400

OSAL Task APIs 408

OSAL Time Base APIs 414

OSAL Timer APIs 419

7 Data Structure Index

7.1 Data Structures
Here are the data structures with brief descriptions:

CCSDS_ExtendedHeader
CCSDS packet extended header 425

CCSDS_PrimaryHeader
CCSDS packet primary header 425

Generated by Doxygen
7.1 Data Structures 105

CFE_ES_AppInfo
Application Information 426

CFE_ES_AppNameCmd_Payload
Generic application name command payload 430

CFE_ES_AppReloadCmd_Payload
Reload Application Command Payload 430

CFE_ES_BlockStats
Block statistics 431

CFE_ES_CDSRegDumpRec
CDS Register Dump Record 432

CFE_ES_ClearERLogCmd 433

CFE_ES_ClearSysLogCmd 433

CFE_ES_DeleteCDSCmd
Delete Critical Data Store Command 434

CFE_ES_DeleteCDSCmd_Payload
Delete Critical Data Store Command Payload 435

CFE_ES_DumpCDSRegistryCmd
Dump CDS Registry Command 435

CFE_ES_DumpCDSRegistryCmd_Payload
Dump CDS Registry Command Payload 436

CFE_ES_FileNameCmd
Generic file name command 436

CFE_ES_FileNameCmd_Payload
Generic file name command payload 437

CFE_ES_HousekeepingTlm 437

CFE_ES_HousekeepingTlm_Payload 438

CFE_ES_MemPoolStats
Memory Pool Statistics 446

CFE_ES_MemStatsTlm 447

CFE_ES_NoopCmd 448

CFE_ES_OneAppTlm 448

CFE_ES_OneAppTlm_Payload 449

CFE_ES_OverWriteSysLogCmd
Overwrite/Discard System Log Configuration Command Payload 449

CFE_ES_OverWriteSysLogCmd_Payload
Overwrite/Discard System Log Configuration Command Payload 450

Generated by Doxygen
106

CFE_ES_PoolAlign
Pool Alignment 451

CFE_ES_PoolStatsTlm_Payload 451

CFE_ES_QueryAllCmd 452

CFE_ES_QueryAllTasksCmd 453

CFE_ES_QueryOneCmd 453

CFE_ES_ReloadAppCmd
Reload Application Command 454

CFE_ES_ResetCountersCmd 454

CFE_ES_ResetPRCountCmd 455

CFE_ES_RestartAppCmd 455

CFE_ES_RestartCmd
Restart cFE Command 456

CFE_ES_RestartCmd_Payload
Restart cFE Command Payload 456

CFE_ES_SendHkCmd 457

CFE_ES_SendMemPoolStatsCmd
Send Memory Pool Statistics Command 457

CFE_ES_SendMemPoolStatsCmd_Payload
Send Memory Pool Statistics Command Payload 458

CFE_ES_SetMaxPRCountCmd
Set Maximum Processor Reset Count Command 459

CFE_ES_SetMaxPRCountCmd_Payload
Set Maximum Processor Reset Count Command Payload 459

CFE_ES_SetPerfFilterMaskCmd
Set Performance Analyzer Filter Mask Command 460

CFE_ES_SetPerfFilterMaskCmd_Payload
Set Performance Analyzer Filter Mask Command Payload 460

CFE_ES_SetPerfTriggerMaskCmd
Set Performance Analyzer Trigger Mask Command 461

CFE_ES_SetPerfTrigMaskCmd_Payload
Set Performance Analyzer Trigger Mask Command Payload 462

CFE_ES_StartApp
Start Application Command 462

CFE_ES_StartAppCmd_Payload
Start Application Command Payload 463

Generated by Doxygen
7.1 Data Structures 107

CFE_ES_StartPerfCmd_Payload
Start Performance Analyzer Command Payload 464

CFE_ES_StartPerfDataCmd
Start Performance Analyzer Command 464

CFE_ES_StopAppCmd 465

CFE_ES_StopPerfCmd_Payload
Stop Performance Analyzer Command Payload 466

CFE_ES_StopPerfDataCmd
Stop Performance Analyzer Command 466

CFE_ES_TaskInfo
Task Information 467

CFE_ES_WriteERLogCmd 468

CFE_ES_WriteSysLogCmd 469

CFE_EVS_AddEventFilterCmd 469

CFE_EVS_AppDataCmd_Payload
Write Event Services Application Information to File Command Payload 470

CFE_EVS_AppNameBitMaskCmd_Payload
Generic App Name and Bitmask Command Payload 471

CFE_EVS_AppNameCmd_Payload
Generic App Name Command Payload 471

CFE_EVS_AppNameEventIDCmd_Payload
Generic App Name and Event ID Command Payload 472

CFE_EVS_AppNameEventIDMaskCmd_Payload
Generic App Name, Event ID, Mask Command Payload 472

CFE_EVS_AppTlmData 473

CFE_EVS_BinFilter
Event message filter definition structure 474

CFE_EVS_BitMaskCmd_Payload
Generic Bitmask Command Payload 475

CFE_EVS_ClearLogCmd 476

CFE_EVS_DeleteEventFilterCmd 476

CFE_EVS_DisableAppEventsCmd 477

CFE_EVS_DisableAppEventTypeCmd 477

CFE_EVS_DisableEventTypeCmd 478

CFE_EVS_DisablePortsCmd 478

Generated by Doxygen
108

CFE_EVS_EnableAppEventsCmd 479

CFE_EVS_EnableAppEventTypeCmd 479

CFE_EVS_EnableEventTypeCmd 480

CFE_EVS_EnablePortsCmd 481

CFE_EVS_HousekeepingTlm 481

CFE_EVS_HousekeepingTlm_Payload 482

CFE_EVS_LogFileCmd_Payload
Write Event Log to File Command Payload 485

CFE_EVS_LongEventTlm 485

CFE_EVS_LongEventTlm_Payload 486

CFE_EVS_NoopCmd 487

CFE_EVS_PacketID 487

CFE_EVS_ResetAllFiltersCmd 489

CFE_EVS_ResetAppCounterCmd 489

CFE_EVS_ResetCountersCmd 490

CFE_EVS_ResetFilterCmd 490

CFE_EVS_SendHkCmd 491

CFE_EVS_SetEventFormatCode_Payload
Set Event Format Mode Command Payload 491

CFE_EVS_SetEventFormatModeCmd
Set Event Format Mode Command 492

CFE_EVS_SetFilterCmd 493

CFE_EVS_SetLogMode_Payload
Set Log Mode Command Payload 493

CFE_EVS_SetLogModeCmd
Set Log Mode Command 494

CFE_EVS_ShortEventTlm 494

CFE_EVS_ShortEventTlm_Payload 495

CFE_EVS_WriteAppDataFileCmd
Write Event Services Application Information to File Command 495

CFE_EVS_WriteLogDataFileCmd
Write Event Log to File Command 496

Generated by Doxygen
7.1 Data Structures 109

CFE_FS_FileWriteMetaData
External Metadata/State object associated with background file writes 497

CFE_FS_Header
Standard cFE File header structure definition 498

CFE_SB_AllSubscriptionsTlm 499

CFE_SB_AllSubscriptionsTlm_Payload 500

CFE_SB_DisableRouteCmd 501

CFE_SB_DisableSubReportingCmd 501

CFE_SB_EnableRouteCmd 502

CFE_SB_EnableSubReportingCmd 502

CFE_SB_HousekeepingTlm 503

CFE_SB_HousekeepingTlm_Payload 503

CFE_SB_Msg
Software Bus generic message 507

CFE_SB_MsgId_t
CFE_SB_MsgId_t type definition 508

CFE_SB_MsgMapFileEntry
SB Map File Entry 508

CFE_SB_NoopCmd 509

CFE_SB_PipeDepthStats
SB Pipe Depth Statistics 509

CFE_SB_PipeInfoEntry
SB Pipe Information File Entry 510

CFE_SB_Qos_t
Quality Of Service Type Definition 512

CFE_SB_ResetCountersCmd 513

CFE_SB_RouteCmd_Payload
Enable/Disable Route Command Payload 513

CFE_SB_RoutingFileEntry
SB Routing File Entry 514

CFE_SB_SendHkCmd 515

CFE_SB_SendPrevSubsCmd 515

CFE_SB_SendSbStatsCmd 516

CFE_SB_SingleSubscriptionTlm 516

Generated by Doxygen
110

CFE_SB_SingleSubscriptionTlm_Payload 517

CFE_SB_StatsTlm 518

CFE_SB_StatsTlm_Payload 518

CFE_SB_SubEntries
SB Previous Subscriptions Entry 522

CFE_SB_WriteFileInfoCmd_Payload
Write File Info Command Payload 523

CFE_SB_WriteMapInfoCmd 523

CFE_SB_WritePipeInfoCmd 524

CFE_SB_WriteRoutingInfoCmd 524

CFE_TBL_AbortLoadCmd
Abort Load Command 525

CFE_TBL_AbortLoadCmd_Payload
Abort Load Command Payload 525

CFE_TBL_ActivateCmd
Activate Table Command 526

CFE_TBL_ActivateCmd_Payload
Activate Table Command Payload 527

CFE_TBL_DelCDSCmd_Payload
Delete Critical Table CDS Command Payload 527

CFE_TBL_DeleteCDSCmd
Delete Critical Table CDS Command 528

CFE_TBL_DumpCmd 528

CFE_TBL_DumpCmd_Payload
Dump Table Command Payload 529

CFE_TBL_DumpRegistryCmd
Dump Registry Command 530

CFE_TBL_DumpRegistryCmd_Payload
Dump Registry Command Payload 530

CFE_TBL_File_Hdr
The definition of the header fields that are included in CFE Table Data files 531

CFE_TBL_FileDef
Table File summary object 532

CFE_TBL_HousekeepingTlm 533

CFE_TBL_HousekeepingTlm_Payload 534

Generated by Doxygen
7.1 Data Structures 111

CFE_TBL_Info
Table Info 538

CFE_TBL_LoadCmd
Load Table Command 540

CFE_TBL_LoadCmd_Payload
Load Table Command Payload 540

CFE_TBL_NoopCmd 541

CFE_TBL_NotifyCmd 541

CFE_TBL_NotifyCmd_Payload
Table Management Notification Command Payload 542

CFE_TBL_ResetCountersCmd 542

CFE_TBL_SendHkCmd 543

CFE_TBL_SendRegistryCmd
Send Table Registry Command 543

CFE_TBL_SendRegistryCmd_Payload
Send Table Registry Command Payload 544

CFE_TBL_TableRegistryTlm 544

CFE_TBL_TblRegPacket_Payload 545

CFE_TBL_ValidateCmd
Validate Table Command 548

CFE_TBL_ValidateCmd_Payload
Validate Table Command Payload 549

CFE_TIME_AddAdjustCmd 549

CFE_TIME_AddDelayCmd 550

CFE_TIME_AddOneHzAdjustmentCmd 551

CFE_TIME_DiagnosticTlm 551

CFE_TIME_DiagnosticTlm_Payload 552

CFE_TIME_FakeToneCmd 560

CFE_TIME_HousekeepingTlm 560

CFE_TIME_HousekeepingTlm_Payload 561

CFE_TIME_LeapsCmd_Payload
Set leap seconds command payload 564

CFE_TIME_NoopCmd 564

Generated by Doxygen
112

CFE_TIME_OneHzAdjustmentCmd_Payload
Generic seconds, subseconds command payload 565

CFE_TIME_OneHzCmd 565

CFE_TIME_ResetCountersCmd 566

CFE_TIME_SendDiagnosticCmd 566

CFE_TIME_SendHkCmd 567

CFE_TIME_SetLeapSecondsCmd
Set leap seconds command 567

CFE_TIME_SetMETCmd 568

CFE_TIME_SetSignalCmd
Set tone signal source command 568

CFE_TIME_SetSourceCmd
Set time data source command 569

CFE_TIME_SetStateCmd
Set clock state command 569

CFE_TIME_SetSTCFCmd 570

CFE_TIME_SetTimeCmd 571

CFE_TIME_SignalCmd_Payload
Set tone signal source command payload 571

CFE_TIME_SourceCmd_Payload
Set time data source command payload 572

CFE_TIME_StateCmd_Payload
Set clock state command payload 572

CFE_TIME_SubAdjustCmd 573

CFE_TIME_SubDelayCmd 573

CFE_TIME_SubOneHzAdjustmentCmd 574

CFE_TIME_SysTime
Data structure used to hold system time values 575

CFE_TIME_TimeCmd_Payload
Generic seconds, microseconds command payload 575

CFE_TIME_ToneDataCmd
Time at tone data command 576

CFE_TIME_ToneDataCmd_Payload
Time at tone data command payload 577

CFE_TIME_ToneSignalCmd 577

Generated by Doxygen
7.1 Data Structures 113

OS_bin_sem_prop_t
OSAL binary semaphore properties 578

OS_condvar_prop_t
OSAL condition variable properties 579

OS_count_sem_prop_t
OSAL counting semaphore properties 579

os_dirent_t
Directory entry 580

OS_FdSet
An abstract structure capable of holding several OSAL IDs 580

OS_file_prop_t
OSAL file properties 581

os_fsinfo_t
OSAL file system info 581

os_fstat_t
File system status 582

OS_heap_prop_t
OSAL heap properties 583

OS_module_address_t
OSAL module address properties 584

OS_module_prop_t
OSAL module properties 585

OS_mut_sem_prop_t
OSAL mutex properties 586

OS_queue_prop_t
OSAL queue properties 586

OS_SockAddr_t
Encapsulates a generic network address 587

OS_SockAddrData_t
Storage buffer for generic network address 587

OS_socket_prop_t
Encapsulates socket properties 588

OS_static_symbol_record_t
Associates a single symbol name with a memory address 589

OS_statvfs_t 590

OS_task_prop_t
OSAL task properties 590

Generated by Doxygen
114

OS_time_t
OSAL time interval structure 591

OS_timebase_prop_t
Time base properties 592

OS_timer_prop_t
Timer properties 592

8 File Index
8.1 File List
Here is a list of all files with brief descriptions:

build/osal_public_api/inc/osconfig.h 593

example_mission_cfg.h 599

example_platform_cfg.h 610

sample_perfids.h 653

cfe/modules/core_api/config/default_cfe_core_api_base_msgids.h 656

cfe/modules/core_api/config/default_cfe_core_api_interface_cfg.h 658

cfe/modules/core_api/config/default_cfe_mission_cfg.h 660

cfe/modules/core_api/config/default_cfe_msgids.h 660

cfe/modules/core_api/fsw/inc/cfe.h 661

cfe/modules/core_api/fsw/inc/cfe_config.h 661

cfe/modules/core_api/fsw/inc/cfe_config_api_typedefs.h 664

cfe/modules/core_api/fsw/inc/cfe_endian.h 665

cfe/modules/core_api/fsw/inc/cfe_error.h 666

cfe/modules/core_api/fsw/inc/cfe_es.h 674

cfe/modules/core_api/fsw/inc/cfe_es_api_typedefs.h 678

cfe/modules/core_api/fsw/inc/cfe_evs.h 683

cfe/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h 684

cfe/modules/core_api/fsw/inc/cfe_fs.h 687

cfe/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h 687

cfe/modules/core_api/fsw/inc/cfe_msg.h 690

cfe/modules/core_api/fsw/inc/cfe_msg_api_typedefs.h 692

Generated by Doxygen
8.1 File List 115

cfe/modules/core_api/fsw/inc/cfe_resourceid.h 696

cfe/modules/core_api/fsw/inc/cfe_resourceid_api_typedefs.h 703

cfe/modules/core_api/fsw/inc/cfe_sb.h 703

cfe/modules/core_api/fsw/inc/cfe_sb_api_typedefs.h 706

cfe/modules/core_api/fsw/inc/cfe_tbl.h 709

cfe/modules/core_api/fsw/inc/cfe_tbl_api_typedefs.h 710

cfe/modules/core_api/fsw/inc/cfe_tbl_filedef.h 713

cfe/modules/core_api/fsw/inc/cfe_time.h 714

cfe/modules/core_api/fsw/inc/cfe_time_api_typedefs.h 716

cfe/modules/core_api/fsw/inc/cfe_version.h 718

cfe/modules/es/config/default_cfe_es_extern_typedefs.h 720

cfe/modules/es/config/default_cfe_es_fcncodes.h 728

cfe/modules/es/config/default_cfe_es_interface_cfg.h 749

cfe/modules/es/config/default_cfe_es_internal_cfg.h 752

cfe/modules/es/config/default_cfe_es_mission_cfg.h 772

cfe/modules/es/config/default_cfe_es_msg.h 772

cfe/modules/es/config/default_cfe_es_msgdefs.h 773

cfe/modules/es/config/default_cfe_es_msgids.h 777

cfe/modules/es/config/default_cfe_es_msgstruct.h 778

cfe/modules/es/config/default_cfe_es_platform_cfg.h 782

cfe/modules/es/config/default_cfe_es_topicids.h 782

cfe/modules/es/fsw/inc/cfe_es_eventids.h 783

cfe/modules/evs/config/default_cfe_evs_extern_typedefs.h 808

cfe/modules/evs/config/default_cfe_evs_fcncodes.h 811

cfe/modules/evs/config/default_cfe_evs_interface_cfg.h 829

cfe/modules/evs/config/default_cfe_evs_internal_cfg.h 830

cfe/modules/evs/config/default_cfe_evs_mission_cfg.h 834

cfe/modules/evs/config/default_cfe_evs_msg.h 834

cfe/modules/evs/config/default_cfe_evs_msgdefs.h 835

cfe/modules/evs/config/default_cfe_evs_msgids.h 838

Generated by Doxygen
116

cfe/modules/evs/config/default_cfe_evs_msgstruct.h 839

cfe/modules/evs/config/default_cfe_evs_platform_cfg.h 842

cfe/modules/evs/config/default_cfe_evs_topicids.h 843

cfe/modules/evs/fsw/inc/cfe_evs_eventids.h 844

cfe/modules/fs/config/default_cfe_fs_extern_typedefs.h 856

cfe/modules/fs/config/default_cfe_fs_filedef.h 856

cfe/modules/fs/config/default_cfe_fs_interface_cfg.h 858

cfe/modules/fs/config/default_cfe_fs_mission_cfg.h 858

cfe/modules/msg/fsw/inc/ccsds_hdr.h 859

cfe/modules/resourceid/fsw/inc/cfe_core_resourceid_basevalues.h 859

cfe/modules/resourceid/fsw/inc/cfe_resourceid_basevalue.h 860

cfe/modules/sb/config/default_cfe_sb_extern_typedefs.h 861

cfe/modules/sb/config/default_cfe_sb_fcncodes.h 863

cfe/modules/sb/config/default_cfe_sb_interface_cfg.h 872

cfe/modules/sb/config/default_cfe_sb_internal_cfg.h 873

cfe/modules/sb/config/default_cfe_sb_mission_cfg.h 881

cfe/modules/sb/config/default_cfe_sb_msg.h 882

cfe/modules/sb/config/default_cfe_sb_msgdefs.h 882

cfe/modules/sb/config/default_cfe_sb_msgids.h 884

cfe/modules/sb/config/default_cfe_sb_msgstruct.h 886

cfe/modules/sb/config/default_cfe_sb_platform_cfg.h 888

cfe/modules/sb/config/default_cfe_sb_topicids.h 888

cfe/modules/sb/fsw/inc/cfe_sb_eventids.h 889

cfe/modules/tbl/config/default_cfe_tbl_extern_typedefs.h 909

cfe/modules/tbl/config/default_cfe_tbl_fcncodes.h 910

cfe/modules/tbl/config/default_cfe_tbl_interface_cfg.h 919

cfe/modules/tbl/config/default_cfe_tbl_internal_cfg.h 920

cfe/modules/tbl/config/default_cfe_tbl_mission_cfg.h 926

cfe/modules/tbl/config/default_cfe_tbl_msg.h 926

cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h 927

Generated by Doxygen
8.1 File List 117

cfe/modules/tbl/config/default_cfe_tbl_msgids.h 929

cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h 930

cfe/modules/tbl/config/default_cfe_tbl_platform_cfg.h 932

cfe/modules/tbl/config/default_cfe_tbl_topicids.h 932

cfe/modules/tbl/fsw/inc/cfe_tbl_eventids.h 933

cfe/modules/time/config/default_cfe_time_extern_typedefs.h 953

cfe/modules/time/config/default_cfe_time_fcncodes.h 958

cfe/modules/time/config/default_cfe_time_interface_cfg.h 974

cfe/modules/time/config/default_cfe_time_internal_cfg.h 978

cfe/modules/time/config/default_cfe_time_mission_cfg.h 983

cfe/modules/time/config/default_cfe_time_msg.h 984

cfe/modules/time/config/default_cfe_time_msgdefs.h 984

cfe/modules/time/config/default_cfe_time_msgids.h 986

cfe/modules/time/config/default_cfe_time_msgstruct.h 988

cfe/modules/time/config/default_cfe_time_platform_cfg.h 991

cfe/modules/time/config/default_cfe_time_topicids.h 991

cfe/modules/time/fsw/inc/cfe_time_eventids.h 993

osal/src/os/inc/common_types.h 1003

osal/src/os/inc/osapi-binsem.h 1008

osal/src/os/inc/osapi-bsp.h 1009

osal/src/os/inc/osapi-clock.h 1009

osal/src/os/inc/osapi-common.h 1011

osal/src/os/inc/osapi-condvar.h 1013

osal/src/os/inc/osapi-constants.h 1014

osal/src/os/inc/osapi-countsem.h 1015

osal/src/os/inc/osapi-dir.h 1015

osal/src/os/inc/osapi-error.h 1016

osal/src/os/inc/osapi-file.h 1019

osal/src/os/inc/osapi-filesys.h 1022

osal/src/os/inc/osapi-heap.h 1024

Generated by Doxygen
118

osal/src/os/inc/osapi-idmap.h 1024

osal/src/os/inc/osapi-macros.h 1026

osal/src/os/inc/osapi-module.h 1027

osal/src/os/inc/osapi-mutex.h 1029

osal/src/os/inc/osapi-network.h 1029

osal/src/os/inc/osapi-printf.h 1030

osal/src/os/inc/osapi-queue.h 1030

osal/src/os/inc/osapi-select.h 1031

osal/src/os/inc/osapi-shell.h 1032

osal/src/os/inc/osapi-sockets.h 1032

osal/src/os/inc/osapi-task.h 1035

osal/src/os/inc/osapi-timebase.h 1037

osal/src/os/inc/osapi-timer.h 1038

osal/src/os/inc/osapi-version.h 1039

osal/src/os/inc/osapi.h 1042

psp/fsw/inc/cfe_psp.h 1043

psp/fsw/inc/cfe_psp_error.h
CFE PSP Error header 1070

9 Module Documentation
9.1 cFE Return Code Defines
Macros

• #define CFE_SUCCESS ((CFE_Status_t)0)

Successful execution.
• #define CFE_STATUS_NO_COUNTER_INCREMENT ((CFE_Status_t)0x48000001)
No Counter Increment.
• #define CFE_STATUS_WRONG_MSG_LENGTH ((CFE_Status_t)0xc8000002)
Wrong Message Length.
• #define CFE_STATUS_UNKNOWN_MSG_ID ((CFE_Status_t)0xc8000003)
Unknown Message ID.
• #define CFE_STATUS_BAD_COMMAND_CODE ((CFE_Status_t)0xc8000004)
Bad Command Code.
• #define CFE_STATUS_EXTERNAL_RESOURCE_FAIL ((CFE_Status_t)0xc8000005)
External failure.
• #define CFE_STATUS_REQUEST_ALREADY_PENDING ((int32)0xc8000006)
Request already pending.

Generated by Doxygen
9.1 cFE Return Code Defines 119

• #define CFE_STATUS_VALIDATION_FAILURE ((int32)0xc8000007)

Request or input value failed basic structural validation.
• #define CFE_STATUS_RANGE_ERROR ((int32)0xc8000008)
Request or input value is out of range.
• #define CFE_STATUS_INCORRECT_STATE ((int32)0xc8000009)
Cannot process request at this time.
• #define CFE_STATUS_NOT_IMPLEMENTED ((CFE_Status_t)0xc800ffff)
Not Implemented.
• #define CFE_EVS_UNKNOWN_FILTER ((CFE_Status_t)0xc2000001)
Unknown Filter.
• #define CFE_EVS_APP_NOT_REGISTERED ((CFE_Status_t)0xc2000002)
Application Not Registered.
• #define CFE_EVS_APP_ILLEGAL_APP_ID ((CFE_Status_t)0xc2000003)
Illegal Application ID.
• #define CFE_EVS_APP_FILTER_OVERLOAD ((CFE_Status_t)0xc2000004)
Application Filter Overload.
• #define CFE_EVS_RESET_AREA_POINTER ((CFE_Status_t)0xc2000005)
Reset Area Pointer Failure.
• #define CFE_EVS_EVT_NOT_REGISTERED ((CFE_Status_t)0xc2000006)
Event Not Registered.
• #define CFE_EVS_FILE_WRITE_ERROR ((CFE_Status_t)0xc2000007)
File Write Error.
• #define CFE_EVS_INVALID_PARAMETER ((CFE_Status_t)0xc2000008)
Invalid Pointer.
• #define CFE_EVS_APP_SQUELCHED ((CFE_Status_t)0xc2000009)
Event squelched.
• #define CFE_EVS_NOT_IMPLEMENTED ((CFE_Status_t)0xc200ffff)
Not Implemented.
• #define CFE_ES_ERR_RESOURCEID_NOT_VALID ((CFE_Status_t)0xc4000001)
Resource ID is not valid.
• #define CFE_ES_ERR_NAME_NOT_FOUND ((CFE_Status_t)0xc4000002)
Resource Name Error.
• #define CFE_ES_ERR_APP_CREATE ((CFE_Status_t)0xc4000004)
Application Create Error.
• #define CFE_ES_ERR_CHILD_TASK_CREATE ((CFE_Status_t)0xc4000005)
Child Task Create Error.
• #define CFE_ES_ERR_SYS_LOG_FULL ((CFE_Status_t)0xc4000006)
System Log Full.
• #define CFE_ES_ERR_MEM_BLOCK_SIZE ((CFE_Status_t)0xc4000008)
Memory Block Size Error.
• #define CFE_ES_ERR_LOAD_LIB ((CFE_Status_t)0xc4000009)
Load Library Error.
• #define CFE_ES_BAD_ARGUMENT ((CFE_Status_t)0xc400000a)
Bad Argument.
• #define CFE_ES_ERR_CHILD_TASK_REGISTER ((CFE_Status_t)0xc400000b)
Child Task Register Error.
• #define CFE_ES_CDS_ALREADY_EXISTS ((CFE_Status_t)0x4400000d)

Generated by Doxygen
120

CDS Already Exists.

• #define CFE_ES_CDS_INSUFFICIENT_MEMORY ((CFE_Status_t)0xc400000e)
CDS Insufficient Memory.
• #define CFE_ES_CDS_INVALID_NAME ((CFE_Status_t)0xc400000f)
CDS Invalid Name.
• #define CFE_ES_CDS_INVALID_SIZE ((CFE_Status_t)0xc4000010)
CDS Invalid Size.
• #define CFE_ES_CDS_INVALID ((CFE_Status_t)0xc4000012)
CDS Invalid.
• #define CFE_ES_CDS_ACCESS_ERROR ((CFE_Status_t)0xc4000013)
CDS Access Error.
• #define CFE_ES_FILE_IO_ERR ((CFE_Status_t)0xc4000014)
File IO Error.
• #define CFE_ES_RST_ACCESS_ERR ((CFE_Status_t)0xc4000015)
Reset Area Access Error.
• #define CFE_ES_ERR_APP_REGISTER ((CFE_Status_t)0xc4000017)
Application Register Error.
• #define CFE_ES_ERR_CHILD_TASK_DELETE ((CFE_Status_t)0xc4000018)
Child Task Delete Error.
• #define CFE_ES_ERR_CHILD_TASK_DELETE_MAIN_TASK ((CFE_Status_t)0xc4000019)
Child Task Delete Passed Main Task.
• #define CFE_ES_CDS_BLOCK_CRC_ERR ((CFE_Status_t)0xc400001A)
CDS Block CRC Error.
• #define CFE_ES_MUT_SEM_DELETE_ERR ((CFE_Status_t)0xc400001B)
Mutex Semaphore Delete Error.
• #define CFE_ES_BIN_SEM_DELETE_ERR ((CFE_Status_t)0xc400001C)
Binary Semaphore Delete Error.
• #define CFE_ES_COUNT_SEM_DELETE_ERR ((CFE_Status_t)0xc400001D)
Counting Semaphore Delete Error.
• #define CFE_ES_QUEUE_DELETE_ERR ((CFE_Status_t)0xc400001E)
Queue Delete Error.
• #define CFE_ES_FILE_CLOSE_ERR ((CFE_Status_t)0xc400001F)
File Close Error.
• #define CFE_ES_CDS_WRONG_TYPE_ERR ((CFE_Status_t)0xc4000020)
CDS Wrong Type Error.
• #define CFE_ES_CDS_OWNER_ACTIVE_ERR ((CFE_Status_t)0xc4000022)
CDS Owner Active Error.
• #define CFE_ES_APP_CLEANUP_ERR ((CFE_Status_t)0xc4000023)
Application Cleanup Error.
• #define CFE_ES_TIMER_DELETE_ERR ((CFE_Status_t)0xc4000024)
Timer Delete Error.
• #define CFE_ES_BUFFER_NOT_IN_POOL ((CFE_Status_t)0xc4000025)
Buffer Not In Pool.
• #define CFE_ES_TASK_DELETE_ERR ((CFE_Status_t)0xc4000026)
Task Delete Error.
• #define CFE_ES_OPERATION_TIMED_OUT ((CFE_Status_t)0xc4000027)
Operation Timed Out.

Generated by Doxygen
9.1 cFE Return Code Defines 121

• #define CFE_ES_LIB_ALREADY_LOADED ((CFE_Status_t)0x44000028)

Library Already Loaded.
• #define CFE_ES_ERR_SYS_LOG_TRUNCATED ((CFE_Status_t)0x44000029)
System Log Message Truncated.
• #define CFE_ES_NO_RESOURCE_IDS_AVAILABLE ((CFE_Status_t)0xc400002B)
Resource ID is not available.
• #define CFE_ES_POOL_BLOCK_INVALID ((CFE_Status_t)0xc400002C)
Invalid pool block.
• #define CFE_ES_ERR_DUPLICATE_NAME ((CFE_Status_t)0xc400002E)
Duplicate Name Error.
• #define CFE_ES_NOT_IMPLEMENTED ((CFE_Status_t)0xc400ffff)
Not Implemented.
• #define CFE_FS_BAD_ARGUMENT ((CFE_Status_t)0xc6000001)
Bad Argument.
• #define CFE_FS_INVALID_PATH ((CFE_Status_t)0xc6000002)
Invalid Path.
• #define CFE_FS_FNAME_TOO_LONG ((CFE_Status_t)0xc6000003)
Filename Too Long.
• #define CFE_FS_NOT_IMPLEMENTED ((CFE_Status_t)0xc600ffff)
Not Implemented.
• #define CFE_SB_TIME_OUT ((CFE_Status_t)0xca000001)
Time Out.
• #define CFE_SB_NO_MESSAGE ((CFE_Status_t)0xca000002)
No Message.
• #define CFE_SB_BAD_ARGUMENT ((CFE_Status_t)0xca000003)
Bad Argument.
• #define CFE_SB_MAX_PIPES_MET ((CFE_Status_t)0xca000004)
Max Pipes Met.
• #define CFE_SB_PIPE_CR_ERR ((CFE_Status_t)0xca000005)
Pipe Create Error.
• #define CFE_SB_PIPE_RD_ERR ((CFE_Status_t)0xca000006)
Pipe Read Error.
• #define CFE_SB_MSG_TOO_BIG ((CFE_Status_t)0xca000007)
Message Too Big.
• #define CFE_SB_BUF_ALOC_ERR ((CFE_Status_t)0xca000008)
Buffer Allocation Error.
• #define CFE_SB_MAX_MSGS_MET ((CFE_Status_t)0xca000009)
Max Messages Met.
• #define CFE_SB_MAX_DESTS_MET ((CFE_Status_t)0xca00000a)
Max Destinations Met.
• #define CFE_SB_INTERNAL_ERR ((CFE_Status_t)0xca00000c)
Internal Error.
• #define CFE_SB_WRONG_MSG_TYPE ((CFE_Status_t)0xca00000d)
Wrong Message Type.
• #define CFE_SB_BUFFER_INVALID ((CFE_Status_t)0xca00000e)
Buffer Invalid.
• #define CFE_SB_NOT_IMPLEMENTED ((CFE_Status_t)0xca00ffff)

Generated by Doxygen
122

Not Implemented.
• #define CFE_TBL_ERR_INVALID_HANDLE ((CFE_Status_t)0xcc000001)
Invalid Handle.
• #define CFE_TBL_ERR_INVALID_NAME ((CFE_Status_t)0xcc000002)
Invalid Name.
• #define CFE_TBL_ERR_INVALID_SIZE ((CFE_Status_t)0xcc000003)
Invalid Size.
• #define CFE_TBL_INFO_UPDATE_PENDING ((CFE_Status_t)0x4c000004)
Update Pending.
• #define CFE_TBL_ERR_NEVER_LOADED ((CFE_Status_t)0xcc000005)
Never Loaded.
• #define CFE_TBL_ERR_REGISTRY_FULL ((CFE_Status_t)0xcc000006)
Registry Full.
• #define CFE_TBL_WARN_DUPLICATE ((CFE_Status_t)0x4c000007)
Duplicate Warning.
• #define CFE_TBL_ERR_NO_ACCESS ((CFE_Status_t)0xcc000008)
No Access.
• #define CFE_TBL_ERR_UNREGISTERED ((CFE_Status_t)0xcc000009)
Unregistered.
• #define CFE_TBL_ERR_HANDLES_FULL ((CFE_Status_t)0xcc00000B)
Handles Full.
• #define CFE_TBL_ERR_DUPLICATE_DIFF_SIZE ((CFE_Status_t)0xcc00000C)
Duplicate Table With Different Size.
• #define CFE_TBL_ERR_DUPLICATE_NOT_OWNED ((CFE_Status_t)0xcc00000D)
Duplicate Table And Not Owned.
• #define CFE_TBL_INFO_UPDATED ((CFE_Status_t)0x4c00000E)
Updated.
• #define CFE_TBL_ERR_NO_BUFFER_AVAIL ((CFE_Status_t)0xcc00000F)
No Buffer Available.
• #define CFE_TBL_ERR_DUMP_ONLY ((CFE_Status_t)0xcc000010)
Dump Only Error.
• #define CFE_TBL_ERR_ILLEGAL_SRC_TYPE ((CFE_Status_t)0xcc000011)
Illegal Source Type.
• #define CFE_TBL_ERR_LOAD_IN_PROGRESS ((CFE_Status_t)0xcc000012)
Load In Progress.
• #define CFE_TBL_ERR_FILE_TOO_LARGE ((CFE_Status_t)0xcc000014)
File Too Large.
• #define CFE_TBL_WARN_SHORT_FILE ((CFE_Status_t)0x4c000015)
Short File Warning.
• #define CFE_TBL_ERR_BAD_CONTENT_ID ((CFE_Status_t)0xcc000016)
Bad Content ID.
• #define CFE_TBL_INFO_NO_UPDATE_PENDING ((CFE_Status_t)0x4c000017)
No Update Pending.
• #define CFE_TBL_INFO_TABLE_LOCKED ((CFE_Status_t)0x4c000018)
Table Locked.
• #define CFE_TBL_INFO_VALIDATION_PENDING ((CFE_Status_t)0x4c000019)
• #define CFE_TBL_INFO_NO_VALIDATION_PENDING ((CFE_Status_t)0x4c00001A)

Generated by Doxygen
9.1 cFE Return Code Defines 123

• #define CFE_TBL_ERR_BAD_SUBTYPE_ID ((CFE_Status_t)0xcc00001B)

Bad Subtype ID.
• #define CFE_TBL_ERR_FILE_SIZE_INCONSISTENT ((CFE_Status_t)0xcc00001C)
File Size Inconsistent.
• #define CFE_TBL_ERR_NO_STD_HEADER ((CFE_Status_t)0xcc00001D)
No Standard Header.
• #define CFE_TBL_ERR_NO_TBL_HEADER ((CFE_Status_t)0xcc00001E)
No Table Header.
• #define CFE_TBL_ERR_FILENAME_TOO_LONG ((CFE_Status_t)0xcc00001F)
Filename Too Long.
• #define CFE_TBL_ERR_FILE_FOR_WRONG_TABLE ((CFE_Status_t)0xcc000020)
File For Wrong Table.
• #define CFE_TBL_ERR_LOAD_INCOMPLETE ((CFE_Status_t)0xcc000021)
Load Incomplete.
• #define CFE_TBL_WARN_PARTIAL_LOAD ((CFE_Status_t)0x4c000022)
Partial Load Warning.
• #define CFE_TBL_ERR_PARTIAL_LOAD ((CFE_Status_t)0xcc000023)
Partial Load Error.
• #define CFE_TBL_INFO_DUMP_PENDING ((CFE_Status_t)0x4c000024)
Dump Pending.
• #define CFE_TBL_ERR_INVALID_OPTIONS ((CFE_Status_t)0xcc000025)
Invalid Options.
• #define CFE_TBL_WARN_NOT_CRITICAL ((CFE_Status_t)0x4c000026)
Not Critical Warning.
• #define CFE_TBL_INFO_RECOVERED_TBL ((CFE_Status_t)0x4c000027)
Recovered Table.
• #define CFE_TBL_ERR_BAD_SPACECRAFT_ID ((CFE_Status_t)0xcc000028)
Bad Spacecraft ID.
• #define CFE_TBL_ERR_BAD_PROCESSOR_ID ((CFE_Status_t)0xcc000029)
Bad Processor ID.
• #define CFE_TBL_MESSAGE_ERROR ((CFE_Status_t)0xcc00002a)
Message Error.
• #define CFE_TBL_ERR_SHORT_FILE ((CFE_Status_t)0xcc00002b)
• #define CFE_TBL_ERR_ACCESS ((CFE_Status_t)0xcc00002c)
• #define CFE_TBL_BAD_ARGUMENT ((CFE_Status_t)0xcc00002d)
Bad Argument.
• #define CFE_TBL_NOT_IMPLEMENTED ((CFE_Status_t)0xcc00ffff)
Not Implemented.
• #define CFE_TIME_NOT_IMPLEMENTED ((CFE_Status_t)0xce00ffff)
Not Implemented.
• #define CFE_TIME_INTERNAL_ONLY ((CFE_Status_t)0xce000001)
Internal Only.
• #define CFE_TIME_OUT_OF_RANGE ((CFE_Status_t)0xce000002)
Out Of Range.
• #define CFE_TIME_TOO_MANY_SYNCH_CALLBACKS ((CFE_Status_t)0xce000003)
Too Many Sync Callbacks.
• #define CFE_TIME_CALLBACK_NOT_REGISTERED ((CFE_Status_t)0xce000004)
Callback Not Registered.
• #define CFE_TIME_BAD_ARGUMENT ((CFE_Status_t)0xce000005)
Bad Argument.

Generated by Doxygen
124

9.1.1 Detailed Description

9.1.2 Macro Definition Documentation

9.1.2.1 CFE_ES_APP_CLEANUP_ERR #define CFE_ES_APP_CLEANUP_ERR ((CFE_Status_t)0xc4000023)

Application Cleanup Error.
Occurs when an attempt was made to Clean Up an application which involves calling Table, EVS, and SB cleanup
functions, then deleting all ES resources, child tasks, and unloading the object module. The approach here is to keep
going even though one of these steps had an error. There will be syslog messages detailing each problem.
Definition at line 588 of file cfe_error.h.

9.1.2.2 CFE_ES_BAD_ARGUMENT #define CFE_ES_BAD_ARGUMENT ((CFE_Status_t)0xc400000a)

Bad Argument.
Bad parameter passed into an ES API.
Definition at line 399 of file cfe_error.h.

9.1.2.3 CFE_ES_BIN_SEM_DELETE_ERR #define CFE_ES_BIN_SEM_DELETE_ERR ((CFE_Status_t)0xc400001C)

Binary Semaphore Delete Error.
Occurs when trying to delete a Binary Semaphore that belongs to a task that ES is cleaning up.
Definition at line 527 of file cfe_error.h.

9.1.2.4 CFE_ES_BUFFER_NOT_IN_POOL #define CFE_ES_BUFFER_NOT_IN_POOL ((CFE_Status_t)0xc4000025)

Buffer Not In Pool.
The specified address is not in the memory pool.
Definition at line 605 of file cfe_error.h.

9.1.2.5 CFE_ES_CDS_ACCESS_ERROR #define CFE_ES_CDS_ACCESS_ERROR ((CFE_Status_t)0xc4000013)

CDS Access Error.
The CDS was inaccessible
Definition at line 458 of file cfe_error.h.

9.1.2.6 CFE_ES_CDS_ALREADY_EXISTS #define CFE_ES_CDS_ALREADY_EXISTS ((CFE_Status_t)0x4400000d)

CDS Already Exists.
The Application is receiving the pointer to a CDS that was already present.
Definition at line 415 of file cfe_error.h.

9.1.2.7 CFE_ES_CDS_BLOCK_CRC_ERR #define CFE_ES_CDS_BLOCK_CRC_ERR ((CFE_Status_t)0xc400001A)

CDS Block CRC Error.
Occurs when trying to read a CDS Data block and the CRC of the current data does not match the stored CRC for the
data. Either the contents of the CDS Data Block are corrupted or the CDS Control Block is corrupted.
Definition at line 509 of file cfe_error.h.

Generated by Doxygen
9.1 cFE Return Code Defines 125

9.1.2.8 CFE_ES_CDS_INSUFFICIENT_MEMORY #define CFE_ES_CDS_INSUFFICIENT_MEMORY ((CFE_Status_t)0xc400000e)

CDS Insufficient Memory.
The Application is requesting a CDS Block that is larger than the remaining CDS memory.
Definition at line 424 of file cfe_error.h.

9.1.2.9 CFE_ES_CDS_INVALID #define CFE_ES_CDS_INVALID ((CFE_Status_t)0xc4000012)

CDS Invalid.
The CDS contents are invalid.
Definition at line 450 of file cfe_error.h.

9.1.2.10 CFE_ES_CDS_INVALID_NAME #define CFE_ES_CDS_INVALID_NAME ((CFE_Status_t)0xc400000f)

CDS Invalid Name.
The Application is requesting a CDS Block with an invalid ASCII string name. Either the name is too long (>
CFE_MISSION_ES_CDS_MAX_NAME_LENGTH) or was an empty string.
Definition at line 433 of file cfe_error.h.

9.1.2.11 CFE_ES_CDS_INVALID_SIZE #define CFE_ES_CDS_INVALID_SIZE ((CFE_Status_t)0xc4000010)

CDS Invalid Size.
The Application is requesting a CDS Block or Pool with a size beyond the applicable limits, either too large or too
small/zero.
Definition at line 442 of file cfe_error.h.

9.1.2.12 CFE_ES_CDS_OWNER_ACTIVE_ERR #define CFE_ES_CDS_OWNER_ACTIVE_ERR ((CFE_Status_t)0xc4000022)

CDS Owner Active Error.
Occurs when an attempt was made to delete a CDS when an application with the same name associated with the CDS
is still present. CDSs can ONLY be deleted when Applications that created them are not present in the system.
Definition at line 575 of file cfe_error.h.

9.1.2.13 CFE_ES_CDS_WRONG_TYPE_ERR #define CFE_ES_CDS_WRONG_TYPE_ERR ((CFE_Status_t)0xc4000020)

CDS Wrong Type Error.
Occurs when Table Services is trying to delete a Critical Data Store that is not a Critical Table Image or when Executive
Services is trying to delete a Critical Table Image.
Definition at line 564 of file cfe_error.h.

9.1.2.14 CFE_ES_COUNT_SEM_DELETE_ERR #define CFE_ES_COUNT_SEM_DELETE_ERR ((CFE_Status_t)0xc400001D)

Counting Semaphore Delete Error.
Occurs when trying to delete a Counting Semaphore that belongs to a task that ES is cleaning up.
Definition at line 536 of file cfe_error.h.

9.1.2.15 CFE_ES_ERR_APP_CREATE #define CFE_ES_ERR_APP_CREATE ((CFE_Status_t)0xc4000004)

Application Create Error.
There was an error loading or creating the App.
Definition at line 358 of file cfe_error.h.

Generated by Doxygen
126

9.1.2.16 CFE_ES_ERR_APP_REGISTER #define CFE_ES_ERR_APP_REGISTER ((CFE_Status_t)0xc4000017)

Application Register Error.
Occurs when a task cannot be registered in ES global tables
Definition at line 482 of file cfe_error.h.

9.1.2.17 CFE_ES_ERR_CHILD_TASK_CREATE #define CFE_ES_ERR_CHILD_TASK_CREATE ((CFE_Status_t)0xc4000005)

Child Task Create Error.
There was an error creating a child task.
Definition at line 366 of file cfe_error.h.

9.1.2.18 CFE_ES_ERR_CHILD_TASK_DELETE #define CFE_ES_ERR_CHILD_TASK_DELETE ((CFE_Status_t)0xc4000018)

Child Task Delete Error.
There was an error deleting a child task.
Definition at line 490 of file cfe_error.h.

9.1.2.19 CFE_ES_ERR_CHILD_TASK_DELETE_MAIN_TASK #define CFE_ES_ERR_CHILD_TASK_DELETE_MAI←-

N_TASK ((CFE_Status_t)0xc4000019)
Child Task Delete Passed Main Task.
There was an attempt to delete a cFE App Main Task with the CFE_ES_DeleteChildTask API.
Definition at line 499 of file cfe_error.h.

9.1.2.20 CFE_ES_ERR_CHILD_TASK_REGISTER #define CFE_ES_ERR_CHILD_TASK_REGISTER ((CFE_Status_t)0xc400000b)

Child Task Register Error.
Errors occurred when trying to register a child task.
Definition at line 407 of file cfe_error.h.

9.1.2.21 CFE_ES_ERR_DUPLICATE_NAME #define CFE_ES_ERR_DUPLICATE_NAME ((CFE_Status_t)0xc400002E)

Duplicate Name Error.
Resource creation failed due to the name already existing in the system.
Definition at line 668 of file cfe_error.h.

9.1.2.22 CFE_ES_ERR_LOAD_LIB #define CFE_ES_ERR_LOAD_LIB ((CFE_Status_t)0xc4000009)

Load Library Error.
Could not load the shared library.
Definition at line 391 of file cfe_error.h.

9.1.2.23 CFE_ES_ERR_MEM_BLOCK_SIZE #define CFE_ES_ERR_MEM_BLOCK_SIZE ((CFE_Status_t)0xc4000008)

Memory Block Size Error.
The block size requested is invalid.
Definition at line 383 of file cfe_error.h.

9.1.2.24 CFE_ES_ERR_NAME_NOT_FOUND #define CFE_ES_ERR_NAME_NOT_FOUND ((CFE_Status_t)0xc4000002)

Resource Name Error.
There is no match in the system for the given name.

Generated by Doxygen
9.1 cFE Return Code Defines 127

Definition at line 350 of file cfe_error.h.

9.1.2.25 CFE_ES_ERR_RESOURCEID_NOT_VALID #define CFE_ES_ERR_RESOURCEID_NOT_VALID ((CFE_Status_t)0xc4000001)

Resource ID is not valid.
This error indicates that the passed in resource identifier (App ID, Lib ID, Counter ID, etc) did not validate.
Definition at line 342 of file cfe_error.h.

9.1.2.26 CFE_ES_ERR_SYS_LOG_FULL #define CFE_ES_ERR_SYS_LOG_FULL ((CFE_Status_t)0xc4000006)

System Log Full.
The cFE system Log is full. This error means the message was not logged at all
Definition at line 375 of file cfe_error.h.

9.1.2.27 CFE_ES_ERR_SYS_LOG_TRUNCATED #define CFE_ES_ERR_SYS_LOG_TRUNCATED ((CFE_Status_t)0x44000029)

System Log Message Truncated.
This information code means the last syslog message was truncated due to insufficient space in the log buffer.
Definition at line 640 of file cfe_error.h.

9.1.2.28 CFE_ES_FILE_CLOSE_ERR #define CFE_ES_FILE_CLOSE_ERR ((CFE_Status_t)0xc400001F)

File Close Error.
Occurs when trying to close a file that belongs to a task that ES is cleaning up.
Definition at line 554 of file cfe_error.h.

9.1.2.29 CFE_ES_FILE_IO_ERR #define CFE_ES_FILE_IO_ERR ((CFE_Status_t)0xc4000014)

File IO Error.
Occurs when a file operation fails
Definition at line 466 of file cfe_error.h.

9.1.2.30 CFE_ES_LIB_ALREADY_LOADED #define CFE_ES_LIB_ALREADY_LOADED ((CFE_Status_t)0x44000028)

Library Already Loaded.
Occurs if CFE_ES_LoadLibrary detects that the requested library name is already loaded.
Definition at line 631 of file cfe_error.h.

9.1.2.31 CFE_ES_MUT_SEM_DELETE_ERR #define CFE_ES_MUT_SEM_DELETE_ERR ((CFE_Status_t)0xc400001B)

Mutex Semaphore Delete Error.
Occurs when trying to delete a Mutex that belongs to a task that ES is cleaning up.
Definition at line 518 of file cfe_error.h.

9.1.2.32 CFE_ES_NO_RESOURCE_IDS_AVAILABLE #define CFE_ES_NO_RESOURCE_IDS_AVAILABLE ((CFE_Status_t)0xc400002

Resource ID is not available.
This error indicates that the maximum resource identifiers (App ID, Lib ID, Counter ID, etc) has already been reached
and a new ID cannot be allocated.
Definition at line 650 of file cfe_error.h.

Generated by Doxygen
128

9.1.2.33 CFE_ES_NOT_IMPLEMENTED #define CFE_ES_NOT_IMPLEMENTED ((CFE_Status_t)0xc400ffff)

Not Implemented.
Current version of cFE does not have the function or the feature of the function implemented. This could be due to either
an early build of the cFE for this platform or the platform does not support the specified feature.
Definition at line 679 of file cfe_error.h.

9.1.2.34 CFE_ES_OPERATION_TIMED_OUT #define CFE_ES_OPERATION_TIMED_OUT ((CFE_Status_t)0xc4000027)

Operation Timed Out.
Occurs if the timeout for a given operation was exceeded
Definition at line 622 of file cfe_error.h.

9.1.2.35 CFE_ES_POOL_BLOCK_INVALID #define CFE_ES_POOL_BLOCK_INVALID ((CFE_Status_t)0xc400002C)

Invalid pool block.
Software attempted to "put" a block back into a pool which does not appear to belong to that pool. This may mean the
pool has become unusable due to memory corruption.
Definition at line 660 of file cfe_error.h.

9.1.2.36 CFE_ES_QUEUE_DELETE_ERR #define CFE_ES_QUEUE_DELETE_ERR ((CFE_Status_t)0xc400001E)

Queue Delete Error.
Occurs when trying to delete a Queue that belongs to a task that ES is cleaning up.
Definition at line 545 of file cfe_error.h.

9.1.2.37 CFE_ES_RST_ACCESS_ERR #define CFE_ES_RST_ACCESS_ERR ((CFE_Status_t)0xc4000015)

Reset Area Access Error.
Occurs when the BSP is not successful in returning the reset area address.
Definition at line 474 of file cfe_error.h.

9.1.2.38 CFE_ES_TASK_DELETE_ERR #define CFE_ES_TASK_DELETE_ERR ((CFE_Status_t)0xc4000026)

Task Delete Error.
Occurs when trying to delete a task that ES is cleaning up.
Definition at line 614 of file cfe_error.h.

9.1.2.39 CFE_ES_TIMER_DELETE_ERR #define CFE_ES_TIMER_DELETE_ERR ((CFE_Status_t)0xc4000024)

Timer Delete Error.
Occurs when trying to delete a Timer that belongs to a task that ES is cleaning up.
Definition at line 597 of file cfe_error.h.

9.1.2.40 CFE_EVS_APP_FILTER_OVERLOAD #define CFE_EVS_APP_FILTER_OVERLOAD ((CFE_Status_t)0xc2000004)

Application Filter Overload.
Number of Application event filters input upon registration is greater than CFE_PLATFORM_EVS_MAX_EVENT_FILTERS
Definition at line 276 of file cfe_error.h.

Generated by Doxygen
9.1 cFE Return Code Defines 129

9.1.2.41 CFE_EVS_APP_ILLEGAL_APP_ID #define CFE_EVS_APP_ILLEGAL_APP_ID ((CFE_Status_t)0xc2000003)

Illegal Application ID.
Application ID returned by CFE_ES_GetAppIDByName is greater than CFE_PLATFORM_ES_MAX_APPLICATIONS
Definition at line 267 of file cfe_error.h.

9.1.2.42 CFE_EVS_APP_NOT_REGISTERED #define CFE_EVS_APP_NOT_REGISTERED ((CFE_Status_t)0xc2000002)

Application Not Registered.
Calling application never previously called CFE_EVS_Register
Definition at line 258 of file cfe_error.h.

9.1.2.43 CFE_EVS_APP_SQUELCHED #define CFE_EVS_APP_SQUELCHED ((CFE_Status_t)0xc2000009)

Event squelched.
Event squelched due to being sent at too high a rate
Definition at line 318 of file cfe_error.h.

9.1.2.44 CFE_EVS_EVT_NOT_REGISTERED #define CFE_EVS_EVT_NOT_REGISTERED ((CFE_Status_t)0xc2000006)

Event Not Registered.
CFE_EVS_ResetFilter EventID argument was not found in any event filter registered by the calling application.
Definition at line 294 of file cfe_error.h.

9.1.2.45 CFE_EVS_FILE_WRITE_ERROR #define CFE_EVS_FILE_WRITE_ERROR ((CFE_Status_t)0xc2000007)

File Write Error.
A file write error occurred while processing an EVS command
Definition at line 302 of file cfe_error.h.

9.1.2.46 CFE_EVS_INVALID_PARAMETER #define CFE_EVS_INVALID_PARAMETER ((CFE_Status_t)0xc2000008)

Invalid Pointer.
Invalid parameter supplied to EVS command
Definition at line 310 of file cfe_error.h.

9.1.2.47 CFE_EVS_NOT_IMPLEMENTED #define CFE_EVS_NOT_IMPLEMENTED ((CFE_Status_t)0xc200ffff)

Not Implemented.
Current version of cFE does not have the function or the feature of the function implemented. This could be due to either
an early build of the cFE for this platform or the platform does not support the specified feature.
Definition at line 329 of file cfe_error.h.

9.1.2.48 CFE_EVS_RESET_AREA_POINTER #define CFE_EVS_RESET_AREA_POINTER ((CFE_Status_t)0xc2000005)

Reset Area Pointer Failure.
Could not get pointer to the ES Reset area, so we could not get the pointer to the EVS Log.
Definition at line 285 of file cfe_error.h.

9.1.2.49 CFE_EVS_UNKNOWN_FILTER #define CFE_EVS_UNKNOWN_FILTER ((CFE_Status_t)0xc2000001)

Unknown Filter.
CFE_EVS_Register FilterScheme parameter was illegal

Generated by Doxygen
130

Definition at line 250 of file cfe_error.h.

9.1.2.50 CFE_FS_BAD_ARGUMENT #define CFE_FS_BAD_ARGUMENT ((CFE_Status_t)0xc6000001)

Bad Argument.
A parameter given by a caller to a File Services API did not pass validation checks.
Definition at line 692 of file cfe_error.h.

9.1.2.51 CFE_FS_FNAME_TOO_LONG #define CFE_FS_FNAME_TOO_LONG ((CFE_Status_t)0xc6000003)

Filename Too Long.
FS filename string is too long
Definition at line 708 of file cfe_error.h.

9.1.2.52 CFE_FS_INVALID_PATH #define CFE_FS_INVALID_PATH ((CFE_Status_t)0xc6000002)

Invalid Path.
FS was unable to extract a filename from a path string
Definition at line 700 of file cfe_error.h.

9.1.2.53 CFE_FS_NOT_IMPLEMENTED #define CFE_FS_NOT_IMPLEMENTED ((CFE_Status_t)0xc600ffff)

Not Implemented.
Current version of cFE does not have the function or the feature of the function implemented. This could be due to either
an early build of the cFE for this platform or the platform does not support the specified feature.
Definition at line 719 of file cfe_error.h.

9.1.2.54 CFE_SB_BAD_ARGUMENT #define CFE_SB_BAD_ARGUMENT ((CFE_Status_t)0xca000003)

Bad Argument.
A parameter given by a caller to a Software Bus API did not pass validation checks.
Definition at line 750 of file cfe_error.h.

9.1.2.55 CFE_SB_BUF_ALOC_ERR #define CFE_SB_BUF_ALOC_ERR ((CFE_Status_t)0xca000008)

Buffer Allocation Error.
Returned when the memory in the SB message buffer pool has been depleted. The amount of memory in the pool is
dictated by the configuration parameter CFE_PLATFORM_SB_BUF_MEMORY_BYTES specified in the cfe_platform←-
_cfg.h file. Also the memory statistics, including current utilization figures and high water marks for the SB Buffer
memory pool can be monitored by sending a Software Bus command to send the SB statistics packet.
Definition at line 808 of file cfe_error.h.

9.1.2.56 CFE_SB_BUFFER_INVALID #define CFE_SB_BUFFER_INVALID ((CFE_Status_t)0xca00000e)

Buffer Invalid.
This error code will be returned when a request to release or send a zero copy buffer is invalid, such as if the handle or
buffer is not correct or the buffer was previously released.
Definition at line 859 of file cfe_error.h.

Generated by Doxygen
9.1 cFE Return Code Defines 131

9.1.2.57 CFE_SB_INTERNAL_ERR #define CFE_SB_INTERNAL_ERR ((CFE_Status_t)0xca00000c)

Internal Error.
This error code will be returned by the CFE_SB_Subscribe API if the code detects an internal index is out of range. The
most likely cause would be a Single Event Upset.
Definition at line 840 of file cfe_error.h.

9.1.2.58 CFE_SB_MAX_DESTS_MET #define CFE_SB_MAX_DESTS_MET ((CFE_Status_t)0xca00000a)

Max Destinations Met.
Will be returned when calling one of the SB subscription API's if the SB routing table cannot accommodate another
destination for a particular the given message ID. This occurs when the number of destinations in use meets the platform
configuration parameter CFE_PLATFORM_SB_MAX_DEST_PER_PKT.
Definition at line 830 of file cfe_error.h.

9.1.2.59 CFE_SB_MAX_MSGS_MET #define CFE_SB_MAX_MSGS_MET ((CFE_Status_t)0xca000009)

Max Messages Met.
Will be returned when calling one of the SB subscription API's if the SB routing table cannot accommodate another
unique message ID because the platform configuration parameter CFE_PLATFORM_SB_MAX_MSG_IDS has been
met.
Definition at line 818 of file cfe_error.h.

9.1.2.60 CFE_SB_MAX_PIPES_MET #define CFE_SB_MAX_PIPES_MET ((CFE_Status_t)0xca000004)

Max Pipes Met.
This error code will be returned from CFE_SB_CreatePipe when the SB cannot accommodate the request to create
a pipe because the maximum number of pipes (CFE_PLATFORM_SB_MAX_PIPES) are in use. This configuration
parameter is defined in the cfe_platform_cfg.h file.
Definition at line 761 of file cfe_error.h.

9.1.2.61 CFE_SB_MSG_TOO_BIG #define CFE_SB_MSG_TOO_BIG ((CFE_Status_t)0xca000007)

Message Too Big.
The size field in the message header indicates the message exceeds the max Software Bus message size. The max
size is defined by configuration parameter CFE_MISSION_SB_MAX_SB_MSG_SIZE in cfe_mission_cfg.h
Definition at line 795 of file cfe_error.h.

9.1.2.62 CFE_SB_NO_MESSAGE #define CFE_SB_NO_MESSAGE ((CFE_Status_t)0xca000002)

No Message.
When "Polling" a pipe for a message in CFE_SB_ReceiveBuffer, this return value indicates that there was not a message
on the pipe.
Definition at line 741 of file cfe_error.h.

9.1.2.63 CFE_SB_NOT_IMPLEMENTED #define CFE_SB_NOT_IMPLEMENTED ((CFE_Status_t)0xca00ffff)

Not Implemented.
Current version of cFE does not have the function or the feature of the function implemented. This could be due to either
an early build of the cFE for this platform or the platform does not support the specified feature.
Definition at line 870 of file cfe_error.h.

Generated by Doxygen
132

9.1.2.64 CFE_SB_PIPE_CR_ERR #define CFE_SB_PIPE_CR_ERR ((CFE_Status_t)0xca000005)

Pipe Create Error.
The maximum number of queues(OS_MAX_QUEUES) are in use. Or possibly a lower level problem with creating the
underlying queue has occurred such as a lack of memory. If the latter is the problem, the status code displayed in the
event must be tracked.
Definition at line 772 of file cfe_error.h.

9.1.2.65 CFE_SB_PIPE_RD_ERR #define CFE_SB_PIPE_RD_ERR ((CFE_Status_t)0xca000006)

Pipe Read Error.
This return value indicates an error at the Queue read level. This error typically cannot be corrected by the caller. Some
possible causes are: queue was not properly initialized or created, the number of bytes read from the queue was not
the number of bytes requested in the read. The queue id is invalid. Similar errors regarding the pipe will be caught by
higher level code in the Software Bus.
Definition at line 785 of file cfe_error.h.

9.1.2.66 CFE_SB_TIME_OUT #define CFE_SB_TIME_OUT ((CFE_Status_t)0xca000001)

Time Out.
In CFE_SB_ReceiveBuffer, this return value indicates that a packet has not been received in the time given in the
"timeout" parameter.
Definition at line 732 of file cfe_error.h.

9.1.2.67 CFE_SB_WRONG_MSG_TYPE #define CFE_SB_WRONG_MSG_TYPE ((CFE_Status_t)0xca00000d)

Wrong Message Type.
This error code will be returned when a request such as CFE_MSG_SetMsgTime is made on a packet that does not
include a field for msg time.
Definition at line 849 of file cfe_error.h.

9.1.2.68 CFE_STATUS_BAD_COMMAND_CODE #define CFE_STATUS_BAD_COMMAND_CODE ((CFE_Status_t)0xc8000004)

Bad Command Code.
This error code will be returned when a message identification process determined that the command code is does not
correspond to any known value
Definition at line 182 of file cfe_error.h.

9.1.2.69 CFE_STATUS_EXTERNAL_RESOURCE_FAIL #define CFE_STATUS_EXTERNAL_RESOURCE_FAIL ((CFE_Status_t)0xc8000

External failure.
This error indicates that the operation failed for some reason outside the scope of CFE. The real failure may have been
in OSAL, PSP, or another dependent library.
Details of the original failure should be written to syslog and/or a system event before returning this error.
Definition at line 194 of file cfe_error.h.

9.1.2.70 CFE_STATUS_INCORRECT_STATE #define CFE_STATUS_INCORRECT_STATE ((int32)0xc8000009)

Cannot process request at this time.
The system is not currently in the correct state to accept the request at this time.
Definition at line 227 of file cfe_error.h.

Generated by Doxygen
9.1 cFE Return Code Defines 133

9.1.2.71 CFE_STATUS_NO_COUNTER_INCREMENT #define CFE_STATUS_NO_COUNTER_INCREMENT ((CFE_Status_t)0x48000001

No Counter Increment.
Informational code indicating that a command was processed successfully but that the command counter should not be
incremented.
Definition at line 155 of file cfe_error.h.

9.1.2.72 CFE_STATUS_NOT_IMPLEMENTED #define CFE_STATUS_NOT_IMPLEMENTED ((CFE_Status_t)0xc800ffff)

Not Implemented.
Current version does not have the function or the feature of the function implemented. This could be due to either an
early build for this platform or the platform does not support the specified feature.
Definition at line 238 of file cfe_error.h.

9.1.2.73 CFE_STATUS_RANGE_ERROR #define CFE_STATUS_RANGE_ERROR ((int32)0xc8000008)

Request or input value is out of range.
A message, table, or function call input contained a value that was outside the acceptable range, and the request was
rejected.
Definition at line 219 of file cfe_error.h.

9.1.2.74 CFE_STATUS_REQUEST_ALREADY_PENDING #define CFE_STATUS_REQUEST_ALREADY_PENDI←-

NG ((int32)0xc8000006)
Request already pending.
Commands or requests are already pending or the pending request limit has been reached. No more requests can be
made until the current request(s) complete.
Definition at line 203 of file cfe_error.h.

9.1.2.75 CFE_STATUS_UNKNOWN_MSG_ID #define CFE_STATUS_UNKNOWN_MSG_ID ((CFE_Status_t)0xc8000003)

Unknown Message ID.
This error code will be returned when a message identification process determined that the message ID does not
correspond to a known value
Definition at line 173 of file cfe_error.h.

9.1.2.76 CFE_STATUS_VALIDATION_FAILURE #define CFE_STATUS_VALIDATION_FAILURE ((int32)0xc8000007)

Request or input value failed basic structural validation.
A message or table input was not in the proper format to be understood and processed by an application, and was
rejected.
Definition at line 211 of file cfe_error.h.

9.1.2.77 CFE_STATUS_WRONG_MSG_LENGTH #define CFE_STATUS_WRONG_MSG_LENGTH ((CFE_Status_t)0xc8000002)

Wrong Message Length.
This error code will be returned when a message validation process determined that the message length is incorrect
Definition at line 164 of file cfe_error.h.

9.1.2.78 CFE_SUCCESS #define CFE_SUCCESS ((CFE_Status_t)0)

Successful execution.
Operation was performed successfully

Generated by Doxygen
134

Definition at line 147 of file cfe_error.h.

9.1.2.79 CFE_TBL_BAD_ARGUMENT #define CFE_TBL_BAD_ARGUMENT ((CFE_Status_t)0xcc00002d)

Bad Argument.
A parameter given by a caller to a Table API did not pass validation checks.
Definition at line 1281 of file cfe_error.h.

9.1.2.80 CFE_TBL_ERR_ACCESS #define CFE_TBL_ERR_ACCESS ((CFE_Status_t)0xcc00002c)

Error code indicating that the TBL file could not be opened by the OS.
Definition at line 1272 of file cfe_error.h.

9.1.2.81 CFE_TBL_ERR_BAD_CONTENT_ID #define CFE_TBL_ERR_BAD_CONTENT_ID ((CFE_Status_t)0xcc000016)

Bad Content ID.
The calling Application called CFE_TBL_Load with a filename that specified a file whose content ID was not that of a
table image.
Definition at line 1064 of file cfe_error.h.

9.1.2.82 CFE_TBL_ERR_BAD_PROCESSOR_ID #define CFE_TBL_ERR_BAD_PROCESSOR_ID ((CFE_Status_t)0xcc000029)

Bad Processor ID.
The selected table file failed validation for Processor ID. The platform configuration file has verification of table files
enabled for Processor ID and an attempt was made to load a table with an invalid Processor ID in the table file header.
Definition at line 1252 of file cfe_error.h.

9.1.2.83 CFE_TBL_ERR_BAD_SPACECRAFT_ID #define CFE_TBL_ERR_BAD_SPACECRAFT_ID ((CFE_Status_t)0xcc000028)

Bad Spacecraft ID.
The selected table file failed validation for Spacecraft ID. The platform configuration file has verification of table files
enabled for Spacecraft ID and an attempt was made to load a table with an invalid Spacecraft ID in the table file header.
Definition at line 1241 of file cfe_error.h.

9.1.2.84 CFE_TBL_ERR_BAD_SUBTYPE_ID #define CFE_TBL_ERR_BAD_SUBTYPE_ID ((CFE_Status_t)0xcc00001B)

Bad Subtype ID.
The calling Application tried to access a table file whose Subtype identifier indicated it was not a table image file.
Definition at line 1105 of file cfe_error.h.

9.1.2.85 CFE_TBL_ERR_DUMP_ONLY #define CFE_TBL_ERR_DUMP_ONLY ((CFE_Status_t)0xcc000010)

Dump Only Error.
The calling Application has attempted to perform a load on a table that was created with "Dump Only" attributes.
Definition at line 1016 of file cfe_error.h.

9.1.2.86 CFE_TBL_ERR_DUPLICATE_DIFF_SIZE #define CFE_TBL_ERR_DUPLICATE_DIFF_SIZE ((CFE_Status_t)0xcc00000C)

Duplicate Table With Different Size.
An application attempted to register a table with the same name as a table that is already in the registry. The size of the
new table is different from the size already in the registry.
Definition at line 977 of file cfe_error.h.

Generated by Doxygen
9.1 cFE Return Code Defines 135

9.1.2.87 CFE_TBL_ERR_DUPLICATE_NOT_OWNED #define CFE_TBL_ERR_DUPLICATE_NOT_OWNED ((CFE_Status_t)0xcc00000D

Duplicate Table And Not Owned.
An application attempted to register a table with the same name as a table that is already in the registry. The previously
registered table is owned by a different application.
Definition at line 987 of file cfe_error.h.

9.1.2.88 CFE_TBL_ERR_FILE_FOR_WRONG_TABLE #define CFE_TBL_ERR_FILE_FOR_WRONG_TABLE ((CFE_Status_t)0xcc0000

File For Wrong Table.
The calling Application tried to load a table using a file whose header indicated that it was for a different table.
Definition at line 1149 of file cfe_error.h.

9.1.2.89 CFE_TBL_ERR_FILE_SIZE_INCONSISTENT #define CFE_TBL_ERR_FILE_SIZE_INCONSISTENT ((CFE_Status_t)0xcc000

File Size Inconsistent.
The calling Application tried to access a table file whose Subtype identifier indicated it was not a table image file.
Definition at line 1114 of file cfe_error.h.

9.1.2.90 CFE_TBL_ERR_FILE_TOO_LARGE #define CFE_TBL_ERR_FILE_TOO_LARGE ((CFE_Status_t)0xcc000014)

File Too Large.
The calling Application called CFE_TBL_Load with a filename that specified a file that contained more data than the
size of the table OR which contained more data than specified in the table header.
Definition at line 1044 of file cfe_error.h.

9.1.2.91 CFE_TBL_ERR_FILENAME_TOO_LONG #define CFE_TBL_ERR_FILENAME_TOO_LONG ((CFE_Status_t)0xcc00001F)

Filename Too Long.
The calling Application tried to load a table using a filename that was too long.
Definition at line 1140 of file cfe_error.h.

9.1.2.92 CFE_TBL_ERR_HANDLES_FULL #define CFE_TBL_ERR_HANDLES_FULL ((CFE_Status_t)0xcc00000B)

Handles Full.
An application attempted to create a table and the Table Handle Array already used all CFE_PLATFORM_TBL_MAX←-
_NUM_HANDLES in it.
Definition at line 967 of file cfe_error.h.

9.1.2.93 CFE_TBL_ERR_ILLEGAL_SRC_TYPE #define CFE_TBL_ERR_ILLEGAL_SRC_TYPE ((CFE_Status_t)0xcc000011)

Illegal Source Type.
The calling Application called CFE_TBL_Load with an illegal value for the second parameter.
Definition at line 1025 of file cfe_error.h.

9.1.2.94 CFE_TBL_ERR_INVALID_HANDLE #define CFE_TBL_ERR_INVALID_HANDLE ((CFE_Status_t)0xcc000001)

Invalid Handle.
The calling Application attempted to pass a Table handle that represented too large an index or identified a Table Access
Descriptor that was not used.
Definition at line 884 of file cfe_error.h.

Generated by Doxygen
136

9.1.2.95 CFE_TBL_ERR_INVALID_NAME #define CFE_TBL_ERR_INVALID_NAME ((CFE_Status_t)0xcc000002)

Invalid Name.
The calling Application attempted to register a table whose name length exceeded the platform configuration value of
CFE_MISSION_TBL_MAX_NAME_LENGTH or was zero characters long.
Definition at line 894 of file cfe_error.h.

9.1.2.96 CFE_TBL_ERR_INVALID_OPTIONS #define CFE_TBL_ERR_INVALID_OPTIONS ((CFE_Status_t)0xcc000025)

Invalid Options.
The calling Application has used an illegal combination of table options. A summary of the illegal combinations are as
follows:
#CFE_TBL_OPT_USR_DEF_ADDR cannot be combined with any of the following:

1. CFE_TBL_OPT_DBL_BUFFER
2. CFE_TBL_OPT_LOAD_DUMP
3. CFE_TBL_OPT_CRITICAL

#CFE_TBL_OPT_DBL_BUFFER cannot be combined with the following:

1. CFE_TBL_OPT_USR_DEF_ADDR
2. CFE_TBL_OPT_DUMP_ONLY

Definition at line 1206 of file cfe_error.h.

9.1.2.97 CFE_TBL_ERR_INVALID_SIZE #define CFE_TBL_ERR_INVALID_SIZE ((CFE_Status_t)0xcc000003)

Invalid Size.
The calling Application attempted to register a table: a) that was a double buffered table with size greater
than CFE_PLATFORM_TBL_MAX_DBL_TABLE_SIZE b) that was a single buffered table with size greater than
CFE_PLATFORM_TBL_MAX_SNGL_TABLE_SIZE c) that had a size of zero
Definition at line 905 of file cfe_error.h.

9.1.2.98 CFE_TBL_ERR_LOAD_IN_PROGRESS #define CFE_TBL_ERR_LOAD_IN_PROGRESS ((CFE_Status_t)0xcc000012)

Load In Progress.
The calling Application called CFE_TBL_Load when another Application was trying to load the table.
Definition at line 1034 of file cfe_error.h.

9.1.2.99 CFE_TBL_ERR_LOAD_INCOMPLETE #define CFE_TBL_ERR_LOAD_INCOMPLETE ((CFE_Status_t)0xcc000021)

Load Incomplete.
The calling Application tried to load a table file whose header claimed the load was larger than what was actually read
from the file.
Definition at line 1158 of file cfe_error.h.

9.1.2.100 CFE_TBL_ERR_NEVER_LOADED #define CFE_TBL_ERR_NEVER_LOADED ((CFE_Status_t)0xcc000005)

Never Loaded.
Table has not been loaded with data.
Definition at line 921 of file cfe_error.h.

Generated by Doxygen
9.1 cFE Return Code Defines 137

9.1.2.101 CFE_TBL_ERR_NO_ACCESS #define CFE_TBL_ERR_NO_ACCESS ((CFE_Status_t)0xcc000008)

No Access.
The calling application either failed when calling CFE_TBL_Register, failed when calling CFE_TBL_Share or forgot to
call either one.
Definition at line 949 of file cfe_error.h.

9.1.2.102 CFE_TBL_ERR_NO_BUFFER_AVAIL #define CFE_TBL_ERR_NO_BUFFER_AVAIL ((CFE_Status_t)0xcc00000F)

No Buffer Available.
The calling Application has tried to allocate a working buffer but none were available.
Definition at line 1007 of file cfe_error.h.

9.1.2.103 CFE_TBL_ERR_NO_STD_HEADER #define CFE_TBL_ERR_NO_STD_HEADER ((CFE_Status_t)0xcc00001D)

No Standard Header.
The calling Application tried to access a table file whose standard cFE File Header was the wrong size, etc.
Definition at line 1122 of file cfe_error.h.

9.1.2.104 CFE_TBL_ERR_NO_TBL_HEADER #define CFE_TBL_ERR_NO_TBL_HEADER ((CFE_Status_t)0xcc00001E)

No Table Header.
The calling Application tried to access a table file whose standard cFE Table File Header was the wrong size, etc.
Definition at line 1131 of file cfe_error.h.

9.1.2.105 CFE_TBL_ERR_PARTIAL_LOAD #define CFE_TBL_ERR_PARTIAL_LOAD ((CFE_Status_t)0xcc000023)

Partial Load Error.
The calling Application tried to load a table file whose header claimed the load did not start with the first byte and the
table image had NEVER been loaded before. Partial loads are not allowed on uninitialized tables. It should be noted
that CFE_TBL_WARN_SHORT_FILE also indicates a partial load.
Definition at line 1180 of file cfe_error.h.

9.1.2.106 CFE_TBL_ERR_REGISTRY_FULL #define CFE_TBL_ERR_REGISTRY_FULL ((CFE_Status_t)0xcc000006)

Registry Full.
An application attempted to create a table and the Table registry already contained CFE_PLATFORM_TBL_MAX_NUM_TABLES
in it.
Definition at line 930 of file cfe_error.h.

9.1.2.107 CFE_TBL_ERR_SHORT_FILE #define CFE_TBL_ERR_SHORT_FILE ((CFE_Status_t)0xcc00002b)

Error code indicating that the TBL file is shorter than indicated in the file header.
Definition at line 1266 of file cfe_error.h.

9.1.2.108 CFE_TBL_ERR_UNREGISTERED #define CFE_TBL_ERR_UNREGISTERED ((CFE_Status_t)0xcc000009)

Unregistered.
The calling application is trying to access a table that has been unregistered.
Definition at line 958 of file cfe_error.h.

Generated by Doxygen
138

9.1.2.109 CFE_TBL_INFO_DUMP_PENDING #define CFE_TBL_INFO_DUMP_PENDING ((CFE_Status_t)0x4c000024)

Dump Pending.
The calling Application should call CFE_TBL_Manage for the specified table. The ground has requested a dump of the
Dump-Only table and needs to synchronize with the owning application.
Definition at line 1190 of file cfe_error.h.

9.1.2.110 CFE_TBL_INFO_NO_UPDATE_PENDING #define CFE_TBL_INFO_NO_UPDATE_PENDING ((CFE_Status_t)0x4c000017)

No Update Pending.
The calling Application has attempted to update a table without a pending load.
Definition at line 1072 of file cfe_error.h.

9.1.2.111 CFE_TBL_INFO_NO_VALIDATION_PENDING #define CFE_TBL_INFO_NO_VALIDATION_PENDI←-

NG ((CFE_Status_t)0x4c00001A)
No Validation Pending
The calling Application tried to validate a table that did not have a validation request pending.
Definition at line 1096 of file cfe_error.h.

9.1.2.112 CFE_TBL_INFO_RECOVERED_TBL #define CFE_TBL_INFO_RECOVERED_TBL ((CFE_Status_t)0x4c000027)

Recovered Table.
The calling Application registered a critical table whose previous contents were discovered in the Critical Data Store.
The discovered contents were copied back into the newly registered table as the table's initial contents.
NOTE: In this situation, the contents of the table are NOT validated using the table's validation function.
Definition at line 1230 of file cfe_error.h.

9.1.2.113 CFE_TBL_INFO_TABLE_LOCKED #define CFE_TBL_INFO_TABLE_LOCKED ((CFE_Status_t)0x4c000018)

Table Locked.
The calling Application tried to update a table that is locked by another user.
Definition at line 1080 of file cfe_error.h.

9.1.2.114 CFE_TBL_INFO_UPDATE_PENDING #define CFE_TBL_INFO_UPDATE_PENDING ((CFE_Status_t)0x4c000004)

Update Pending.
The calling Application has identified a table that has a load pending.
Definition at line 913 of file cfe_error.h.

9.1.2.115 CFE_TBL_INFO_UPDATED #define CFE_TBL_INFO_UPDATED ((CFE_Status_t)0x4c00000E)

Updated.
The calling Application has identified a table that has been updated.
NOTE: This is a nominal return code informing the calling application that the table identified in the call has had its
contents updated since the last time the application obtained its address or status.
Definition at line 998 of file cfe_error.h.

9.1.2.116 CFE_TBL_INFO_VALIDATION_PENDING #define CFE_TBL_INFO_VALIDATION_PENDING ((CFE_Status_t)0x4c000019)

Validation Pending
The calling Application should call CFE_TBL_Validate for the specified table.
Definition at line 1088 of file cfe_error.h.

Generated by Doxygen
9.1 cFE Return Code Defines 139

9.1.2.117 CFE_TBL_MESSAGE_ERROR #define CFE_TBL_MESSAGE_ERROR ((CFE_Status_t)0xcc00002a)

Message Error.
Error code indicating that the TBL command was not processed successfully and that the error counter should be
incremented.
Definition at line 1260 of file cfe_error.h.

9.1.2.118 CFE_TBL_NOT_IMPLEMENTED #define CFE_TBL_NOT_IMPLEMENTED ((CFE_Status_t)0xcc00ffff)

Not Implemented.
Current version of cFE does not have the function or the feature of the function implemented. This could be due to either
an early build of the cFE for this platform or the platform does not support the specified feature.
Definition at line 1292 of file cfe_error.h.

9.1.2.119 CFE_TBL_WARN_DUPLICATE #define CFE_TBL_WARN_DUPLICATE ((CFE_Status_t)0x4c000007)

Duplicate Warning.
This is an error that the registration is trying to replace an existing table with the same name. The previous table stays
in place and the new table is rejected.
Definition at line 940 of file cfe_error.h.

9.1.2.120 CFE_TBL_WARN_NOT_CRITICAL #define CFE_TBL_WARN_NOT_CRITICAL ((CFE_Status_t)0x4c000026)

Not Critical Warning.
The calling Application attempted to register a table as "Critical". Table Services failed to create an appropriate Critical
Data Store (See System Log for reason) to save the table contents. The table will be treated as a normal table from now
on.
Definition at line 1217 of file cfe_error.h.

9.1.2.121 CFE_TBL_WARN_PARTIAL_LOAD #define CFE_TBL_WARN_PARTIAL_LOAD ((CFE_Status_t)0x4c000022)

Partial Load Warning.
The calling Application tried to load a table file whose header claimed the load did not start with the first byte. It should
be noted that CFE_TBL_WARN_SHORT_FILE also indicates a partial load.
Definition at line 1168 of file cfe_error.h.

9.1.2.122 CFE_TBL_WARN_SHORT_FILE #define CFE_TBL_WARN_SHORT_FILE ((CFE_Status_t)0x4c000015)

Short File Warning.
The calling Application called CFE_TBL_Load with a filename that specified a file that started with the first byte of the
table but contained less data than the size of the table. It should be noted that CFE_TBL_WARN_PARTIAL_LOAD also
indicates a partial load (one that starts at a non-zero offset).
Definition at line 1055 of file cfe_error.h.

9.1.2.123 CFE_TIME_BAD_ARGUMENT #define CFE_TIME_BAD_ARGUMENT ((CFE_Status_t)0xce000005)

Bad Argument.
A parameter given by a caller to a TIME Services API did not pass validation checks.
Definition at line 1364 of file cfe_error.h.

9.1.2.124 CFE_TIME_CALLBACK_NOT_REGISTERED #define CFE_TIME_CALLBACK_NOT_REGISTERED ((CFE_Status_t)0xce0000

Callback Not Registered.

Generated by Doxygen
140

An attempt to unregister a cFE Time Services Synchronization callback has failed because the specified callback func-
tion was not located in the Synchronization Callback Registry.
Definition at line 1355 of file cfe_error.h.

9.1.2.125 CFE_TIME_INTERNAL_ONLY #define CFE_TIME_INTERNAL_ONLY ((CFE_Status_t)0xce000001)

Internal Only.
One of the TIME Services API functions to set the time with data from an external time source has been called, but
TIME Services has been commanded to not accept external time data. However, the command is still a signal for the
Time Server to generate a "time at the tone" command packet using internal data.
Definition at line 1319 of file cfe_error.h.

9.1.2.126 CFE_TIME_NOT_IMPLEMENTED #define CFE_TIME_NOT_IMPLEMENTED ((CFE_Status_t)0xce00ffff)

Not Implemented.
Current version of cFE does not have the function or the feature of the function implemented. This could be due to either
an early build of the cFE for this platform or the platform does not support the specified feature.
Definition at line 1307 of file cfe_error.h.

9.1.2.127 CFE_TIME_OUT_OF_RANGE #define CFE_TIME_OUT_OF_RANGE ((CFE_Status_t)0xce000002)

Out Of Range.
One of the TIME Services API functions to set the time with data from an external time source has been called, but
TIME Services has determined that the new time data is invalid. However, the command is still a signal for the Time
Server to generate a "time at the tone" command packet using internal data.
Note that the test for invalid time update data only occurs if TIME Services has previously been commanded to set the
clock state to "valid".
Definition at line 1334 of file cfe_error.h.

9.1.2.128 CFE_TIME_TOO_MANY_SYNCH_CALLBACKS #define CFE_TIME_TOO_MANY_SYNCH_CALLBAC←-

KS ((CFE_Status_t)0xce000003)
Too Many Sync Callbacks.
An attempt to register too many cFE Time Services Synchronization callbacks has been made. Only one callback
function is allowed per application. It is expected that the application itself will distribute the single callback to child
threads as needed.
Definition at line 1345 of file cfe_error.h.

Generated by Doxygen
9.2 cFE Resource ID APIs 141

9.2 cFE Resource ID APIs

Functions

• CFE_Status_t CFE_ES_AppID_ToIndex (CFE_ES_AppId_t AppID, uint32 ∗Idx)

Obtain an index value correlating to an ES Application ID.
• int32 CFE_ES_LibID_ToIndex (CFE_ES_LibId_t LibId, uint32 ∗Idx)
Obtain an index value correlating to an ES Library ID.
• CFE_Status_t CFE_ES_TaskID_ToIndex (CFE_ES_TaskId_t TaskID, uint32 ∗Idx)
Obtain an index value correlating to an ES Task ID.
• CFE_Status_t CFE_ES_CounterID_ToIndex (CFE_ES_CounterId_t CounterId, uint32 ∗Idx)
Obtain an index value correlating to an ES Counter ID.

9.2.1 Detailed Description

9.2.2 Function Documentation

9.2.2.1 CFE_ES_AppID_ToIndex() CFE_Status_t CFE_ES_AppID_ToIndex (

CFE_ES_AppId_t AppID,
uint32 ∗ Idx )
Obtain an index value correlating to an ES Application ID.
This calculates a zero based integer value that may be used for indexing into a local resource table/array.
Index values are only guaranteed to be unique for resources of the same type. For instance, the indices corresponding
to two [valid] application IDs will never overlap, but the index of an application and a library ID may be the same.
Furthermore, indices may be reused if a resource is deleted and re-created.

Note

There is no inverse of this function - indices cannot be converted back to the original AppID value. The caller
should retain the original ID for future use.

Parameters
in AppID Application ID to convert
out Idx Buffer where the calculated index will be stored (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

9.2.2.2 CFE_ES_CounterID_ToIndex() CFE_Status_t CFE_ES_CounterID_ToIndex (

CFE_ES_CounterId_t CounterId,
uint32 ∗ Idx )

Generated by Doxygen
142

Obtain an index value correlating to an ES Counter ID.

This calculates a zero based integer value that may be used for indexing into a local resource table/array.
Index values are only guaranteed to be unique for resources of the same type. For instance, the indices corresponding
to two [valid] Counter IDs will never overlap, but the index of a Counter and a library ID may be the same. Furthermore,
indices may be reused if a resource is deleted and re-created.

Note

There is no inverse of this function - indices cannot be converted back to the original CounterID value. The caller
should retain the original ID for future use.

Parameters

in Counter←- Counter ID to convert

Id
out Idx Buffer where the calculated index will be stored (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

9.2.2.3 CFE_ES_LibID_ToIndex() int32 CFE_ES_LibID_ToIndex (

CFE_ES_LibId_t LibId,
uint32 ∗ Idx )
Obtain an index value correlating to an ES Library ID.
This calculates a zero based integer value that may be used for indexing into a local resource table/array.
Index values are only guaranteed to be unique for resources of the same type. For instance, the indices corresponding
to two [valid] Library IDs will never overlap, but the index of an Library and a library ID may be the same. Furthermore,
indices may be reused if a resource is deleted and re-created.

Note

There is no inverse of this function - indices cannot be converted back to the original LibID value. The caller should
retain the original ID for future use.

Parameters
in Lib←- Library ID to convert
Id
out Idx Buffer where the calculated index will be stored (must not be null)

Returns

Execution status, see cFE Return Code Defines

Generated by Doxygen
9.2 cFE Resource ID APIs 143

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

9.2.2.4 CFE_ES_TaskID_ToIndex() CFE_Status_t CFE_ES_TaskID_ToIndex (

CFE_ES_TaskId_t TaskID,
uint32 ∗ Idx )
Obtain an index value correlating to an ES Task ID.
This calculates a zero based integer value that may be used for indexing into a local resource table/array.
Index values are only guaranteed to be unique for resources of the same type. For instance, the indices corresponding
to two [valid] Task IDs will never overlap, but the index of a Task and a library ID may be the same. Furthermore, indices
may be reused if a resource is deleted and re-created.

Note

There is no inverse of this function - indices cannot be converted back to the original TaskID value. The caller
should retain the original ID for future use.

Parameters
in TaskID Task ID to convert
out Idx Buffer where the calculated index will be stored (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
144

9.3 cFE Entry/Exit APIs

Functions

• void CFE_ES_Main (uint32 StartType, uint32 StartSubtype, uint32 ModeId, const char ∗StartFilePath)
cFE Main Entry Point used by Board Support Package to start cFE
• CFE_Status_t CFE_ES_ResetCFE (uint32 ResetType)
Reset the cFE Core and all cFE Applications.

9.3.1 Detailed Description

9.3.2 Function Documentation

9.3.2.1 CFE_ES_Main() void CFE_ES_Main (

uint32 StartType,
uint32 StartSubtype,
uint32 ModeId,
const char ∗ StartFilePath )
cFE Main Entry Point used by Board Support Package to start cFE

Description

cFE main entry point. This is the entry point into the cFE software. It is called only by the Board Support Package
software.

Assumptions, External Events, and Notes:

None

Parameters

in StartType Identifies whether this was a CFE_PSP_RST_TYPE_POWERON or

CFE_PSP_RST_TYPE_PROCESSOR.
in StartSubtype Specifies, in more detail, what caused the StartType identified above. See
CFE_PSP_RST_SUBTYPE_POWER_CYCLE for possible examples.
in ModeId Identifies the source of the Boot as determined by the BSP.
in StartFilePath Identifies the startup file to use to initialize the cFE apps.

See also

CFE_ES_ResetCFE

9.3.2.2 CFE_ES_ResetCFE() CFE_Status_t CFE_ES_ResetCFE (

uint32 ResetType )
Reset the cFE Core and all cFE Applications.
Description

This API causes an immediate reset of the cFE Kernel and all cFE Applications. The caller can specify whether
the reset should clear all memory (CFE_PSP_RST_TYPE_POWERON) or try to retain volatile memory areas
(CFE_PSP_RST_TYPE_PROCESSOR).

Generated by Doxygen
9.3 cFE Entry/Exit APIs 145

Assumptions, External Events, and Notes:

None

Parameters

in ResetType Identifies the type of reset desired. Allowable settings are:

• CFE_PSP_RST_TYPE_POWERON - Causes all memory to be cleared

• CFE_PSP_RST_TYPE_PROCESSOR - Attempts to retain volatile disk, critical data

store and user reserved memory.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.
CFE_ES_NOT_IMPLEMENTED Not Implemented.

See also

CFE_ES_Main

Generated by Doxygen
146

9.4 cFE Application Control APIs

Functions

• CFE_Status_t CFE_ES_RestartApp (CFE_ES_AppId_t AppID)

Restart a single cFE Application.
• CFE_Status_t CFE_ES_ReloadApp (CFE_ES_AppId_t AppID, const char ∗AppFileName)
Reload a single cFE Application.
• CFE_Status_t CFE_ES_DeleteApp (CFE_ES_AppId_t AppID)
Delete a cFE Application.

9.4.1 Detailed Description

9.4.2 Function Documentation

9.4.2.1 CFE_ES_DeleteApp() CFE_Status_t CFE_ES_DeleteApp (

CFE_ES_AppId_t AppID )
Delete a cFE Application.

Description

This API causes a cFE Application to be stopped deleted.

Assumptions, External Events, and Notes:

None

Parameters

in AppID Identifies the application to be reset.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

CFE_SUCCESS Successful execution.

See also

CFE_ES_RestartApp, CFE_ES_ReloadApp

9.4.2.2 CFE_ES_ReloadApp() CFE_Status_t CFE_ES_ReloadApp (

CFE_ES_AppId_t AppID,
const char ∗ AppFileName )
Reload a single cFE Application.

Generated by Doxygen
9.4 cFE Application Control APIs 147

Description

This API causes a cFE Application to be stopped and restarted from the specified file.

Assumptions, External Events, and Notes:

The filename is checked for existence prior to load. A missing file will be reported and the reload operation will be
aborted prior to unloading the app.

Goes through the standard CFE_ES_CleanUpApp which unloads, then attempts a load using the specified file name.
In the event that an application cannot be reloaded due to a corrupt file, the application may no longer be reloaded when
given a valid load file (it has been deleted and no longer exists). To recover, the application may be started by loading
the application via the ES_STARTAPP command (CFE_ES_START_APP_CC).

Parameters

in AppID Identifies the application to be reset.

in AppFileName Identifies the new file to start (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

CFE_SUCCESS Successful execution.
CFE_ES_FILE_IO_ERR File IO Error.

See also

CFE_ES_RestartApp, CFE_ES_DeleteApp, CFE_ES_START_APP_CC

9.4.2.3 CFE_ES_RestartApp() CFE_Status_t CFE_ES_RestartApp (

CFE_ES_AppId_t AppID )
Restart a single cFE Application.

Description

This API causes a cFE Application to be unloaded and restarted from the same file name as the last start.

Assumptions, External Events, and Notes:

The filename is checked for existence prior to load. A missing file will be reported and the reload operation will be
aborted prior to unloading the app.

Goes through the standard CFE_ES_CleanUpApp which unloads, then attempts a load using the original file name.
In the event that an application cannot be reloaded due to a missing file or any other load issue, the applica-
tion may no longer be restarted or reloaded when given a valid load file (the app has been deleted and no longer
exists). To recover, the application may be started by loading the application via the ES_STARTAPP command
(CFE_ES_START_APP_CC).

Generated by Doxygen
148

Parameters

in AppID Identifies the application to be reset.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

CFE_ES_FILE_IO_ERR File IO Error.
CFE_SUCCESS Successful execution.

See also

CFE_ES_ReloadApp, CFE_ES_DeleteApp

Generated by Doxygen
9.5 cFE Application Behavior APIs 149

9.5 cFE Application Behavior APIs

Functions

• void CFE_ES_ExitApp (uint32 ExitStatus)

Exit a cFE Application.
• bool CFE_ES_RunLoop (uint32 ∗RunStatus)
Check for Exit, Restart, or Reload commands.
• CFE_Status_t CFE_ES_WaitForSystemState (uint32 MinSystemState, uint32 TimeOutMilliseconds)
Allow an Application to Wait for a minimum global system state.
• void CFE_ES_WaitForStartupSync (uint32 TimeOutMilliseconds)
Allow an Application to Wait for the "OPERATIONAL" global system state.
• void CFE_ES_IncrementTaskCounter (void)
Increments the execution counter for the calling task.

9.5.1 Detailed Description

9.5.2 Function Documentation

9.5.2.1 CFE_ES_ExitApp() void CFE_ES_ExitApp (

uint32 ExitStatus )
Exit a cFE Application.

Description

This API is the "Exit Point" for the cFE application

Assumptions, External Events, and Notes:

None

Parameters

in ExitStatus Acceptable values are:

• CFE_ES_RunStatus_APP_EXIT - Indicates that the Application wants to exit normally.

• CFE_ES_RunStatus_APP_ERROR - Indicates that the Application is quitting with an

error.

• CFE_ES_RunStatus_CORE_APP_INIT_ERROR - Indicates that the Core Application

could not Init.

• CFE_ES_RunStatus_CORE_APP_RUNTIME_ERROR - Indicates that the Core

Application had a runtime failure.

Generated by Doxygen
150

See also

CFE_ES_RunLoop

9.5.2.2 CFE_ES_IncrementTaskCounter() void CFE_ES_IncrementTaskCounter (

void )
Increments the execution counter for the calling task.

Description

This routine increments the execution counter that is stored for the calling task. It can be called from cFE Appli-
cation main tasks, child tasks, or cFE Core application main tasks. Normally, the call is not necessary from a cFE
Application, since the CFE_ES_RunLoop call increments the counter for the Application.

Assumptions, External Events, and Notes:

NOTE: This API is not needed for Applications that call the CFE_ES_RunLoop call.

See also

CFE_ES_RunLoop

9.5.2.3 CFE_ES_RunLoop() bool CFE_ES_RunLoop (

uint32 ∗ RunStatus )
Check for Exit, Restart, or Reload commands.

Description

This is the API that allows an app to check for exit requests from the system, or request shutdown from the system.

Assumptions, External Events, and Notes:

This API updates the internal task counter tracked by ES for the calling task. For ES to report application counters
correctly this API should be called from the main app task as part of it's main processing loop.

In the event of a externally initiated app shutdown request (such as the APP_STOP, APP_RELOAD, and APP_RES←-
TART commands) or if a system error occurs requiring the app to be shut down administratively, this function returns
"false" and optionally sets the "RunStatus" output to further indicate the specific application state.
If "RunStatus" is passed as non-NULL, it should point to a local status variable containing the requested status to ES.
Normally, this should be initialized to CFE_ES_RunStatus_APP_RUN during application start up, and should remain as
this value during normal operation.
If "RunStatus" is set to CFE_ES_RunStatus_APP_EXIT or CFE_ES_RunStatus_APP_ERROR on input, this acts as a
shutdown request - CFE_ES_RunLoop() function will return "false", and a shutdown will be initiated similar to if ES had
been externally commanded to shut down the app.
If "RunStatus" is not used, it should be passed as NULL. In this mode, only the boolean return value is relevant, which
will indicate if an externally-initiated shutdown request is pending.

Parameters

in,out RunStatus Optional pointer to a variable containing the desired run status

Generated by Doxygen
9.5 cFE Application Behavior APIs 151

Returns

Boolean indicating application should continue running

Return values
true Application should continue running
false Application should not continue running

See also

CFE_ES_ExitApp

9.5.2.4 CFE_ES_WaitForStartupSync() void CFE_ES_WaitForStartupSync (

uint32 TimeOutMilliseconds )
Allow an Application to Wait for the "OPERATIONAL" global system state.

Description

This is the API that allows an app to wait for the rest of the apps to complete their entire initialization before
continuing. It is most useful for applications such as Health and Safety or the Scheduler that need to wait until
applications exist and are running before sending out packets to them.

This is a specialized wrapper for CFE_ES_WaitForSystemState for compatibility with applications using this API.

Assumptions, External Events, and Notes:

This API should only be called as the last item of an Apps initialization. In addition, this API should only be called
by an App that is started from the ES Startup file. It should not be used by an App that is started after the system
is running. ( Although it will cause no harm )

Parameters

in TimeOutMilliseconds The timeout value in Milliseconds. This parameter must be at least 1000. Lower
values will be rounded up. There is not an option to wait indefinitely to avoid
hanging a critical application because a non-critical app did not start.

See also

CFE_ES_RunLoop

9.5.2.5 CFE_ES_WaitForSystemState() CFE_Status_t CFE_ES_WaitForSystemState (

uint32 MinSystemState,
uint32 TimeOutMilliseconds )
Allow an Application to Wait for a minimum global system state.
Description

This is the API that allows an app to wait for the rest of the apps to complete a given stage of initialization before
continuing.

This gives finer grained control than CFE_ES_WaitForStartupSync

Generated by Doxygen
152

Assumptions, External Events, and Notes:

This API assumes that the caller has also been initialized sufficiently to satisfy the global system state it is waiting
for, and the apps own state will be updated accordingly.

Parameters

in MinSystemState Determine the state of the App

in TimeOutMilliseconds The timeout value in Milliseconds. There is not an option to wait indefinitely to avoid
hanging a critical application because a non-critical app did not start.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS State successfully achieved

CFE_ES_OPERATION_TIMED_OUT (return value only verified in coverage test) Timeout was reached

See also

CFE_ES_RunLoop

Generated by Doxygen
9.6 cFE Information APIs 153

9.6 cFE Information APIs

Functions

• int32 CFE_ES_GetResetType (uint32 ∗ResetSubtypePtr)

Return the most recent Reset Type.
• CFE_Status_t CFE_ES_GetAppID (CFE_ES_AppId_t ∗AppIdPtr)
Get an Application ID for the calling Application.
• CFE_Status_t CFE_ES_GetTaskID (CFE_ES_TaskId_t ∗TaskIdPtr)
Get the task ID of the calling context.
• CFE_Status_t CFE_ES_GetAppIDByName (CFE_ES_AppId_t ∗AppIdPtr, const char ∗AppName)
Get an Application ID associated with a specified Application name.
• CFE_Status_t CFE_ES_GetLibIDByName (CFE_ES_LibId_t ∗LibIdPtr, const char ∗LibName)
Get a Library ID associated with a specified Library name.
• CFE_Status_t CFE_ES_GetAppName (char ∗AppName, CFE_ES_AppId_t AppId, size_t BufferLength)
Get an Application name for a specified Application ID.
• CFE_Status_t CFE_ES_GetLibName (char ∗LibName, CFE_ES_LibId_t LibId, size_t BufferLength)
Get a Library name for a specified Library ID.
• CFE_Status_t CFE_ES_GetAppInfo (CFE_ES_AppInfo_t ∗AppInfo, CFE_ES_AppId_t AppId)
Get Application Information given a specified App ID.
• CFE_Status_t CFE_ES_GetTaskInfo (CFE_ES_TaskInfo_t ∗TaskInfo, CFE_ES_TaskId_t TaskId)
Get Task Information given a specified Task ID.
• int32 CFE_ES_GetLibInfo (CFE_ES_AppInfo_t ∗LibInfo, CFE_ES_LibId_t LibId)
Get Library Information given a specified Resource ID.
• int32 CFE_ES_GetModuleInfo (CFE_ES_AppInfo_t ∗ModuleInfo, CFE_ResourceId_t ResourceId)
Get Information given a specified Resource ID.

9.6.1 Detailed Description

9.6.2 Function Documentation

9.6.2.1 CFE_ES_GetAppID() CFE_Status_t CFE_ES_GetAppID (

CFE_ES_AppId_t ∗ AppIdPtr )
Get an Application ID for the calling Application.

Description

This routine retrieves the cFE Application ID for the calling Application.

Assumptions, External Events, and Notes:

NOTE: All tasks associated with the Application would return the same Application ID.

Parameters

out AppIdPtr Pointer to variable that is to receive the Application's ID (must not be null). ∗AppIdPtr will be
set to the application ID of the calling Application.

Generated by Doxygen
154

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetResetType, CFE_ES_GetAppIDByName, CFE_ES_GetAppName, CFE_ES_GetTaskInfo

9.6.2.2 CFE_ES_GetAppIDByName() CFE_Status_t CFE_ES_GetAppIDByName (

CFE_ES_AppId_t ∗ AppIdPtr,
const char ∗ AppName )
Get an Application ID associated with a specified Application name.

Description

This routine retrieves the cFE Application ID associated with a specified Application name.

Assumptions, External Events, and Notes:

None

Parameters

out AppIdPtr Pointer to variable that is to receive the Application's ID (must not be null).
in AppName Pointer to null terminated character string containing an Application name (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_NAME_NOT_FOUND Resource Name Error.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetAppID, CFE_ES_GetAppName, CFE_ES_GetAppInfo

9.6.2.3 CFE_ES_GetAppInfo() CFE_Status_t CFE_ES_GetAppInfo (

CFE_ES_AppInfo_t ∗ AppInfo,

Generated by Doxygen
9.6 cFE Information APIs 155

CFE_ES_AppId_t AppId )
Get Application Information given a specified App ID.

Description

This routine retrieves the information about an App associated with a specified App ID. The information includes
all of the information ES maintains for an application ( documented in the CFE_ES_AppInfo_t type )

Assumptions, External Events, and Notes:

None

Parameters

out AppInfo Pointer to a structure (must not be null) that will be filled with resource name and memory
addresses information.
in AppId ID of application to obtain information about

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetAppID, CFE_ES_GetAppIDByName, CFE_ES_GetAppName

9.6.2.4 CFE_ES_GetAppName() CFE_Status_t CFE_ES_GetAppName (

char ∗ AppName,
CFE_ES_AppId_t AppId,
size_t BufferLength )
Get an Application name for a specified Application ID.

Description

This routine retrieves the cFE Application name associated with a specified Application ID.

Assumptions, External Events, and Notes:

In the case of a failure (CFE_ES_ERR_RESOURCEID_NOT_VALID), an empty string is returned.

Parameters

out AppName Pointer to a character array (must not be null) of at least BufferLength in size that will
be filled with the appropriate Application name.
in AppId Application ID of Application whose name is being requested.
in BufferLength The maximum number of characters, including the null terminator, that can be put into the
Generated by Doxygen AppName buffer. This routine will truncate the name to this length, if necessary.
156

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetAppID, CFE_ES_GetAppIDByName, CFE_ES_GetAppInfo

9.6.2.5 CFE_ES_GetLibIDByName() CFE_Status_t CFE_ES_GetLibIDByName (

CFE_ES_LibId_t ∗ LibIdPtr,
const char ∗ LibName )
Get a Library ID associated with a specified Library name.

Description

This routine retrieves the cFE Library ID associated with a specified Library name.

Assumptions, External Events, and Notes:

None

Parameters

out LibIdPtr Pointer to variable that is to receive the Library's ID (must not be null).
in LibName Pointer to null terminated character string containing a Library name (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_NAME_NOT_FOUND Resource Name Error.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetLibName

9.6.2.6 CFE_ES_GetLibInfo() int32 CFE_ES_GetLibInfo (

CFE_ES_AppInfo_t ∗ LibInfo,

Generated by Doxygen
9.6 cFE Information APIs 157

CFE_ES_LibId_t LibId )
Get Library Information given a specified Resource ID.

Description

This routine retrieves the information about a Library associated with a specified ID. The information includes all
of the information ES maintains for this resource type ( documented in the CFE_ES_AppInfo_t type ).

This shares the same output structure as CFE_ES_GetAppInfo, such that informational commands can be executed
against either applications or libraries. When applied to a library, the task information in the structure will be omitted, as
libraries do not have tasks associated.
Assumptions, External Events, and Notes:

None

Parameters

out LibInfo Pointer to a structure (must not be null) that will be filled with resource name and memory
addresses information.
in LibId ID of application to obtain information about

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetLibIDByName, CFE_ES_GetLibName

9.6.2.7 CFE_ES_GetLibName() CFE_Status_t CFE_ES_GetLibName (

char ∗ LibName,
CFE_ES_LibId_t LibId,
size_t BufferLength )
Get a Library name for a specified Library ID.

Description

This routine retrieves the cFE Library name associated with a specified Library ID.

Assumptions, External Events, and Notes:

In the case of a failure (CFE_ES_ERR_RESOURCEID_NOT_VALID), an empty string is returned.

Generated by Doxygen
158

Parameters

out LibName Pointer to a character array (must not be null) of at least BufferLength in size that will
be filled with the Library name.
in LibId Library ID of Library whose name is being requested.
in BufferLength The maximum number of characters (must not be zero), including the null terminator, that
can be put into the LibName buffer. This routine will truncate the name to this length, if
necessary.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetLibIDByName

9.6.2.8 CFE_ES_GetModuleInfo() int32 CFE_ES_GetModuleInfo (

CFE_ES_AppInfo_t ∗ ModuleInfo,
CFE_ResourceId_t ResourceId )
Get Information given a specified Resource ID.

Description

This routine retrieves the information about an Application or Library associated with a specified ID.

This is a wrapper API that in turn calls either CFE_ES_GetAppInfo or CFE_ES_GetLibInfo if passed an AppId or LibId,
respectively.
This allows commands originally targeted to operate on AppIDs to be easily ported to operate on either Libraries or
Applications, where relevant.

Assumptions, External Events, and Notes:

None

Parameters

out ModuleInfo Pointer to a structure (must not be null) that will be filled with resource name and memory
addresses information.
in Resource←- ID of application or library to obtain information about
Id

Generated by Doxygen
9.6 cFE Information APIs 159

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetLibInfo, CFE_ES_GetAppInfo

9.6.2.9 CFE_ES_GetResetType() int32 CFE_ES_GetResetType (

uint32 ∗ ResetSubtypePtr )
Return the most recent Reset Type.

Description

Provides the caller with codes that identifies the type of Reset the processor most recently underwent. The caller
can also obtain information on what caused the reset by supplying a pointer to a variable that will be filled with the
Reset Sub-Type.

Assumptions, External Events, and Notes:

None

Parameters

in,out ResetSubtypePtr Pointer to uint32 type variable in which the Reset Sub-Type will be stored. The
caller can set this pointer to NULL if the Sub-Type is of no interest.
ResetSubtypePtr If the provided pointer was not NULL, the Reset Sub-Type is
stored at the given address. For a list of possible Sub-Type values, see
"Reset Sub-Types" .

Returns

Processor reset type

Return values

CFE_PSP_RST_TYPE_POWERON
CFE_PSP_RST_TYPE_PROCESSOR

See also

CFE_ES_GetAppID, CFE_ES_GetAppIDByName, CFE_ES_GetAppName, CFE_ES_GetTaskInfo

Generated by Doxygen
160

9.6.2.10 CFE_ES_GetTaskID() CFE_Status_t CFE_ES_GetTaskID (

CFE_ES_TaskId_t ∗ TaskIdPtr )
Get the task ID of the calling context.

Description

This retrieves the current task context from OSAL

Assumptions, External Events, and Notes:

Applications which desire to call other CFE ES services such as CFE_ES_TaskGetInfo() should use this API rather
than getting the ID from OSAL directly via OS_TaskGetId().

Parameters

out TaskIdPtr Pointer to variable that is to receive the ID (must not be null). Will be set to the ID of the calling
task.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

9.6.2.11 CFE_ES_GetTaskInfo() CFE_Status_t CFE_ES_GetTaskInfo (

CFE_ES_TaskInfo_t ∗ TaskInfo,
CFE_ES_TaskId_t TaskId )
Get Task Information given a specified Task ID.

Description

This routine retrieves the information about a Task associated with a specified Task ID. The information includes
Task Name, and Parent/Creator Application ID.

Assumptions, External Events, and Notes:

None

Parameters

out TaskInfo Pointer to a CFE_ES_TaskInfo_t structure (must not be null) that holds the specific task
information. ∗TaskInfo is the filled out CFE_ES_TaskInfo_t structure containing the Task
Name, Parent App Name, Parent App ID among other fields.
in TaskId Application ID of Application whose name is being requested.

Generated by Doxygen
9.6 cFE Information APIs 161

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetTaskID, CFE_ES_GetTaskIDByName, CFE_ES_GetTaskName

Generated by Doxygen
162

9.7 cFE Child Task APIs

Functions

• CFE_Status_t CFE_ES_CreateChildTask (CFE_ES_TaskId_t ∗TaskIdPtr, const char ∗TaskName, CFE_ES_ChildTaskMainFuncPtr_

FunctionPtr, CFE_ES_StackPointer_t StackPtr, size_t StackSize, CFE_ES_TaskPriority_Atom_t Priority, uint32
Flags)
Creates a new task under an existing Application.
• CFE_Status_t CFE_ES_GetTaskIDByName (CFE_ES_TaskId_t ∗TaskIdPtr, const char ∗TaskName)
Get a Task ID associated with a specified Task name.
• CFE_Status_t CFE_ES_GetTaskName (char ∗TaskName, CFE_ES_TaskId_t TaskId, size_t BufferLength)
Get a Task name for a specified Task ID.
• CFE_Status_t CFE_ES_DeleteChildTask (CFE_ES_TaskId_t TaskId)
Deletes a task under an existing Application.
• void CFE_ES_ExitChildTask (void)
Exits a child task.

9.7.1 Detailed Description

9.7.2 Function Documentation

9.7.2.1 CFE_ES_CreateChildTask() CFE_Status_t CFE_ES_CreateChildTask (

CFE_ES_TaskId_t ∗ TaskIdPtr,
const char ∗ TaskName,
CFE_ES_ChildTaskMainFuncPtr_t FunctionPtr,
CFE_ES_StackPointer_t StackPtr,
size_t StackSize,
CFE_ES_TaskPriority_Atom_t Priority,
uint32 Flags )
Creates a new task under an existing Application.

Description

This routine creates a new task (a separate execution thread) owned by the calling Application.

Assumptions, External Events, and Notes:

None

Parameters

out TaskIdPtr A pointer to a variable that will be filled in with the new task's ID (must not be null).
TaskIdPtr is the Task ID of the newly created child task.
in TaskName A pointer to a string containing the desired name of the new task (must not be null). This
can be up to OS_MAX_API_NAME characters, including the trailing null.
in FunctionPtr A pointer to the function that will be spawned as a new task (must not be null).
in StackPtr A pointer to the location where the child task's stack pointer should start. NOTE: Not all
underlying operating systems support this parameter. The
CFE_ES_TASK_STACK_ALLOCATE constant may be passed to indicate that the stack
should be dynamically allocated.
in StackSize The number of bytes to allocate for the new task's stack (must not be zero).

Generated by Doxygen
9.7 cFE Child Task APIs 163

Parameters

in Priority The priority for the new task. Lower numbers are higher priority, with 0 being the highest
priority.
in Flags Reserved for future expansion.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_CHILD_TASK_CREATE Child Task Create Error.
CFE_ES_BAD_ARGUMENT Bad Argument.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

See also

CFE_ES_DeleteChildTask, CFE_ES_ExitChildTask

9.7.2.2 CFE_ES_DeleteChildTask() CFE_Status_t CFE_ES_DeleteChildTask (

CFE_ES_TaskId_t TaskId )
Deletes a task under an existing Application.

Description

This routine deletes a task under an Application specified by the TaskId obtained when the child task was
created using the CFE_ES_CreateChildTask API.

Assumptions, External Events, and Notes:

None

Parameters

in Task←- The task ID previously obtained when the Child Task was created with the
Id CFE_ES_CreateChildTask API.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_CHILD_TASK_DELETE (return value only verified in coverage test) Child Task
Delete Error.
CFE_ES_ERR_CHILD_TASK_DELETE_MAIN_TASK Child Task Delete Passed Main Task.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

Generated by Doxygen
164

See also

CFE_ES_CreateChildTask, CFE_ES_ExitChildTask

9.7.2.3 CFE_ES_ExitChildTask() void CFE_ES_ExitChildTask (

void )
Exits a child task.
Description

This routine allows the current executing child task to exit and be deleted by ES.

Assumptions, External Events, and Notes:

This function cannot be called from an Application's Main Task.

Note

This function does not return a value, but if it does return at all, it is assumed that the Task was either unregistered
or this function was called from a cFE Application's main task.

See also

CFE_ES_CreateChildTask, CFE_ES_DeleteChildTask

9.7.2.4 CFE_ES_GetTaskIDByName() CFE_Status_t CFE_ES_GetTaskIDByName (

CFE_ES_TaskId_t ∗ TaskIdPtr,
const char ∗ TaskName )
Get a Task ID associated with a specified Task name.

Description

This routine retrieves the cFE Task ID associated with a specified Task name.

Assumptions, External Events, and Notes:

None

Parameters

out TaskIdPtr Pointer to variable that is to receive the Task's ID (must not be null).
in TaskName Pointer to null terminated character string containing a Task name (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_NAME_NOT_FOUND Resource Name Error.

Generated by Doxygen
9.7 cFE Child Task APIs 165

Return values

CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetTaskName

9.7.2.5 CFE_ES_GetTaskName() CFE_Status_t CFE_ES_GetTaskName (

char ∗ TaskName,
CFE_ES_TaskId_t TaskId,
size_t BufferLength )
Get a Task name for a specified Task ID.

Description

This routine retrieves the cFE Task name associated with a specified Task ID.

Assumptions, External Events, and Notes:

In the case of a failure (CFE_ES_ERR_RESOURCEID_NOT_VALID), an empty string is returned.

Parameters

out TaskName Pointer to a character array (must not be null) of at least BufferLength in size that will
be filled with the Task name.
in TaskId Task ID of Task whose name is being requested.
in BufferLength The maximum number of characters, including the null terminator, that can be put into the
TaskName buffer. This routine will truncate the name to this length, if necessary.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetTaskIDByName

Generated by Doxygen
166

9.8 cFE Miscellaneous APIs

Functions

• void CFE_ES_BackgroundWakeup (void)

Wakes up the CFE background task.
• CFE_Status_t CFE_ES_WriteToSysLog (const char ∗SpecStringPtr,...) OS_PRINTF(1
Write a string to the cFE System Log.
• CFE_Status_t uint32 CFE_ES_CalculateCRC (const void ∗DataPtr, size_t DataLength, uint32 InputCRC,
CFE_ES_CrcType_Enum_t TypeCRC)
Calculate a CRC on a block of memory.
• void CFE_ES_ProcessAsyncEvent (void)
Notification that an asynchronous event was detected by the underlying OS/PSP.

9.8.1 Detailed Description

9.8.2 Function Documentation

9.8.2.1 CFE_ES_BackgroundWakeup() void CFE_ES_BackgroundWakeup (

void )
Wakes up the CFE background task.

Description

Normally the ES background task wakes up at a periodic interval. Whenever new background work is added,
this can be used to wake the task early, which may reduce the delay between adding the job and the job getting
processed.

Assumptions, External Events, and Notes:

Note the amount of work that the background task will perform is pro-rated based on the amount of time elapsed
since the last wakeup. Waking the task early will not cause the background task to do more work than it otherwise
would - it just reduces the delay before work starts initially.

9.8.2.2 CFE_ES_CalculateCRC() CFE_Status_t uint32 CFE_ES_CalculateCRC (

const void ∗ DataPtr,
size_t DataLength,
uint32 InputCRC,
CFE_ES_CrcType_Enum_t TypeCRC )
Calculate a CRC on a block of memory.

Description

This routine calculates a cyclic redundancy check (CRC) on a block of memory. The CRC algorithm used is
determined by the last parameter.

Assumptions, External Events, and Notes:

None

Generated by Doxygen
9.8 cFE Miscellaneous APIs 167

Parameters

in DataPtr Pointer to the base of the memory block.

in DataLength The number of bytes in the memory block.
in InputCRC A starting value for use in the CRC calculation. This parameter allows the user to calculate
the CRC of non-contiguous blocks as a single value. Nominally, the user should set this value
to zero.
in TypeCRC One of the following CRC algorithm selections defined in CFE_ES_CrcType_Enum_t

Returns

The result of the CRC calculation on the specified memory block. If the TypeCRC is unimplemented will return 0.
If DataPtr is null or DataLength is 0, will return InputCRC

9.8.2.3 CFE_ES_ProcessAsyncEvent() void CFE_ES_ProcessAsyncEvent (

void )
Notification that an asynchronous event was detected by the underlying OS/PSP.

Description

This hook routine is called from the PSP when an exception or other asynchronous system event occurs

Assumptions, External Events, and Notes:

The PSP must guarantee that this function is only invoked from a context which may use OSAL primitives. In
general this means that it shouldn't be directly invoked from an ISR/signal context.

9.8.2.4 CFE_ES_WriteToSysLog() CFE_Status_t CFE_ES_WriteToSysLog (

const char ∗ SpecStringPtr,
... )
Write a string to the cFE System Log.

Description

This routine writes a formatted string to the cFE system log. This can be used to record very low-level errors that
can't be reported using the Event Services. This function is used in place of printf for flight software. It should be
used for significant startup events, critical errors, and conditionally compiled debug software.

Assumptions, External Events, and Notes:

None

Parameters

in SpecStringPtr The format string for the log message (must not be null). This is similar to the format string
for a printf() call.

Generated by Doxygen
168

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_SYS_LOG_FULL System Log Full.
CFE_ES_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
9.9 cFE Critical Data Store APIs 169

9.9 cFE Critical Data Store APIs

Functions

• CFE_Status_t CFE_ES_RegisterCDS (CFE_ES_CDSHandle_t ∗CDSHandlePtr, size_t BlockSize, const char

∗Name)
Reserve space (or re-obtain previously reserved space) in the Critical Data Store (CDS)
• CFE_Status_t CFE_ES_GetCDSBlockIDByName (CFE_ES_CDSHandle_t ∗BlockIdPtr, const char ∗BlockName)
Get a CDS Block ID associated with a specified CDS Block name.
• CFE_Status_t CFE_ES_GetCDSBlockName (char ∗BlockName, CFE_ES_CDSHandle_t BlockId, size_t Buffer←-
Length)
Get a Block name for a specified Block ID.
• CFE_Status_t CFE_ES_CopyToCDS (CFE_ES_CDSHandle_t Handle, const void ∗DataToCopy)
Save a block of data in the Critical Data Store (CDS)
• CFE_Status_t CFE_ES_RestoreFromCDS (void ∗RestoreToMemory, CFE_ES_CDSHandle_t Handle)
Recover a block of data from the Critical Data Store (CDS)

9.9.1 Detailed Description

9.9.2 Function Documentation

9.9.2.1 CFE_ES_CopyToCDS() CFE_Status_t CFE_ES_CopyToCDS (

CFE_ES_CDSHandle_t Handle,
const void ∗ DataToCopy )
Save a block of data in the Critical Data Store (CDS)

Description

This routine copies a specified block of memory into the Critical Data Store that had been previously registered
via CFE_ES_RegisterCDS. The block of memory to be copied must be at least as big as the size specified when
registering the CDS.

Assumptions, External Events, and Notes:

None

Parameters

in Handle The handle of the CDS block that was previously obtained from CFE_ES_RegisterCDS.
in DataToCopy A Pointer to the block of memory to be copied into the CDS (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
170

See also

CFE_ES_RegisterCDS, CFE_ES_RestoreFromCDS

9.9.2.2 CFE_ES_GetCDSBlockIDByName() CFE_Status_t CFE_ES_GetCDSBlockIDByName (

CFE_ES_CDSHandle_t ∗ BlockIdPtr,
const char ∗ BlockName )
Get a CDS Block ID associated with a specified CDS Block name.

Description

This routine retrieves the CDS Block ID associated with a specified CDS Block name.

Assumptions, External Events, and Notes:

None

Parameters

out BlockIdPtr Pointer to variable that is to receive the CDS Block ID (must not be null).
in BlockName Pointer to null terminated character string containing a CDS Block name (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_NAME_NOT_FOUND Resource Name Error.
CFE_ES_BAD_ARGUMENT Bad Argument.
CFE_ES_NOT_IMPLEMENTED The processor does not support a Critical Data Store.

See also

CFE_ES_GetCDSBlockName

9.9.2.3 CFE_ES_GetCDSBlockName() CFE_Status_t CFE_ES_GetCDSBlockName (

char ∗ BlockName,
CFE_ES_CDSHandle_t BlockId,
size_t BufferLength )
Get a Block name for a specified Block ID.
Description

This routine retrieves the cFE Block name associated with a specified Block ID.

Assumptions, External Events, and Notes:

In the case of a failure (CFE_ES_ERR_RESOURCEID_NOT_VALID), an empty string is returned.

Generated by Doxygen
9.9 cFE Critical Data Store APIs 171

Parameters

out BlockName Pointer to a character array (must not be null) of at least BufferLength in size that will
be filled with the CDS Block name.
in BlockId Block ID/Handle of CDS registry entry whose name is being requested.
in BufferLength The maximum number of characters, including the null terminator, that can be put into the
BlockName buffer. This routine will truncate the name to this length, if necessary.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.
CFE_ES_NOT_IMPLEMENTED The processor does not support a Critical Data Store.

See also

CFE_ES_GetCDSBlockIDByName

9.9.2.4 CFE_ES_RegisterCDS() CFE_Status_t CFE_ES_RegisterCDS (

CFE_ES_CDSHandle_t ∗ CDSHandlePtr,
size_t BlockSize,
const char ∗ Name )
Reserve space (or re-obtain previously reserved space) in the Critical Data Store (CDS)

Description

This routine allocates a block of memory in the Critical Data Store and associates it with the calling Application.
The memory can survive an Application restart as well as a Processor Reset.

Assumptions, External Events, and Notes:

This function does not clear or otherwise initialize/modify the data within the CDS block. If this function returns
CFE_ES_CDS_ALREADY_EXISTS the block may already have valid data in it.

If a new CDS block is reserved (either because the name did not exist, or existed as a different size) it is the responsibility
of the calling application to fill the CDS block with valid data. This is indicated by a CFE_SUCCESS return code, and in
this case the calling application should ensure that it also calls CFE_ES_CopyToCDS() to fill the block with valid data.

Parameters

out CDSHandlePtr Pointer Application's variable that will contain the CDS Memory Block Handle (must not
be null). HandlePtr is the handle of the CDS block that can be used in
CFE_ES_CopyToCDS and CFE_ES_RestoreFromCDS.
in BlockSize The number of bytes needed in the CDS (must not be zero).
in Name A pointer to a character string (must not be null) containing an application unique name
of CFE_MISSION_ES_CDS_MAX_NAME_LENGTH characters or less.

Generated by Doxygen
172

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS The memory block was successfully created in the CDS.

CFE_ES_NOT_IMPLEMENTED The processor does not support a Critical Data Store.
CFE_ES_CDS_ALREADY_EXISTS CDS Already Exists.
CFE_ES_CDS_INVALID_SIZE CDS Invalid Size.
CFE_ES_CDS_INVALID_NAME CDS Invalid Name.
CFE_ES_BAD_ARGUMENT Bad Argument.
CFE_ES_CDS_INVALID (return value only verified in coverage test) CDS Invalid.

See also

CFE_ES_CopyToCDS, CFE_ES_RestoreFromCDS

9.9.2.5 CFE_ES_RestoreFromCDS() CFE_Status_t CFE_ES_RestoreFromCDS (

void ∗ RestoreToMemory,
CFE_ES_CDSHandle_t Handle )
Recover a block of data from the Critical Data Store (CDS)

Description

This routine copies data from the Critical Data Store identified with the Handle into the area of memory pointed
to by the RestoreToMemory pointer. The area of memory to be copied into must be at least as big as the
size specified when registering the CDS. The recovery will indicate an error if the data integrity check maintained
by the CDS indicates the contents of the CDS have changed. However, the contents will still be copied into the
specified area of memory.

Assumptions, External Events, and Notes:

None

Parameters

in Handle The handle of the CDS block that was previously obtained from
CFE_ES_RegisterCDS.
out RestoreToMemory A Pointer to the block of memory (must not be null) that is to be restored with the
contents of the CDS. ∗RestoreToMemory is the contents of the specified CDS.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

Generated by Doxygen
9.9 cFE Critical Data Store APIs 173

Return values

CFE_ES_CDS_BLOCK_CRC_ERR (return value only verified in coverage test) CDS Block CRC Error.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_RegisterCDS, CFE_ES_CopyToCDS

Generated by Doxygen
174

9.10 cFE Memory Manager APIs

Functions

• CFE_Status_t CFE_ES_PoolCreateNoSem (CFE_ES_MemHandle_t ∗PoolID, void ∗MemPtr, size_t Size)

Initializes a memory pool created by an application without using a semaphore during processing.
• CFE_Status_t CFE_ES_PoolCreate (CFE_ES_MemHandle_t ∗PoolID, void ∗MemPtr, size_t Size)
Initializes a memory pool created by an application while using a semaphore during processing.
• CFE_Status_t CFE_ES_PoolCreateEx (CFE_ES_MemHandle_t ∗PoolID, void ∗MemPtr, size_t Size, uint16
NumBlockSizes, const size_t ∗BlockSizes, bool UseMutex)
Initializes a memory pool created by an application with application specified block sizes.
• int32 CFE_ES_PoolDelete (CFE_ES_MemHandle_t PoolID)
Deletes a memory pool that was previously created.
• int32 CFE_ES_GetPoolBuf (CFE_ES_MemPoolBuf_t ∗BufPtr, CFE_ES_MemHandle_t Handle, size_t Size)
Gets a buffer from the memory pool created by CFE_ES_PoolCreate or CFE_ES_PoolCreateNoSem.
• CFE_Status_t CFE_ES_GetPoolBufInfo (CFE_ES_MemHandle_t Handle, CFE_ES_MemPoolBuf_t BufPtr)
Gets info on a buffer previously allocated via CFE_ES_GetPoolBuf.
• int32 CFE_ES_PutPoolBuf (CFE_ES_MemHandle_t Handle, CFE_ES_MemPoolBuf_t BufPtr)
Releases a buffer from the memory pool that was previously allocated via CFE_ES_GetPoolBuf.
• CFE_Status_t CFE_ES_GetMemPoolStats (CFE_ES_MemPoolStats_t ∗BufPtr, CFE_ES_MemHandle_t Handle)
Extracts the statistics maintained by the memory pool software.

9.10.1 Detailed Description

9.10.2 Function Documentation

9.10.2.1 CFE_ES_GetMemPoolStats() CFE_Status_t CFE_ES_GetMemPoolStats (

CFE_ES_MemPoolStats_t ∗ BufPtr,
CFE_ES_MemHandle_t Handle )
Extracts the statistics maintained by the memory pool software.

Description

This routine fills the CFE_ES_MemPoolStats_t data structure with the statistics maintained by the memory pool
software. These statistics can then be telemetered by the calling Application.

Assumptions, External Events, and Notes:

None

Parameters

out BufPtr Pointer to CFE_ES_MemPoolStats_t data structure (must not be null) to be filled with memory
statistics. ∗BufPtr is the Memory Pool Statistics stored in given data structure.
in Handle The handle to the memory pool whose statistics are desired.

Returns

Execution status, see cFE Return Code Defines

Generated by Doxygen
9.10 cFE Memory Manager APIs 175

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_PoolCreate, CFE_ES_PoolCreateNoSem, CFE_ES_PoolCreateEx, CFE_ES_GetPoolBuf, CFE_ES_PutPoolBuf

9.10.2.2 CFE_ES_GetPoolBuf() int32 CFE_ES_GetPoolBuf (

CFE_ES_MemPoolBuf_t ∗ BufPtr,
CFE_ES_MemHandle_t Handle,
size_t Size )
Gets a buffer from the memory pool created by CFE_ES_PoolCreate or CFE_ES_PoolCreateNoSem.

Description

This routine obtains a block of memory from the memory pool supplied by the calling application.

Assumptions, External Events, and Notes:

1. The size allocated from the memory pool is, at a minimum, 12 bytes more than requested.

Parameters

out BufPtr A pointer to the Application's pointer (must not be null) in which will be stored the address of the
allocated memory buffer. ∗BufPtr is the address of the requested buffer.
in Handle The handle to the memory pool as returned by CFE_ES_PoolCreate or
CFE_ES_PoolCreateNoSem.
in Size The size of the buffer requested. NOTE: The size allocated may be larger.

Returns

Bytes Allocated, or error code cFE Return Code Defines

Return values

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

CFE_ES_ERR_MEM_BLOCK_SIZE Memory Block Size Error.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_PoolCreate, CFE_ES_PoolCreateNoSem, CFE_ES_PoolCreateEx, CFE_ES_PutPoolBuf, CFE_ES_GetMemPoolStats,

CFE_ES_GetPoolBufInfo

9.10.2.3 CFE_ES_GetPoolBufInfo() CFE_Status_t CFE_ES_GetPoolBufInfo (

Generated by Doxygen
176

CFE_ES_MemHandle_t Handle,
CFE_ES_MemPoolBuf_t BufPtr )
Gets info on a buffer previously allocated via CFE_ES_GetPoolBuf.

Description

This routine gets info on a buffer in the memory pool.

Assumptions, External Events, and Notes:

None

Parameters

in Handle The handle to the memory pool as returned by CFE_ES_PoolCreate or CFE_ES_PoolCreateNoSem.

in BufPtr A pointer to the memory buffer to provide status for (must not be null).

Returns

Size of the buffer if successful, or status code if not successful, see cFE Return Code Defines

Return values

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

CFE_ES_BUFFER_NOT_IN_POOL Buffer Not In Pool.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_PoolCreate, CFE_ES_PoolCreateNoSem, CFE_ES_PoolCreateEx, CFE_ES_GetPoolBuf, CFE_ES_GetMemPoolStats,

CFE_ES_PutPoolBuf

9.10.2.4 CFE_ES_PoolCreate() CFE_Status_t CFE_ES_PoolCreate (

CFE_ES_MemHandle_t ∗ PoolID,
void ∗ MemPtr,
size_t Size )
Initializes a memory pool created by an application while using a semaphore during processing.

Description

This routine initializes a pool of memory supplied by the calling application. When a memory pool created by this
routine is processed, mutex handling will be performed.

Assumptions, External Events, and Notes:

1. The size of the pool must be an integral number of 32-bit words

2. The start address of the pool must be 32-bit aligned
3. 168 bytes are used for internal bookkeeping, therefore, they will not be available for allocation.

Generated by Doxygen
9.10 cFE Memory Manager APIs 177

Parameters

out PoolID A pointer to the variable the caller wishes to have the memory pool handle kept in (must not be
null). PoolID is the memory pool handle.
in MemPtr A Pointer to the pool of memory created by the calling application (must not be null). This
address must be aligned suitably for the processor architecture. The
CFE_ES_STATIC_POOL_TYPE macro may be used to assist in creating properly aligned
memory pools.
in Size The size of the pool of memory (must not be zero). Note that this must be an integral multiple of
the memory alignment of the processor architecture.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_PoolCreateNoSem, CFE_ES_PoolCreateEx, CFE_ES_GetPoolBuf, CFE_ES_PutPoolBuf, CFE_ES_GetMemPoolStats

9.10.2.5 CFE_ES_PoolCreateEx() CFE_Status_t CFE_ES_PoolCreateEx (

CFE_ES_MemHandle_t ∗ PoolID,
void ∗ MemPtr,
size_t Size,
uint16 NumBlockSizes,
const size_t ∗ BlockSizes,
bool UseMutex )
Initializes a memory pool created by an application with application specified block sizes.

Description

This routine initializes a pool of memory supplied by the calling application.

Assumptions, External Events, and Notes:

1. The size of the pool must be an integral number of 32-bit words

2. The start address of the pool must be 32-bit aligned
3. 168 bytes are used for internal bookkeeping, therefore, they will not be available for allocation.

Parameters

out PoolID A pointer to the variable the caller wishes to have the memory pool handle kept in (must
not be null). PoolID is the memory pool handle.
in MemPtr A Pointer to the pool of memory created by the calling application (must not be null).
This address must be aligned suitably for the processor architecture. The
CFE_ES_STATIC_POOL_TYPE macro may be used to assist in creating properly
aligned memory pools.
Generated by Doxygen
178

Parameters

in Size The size of the pool of memory (must not be zero). Note that this must be an integral
multiple of the memory alignment of the processor architecture.
in NumBlockSizes The number of different block sizes specified in the BlockSizes array. If set larger
than CFE_PLATFORM_ES_POOL_MAX_BUCKETS, CFE_ES_BAD_ARGUMENT will
be returned. If BlockSizes is null and NumBlockSizes is 0, NubBlockSizes will be set to
CFE_PLATFORM_ES_POOL_MAX_BUCKETS.
in BlockSizes Pointer to an array of sizes to be used instead of the default block sizes specified by
CFE_PLATFORM_ES_MEM_BLOCK_SIZE_01 through
CFE_PLATFORM_ES_MAX_BLOCK_SIZE. If the pointer is equal to NULL, the default
block sizes are used.
in UseMutex Flag indicating whether the new memory pool will be processing with mutex handling or
not. Valid parameter values are CFE_ES_USE_MUTEX and CFE_ES_NO_MUTEX

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.
CFE_ES_NO_RESOURCE_IDS_AVAILABLE Resource ID is not available.
CFE_STATUS_EXTERNAL_RESOURCE_FAIL (return value only verified in coverage test) External failure.

See also

CFE_ES_PoolCreate, CFE_ES_PoolCreateNoSem, CFE_ES_GetPoolBuf, CFE_ES_PutPoolBuf, CFE_ES_GetMemPoolStats

9.10.2.6 CFE_ES_PoolCreateNoSem() CFE_Status_t CFE_ES_PoolCreateNoSem (

CFE_ES_MemHandle_t ∗ PoolID,
void ∗ MemPtr,
size_t Size )
Initializes a memory pool created by an application without using a semaphore during processing.

Description

This routine initializes a pool of memory supplied by the calling application. When a memory pool created by this
routine is processed, no mutex handling is performed.

Assumptions, External Events, and Notes:

1. The size of the pool must be an integral number of 32-bit words

2. The start address of the pool must be 32-bit aligned
3. 168 bytes are used for internal bookkeeping, therefore, they will not be available for allocation.

Generated by Doxygen
9.10 cFE Memory Manager APIs 179

Parameters

out PoolID A pointer to the variable the caller wishes to have the memory pool handle kept in (must not be
null). PoolID is the memory pool handle.
in MemPtr A Pointer to the pool of memory created by the calling application (must not be null). This
address must be aligned suitably for the processor architecture. The
CFE_ES_STATIC_POOL_TYPE macro may be used to assist in creating properly aligned
memory pools.
in Size The size of the pool of memory (must not be zero). Note that this must be an integral multiple of
the memory alignment of the processor architecture.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_PoolCreate, CFE_ES_PoolCreateEx, CFE_ES_GetPoolBuf, CFE_ES_PutPoolBuf, CFE_ES_GetMemPoolStats

9.10.2.7 CFE_ES_PoolDelete() int32 CFE_ES_PoolDelete (

CFE_ES_MemHandle_t PoolID )
Deletes a memory pool that was previously created.

Description

This routine removes the pool ID and frees the global table entry for future re-use.

Assumptions, External Events, and Notes:

All buffers associated with the pool become invalid after this call. The application should ensure that
buffers/references to the pool are returned before deleting the pool.

Parameters

in PoolID The ID of the pool to delete

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

Generated by Doxygen
180

See also

CFE_ES_PoolCreate, CFE_ES_PoolCreateNoSem, CFE_ES_GetPoolBuf, CFE_ES_PutPoolBuf, CFE_ES_GetMemPoolStats

9.10.2.8 CFE_ES_PutPoolBuf() int32 CFE_ES_PutPoolBuf (

CFE_ES_MemHandle_t Handle,
CFE_ES_MemPoolBuf_t BufPtr )
Releases a buffer from the memory pool that was previously allocated via CFE_ES_GetPoolBuf.

Description

This routine releases a buffer back into the memory pool.

Assumptions, External Events, and Notes:

None

Parameters

in Handle The handle to the memory pool as returned by CFE_ES_PoolCreate or CFE_ES_PoolCreateNoSem.

in BufPtr A pointer to the memory buffer to be released (must not be null).

Returns

Bytes released, or error code cFE Return Code Defines

Return values

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

CFE_ES_BAD_ARGUMENT Bad Argument.
CFE_ES_BUFFER_NOT_IN_POOL Buffer Not In Pool.
CFE_ES_POOL_BLOCK_INVALID Invalid pool block.

See also

CFE_ES_PoolCreate, CFE_ES_PoolCreateNoSem, CFE_ES_PoolCreateEx, CFE_ES_GetPoolBuf, CFE_ES_GetMemPoolStats,

CFE_ES_GetPoolBufInfo

Generated by Doxygen
9.11 cFE Performance Monitor APIs 181

9.11 cFE Performance Monitor APIs

Macros

• #define CFE_ES_PerfLogEntry(id) (CFE_ES_PerfLogAdd(id, 0))

Entry marker for use with Software Performance Analysis Tool.
• #define CFE_ES_PerfLogExit(id) (CFE_ES_PerfLogAdd(id, 1))
Exit marker for use with Software Performance Analysis Tool.

Functions

• void CFE_ES_PerfLogAdd (uint32 Marker, uint32 EntryExit)

Adds a new entry to the data buffer.

9.11.1 Detailed Description

9.11.2 Macro Definition Documentation

9.11.2.1 CFE_ES_PerfLogEntry #define CFE_ES_PerfLogEntry(

id ) (CFE_ES_PerfLogAdd(id, 0))
Entry marker for use with Software Performance Analysis Tool.

Description

This macro logs the entry or start event/marker for the specified entry id. This macro, in conjunction with the
CFE_ES_PerfLogExit, is used by the Software Performance Analysis tool.

Assumptions, External Events, and Notes:

None

Parameters

in id Identifier of the specific event or marker.

See also

CFE_ES_PerfLogExit, CFE_ES_PerfLogAdd
Definition at line 1464 of file cfe_es.h.

9.11.2.2 CFE_ES_PerfLogExit #define CFE_ES_PerfLogExit(

id ) (CFE_ES_PerfLogAdd(id, 1))
Exit marker for use with Software Performance Analysis Tool.
Description

This macro logs the exit or end event/marker for the specified entry id. This macro, in conjunction with the
CFE_ES_PerfLogEntry, is used by the Software Performance Analysis tool.

Assumptions, External Events, and Notes:

None

Generated by Doxygen
182

Parameters

in id Identifier of the specific event or marker.

See also

CFE_ES_PerfLogEntry, CFE_ES_PerfLogAdd

Definition at line 1483 of file cfe_es.h.

9.11.3 Function Documentation

9.11.3.1 CFE_ES_PerfLogAdd() void CFE_ES_PerfLogAdd (

uint32 Marker,
uint32 EntryExit )
Adds a new entry to the data buffer.
Function called by CFE_ES_PerfLogEntry and CFE_ES_PerfLogExit macros

Description

This function logs the entry and exit marker for the specified id. This function is used by the Software Performance
Analysis tool.

Assumptions, External Events, and Notes:

Marker limited to the range of 0 to CFE_MISSION_ES_PERF_MAX_IDS - 1. Any performance ids outside of this
range will be ignored and will be flagged as an error.
This function implements a circular buffer using an array. DataStart points to first stored entry DataEnd points to next
available entry if DataStart == DataEnd then the buffer is either empty or full depending on the value of the DataCount
Time is stored as 2 32 bit integers, (TimerLower32, TimerUpper32): TimerLower32 is the current value of the hardware
timer register. TimerUpper32 is the number of times the timer has rolled over.

Parameters

in Marker Identifier of the specific event or marker.

in EntryExit Used to specify Entry(0) or Exit(1)

See also

CFE_ES_PerfLogEntry, CFE_ES_PerfLogExit

Generated by Doxygen
9.12 cFE Generic Counter APIs 183

9.12 cFE Generic Counter APIs

Functions

• CFE_Status_t CFE_ES_RegisterGenCounter (CFE_ES_CounterId_t ∗CounterIdPtr, const char ∗CounterName)

Register a generic counter.
• CFE_Status_t CFE_ES_DeleteGenCounter (CFE_ES_CounterId_t CounterId)
Delete a generic counter.
• CFE_Status_t CFE_ES_IncrementGenCounter (CFE_ES_CounterId_t CounterId)
Increments the specified generic counter.
• CFE_Status_t CFE_ES_SetGenCount (CFE_ES_CounterId_t CounterId, uint32 Count)
Set the specified generic counter.
• CFE_Status_t CFE_ES_GetGenCount (CFE_ES_CounterId_t CounterId, uint32 ∗Count)
Get the specified generic counter count.
• CFE_Status_t CFE_ES_GetGenCounterIDByName (CFE_ES_CounterId_t ∗CounterIdPtr, const char
∗CounterName)
Get the Id associated with a generic counter name.
• CFE_Status_t CFE_ES_GetGenCounterName (char ∗CounterName, CFE_ES_CounterId_t CounterId, size_←-
t BufferLength)
Get a Counter name for a specified Counter ID.

9.12.1 Detailed Description

9.12.2 Function Documentation

9.12.2.1 CFE_ES_DeleteGenCounter() CFE_Status_t CFE_ES_DeleteGenCounter (

CFE_ES_CounterId_t CounterId )
Delete a generic counter.

Description

This routine deletes a previously registered generic counter.

Assumptions, External Events, and Notes:

None.

Parameters

in Counter←- The Counter Id of the newly created counter.

Id

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
184

See also

CFE_ES_IncrementGenCounter, CFE_ES_RegisterGenCounter, CFE_ES_SetGenCount, CFE_ES_GetGenCount,

CFE_ES_GetGenCounterIDByName

9.12.2.2 CFE_ES_GetGenCount() CFE_Status_t CFE_ES_GetGenCount (

CFE_ES_CounterId_t CounterId,
uint32 ∗ Count )
Get the specified generic counter count.

Description

This routine gets the value of a generic counter.

Assumptions, External Events, and Notes:

None.

Parameters

in Counter←- The Counter to get the value from.

Id
out Count Buffer to store value of the Counter (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_RegisterGenCounter, CFE_ES_DeleteGenCounter, CFE_ES_SetGenCount, CFE_ES_IncrementGenCounter,

CFE_ES_GetGenCounterIDByName

9.12.2.3 CFE_ES_GetGenCounterIDByName() CFE_Status_t CFE_ES_GetGenCounterIDByName (

CFE_ES_CounterId_t ∗ CounterIdPtr,
const char ∗ CounterName )
Get the Id associated with a generic counter name.
Description

This routine gets the Counter Id for a generic counter specified by name.

Assumptions, External Events, and Notes:

None.

Generated by Doxygen
9.12 cFE Generic Counter APIs 185

Parameters

out CounterIdPtr Pointer to variable that is to receive the Counter's ID (must not be null).
in CounterName Pointer to null terminated character string containing a Counter name (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_NAME_NOT_FOUND Resource Name Error.
CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetGenCounterName

9.12.2.4 CFE_ES_GetGenCounterName() CFE_Status_t CFE_ES_GetGenCounterName (

char ∗ CounterName,
CFE_ES_CounterId_t CounterId,
size_t BufferLength )
Get a Counter name for a specified Counter ID.

Description

This routine retrieves the cFE Counter name associated with a specified Counter ID.

Assumptions, External Events, and Notes:

In the case of a failure (CFE_ES_ERR_RESOURCEID_NOT_VALID), an empty string is returned.

Parameters

out CounterName Pointer to a character array (must not be null) of at least BufferLength in size that
will be filled with the Counter name.
in CounterId ID of Counter whose name is being requested.
in BufferLength The maximum number of characters, including the null terminator (must not be zero), that
can be put into the CounterName buffer. This routine will truncate the name to this
length, if necessary.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

Generated by Doxygen
186

Return values

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_GetGenCounterIDByName

9.12.2.5 CFE_ES_IncrementGenCounter() CFE_Status_t CFE_ES_IncrementGenCounter (

CFE_ES_CounterId_t CounterId )
Increments the specified generic counter.

Description

This routine increments the specified generic counter.

Assumptions, External Events, and Notes:

None.

Parameters

in Counter←- The Counter to be incremented.

Id

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_RegisterGenCounter, CFE_ES_DeleteGenCounter, CFE_ES_SetGenCount, CFE_ES_GetGenCount,

CFE_ES_GetGenCounterIDByName

9.12.2.6 CFE_ES_RegisterGenCounter() CFE_Status_t CFE_ES_RegisterGenCounter (

CFE_ES_CounterId_t ∗ CounterIdPtr,
const char ∗ CounterName )
Register a generic counter.

Description

This routine registers a generic thread-safe counter which can be used for inter-task management.

Generated by Doxygen
9.12 cFE Generic Counter APIs 187

Assumptions, External Events, and Notes:

The initial value of all newly registered counters is 0.

Parameters

out CounterIdPtr Buffer to store the Counter Id of the newly created counter (must not be null).
in CounterName The Name of the generic counter (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.
CFE_ES_ERR_DUPLICATE_NAME Duplicate Name Error.
CFE_ES_NO_RESOURCE_IDS_AVAILABLE Resource ID is not available.

See also

CFE_ES_IncrementGenCounter, CFE_ES_DeleteGenCounter, CFE_ES_SetGenCount, CFE_ES_GetGenCount,

CFE_ES_GetGenCounterIDByName

9.12.2.7 CFE_ES_SetGenCount() CFE_Status_t CFE_ES_SetGenCount (

CFE_ES_CounterId_t CounterId,
uint32 Count )
Set the specified generic counter.

Description

This routine sets the specified generic counter to the specified value.

Assumptions, External Events, and Notes:

None.

Parameters

in Counter←- The Counter to be set.

Id
in Count The new value of the Counter.

Returns

Execution status, see cFE Return Code Defines

Generated by Doxygen
188

Return values

CFE_SUCCESS Successful execution.

CFE_ES_BAD_ARGUMENT Bad Argument.

See also

CFE_ES_RegisterGenCounter, CFE_ES_DeleteGenCounter, CFE_ES_IncrementGenCounter, CFE_ES_GetGenCount,

CFE_ES_GetGenCounterIDByName

Generated by Doxygen
9.13 cFE Registration APIs 189

9.13 cFE Registration APIs

Functions

• CFE_Status_t CFE_EVS_Register (const void ∗Filters, uint16 NumEventFilters, uint16 FilterScheme)

Register an application for receiving event services.

9.13.1 Detailed Description

9.13.2 Function Documentation

9.13.2.1 CFE_EVS_Register() CFE_Status_t CFE_EVS_Register (

const void ∗ Filters,
uint16 NumEventFilters,
uint16 FilterScheme )
Register an application for receiving event services.

Description

This routine registers an application with event services and allocates/initializes the internal data structures used
to support this application's events. An application may not send events unless it has called this routine. The
routine also accepts a filter array structure for applications requiring event filtering. In the current implementation
of the EVS, only the binary filtering scheme is supported. See section TBD of the cFE Application Programmer's
Guide for a description of the behavior of binary filters. Applications may call CFE_EVS_Register more than once,
but each call will wipe out all filters registered by previous calls (filter registration is NOT cumulative).

Assumptions, External Events, and Notes:

Note: Event filters can be added, deleted or modified by ground commands. All filtering schemes include a default
setting that results in no filtering (such as CFE_EVS_NO_FILTER for binary filters).

Filter Scheme: Binary

Code: CFE_EVS_EventFilter_BINARY
Filter Structure:
typedef struct CFE_EVS_BinFilter {
uint16 EventID,
uint16 Mask ;
} CFE_EVS_BinFilter_t;

Parameters

in Filters Pointer to an array of event message filters, or NULL if no filtering is desired. The
structure of an event message filter depends on the FilterScheme selected. (see Filter
Schemes mentioned above)
in NumEventFilters The number of event message filters included in this call. This must be less than or
equal to the maximum number of events allowed per application
(CFE_PLATFORM_EVS_MAX_EVENT_FILTERS).
in FilterScheme The event filtering scheme that this application will use. For the first implementation of
the event services, only filter type CFE_EVS_EventFilter_BINARY will be supported.

Returns

Execution status below or from CFE_ES_GetAppID, see cFE Return Code Defines

Generated by Doxygen
190

Return values

CFE_SUCCESS Successful execution.

CFE_EVS_APP_FILTER_OVERLOAD Application Filter Overload.
CFE_EVS_UNKNOWN_FILTER Unknown Filter.
CFE_EVS_APP_ILLEGAL_APP_ID Illegal Application ID.
CFE_ES_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
9.14 cFE Send Event APIs 191

9.14 cFE Send Event APIs

Functions

• CFE_Status_t CFE_EVS_SendEvent (uint16 EventID, uint16 EventType, const char ∗Spec,...) OS_PRINTF(3
Generate a software event.
• CFE_Status_t CFE_Status_t CFE_EVS_SendEventWithAppID (uint16 EventID, uint16 EventType, CFE_ES_AppId_t
AppID, const char ∗Spec,...) OS_PRINTF(4
Generate a software event given the specified Application ID.
• CFE_Status_t CFE_Status_t CFE_Status_t CFE_EVS_SendTimedEvent (CFE_TIME_SysTime_t Time, uint16
EventID, uint16 EventType, const char ∗Spec,...) OS_PRINTF(4
Generate a software event with a specific time tag.

9.14.1 Detailed Description

9.14.2 Function Documentation

9.14.2.1 CFE_EVS_SendEvent() CFE_Status_t CFE_EVS_SendEvent (

uint16 EventID,
uint16 EventType,
const char ∗ Spec,
... )
Generate a software event.
Description

This routine generates a software event message. If the EventID is not filtered, the event will be sent as a software
bus message, optionally logged in the local event log, and optionally sent as an ASCII text string out the enabled
output port(s).

Assumptions, External Events, and Notes:

This API only works within the context of a registered application or core service. For messages outside the context
of a registered application (for example early in app initialization or if registration fails) CFE_ES_WriteToSysLog
can be used for reporting.

Parameters

in EventID A numeric literal used to uniquely identify an application event. The EventID is defined and
supplied by the application sending the event.
in EventType A numeric literal used to classify an event, one of:

• CFE_EVS_EventType_DEBUG

• CFE_EVS_EventType_INFORMATION

• CFE_EVS_EventType_ERROR

• CFE_EVS_EventType_CRITICAL

Generated by Doxygen
192

Parameters

in Spec A pointer to a null terminated text string (must not be null) describing the output format for the
event. This is the same type of format string used for the ANSI printf function. Nominally
the post-conversion string is limited to 80 characters, but this limit is configurable through the
parameter CFE_MISSION_EVS_MAX_MESSAGE_LENGTH. Characters beyond the limit will
be truncated. Do not use floating point conversions (f, e, E, g, and G) in the format string
unless your application will be running in a system that supports floating point arithmetic. Do
not use non-printable characters (\t, \n, etc.) in the format string; they will mess up the
formatting when the events are displayed on the ground system.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_EVS_APP_NOT_REGISTERED Application Not Registered.
CFE_EVS_APP_ILLEGAL_APP_ID Illegal Application ID.
CFE_EVS_INVALID_PARAMETER Invalid Pointer.

See also

CFE_EVS_SendEventWithAppID, CFE_EVS_SendTimedEvent

9.14.2.2 CFE_EVS_SendEventWithAppID() CFE_Status_t CFE_Status_t CFE_EVS_SendEventWithAppID (

uint16 EventID,
uint16 EventType,
CFE_ES_AppId_t AppID,
const char ∗ Spec,
... )
Generate a software event given the specified Application ID.

Description

This routine generates a software event message. If the EventID is not filtered, the event will be sent as a software
bus message, optionally logged in the local event log, and optionally sent as an ASCII text string out the enabled
output port(s). Note that this function should really only be used from within an API in order to preserve the context
of an Application's event. In general, CFE_EVS_SendEvent should be used.

Assumptions, External Events, and Notes:

The Application ID must correspond to a registered application or core service. For messages outside the context
of a registered application (for example early in app initialization or if registration fails) CFE_ES_WriteToSysLog
can be used for reporting.

Parameters

in EventID A numeric literal used to uniquely identify an application event. The EventID is defined and
supplied by the application sending the event.

Generated by Doxygen
9.14 cFE Send Event APIs 193

Parameters

in EventType A numeric literal used to classify an event, one of:

• CFE_EVS_EventType_DEBUG

• CFE_EVS_EventType_INFORMATION

• CFE_EVS_EventType_ERROR

• CFE_EVS_EventType_CRITICAL

in AppID The Application ID from which the event message should appear.
in Spec A pointer to a null terminated text string (must not be null) describing the output format for the
event. This is the same type of format string used for the ANSI printf function. Nominally
the post-conversion string is limited to 80 characters, but this limit is configurable through the
parameter CFE_MISSION_EVS_MAX_MESSAGE_LENGTH. Characters beyond the limit will
be truncated. Do not use floating point conversions (f, e, E, g, and G) in the format string
unless your application will be running in a system that supports floating point arithmetic. Do
not use non-printable characters (\t, \n, etc.) in the format string; they will mess up the
formatting when the events are displayed on the ground system.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_EVS_APP_NOT_REGISTERED Application Not Registered.
CFE_EVS_APP_ILLEGAL_APP_ID Illegal Application ID.
CFE_EVS_INVALID_PARAMETER Invalid Pointer.

See also

CFE_EVS_SendEvent, CFE_EVS_SendTimedEvent

9.14.2.3 CFE_EVS_SendTimedEvent() CFE_Status_t CFE_Status_t CFE_Status_t CFE_EVS_SendTimedEvent

(
CFE_TIME_SysTime_t Time,
uint16 EventID,
uint16 EventType,
const char ∗ Spec,
... )
Generate a software event with a specific time tag.

Description

This routine is the same as CFE_EVS_SendEvent except that the caller specifies the event time instead of having
the EVS use the current spacecraft time. This routine should be used in situations where an error condition is
detected at one time, but the event message is reported at a later time.

Generated by Doxygen
194

Assumptions, External Events, and Notes:

This API only works within the context of a registered application or core service. For messages outside the context
of a registered application (for example early in app initialization or if registration fails) CFE_ES_WriteToSysLog
can be used for reporting.

Parameters

in Time The time to include in the event. This will usually be a time returned by the function
CFE_TIME_GetTime.
in EventID A numeric literal used to uniquely identify an application event. The EventID is defined and
supplied by the application sending the event.
in EventType A numeric literal used to classify an event, one of:

• CFE_EVS_EventType_DEBUG

• CFE_EVS_EventType_INFORMATION

• CFE_EVS_EventType_ERROR

• CFE_EVS_EventType_CRITICAL

in Spec A pointer to a null terminated text string (must not be null) describing the output format for the
event. This is the same type of format string used for the ANSI printf function. Nominally
the post-conversion string is limited to 80 characters, but this limit is configurable through the
parameter CFE_MISSION_EVS_MAX_MESSAGE_LENGTH. Characters beyond the limit will
be truncated. Do not use floating point conversions (f, e, E, g, and G) in the format string
unless your application will be running in a system that supports floating point arithmetic. Do
not use non-printable characters (\t, \n, etc.) in the format string; they will mess up the
formatting when the events are displayed on the ground system.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_EVS_APP_NOT_REGISTERED Application Not Registered.
CFE_EVS_APP_ILLEGAL_APP_ID Illegal Application ID.
CFE_EVS_INVALID_PARAMETER Invalid Pointer.

See also

CFE_EVS_SendEvent, CFE_EVS_SendEventWithAppID

Generated by Doxygen
9.15 cFE Reset Event Filter APIs 195

9.15 cFE Reset Event Filter APIs

Functions

• CFE_Status_t CFE_EVS_ResetFilter (uint16 EventID)

Resets the calling application's event filter for a single event ID.
• CFE_Status_t CFE_EVS_ResetAllFilters (void)
Resets all of the calling application's event filters.

9.15.1 Detailed Description

9.15.2 Function Documentation

9.15.2.1 CFE_EVS_ResetAllFilters() CFE_Status_t CFE_EVS_ResetAllFilters (

void )
Resets all of the calling application's event filters.

Description

This routine resets all the calling application's event filter counters to zero, providing a quick and convenient method
for resetting event filters.

Assumptions, External Events, and Notes:

None

Returns

Execution status below or from CFE_ES_GetAppID, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_EVS_APP_NOT_REGISTERED Application Not Registered.
CFE_EVS_APP_ILLEGAL_APP_ID Illegal Application ID.

See also

CFE_EVS_ResetFilter

9.15.2.2 CFE_EVS_ResetFilter() CFE_Status_t CFE_EVS_ResetFilter (

uint16 EventID )
Resets the calling application's event filter for a single event ID.

Description

Resets the filter such that the next event is treated like the first. For example, if the filter was set to only send the
first event, the next event following the reset would be sent.

Generated by Doxygen
196

Assumptions, External Events, and Notes:

None

Parameters

in EventID A numeric literal used to uniquely identify an application event. The EventID is defined and
supplied by the application sending the event.

Returns

Execution status below or from CFE_ES_GetAppID, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_EVS_APP_NOT_REGISTERED Application Not Registered.
CFE_EVS_APP_ILLEGAL_APP_ID Illegal Application ID.
CFE_EVS_EVT_NOT_REGISTERED Event Not Registered.

See also

CFE_EVS_ResetAllFilters

Generated by Doxygen
9.16 cFE File Header Management APIs 197

9.16 cFE File Header Management APIs

Functions

• CFE_Status_t CFE_FS_ReadHeader (CFE_FS_Header_t ∗Hdr, osal_id_t FileDes)

Read the contents of the Standard cFE File Header.
• void CFE_FS_InitHeader (CFE_FS_Header_t ∗Hdr, const char ∗Description, uint32 SubType)
Initializes the contents of the Standard cFE File Header.
• CFE_Status_t CFE_FS_WriteHeader (osal_id_t FileDes, CFE_FS_Header_t ∗Hdr)
Write the specified Standard cFE File Header to the specified file.
• CFE_Status_t CFE_FS_SetTimestamp (osal_id_t FileDes, CFE_TIME_SysTime_t NewTimestamp)
Modifies the Time Stamp field in the Standard cFE File Header for the specified file.

9.16.1 Detailed Description

9.16.2 Function Documentation

9.16.2.1 CFE_FS_InitHeader() void CFE_FS_InitHeader (

CFE_FS_Header_t ∗ Hdr,
const char ∗ Description,
uint32 SubType )
Initializes the contents of the Standard cFE File Header.
Description

This API will clear the specified CFE_FS_Header_t variable and initialize the description field with the specified
value

Parameters

in Hdr Pointer to a variable of type CFE_FS_Header_t that will be cleared and initialized
in Description Initializes Header's Description (must not be null)
in SubType Initializes Header's SubType

See also

CFE_FS_WriteHeader

9.16.2.2 CFE_FS_ReadHeader() CFE_Status_t CFE_FS_ReadHeader (

CFE_FS_Header_t ∗ Hdr,
osal_id_t FileDes )
Read the contents of the Standard cFE File Header.

Description

This API will fill the specified CFE_FS_Header_t variable with the contents of the Standard cFE File Header of the
file identified by the given File Descriptor.

Generated by Doxygen
198

Assumptions, External Events, and Notes:

1. The File has already been successfully opened using OS_OpenCreate and the caller has a legitimate File
Descriptor.
2. File offset behavior: Agnostic on entry since it will move the offset to the start of the file, on success the offset
will be at the end of the header, undefined offset behavior for error cases.

Parameters

out Hdr Pointer to a variable of type CFE_FS_Header_t (must not be null) that will be filled with the
contents of the Standard cFE File Header. ∗Hdr is the contents of the Standard cFE File
Header for the specified file.
in FileDes File Descriptor obtained from a previous call to OS_OpenCreate that is associated with the file
whose header is to be read.

Returns

Bytes read or error status from OSAL

Return values

CFE_FS_BAD_ARGUMENT Bad Argument.

Note

This function invokes OSAL API routines and the current implementation may return OSAL error codes to
the caller if failure occurs. In a future version of CFE, the status codes will be converted to a value in
cFE Return Code Defines.

See also

CFE_FS_WriteHeader

9.16.2.3 CFE_FS_SetTimestamp() CFE_Status_t CFE_FS_SetTimestamp (

osal_id_t FileDes,
CFE_TIME_SysTime_t NewTimestamp )
Modifies the Time Stamp field in the Standard cFE File Header for the specified file.
Description

This API will modify the timestamp found in the Standard cFE File Header of the specified file. The timestamp will
be replaced with the time specified by the caller.

Assumptions, External Events, and Notes:

1. The File has already been successfully opened using OS_OpenCreate and the caller has a legitimate File
Descriptor.
2. The NewTimestamp field has been filled appropriately by the Application.
3. File offset behavior: Agnostic on entry since it will move the offset, on success the offset will be at the end of
the time stamp, undefined offset behavior for error cases.

Generated by Doxygen
9.16 cFE File Header Management APIs 199

Parameters

in FileDes File Descriptor obtained from a previous call to OS_OpenCreate that is associated with
the file whose header is to be read.
in NewTimestamp A CFE_TIME_SysTime_t data structure containing the desired time to be put into the
file's Standard cFE File Header.

Returns

Execution status, see cFE Return Code Defines, or OSAL status

Return values

CFE_STATUS_EXTERNAL_RESOURCE_FAIL (return value only verified in coverage test) External failure.

CFE_SUCCESS Successful execution.

Note

This function invokes OSAL API routines and the current implementation may return OSAL error codes to
the caller if failure occurs. In a future version of CFE, the status codes will be converted to a value in
cFE Return Code Defines.

9.16.2.4 CFE_FS_WriteHeader() CFE_Status_t CFE_FS_WriteHeader (

osal_id_t FileDes,
CFE_FS_Header_t ∗ Hdr )
Write the specified Standard cFE File Header to the specified file.
Description

This API will output the specified CFE_FS_Header_t variable, with some fields automatically updated, to the
specified file as the Standard cFE File Header. This API will automatically populate the following fields in the
specified CFE_FS_Header_t:
1. ContentType - Filled with 0x63464531 ('cFE1')

2. Length - Filled with the sizeof(CFE_FS_Header_t)

3. SpacecraftID - Filled with the Spacecraft ID

4. ProcessorID - Filled with the Processor ID

5. ApplicationID - Filled with the Application ID

6. TimeSeconds - Filled with the Time, in seconds, as obtained by CFE_TIME_GetTime

7. TimeSubSeconds - Filled with the Time, subseconds, as obtained by CFE_TIME_GetTime

Assumptions, External Events, and Notes:

1. The File has already been successfully opened using OS_OpenCreate and the caller has a legitimate File
Descriptor.
2. The SubType field has been filled appropriately by the Application.
3. The Description field has been filled appropriately by the Application.
4. File offset behavior: Agnostic on entry since it will move the offset to the start of the file, on success the offset
will be at the end of the header, undefined offset behavior for error cases.

Generated by Doxygen
200

Parameters

in FileDes File Descriptor obtained from a previous call to OS_OpenCreate that is associated with the file
whose header is to be read.
out Hdr Pointer to a variable of type CFE_FS_Header_t (must not be null) that will be filled with the
contents of the Standard cFE File Header. ∗Hdr is the contents of the Standard cFE File
Header for the specified file.

Returns

Bytes read or error status from OSAL

Return values

CFE_FS_BAD_ARGUMENT Bad Argument.

Note

This function invokes OSAL API routines and the current implementation may return OSAL error codes to
the caller if failure occurs. In a future version of CFE, the status codes will be converted to a value in
cFE Return Code Defines.

See also

CFE_FS_ReadHeader

Generated by Doxygen
9.17 cFE File Utility APIs 201

9.17 cFE File Utility APIs

Functions

• const char ∗ CFE_FS_GetDefaultMountPoint (CFE_FS_FileCategory_t FileCategory)

Get the default virtual mount point for a file category.
• const char ∗ CFE_FS_GetDefaultExtension (CFE_FS_FileCategory_t FileCategory)
Get the default filename extension for a file category.
• int32 CFE_FS_ParseInputFileNameEx (char ∗OutputBuffer, const char ∗InputBuffer, size_t OutputBufSize, size←-
_t InputBufSize, const char ∗DefaultInput, const char ∗DefaultPath, const char ∗DefaultExtension)
Parse a filename input from an input buffer into a local buffer.
• int32 CFE_FS_ParseInputFileName (char ∗OutputBuffer, const char ∗InputName, size_t OutputBufSize,
CFE_FS_FileCategory_t FileCategory)
Parse a filename string from the user into a local buffer.
• CFE_Status_t CFE_FS_ExtractFilenameFromPath (const char ∗OriginalPath, char ∗FileNameOnly)
Extracts the filename from a unix style path and filename string.
• int32 CFE_FS_BackgroundFileDumpRequest (CFE_FS_FileWriteMetaData_t ∗Meta)
Register a background file dump request.
• bool CFE_FS_BackgroundFileDumpIsPending (const CFE_FS_FileWriteMetaData_t ∗Meta)
Query if a background file write request is currently pending.

9.17.1 Detailed Description

9.17.2 Function Documentation

9.17.2.1 CFE_FS_BackgroundFileDumpIsPending() bool CFE_FS_BackgroundFileDumpIsPending (

const CFE_FS_FileWriteMetaData_t ∗ Meta )
Query if a background file write request is currently pending.

Description

This returns "true" while the request is on the background work queue This returns "false" once the request is
complete and removed from the queue.

Assumptions, External Events, and Notes:

None

Parameters

in,out Meta The background file write persistent state object (must not be null)

Returns

boolean value indicating if request is already pending

Return values

true if request is pending

false if request is not pending

Generated by Doxygen
202

9.17.2.2 CFE_FS_BackgroundFileDumpRequest() int32 CFE_FS_BackgroundFileDumpRequest (

CFE_FS_FileWriteMetaData_t ∗ Meta )
Register a background file dump request.

Description

Puts the previously-initialized metadata into the pending request queue

Assumptions, External Events, and Notes:

Metadata structure should be stored in a persistent memory area (not on stack) as it must remain accessible by
the file writer task throughout the asynchronous job operation.

Parameters

in,out Meta The background file write persistent state object (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_FS_BAD_ARGUMENT Bad Argument.

CFE_FS_INVALID_PATH Invalid Path.
CFE_STATUS_REQUEST_ALREADY_PENDING Request already pending.
CFE_SUCCESS Successful execution.

9.17.2.3 CFE_FS_ExtractFilenameFromPath() CFE_Status_t CFE_FS_ExtractFilenameFromPath (

const char ∗ OriginalPath,
char ∗ FileNameOnly )
Extracts the filename from a unix style path and filename string.

Description

This API will take the original unix path/filename combination and extract the base filename. Example: Given the
path/filename : "/cf/apps/myapp.o.gz" this function will return the filename: "myapp.o.gz".

Assumptions, External Events, and Notes:

1. The paths and filenames used here are the standard unix style filenames separated by "/" characters.
2. The extracted filename (including terminator) is no longer than OS_MAX_PATH_LEN

Parameters

in OriginalPath The original path (must not be null)

out FileNameOnly The filename that is extracted from the path (must not be null)

Generated by Doxygen
9.17 cFE File Utility APIs 203

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_FS_BAD_ARGUMENT Bad Argument.

CFE_FS_FNAME_TOO_LONG Filename Too Long.
CFE_FS_INVALID_PATH Invalid Path.
CFE_SUCCESS Successful execution.

9.17.2.4 CFE_FS_GetDefaultExtension() const char∗ CFE_FS_GetDefaultExtension (

CFE_FS_FileCategory_t FileCategory )
Get the default filename extension for a file category.
Certain file types may have an extension that varies from system to system. This is primarily an issue for application
modules which are ".so" on Linux systems, ".dll" on Windows, ".o" on VxWorks, ".obj" on RTEMS, and so on.
This uses a combination of compile-time configuration and hints from the build environment to get the default/expected
extension for a given file category.

Returns

String containing the extension

Return values

NULL if no default extension is known for the given file category

9.17.2.5 CFE_FS_GetDefaultMountPoint() const char∗ CFE_FS_GetDefaultMountPoint (

CFE_FS_FileCategory_t FileCategory )
Get the default virtual mount point for a file category.
Certain classes of files generally reside in a common directory, mainly either the persistent storage (/cf typically) or ram
disk (/ram typically).
Ephemeral status files are generally in the ram disk while application modules and scripts are generally in the persistent
storage.
This returns the expected directory for a given class of files in the form of a virtual OSAL mount point string.

Returns

String containing the mount point

Return values

NULL if no mount point is known for the given file category

9.17.2.6 CFE_FS_ParseInputFileName() int32 CFE_FS_ParseInputFileName (

char ∗ OutputBuffer,

Generated by Doxygen
204

const char ∗ InputName,

size_t OutputBufSize,
CFE_FS_FileCategory_t FileCategory )
Parse a filename string from the user into a local buffer.

Description

Simplified API for CFE_FS_ParseInputFileNameEx() where input is always known to be a non-empty, null termi-
nated string and the fixed-length input buffer not needed. For instance this may be used where the input is a fixed
string from cfe_platform_cfg.h or similar.

Assumptions, External Events, and Notes:

The parameters are organized such that this is basically like strncpy() with an extra argument, and existing file
name accesses which use a direct copy can easily change to use this instead.

See also

CFE_FS_ParseInputFileNameEx()

Parameters

out OutputBuffer Buffer to store result (must not be null).

in InputName A null terminated input string (must not be null).
in OutputBufSize Maximum Size of output buffer (must not be zero).
in FileCategory The generalized category of file (implies default path/extension)

Returns

Execution status, see cFE Return Code Defines

9.17.2.7 CFE_FS_ParseInputFileNameEx() int32 CFE_FS_ParseInputFileNameEx (

char ∗ OutputBuffer,
const char ∗ InputBuffer,
size_t OutputBufSize,
size_t InputBufSize,
const char ∗ DefaultInput,
const char ∗ DefaultPath,
const char ∗ DefaultExtension )
Parse a filename input from an input buffer into a local buffer.

Description

This provides a more user friendly way to specify file names, using default values for the path and extension, which
can vary from system to system.

If InputBuffer is null or its length is zero, then DefaultInput is used as if it was the content of the input buffer.
If either the pathname or extension is missing from the input, it will be added from defaults, with the complete fully-
qualified filename stored in the output buffer.

Generated by Doxygen
9.17 cFE File Utility APIs 205

Assumptions, External Events, and Notes:

1. The paths and filenames used here are the standard unix style filenames separated by "/" (path) and "."
(extension) characters.
2. Input Buffer has a fixed max length. Parsing will not exceed InputBufSize, and does not need to be null
terminated. However parsing will stop at the first null char, when the input is shorter than the maximum.

Parameters

out OutputBuffer Buffer to store result (must not be null).

in InputBuffer A input buffer that may contain a file name (e.g. from command) (must not be null).
in OutputBufSize Maximum Size of output buffer (must not be zero).
in InputBufSize Maximum Size of input buffer.
in DefaultInput Default value to use for input if InputBffer is empty
in DefaultPath Default value to use for pathname if omitted from input
in DefaultExtension Default value to use for extension if omitted from input

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_FS_BAD_ARGUMENT Bad Argument.

CFE_FS_FNAME_TOO_LONG Filename Too Long.
CFE_FS_INVALID_PATH Invalid Path.
CFE_SUCCESS Successful execution.

Generated by Doxygen
206

9.18 cFE Generic Message APIs

Functions

• CFE_Status_t CFE_MSG_Init (CFE_MSG_Message_t ∗MsgPtr, CFE_SB_MsgId_t MsgId, CFE_MSG_Size_t

Size)
Initialize a message.

9.18.1 Detailed Description

9.18.2 Function Documentation

9.18.2.1 CFE_MSG_Init() CFE_Status_t CFE_MSG_Init (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_SB_MsgId_t MsgId,
CFE_MSG_Size_t Size )
Initialize a message.

Description

This routine initialize a message. The entire message is set to zero (based on size), defaults are set, then the size
and bits from MsgId are set.

Parameters

out MsgPtr A pointer to the buffer that contains the message (must not be null).
in MsgId MsgId that corresponds to message
in Size Total size of the message (used to set length field)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

Generated by Doxygen
9.19 cFE Message Primary Header APIs 207

9.19 cFE Message Primary Header APIs

Functions

• CFE_Status_t CFE_MSG_GetSize (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_Size_t ∗Size)

Gets the total size of a message.
• CFE_Status_t CFE_MSG_SetSize (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_Size_t Size)
Sets the total size of a message.
• CFE_Status_t CFE_MSG_GetType (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_Type_t ∗Type)
Gets the message type.
• CFE_Status_t CFE_MSG_SetType (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_Type_t Type)
Sets the message type.
• CFE_Status_t CFE_MSG_GetHeaderVersion (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_HeaderVersion_t
∗Version)
Gets the message header version.
• CFE_Status_t CFE_MSG_SetHeaderVersion (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_HeaderVersion_t
Version)
Sets the message header version.
• CFE_Status_t CFE_MSG_GetHasSecondaryHeader (const CFE_MSG_Message_t ∗MsgPtr, bool ∗Has←-
Secondary)
Gets the message secondary header boolean.
• CFE_Status_t CFE_MSG_SetHasSecondaryHeader (CFE_MSG_Message_t ∗MsgPtr, bool HasSecondary)
Sets the message secondary header boolean.
• CFE_Status_t CFE_MSG_GetApId (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_ApId_t ∗ApId)
Gets the message application ID.
• CFE_Status_t CFE_MSG_SetApId (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_ApId_t ApId)
Sets the message application ID.
• CFE_Status_t CFE_MSG_GetSegmentationFlag (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_SegmentationFlag_t
∗SegFlag)
Gets the message segmentation flag.
• CFE_Status_t CFE_MSG_SetSegmentationFlag (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_SegmentationFlag_t
SegFlag)
Sets the message segmentation flag.
• CFE_Status_t CFE_MSG_GetSequenceCount (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_SequenceCount_t
∗SeqCnt)
Gets the message sequence count.
• CFE_Status_t CFE_MSG_SetSequenceCount (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_SequenceCount_t
SeqCnt)
Sets the message sequence count.
• CFE_MSG_SequenceCount_t CFE_MSG_GetNextSequenceCount (CFE_MSG_SequenceCount_t SeqCnt)
Gets the next sequence count value (rolls over if appropriate)

9.19.1 Detailed Description

9.19.2 Function Documentation

Generated by Doxygen
208

9.19.2.1 CFE_MSG_GetApId() CFE_Status_t CFE_MSG_GetApId (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_ApId_t ∗ ApId )
Gets the message application ID.

Description

This routine gets the message application ID.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out ApId Application ID (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.2 CFE_MSG_GetHasSecondaryHeader() CFE_Status_t CFE_MSG_GetHasSecondaryHeader (

const CFE_MSG_Message_t ∗ MsgPtr,
bool ∗ HasSecondary )
Gets the message secondary header boolean.

Description

This routine gets the message secondary header boolean.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out HasSecondary Has secondary header flag (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

Generated by Doxygen
9.19 cFE Message Primary Header APIs 209

9.19.2.3 CFE_MSG_GetHeaderVersion() CFE_Status_t CFE_MSG_GetHeaderVersion (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_HeaderVersion_t ∗ Version )
Gets the message header version.

Description

This routine gets the message header version.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out Version Header version (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.4 CFE_MSG_GetNextSequenceCount() CFE_MSG_SequenceCount_t CFE_MSG_GetNextSequenceCount (

CFE_MSG_SequenceCount_t SeqCnt )
Gets the next sequence count value (rolls over if appropriate)

Description

Abstract method to get the next valid sequence count value. Will roll over to zero for any input value greater than
or equal to the maximum possible sequence count value given the field in the header.

Parameters

in SeqCnt Sequence count

Returns

The next valid sequence count value

9.19.2.5 CFE_MSG_GetSegmentationFlag() CFE_Status_t CFE_MSG_GetSegmentationFlag (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_SegmentationFlag_t ∗ SegFlag )
Gets the message segmentation flag.
Description

This routine gets the message segmentation flag

Generated by Doxygen
210

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out SegFlag Segmentation flag (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.6 CFE_MSG_GetSequenceCount() CFE_Status_t CFE_MSG_GetSequenceCount (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_SequenceCount_t ∗ SeqCnt )
Gets the message sequence count.

Description

This routine gets the message sequence count.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out SeqCnt Sequence count (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.7 CFE_MSG_GetSize() CFE_Status_t CFE_MSG_GetSize (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_Size_t ∗ Size )
Gets the total size of a message.

Description

This routine gets the total size of the message.

Generated by Doxygen
9.19 cFE Message Primary Header APIs 211

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out Size Total message size (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.8 CFE_MSG_GetType() CFE_Status_t CFE_MSG_GetType (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_Type_t ∗ Type )
Gets the message type.

Description

This routine gets the message type.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out Type Message type (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.9 CFE_MSG_SetApId() CFE_Status_t CFE_MSG_SetApId (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_ApId_t ApId )
Sets the message application ID.
Description

This routine sets the message application ID. Typically set at initialization using the MsgId, but API available to set
bits that may not be included in MsgId.

Generated by Doxygen
212

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in ApId Application ID

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.10 CFE_MSG_SetHasSecondaryHeader() CFE_Status_t CFE_MSG_SetHasSecondaryHeader (

CFE_MSG_Message_t ∗ MsgPtr,
bool HasSecondary )
Sets the message secondary header boolean.

Description

This routine sets the message secondary header boolean. Typically only set within message initialization and not
used by APPs.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in HasSecondary Has secondary header flag

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.11 CFE_MSG_SetHeaderVersion() CFE_Status_t CFE_MSG_SetHeaderVersion (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_HeaderVersion_t Version )
Sets the message header version.

Description

This routine sets the message header version. Typically only set within message initialization and not used by
APPs.

Generated by Doxygen
9.19 cFE Message Primary Header APIs 213

Parameters

in,out MsgPtr A pointer to the buffer that contains the message.

in Version Header version

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.12 CFE_MSG_SetSegmentationFlag() CFE_Status_t CFE_MSG_SetSegmentationFlag (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_SegmentationFlag_t SegFlag )
Sets the message segmentation flag.

Description

This routine sets the message segmentation flag.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in SegFlag Segmentation flag

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.13 CFE_MSG_SetSequenceCount() CFE_Status_t CFE_MSG_SetSequenceCount (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_SequenceCount_t SeqCnt )
Sets the message sequence count.

Description

This routine sets the message sequence count.

Generated by Doxygen
214

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in SeqCnt Sequence count

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.14 CFE_MSG_SetSize() CFE_Status_t CFE_MSG_SetSize (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_Size_t Size )
Sets the total size of a message.

Description

This routine sets the total size of the message.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in Size Total message size

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.19.2.15 CFE_MSG_SetType() CFE_Status_t CFE_MSG_SetType (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_Type_t Type )
Sets the message type.

Description

This routine sets the message type.

Generated by Doxygen
9.19 cFE Message Primary Header APIs 215

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in Type Message type

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

Generated by Doxygen
216

9.20 cFE Message Extended Header APIs

Functions

• CFE_Status_t CFE_MSG_GetEDSVersion (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_EDSVersion_t

∗Version)
Gets the message EDS version.
• CFE_Status_t CFE_MSG_SetEDSVersion (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_EDSVersion_t Version)
Sets the message EDS version.
• CFE_Status_t CFE_MSG_GetEndian (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_Endian_t ∗Endian)
Gets the message endian.
• CFE_Status_t CFE_MSG_SetEndian (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_Endian_t Endian)
Sets the message endian.
• CFE_Status_t CFE_MSG_GetPlaybackFlag (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_PlaybackFlag_t
∗PlayFlag)
Gets the message playback flag.
• CFE_Status_t CFE_MSG_SetPlaybackFlag (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_PlaybackFlag_t
PlayFlag)
Sets the message playback flag.
• CFE_Status_t CFE_MSG_GetSubsystem (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_Subsystem_t
∗Subsystem)
Gets the message subsystem.
• CFE_Status_t CFE_MSG_SetSubsystem (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_Subsystem_t Subsys-
tem)
Sets the message subsystem.
• CFE_Status_t CFE_MSG_GetSystem (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_System_t ∗System)
Gets the message system.
• CFE_Status_t CFE_MSG_SetSystem (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_System_t System)
Sets the message system.

9.20.1 Detailed Description

9.20.2 Function Documentation

9.20.2.1 CFE_MSG_GetEDSVersion() CFE_Status_t CFE_MSG_GetEDSVersion (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_EDSVersion_t ∗ Version )
Gets the message EDS version.

Description

This routine gets the message EDS version.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out Version EDS Version (must not be null)

Generated by Doxygen
9.20 cFE Message Extended Header APIs 217

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.2 CFE_MSG_GetEndian() CFE_Status_t CFE_MSG_GetEndian (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_Endian_t ∗ Endian )
Gets the message endian.

Description

This routine gets the message endian.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out Endian Endian (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.3 CFE_MSG_GetPlaybackFlag() CFE_Status_t CFE_MSG_GetPlaybackFlag (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_PlaybackFlag_t ∗ PlayFlag )
Gets the message playback flag.

Description

This routine gets the message playback flag.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out PlayFlag Playback Flag (must not be null)

Generated by Doxygen
218

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.4 CFE_MSG_GetSubsystem() CFE_Status_t CFE_MSG_GetSubsystem (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_Subsystem_t ∗ Subsystem )
Gets the message subsystem.

Description

This routine gets the message subsystem

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out Subsystem Subsystem (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.5 CFE_MSG_GetSystem() CFE_Status_t CFE_MSG_GetSystem (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_System_t ∗ System )
Gets the message system.

Description

This routine gets the message system id

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out System System (must not be null)

Generated by Doxygen
9.20 cFE Message Extended Header APIs 219

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.6 CFE_MSG_SetEDSVersion() CFE_Status_t CFE_MSG_SetEDSVersion (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_EDSVersion_t Version )
Sets the message EDS version.

Description

This routine sets the message EDS version.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in Version EDS Version

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.7 CFE_MSG_SetEndian() CFE_Status_t CFE_MSG_SetEndian (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_Endian_t Endian )
Sets the message endian.

Description

This routine sets the message endian. Invalid endian selection will set big endian.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in Endian Endian

Generated by Doxygen
220

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.8 CFE_MSG_SetPlaybackFlag() CFE_Status_t CFE_MSG_SetPlaybackFlag (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_PlaybackFlag_t PlayFlag )
Sets the message playback flag.

Description

This routine sets the message playback flag.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in PlayFlag Playback Flag

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.9 CFE_MSG_SetSubsystem() CFE_Status_t CFE_MSG_SetSubsystem (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_Subsystem_t Subsystem )
Sets the message subsystem.

Description

This routine sets the message subsystem. Some bits may be set at initialization using the MsgId, but API available
to set bits that may not be included in MsgId.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in Subsystem Subsystem

Generated by Doxygen
9.20 cFE Message Extended Header APIs 221

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.20.2.10 CFE_MSG_SetSystem() CFE_Status_t CFE_MSG_SetSystem (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_System_t System )
Sets the message system.

Description

This routine sets the message system id. Some bits may be set at initialization using the MsgId, but API available
to set bits that may not be included in MsgId.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in System System

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

Generated by Doxygen
222

9.21 cFE Message Secondary Header APIs

Functions

• CFE_Status_t CFE_MSG_GenerateChecksum (CFE_MSG_Message_t ∗MsgPtr)

Calculates and sets the checksum of a message.
• CFE_Status_t CFE_MSG_ValidateChecksum (const CFE_MSG_Message_t ∗MsgPtr, bool ∗IsValid)
Validates the checksum of a message.
• CFE_Status_t CFE_MSG_SetFcnCode (CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_FcnCode_t FcnCode)
Sets the function code field in a message.
• CFE_Status_t CFE_MSG_GetFcnCode (const CFE_MSG_Message_t ∗MsgPtr, CFE_MSG_FcnCode_t ∗Fcn←-
Code)
Gets the function code field from a message.
• CFE_Status_t CFE_MSG_GetMsgTime (const CFE_MSG_Message_t ∗MsgPtr, CFE_TIME_SysTime_t ∗Time)
Gets the time field from a message.
• CFE_Status_t CFE_MSG_SetMsgTime (CFE_MSG_Message_t ∗MsgPtr, CFE_TIME_SysTime_t NewTime)
Sets the time field in a message.

9.21.1 Detailed Description

9.21.2 Function Documentation

9.21.2.1 CFE_MSG_GenerateChecksum() CFE_Status_t CFE_MSG_GenerateChecksum (

CFE_MSG_Message_t ∗ MsgPtr )
Calculates and sets the checksum of a message.

Description

This routine calculates the checksum of a message according to an implementation-defined algorithm. Then, it
sets the checksum field in the message with the calculated value. The contents and location of this field will
depend on the underlying implementation of messages. It may be a checksum, a CRC, or some other algorithm.

Assumptions, External Events, and Notes:

• If the underlying implementation of messages does not include a checksum field, then this routine will return
CFE_MSG_WRONG_MSG_TYPE

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.
CFE_MSG_WRONG_MSG_TYPE Error - wrong type.

Generated by Doxygen
9.21 cFE Message Secondary Header APIs 223

9.21.2.2 CFE_MSG_GetFcnCode() CFE_Status_t CFE_MSG_GetFcnCode (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_FcnCode_t ∗ FcnCode )
Gets the function code field from a message.

Description

This routine gets the function code from a message.

Assumptions, External Events, and Notes:

• If the underlying implementation of messages does not include a function code field, then this routine will set
FcnCode to zero and return CFE_MSG_WRONG_MSG_TYPE

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out FcnCode The function code from the message (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.
CFE_MSG_WRONG_MSG_TYPE Error - wrong type.

9.21.2.3 CFE_MSG_GetMsgTime() CFE_Status_t CFE_MSG_GetMsgTime (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_TIME_SysTime_t ∗ Time )
Gets the time field from a message.

Description

This routine gets the time from a message.

Assumptions, External Events, and Notes:

• If the underlying implementation of messages does not include a time field, then this routine will set Time to
zero and return CFE_MSG_WRONG_MSG_TYPE
• Note default implementation of command messages do not have a time field.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out Time Time from the message (must not be null)

Generated by Doxygen
224

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.
CFE_MSG_WRONG_MSG_TYPE Error - wrong type.

9.21.2.4 CFE_MSG_SetFcnCode() CFE_Status_t CFE_MSG_SetFcnCode (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_MSG_FcnCode_t FcnCode )
Sets the function code field in a message.

Description

This routine sets the function code of a message.

Assumptions, External Events, and Notes:

• If the underlying implementation of messages does not include a function code field, then this routine will do
nothing to the message contents and will return CFE_MSG_WRONG_MSG_TYPE.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in FcnCode The function code to include in the message.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.
CFE_MSG_WRONG_MSG_TYPE Error - wrong type.

9.21.2.5 CFE_MSG_SetMsgTime() CFE_Status_t CFE_MSG_SetMsgTime (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_TIME_SysTime_t NewTime )
Sets the time field in a message.

Generated by Doxygen
9.21 cFE Message Secondary Header APIs 225

Description

This routine sets the time of a message. Most applications will want to use CFE_SB_TimeStampMsg instead of
this function. But, when needed, this API can be used to set multiple messages with identical time stamps.

Assumptions, External Events, and Notes:

• If the underlying implementation of messages does not include a time field, then this routine will do nothing
to the message contents and will return CFE_MSG_WRONG_MSG_TYPE.
• Note default implementation of command messages do not have a time field.

Parameters

in,out MsgPtr A pointer to the message (must not be null).

in NewTime The time to include in the message. This will usually be a time from CFE_TIME_GetTime.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.
CFE_MSG_WRONG_MSG_TYPE Error - wrong type.

9.21.2.6 CFE_MSG_ValidateChecksum() CFE_Status_t CFE_MSG_ValidateChecksum (

const CFE_MSG_Message_t ∗ MsgPtr,
bool ∗ IsValid )
Validates the checksum of a message.

Description

This routine validates the checksum of a message according to an implementation-defined algorithm.

Assumptions, External Events, and Notes:

• If the underlying implementation of messages does not include a checksum field, then this routine will return
CFE_MSG_WRONG_MSG_TYPE and set the IsValid parameter false.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null). This must point to the first
byte of the message header.
out IsValid Checksum validation result (must not be null)

• true - valid

• false - invalid or not supported/implemented

Generated by Doxygen
226

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.
CFE_MSG_WRONG_MSG_TYPE Error - wrong type.

Generated by Doxygen
9.22 cFE Message Id APIs 227

9.22 cFE Message Id APIs

Functions

• CFE_Status_t CFE_MSG_GetMsgId (const CFE_MSG_Message_t ∗MsgPtr, CFE_SB_MsgId_t ∗MsgId)

Gets the message id from a message.
• CFE_Status_t CFE_MSG_SetMsgId (CFE_MSG_Message_t ∗MsgPtr, CFE_SB_MsgId_t MsgId)
Sets the message id bits in a message.
• CFE_Status_t CFE_MSG_GetTypeFromMsgId (CFE_SB_MsgId_t MsgId, CFE_MSG_Type_t ∗Type)
Gets message type using message ID.

9.22.1 Detailed Description

9.22.2 Function Documentation

9.22.2.1 CFE_MSG_GetMsgId() CFE_Status_t CFE_MSG_GetMsgId (

const CFE_MSG_Message_t ∗ MsgPtr,
CFE_SB_MsgId_t ∗ MsgId )
Gets the message id from a message.

Description

This routine gets the message id from a message. The message id is a hash of bits in the message header, used
by the software bus for routing. Message id needs to be unique for each endpoint in the system.

Parameters

in MsgPtr A pointer to the buffer that contains the message (must not be null).
out MsgId Message id (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.22.2.2 CFE_MSG_GetTypeFromMsgId() CFE_Status_t CFE_MSG_GetTypeFromMsgId (

CFE_SB_MsgId_t MsgId,
CFE_MSG_Type_t ∗ Type )
Gets message type using message ID.

Description

This routine gets the message type using the message ID

Generated by Doxygen
228

Parameters
in Msg←- Message id
Id
out Type Message type (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.22.2.3 CFE_MSG_SetMsgId() CFE_Status_t CFE_MSG_SetMsgId (

CFE_MSG_Message_t ∗ MsgPtr,
CFE_SB_MsgId_t MsgId )
Sets the message id bits in a message.

Description

This routine sets the message id bits in a message. The message id is a hash of bits in the message header, used
by the software bus for routing. Message id needs to be unique for each endpoint in the system.

Note

This API only sets the bits in the header that make up the message ID. No other values in the header are modified.

The user should ensure that this function is only called with a valid MsgId parameter value. If called with an in-
valid value, the results are implementation-defined. The implementation may or may not return the error code
CFE_MSG_BAD_ARGUMENT in this case.

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in MsgId Message id

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

Generated by Doxygen
9.23 cFE Message Integrity APIs 229

9.23 cFE Message Integrity APIs

Functions

• CFE_Status_t CFE_MSG_OriginationAction (CFE_MSG_Message_t ∗MsgPtr, size_t BufferSize, bool ∗Is←-

Acceptable)
Perform any necessary actions on a newly-created message, prior to sending.
• CFE_Status_t CFE_MSG_VerificationAction (const CFE_MSG_Message_t ∗MsgPtr, size_t BufferSize, bool ∗Is←-
Acceptable)
Checks message integrity/acceptability.

9.23.1 Detailed Description

9.23.2 Function Documentation

9.23.2.1 CFE_MSG_OriginationAction() CFE_Status_t CFE_MSG_OriginationAction (

CFE_MSG_Message_t ∗ MsgPtr,
size_t BufferSize,
bool ∗ IsAcceptable )
Perform any necessary actions on a newly-created message, prior to sending.

Description

This routine updates and/or appends any necessary fields on a message, is invoked via SB just prior to broad-
casting the message. The actions include updating any values that should be computed/updated per message,
including:

• setting the sequence number

• updating the timestamp, if present
• computing any error control or checksum fields, if present

The MSG module implementation determines which header fields meet this criteria and how they should be computed.
The BufferSize parameter indicates the allocation size message of the buffer that holds the message (i.e. the message
envelope size). In some implementations, the allocated buffer may include extra space in order to append a CRC or
digital signature.

See also

CFE_MSG_VerificationAction

Parameters

in,out MsgPtr A pointer to the buffer that contains the message (must not be null).
in BufferSize The size of the buffer encapsulating the message
out IsAcceptable Output variable to be set, indicates message acceptability (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

Generated by Doxygen
230

Return values

CFE_MSG_BAD_ARGUMENT Error - bad argument.

9.23.2.2 CFE_MSG_VerificationAction() CFE_Status_t CFE_MSG_VerificationAction (

const CFE_MSG_Message_t ∗ MsgPtr,
size_t BufferSize,
bool ∗ IsAcceptable )
Checks message integrity/acceptability.

Description

This routine validates that any error-control field(s) in the message header matches the expected value.

The specific function of this API is entirely dependent on the header fields and may be a no-op if no error checking is
implemented. In that case, it will always output "true".

Note

Due to the fact that software bus uses a multicast architecture, this function must not modify the mes-
sage, as the buffer may be shared among multiple receivers. This should generally be the inverse of
CFE_MSG_OriginationAction(), but on the origination side it may update header fields and/or modify the mes-
sage, on the verification/receive side it must only check those fields, not modify them.

See also

CFE_MSG_OriginationAction

Parameters

in MsgPtr Message Pointer (must not be null)

in BufferSize The size of the buffer encapsulating the message
out IsAcceptable Output variable to be set, indicates message acceptability (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_MSG_BAD_ARGUMENT Error - bad argument.

Generated by Doxygen
9.24 cFE Pipe Management APIs 231

9.24 cFE Pipe Management APIs

Functions

• CFE_Status_t CFE_SB_CreatePipe (CFE_SB_PipeId_t ∗PipeIdPtr, uint16 Depth, const char ∗PipeName)

Creates a new software bus pipe.
• CFE_Status_t CFE_SB_DeletePipe (CFE_SB_PipeId_t PipeId)
Delete a software bus pipe.
• CFE_Status_t CFE_SB_PipeId_ToIndex (CFE_SB_PipeId_t PipeID, uint32 ∗Idx)
Obtain an index value correlating to an SB Pipe ID.
• CFE_Status_t CFE_SB_SetPipeOpts (CFE_SB_PipeId_t PipeId, uint8 Opts)
Set options on a pipe.
• CFE_Status_t CFE_SB_GetPipeOpts (CFE_SB_PipeId_t PipeId, uint8 ∗OptsPtr)
Get options on a pipe.
• CFE_Status_t CFE_SB_GetPipeName (char ∗PipeNameBuf, size_t PipeNameSize, CFE_SB_PipeId_t PipeId)
Get the pipe name for a given id.
• CFE_Status_t CFE_SB_GetPipeIdByName (CFE_SB_PipeId_t ∗PipeIdPtr, const char ∗PipeName)
Get pipe id by pipe name.

9.24.1 Detailed Description

9.24.2 Function Documentation

9.24.2.1 CFE_SB_CreatePipe() CFE_Status_t CFE_SB_CreatePipe (

CFE_SB_PipeId_t ∗ PipeIdPtr,
uint16 Depth,
const char ∗ PipeName )
Creates a new software bus pipe.

Description

This routine creates and initializes an input pipe that the calling application can use to receive software bus mes-
sages. By default, no messages are routed to the new pipe. So, the application must use CFE_SB_Subscribe to
specify which messages it wants to receive on this pipe.

Assumptions, External Events, and Notes:

None

Parameters

out PipeIdPtr A pointer to a variable of type CFE_SB_PipeId_t (must not be null), which will be filled in with
the pipe ID information by the CFE_SB_CreatePipe routine. ∗PipeIdPtr is the identifier for
the created pipe.
in Depth The maximum number of messages that will be allowed on this pipe at one time.
in PipeName A string (must not be null) to be used to identify this pipe in error messages and routing
information telemetry. The string must be no longer than OS_MAX_API_NAME (including
terminator). Longer strings will be truncated.

Generated by Doxygen
232

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.
CFE_SB_MAX_PIPES_MET Max Pipes Met.
CFE_SB_PIPE_CR_ERR Pipe Create Error.

See also

CFE_SB_DeletePipe CFE_SB_GetPipeOpts CFE_SB_SetPipeOpts CFE_SB_GetPipeIdByName

9.24.2.2 CFE_SB_DeletePipe() CFE_Status_t CFE_SB_DeletePipe (

CFE_SB_PipeId_t PipeId )
Delete a software bus pipe.

Description

This routine deletes an input pipe and cleans up all data structures associated with the pipe. All subscriptions
made for this pipe by calls to CFE_SB_Subscribe will be automatically removed from the SB routing tables. Any
messages in the pipe will be discarded.

Applications should not call this routine for all of their SB pipes as part of their orderly shutdown process, as the pipe
will be deleted by the support framework at the appropriate time.

Assumptions, External Events, and Notes:

None

Parameters

in Pipe←- The pipe ID (obtained previously from CFE_SB_CreatePipe) of the pipe to be deleted.
Id

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.

See also

CFE_SB_CreatePipe CFE_SB_GetPipeOpts CFE_SB_SetPipeOpts CFE_SB_GetPipeIdByName

Generated by Doxygen
9.24 cFE Pipe Management APIs 233

9.24.2.3 CFE_SB_GetPipeIdByName() CFE_Status_t CFE_SB_GetPipeIdByName (

CFE_SB_PipeId_t ∗ PipeIdPtr,
const char ∗ PipeName )
Get pipe id by pipe name.

Description

This routine finds the pipe id for a pipe name.

Parameters

in PipeName The name of the pipe (must not be null).

out PipeIdPtr The PipeId for that name (must not be null).

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.

See also

CFE_SB_CreatePipe CFE_SB_DeletePipe CFE_SB_SetPipeOpts CFE_SB_PIPEOPTS_IGNOREMINE

9.24.2.4 CFE_SB_GetPipeName() CFE_Status_t CFE_SB_GetPipeName (

char ∗ PipeNameBuf,
size_t PipeNameSize,
CFE_SB_PipeId_t PipeId )
Get the pipe name for a given id.

Description

This routine finds the pipe name for a pipe id.

Parameters

out PipeNameBuf The buffer to receive the pipe name (must not be null).
in PipeNameSize The size (in chars) of the PipeName buffer (must not be zero).
in PipeId The PipeId for that name.

Returns

Execution status, see cFE Return Code Defines

Generated by Doxygen
234

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.

See also

CFE_SB_CreatePipe CFE_SB_DeletePipe CFE_SB_SetPipeOpts CFE_SB_GetPipeIdByName

9.24.2.5 CFE_SB_GetPipeOpts() CFE_Status_t CFE_SB_GetPipeOpts (

CFE_SB_PipeId_t PipeId,
uint8 ∗ OptsPtr )
Get options on a pipe.

Description

This routine gets the current options on a pipe.

Parameters

in PipeId The pipe ID of the pipe to get options from.

out OptsPtr A bit field of options: cFE SB Pipe options (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.

See also

CFE_SB_CreatePipe CFE_SB_DeletePipe CFE_SB_SetPipeOpts CFE_SB_GetPipeIdByName CFE_SB_PIPEOPTS_IGNOREMIN

9.24.2.6 CFE_SB_PipeId_ToIndex() CFE_Status_t CFE_SB_PipeId_ToIndex (

CFE_SB_PipeId_t PipeID,
uint32 ∗ Idx )
Obtain an index value correlating to an SB Pipe ID.
This calculates a zero based integer value that may be used for indexing into a local resource table/array.
Index values are only guaranteed to be unique for resources of the same type. For instance, the indices corresponding
to two [valid] application IDs will never overlap, but the index of a pipe ID and an app ID may be the same. Furthermore,
indices may be reused if a resource is deleted and re-created.
Note

There is no inverse of this function - indices cannot be converted back to the original PipeID value. The caller
should retain the original ID for future use.

Generated by Doxygen
9.24 cFE Pipe Management APIs 235

Parameters
in PipeID Pipe ID to convert
out Idx Buffer where the calculated index will be stored (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

9.24.2.7 CFE_SB_SetPipeOpts() CFE_Status_t CFE_SB_SetPipeOpts (

CFE_SB_PipeId_t PipeId,
uint8 Opts )
Set options on a pipe.

Description

This routine sets (or clears) options to alter the pipe's behavior. Options are (re)set every call to this routine.

Parameters

in Pipe←- The pipe ID of the pipe to set options on.

Id
in Opts A bit field of options: cFE SB Pipe options

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.

See also

CFE_SB_CreatePipe CFE_SB_DeletePipe CFE_SB_GetPipeOpts CFE_SB_GetPipeIdByName CFE_SB_PIPEOPTS_IGNOREMIN

Generated by Doxygen
236

9.25 cFE Message Subscription Control APIs

Functions

• CFE_Status_t CFE_SB_SubscribeEx (CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, CFE_SB_Qos_t

Quality, uint16 MsgLim)
Subscribe to a message on the software bus.
• CFE_Status_t CFE_SB_Subscribe (CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId)
Subscribe to a message on the software bus with default parameters.
• CFE_Status_t CFE_SB_SubscribeLocal (CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, uint16 MsgLim)
Subscribe to a message while keeping the request local to a cpu.
• CFE_Status_t CFE_SB_Unsubscribe (CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId)
Remove a subscription to a message on the software bus.
• CFE_Status_t CFE_SB_UnsubscribeLocal (CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId)
Remove a subscription to a message on the software bus on the current CPU.

9.25.1 Detailed Description

9.25.2 Function Documentation

9.25.2.1 CFE_SB_Subscribe() CFE_Status_t CFE_SB_Subscribe (

CFE_SB_MsgId_t MsgId,
CFE_SB_PipeId_t PipeId )
Subscribe to a message on the software bus with default parameters.

Description

This routine adds the specified pipe to the destination list for the specified message ID. This is the
same as CFE_SB_SubscribeEx with the Quality field set to CFE_SB_DEFAULT_QOS and MsgLim set to
CFE_PLATFORM_SB_DEFAULT_MSG_LIMIT (4).

Assumptions, External Events, and Notes:

Note: As subscriptions are received, the destinations are added to the head of a linked list. During the sending of
a message, the list is traversed beginning at the head of the list. Therefore the message will first be sent to the last
subscriber. If an application has timing constraints and needs to receive a message in the shortest possible time,
the developer may consider holding off its subscription until other applications have subscribed to the message.

Parameters

in Msg←- The message ID of the message to be subscribed to.

Id
in Pipe←- The pipe ID of the pipe the subscribed message should be sent to.
Id

Returns

Execution status, see cFE Return Code Defines

Generated by Doxygen
9.25 cFE Message Subscription Control APIs 237

Return values

CFE_SUCCESS Successful execution.

CFE_SB_MAX_MSGS_MET (return value only verified in coverage test) Max Messages Met.
CFE_SB_MAX_DESTS_MET Max Destinations Met.
CFE_SB_BAD_ARGUMENT Bad Argument.
CFE_SB_BUF_ALOC_ERR (return value only verified in coverage test) Buffer Allocation Error.

See also

CFE_SB_SubscribeEx, CFE_SB_SubscribeLocal, CFE_SB_Unsubscribe, CFE_SB_UnsubscribeLocal

9.25.2.2 CFE_SB_SubscribeEx() CFE_Status_t CFE_SB_SubscribeEx (

CFE_SB_MsgId_t MsgId,
CFE_SB_PipeId_t PipeId,
CFE_SB_Qos_t Quality,
uint16 MsgLim )
Subscribe to a message on the software bus.

Description

This routine adds the specified pipe to the destination list associated with the specified message ID.

Assumptions, External Events, and Notes:

Note: As subscriptions are received, the destinations are added to the head of a linked list. During the sending of
a message, the list is traversed beginning at the head of the list. Therefore the message will first be sent to the last
subscriber. If an application has timing constraints and needs to receive a message in the shortest possible time,
the developer may consider holding off its subscription until other applications have subscribed to the message.

Parameters

in MsgId The message ID of the message to be subscribed to.

in PipeId The pipe ID of the pipe the subscribed message should be sent to.
in Quality The requested Quality of Service (QoS) required of the messages. Most callers will use
CFE_SB_DEFAULT_QOS for this parameter.
in MsgLim The maximum number of messages with this Message ID to allow in this pipe at the same time.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_MAX_MSGS_MET (return value only verified in coverage test) Max Messages Met.
CFE_SB_MAX_DESTS_MET Max Destinations Met.
CFE_SB_BAD_ARGUMENT Bad Argument.
CFE_SB_BUF_ALOC_ERR (return value only verified in coverage test) Buffer Allocation Error.

Generated by Doxygen
238

See also

CFE_SB_Subscribe, CFE_SB_SubscribeLocal, CFE_SB_Unsubscribe, CFE_SB_UnsubscribeLocal

9.25.2.3 CFE_SB_SubscribeLocal() CFE_Status_t CFE_SB_SubscribeLocal (

CFE_SB_MsgId_t MsgId,
CFE_SB_PipeId_t PipeId,
uint16 MsgLim )
Subscribe to a message while keeping the request local to a cpu.

Description

This routine adds the specified pipe to the destination list for the specified message ID. This is simi-
lar to CFE_SB_SubscribeEx with the Quality field set to CFE_SB_DEFAULT_QOS and MsgLim set to
CFE_PLATFORM_SB_DEFAULT_MSG_LIMIT, but will not report the subscription.

Software Bus Network (SBN) application is an example use case, where local subscriptions should not be reported to
peers.

Assumptions, External Events, and Notes:

• This API is typically only used by Software Bus Network (SBN) Application

Parameters

in MsgId The message ID of the message to be subscribed to.

in PipeId The pipe ID of the pipe the subscribed message should be sent to.
in MsgLim The maximum number of messages with this Message ID to allow in this pipe at the same time.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_MAX_MSGS_MET (return value only verified in coverage test) Max Messages Met.
CFE_SB_MAX_DESTS_MET Max Destinations Met.
CFE_SB_BAD_ARGUMENT Bad Argument.
CFE_SB_BUF_ALOC_ERR (return value only verified in coverage test) Buffer Allocation Error.

See also

CFE_SB_Subscribe, CFE_SB_SubscribeEx, CFE_SB_Unsubscribe, CFE_SB_UnsubscribeLocal

9.25.2.4 CFE_SB_Unsubscribe() CFE_Status_t CFE_SB_Unsubscribe (

CFE_SB_MsgId_t MsgId,
CFE_SB_PipeId_t PipeId )
Remove a subscription to a message on the software bus.

Generated by Doxygen
9.25 cFE Message Subscription Control APIs 239

Description

This routine removes the specified pipe from the destination list for the specified message ID.

Assumptions, External Events, and Notes:

If the Pipe is not subscribed to MsgId, the CFE_SB_UNSUB_NO_SUBS_EID event will be generated and
CFE_SUCCESS will be returned

Parameters

in Msg←- The message ID of the message to be unsubscribed.

Id
in Pipe←- The pipe ID of the pipe the subscribed message should no longer be sent to.
Id

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.

See also

CFE_SB_Subscribe, CFE_SB_SubscribeEx, CFE_SB_SubscribeLocal, CFE_SB_UnsubscribeLocal

9.25.2.5 CFE_SB_UnsubscribeLocal() CFE_Status_t CFE_SB_UnsubscribeLocal (

CFE_SB_MsgId_t MsgId,
CFE_SB_PipeId_t PipeId )
Remove a subscription to a message on the software bus on the current CPU.

Description

This routine removes the specified pipe from the destination list for the specified message ID on the current CPU.

Assumptions, External Events, and Notes:

This API is typically only used by Software Bus Network (SBN) Application. If the Pipe is not subscribed to MsgId,
the CFE_SB_UNSUB_NO_SUBS_EID event will be generated and CFE_SUCCESS will be returned

Parameters

in Msg←- The message ID of the message to be unsubscribed.

Id
in Pipe←- The pipe ID of the pipe the subscribed message should no longer be sent to.
Id

Generated by Doxygen
240

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.

See also

CFE_SB_Subscribe, CFE_SB_SubscribeEx, CFE_SB_SubscribeLocal, CFE_SB_Unsubscribe

Generated by Doxygen
9.26 cFE Send/Receive Message APIs 241

9.26 cFE Send/Receive Message APIs

Functions

• CFE_Status_t CFE_SB_TransmitMsg (const CFE_MSG_Message_t ∗MsgPtr, bool IsOrigination)

Transmit a message.
• CFE_Status_t CFE_SB_ReceiveBuffer (CFE_SB_Buffer_t ∗∗BufPtr, CFE_SB_PipeId_t PipeId, int32 TimeOut)
Receive a message from a software bus pipe.

9.26.1 Detailed Description

9.26.2 Function Documentation

9.26.2.1 CFE_SB_ReceiveBuffer() CFE_Status_t CFE_SB_ReceiveBuffer (

CFE_SB_Buffer_t ∗∗ BufPtr,
CFE_SB_PipeId_t PipeId,
int32 TimeOut )
Receive a message from a software bus pipe.

Description

This routine retrieves the next message from the specified pipe. If the pipe is empty, this routine will block until
either a new message comes in or the timeout value is reached.

Assumptions, External Events, and Notes:

Note - If an error occurs in this API, the ∗BufPtr value may be NULL or random. Therefore, it is recommended that
the return code be tested for CFE_SUCCESS before processing the message.

Parameters

in,out BufPtr A pointer to the software bus buffer to receive to (must not be null). Typically a caller
declares a ptr of type CFE_SB_Buffer_t (i.e. CFE_SB_Buffer_t ∗Ptr) then gives the
address of that pointer (&Ptr) as this parameter. After a successful receipt of a message,
∗BufPtr will point to the first byte of the software bus buffer. This should be used as a
read-only pointer (in systems with an MMU, writes to this pointer may cause a memory
protection fault). The ∗BufPtr is valid only until the next call to CFE_SB_ReceiveBuffer for
the same pipe.
in PipeId The pipe ID of the pipe containing the message to be obtained.
in TimeOut The number of milliseconds to wait for a new message if the pipe is empty at the time of
the call. This can also be set to CFE_SB_POLL for a non-blocking receive or
CFE_SB_PEND_FOREVER to wait forever for a message to arrive.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
242

Return values

CFE_SB_TIME_OUT Time Out.

CFE_SB_PIPE_RD_ERR (return value only verified in coverage test) Pipe Read Error.
CFE_SB_NO_MESSAGE No Message.

9.26.2.2 CFE_SB_TransmitMsg() CFE_Status_t CFE_SB_TransmitMsg (

const CFE_MSG_Message_t ∗ MsgPtr,
bool IsOrigination )
Transmit a message.

Description

This routine copies the specified message into a software bus buffer which is then transmitted to all subscribers.
The software bus will read the message ID from the message header to determine which pipes should receive the
message.

The IsOrigination parameter should be passed as "true" if the message was newly constructed by the sender and is
being sent for the first time. This enables the message origination actions as determined by the CFE MSG module,
which may include (but not limited to):

• Updating sequence number

• Updating timestamp

• Calcualating a CRC, checksum, or other message error control field

Conversely, when forwarding a message that originated from an external entity (e.g. messages passing through CI or
SBN), the parameter should be passed as "false" to not overwrite existing data.

Assumptions, External Events, and Notes:

• This routine will not normally wait for the receiver tasks to process the message before returning control to
the caller's task.
• However, if a higher priority task is pending and subscribed to this message, that task may get to run before
returning control to the caller.
• In previous versions of CFE, the boolean parameter referred to the sequence number header of telemetry
messages only. This has been extended to apply more generically to any headers, as determined by the
CFE MSG implementation.

Parameters

in MsgPtr A pointer to the message to be sent (must not be null). This must point to the first byte of the
message header.
in IsOrigination Update the headers of the message

Returns

Execution status, see cFE Return Code Defines

Generated by Doxygen
9.26 cFE Send/Receive Message APIs 243

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.
CFE_SB_MSG_TOO_BIG Message Too Big.
CFE_SB_BUF_ALOC_ERR (return value only verified in coverage test) Buffer Allocation Error.

Generated by Doxygen
244

9.27 cFE Zero Copy APIs

Functions

• CFE_SB_Buffer_t ∗ CFE_SB_AllocateMessageBuffer (size_t MsgSize)

Get a buffer pointer to use for "zero copy" SB sends.
• CFE_Status_t CFE_SB_ReleaseMessageBuffer (CFE_SB_Buffer_t ∗BufPtr)
Release an unused "zero copy" buffer pointer.
• CFE_Status_t CFE_SB_TransmitBuffer (CFE_SB_Buffer_t ∗BufPtr, bool IsOrigination)
Transmit a buffer.

9.27.1 Detailed Description

9.27.2 Function Documentation

9.27.2.1 CFE_SB_AllocateMessageBuffer() CFE_SB_Buffer_t∗ CFE_SB_AllocateMessageBuffer (

size_t MsgSize )
Get a buffer pointer to use for "zero copy" SB sends.

Description

This routine can be used to get a pointer to one of the software bus' internal memory buffers that are used
for sending messages. The caller can use this memory buffer to build an SB message, then send it using the
CFE_SB_TransmitBuffer() function. This interface avoids an extra copy of the message from the user's memory
buffer to the software bus internal buffer.

Assumptions, External Events, and Notes:

1. The pointer returned by CFE_SB_AllocateMessageBuffer() is only good for one call to CFE_SB_TransmitBuffer().
2. Once a buffer has been successfully transmitted (as indicated by a successful return from CFE_SB_TransmitBuffer())
the buffer becomes owned by the SB application. It will automatically be freed by SB once all recipients have
finished reading it.
3. Applications must not de-reference the message pointer (for reading or writing) after the call to
CFE_SB_TransmitBuffer().
4. If CFE_SB_ReleaseMessageBuffer should be used only if a message is not transmitted

Parameters

in MsgSize The size of the SB message buffer the caller wants (including the SB message header).

Returns

A pointer to a memory buffer that message data can be written to for use with CFE_SB_TransmitBuffer().

9.27.2.2 CFE_SB_ReleaseMessageBuffer() CFE_Status_t CFE_SB_ReleaseMessageBuffer (

CFE_SB_Buffer_t ∗ BufPtr )
Release an unused "zero copy" buffer pointer.

Generated by Doxygen
9.27 cFE Zero Copy APIs 245

Description

This routine can be used to release a pointer to one of the software bus' internal memory buffers.

Assumptions, External Events, and Notes:

1. This function is not needed for normal "zero copy" transfers. It is needed only for cleanup when an application
gets a pointer using CFE_SB_AllocateMessageBuffer(), but (due to some error condition) never uses that
pointer in a call to CFE_SB_TransmitBuffer().

Parameters

in BufPtr A pointer to the SB internal buffer (must not be null). This must be a pointer returned by a call to
CFE_SB_AllocateMessageBuffer(), but never used in a call to CFE_SB_TransmitBuffer().

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BUFFER_INVALID Buffer Invalid.

9.27.2.3 CFE_SB_TransmitBuffer() CFE_Status_t CFE_SB_TransmitBuffer (

CFE_SB_Buffer_t ∗ BufPtr,
bool IsOrigination )
Transmit a buffer.

Description

This routine sends a message that has been created directly in an internal SB message buffer by an appli-
cation (after a call to CFE_SB_AllocateMessageBuffer). This interface is more complicated than the normal
CFE_SB_TransmitMsg interface, but it avoids an extra copy of the message from the user's memory buffer to
the software bus internal buffer. The "zero copy" interface can be used to improve performance in high-rate,
high-volume software bus traffic.

The IsOrigination parameter should be passed as "true" if the message was newly constructed by the sender and is
being sent for the first time. This enables the message origination actions as determined by the CFE MSG module,
which may include (but not limited to):

• Updating sequence number

• Updating timestamp

• Calcualating a CRC, checksum, or other message error control field

Conversely, when forwarding a message that originated from an external entity (e.g. messages passing through CI or
SBN), the parameter should be passed as "false" to not overwrite existing data.

Generated by Doxygen
246

Assumptions, External Events, and Notes:

1. A handle returned by CFE_SB_AllocateMessageBuffer is "consumed" by a successful call to

CFE_SB_TransmitBuffer.
2. If this function returns CFE_SUCCESS, this indicates the zero copy handle is now owned by software bus,
and is no longer owned by the calling application, and should not be re-used.
3. However if this function fails (returns any error status) it does not change the state of the buffer at all, meaning
the calling application still owns it. (a failure means the buffer is left in the same state it was before the call).
4. Applications should be written as if CFE_SB_AllocateMessageBuffer is equivalent to a malloc() and a
successful call to CFE_SB_TransmitBuffer is equivalent to a free().
5. Applications must not de-reference the message pointer (for reading or writing) after a successful call to
CFE_SB_TransmitBuffer.
6. This function will increment and apply the internally tracked sequence counter if set to do so.

Parameters

in BufPtr A pointer to the buffer to be sent (must not be null).

in IsOrigination Update applicable header field(s) of a newly constructed message

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_SB_BAD_ARGUMENT Bad Argument.
CFE_SB_MSG_TOO_BIG Message Too Big.

Generated by Doxygen
9.28 cFE Message Characteristics APIs 247

9.28 cFE Message Characteristics APIs

Functions

• void CFE_SB_SetUserDataLength (CFE_MSG_Message_t ∗MsgPtr, size_t DataLength)

Sets the length of user data in a software bus message.
• void CFE_SB_TimeStampMsg (CFE_MSG_Message_t ∗MsgPtr)
Sets the time field in a software bus message with the current spacecraft time.
• int32 CFE_SB_MessageStringSet (char ∗DestStringPtr, const char ∗SourceStringPtr, size_t DestMaxSize, size←-
_t SourceMaxSize)
Copies a string into a software bus message.
• void ∗ CFE_SB_GetUserData (CFE_MSG_Message_t ∗MsgPtr)
Get a pointer to the user data portion of a software bus message.
• size_t CFE_SB_GetUserDataLength (const CFE_MSG_Message_t ∗MsgPtr)
Gets the length of user data in a software bus message.
• int32 CFE_SB_MessageStringGet (char ∗DestStringPtr, const char ∗SourceStringPtr, const char ∗DefaultString,
size_t DestMaxSize, size_t SourceMaxSize)
Copies a string out of a software bus message.

9.28.1 Detailed Description

9.28.2 Function Documentation

9.28.2.1 CFE_SB_GetUserData() void∗ CFE_SB_GetUserData (

CFE_MSG_Message_t ∗ MsgPtr )
Get a pointer to the user data portion of a software bus message.

Description

This routine returns a pointer to the user data portion of a software bus message. SB message header formats
can be different for each deployment of the cFE. So, applications should use this function and avoid hard coding
offsets into their SB message buffers.

Assumptions, External Events, and Notes:

None

Parameters

in MsgPtr A pointer to the buffer that contains the software bus message (must not be null).

Returns

A pointer to the first byte of user data within the software bus message.

9.28.2.2 CFE_SB_GetUserDataLength() size_t CFE_SB_GetUserDataLength (

const CFE_MSG_Message_t ∗ MsgPtr )
Gets the length of user data in a software bus message.

Generated by Doxygen
248

Description

This routine returns the size of the user data in a software bus message.

Assumptions, External Events, and Notes:

None

Parameters

in MsgPtr A pointer to the buffer that contains the software bus message (must not be null). This must point
to the first byte of the message header.

Returns

The size (in bytes) of the user data in the software bus message.

Return values

0 if an error occurs, such as if the MsgPtr argument is not valid.

9.28.2.3 CFE_SB_MessageStringGet() int32 CFE_SB_MessageStringGet (

char ∗ DestStringPtr,
const char ∗ SourceStringPtr,
const char ∗ DefaultString,
size_t DestMaxSize,
size_t SourceMaxSize )
Copies a string out of a software bus message.

Description

Strings within software bus messages have a defined/fixed maximum length, and may not necessarily be null
terminated within the message. This presents a possible issue when using the C library functions to copy strings
out of a message.

This function should replace use of C library functions such as strcpy/strncpy when copying strings out of software bus
messages to local storage buffers.
Up to [SourceMaxSize] or [DestMaxSize-1] (whichever is smaller) characters will be copied from the source buffer to the
destination buffer, and a NUL termination character will be written to the destination buffer as the last character.
If the DefaultString pointer is non-NULL, it will be used in place of the source string if the source is an empty string. This
is typically a string constant that comes from the platform configuration, allowing default values to be assumed for fields
that are unspecified.
IMPORTANT - the default string, if specified, must be null terminated. This will be the case if a string literal is passed in
(the typical/expected use case).
If the default is NULL, then only the source string will be copied, and the result will be an empty string if the source was
empty.
If the destination buffer is too small to store the entire string, it will be truncated, but it will still be null terminated.

Parameters

out DestStringPtr Pointer to destination buffer (must not be null)

Generated by Doxygen
9.28 cFE Message Characteristics APIs 249

Parameters

in SourceStringPtr Pointer to source buffer (component of SB message definition)

in DefaultString Default string to use if source is empty
in DestMaxSize Size of destination storage buffer (must not be zero)
in SourceMaxSize Size of source buffer as defined by the message definition

Returns

Number of characters copied or error code, see cFE Return Code Defines

Return values

CFE_SB_BAD_ARGUMENT Bad Argument.

9.28.2.4 CFE_SB_MessageStringSet() int32 CFE_SB_MessageStringSet (

char ∗ DestStringPtr,
const char ∗ SourceStringPtr,
size_t DestMaxSize,
size_t SourceMaxSize )
Copies a string into a software bus message.

Description

Strings within software bus messages have a defined/fixed maximum length, and may not necessarily be null
terminated within the message. This presents a possible issue when using the C library functions to copy strings
out of a message.

This performs a very similar function to "strncpy()" except that the sizes of both buffers are passed in. Neither buffer is
required to be null-terminated, but copying will stop after the first termination character is encountered.
If the destination buffer is not completely filled by the source data (such as if the supplied string was shorter than the
allotted length) the destination buffer will be padded with NUL characters up to the size of the buffer, similar to what
strncpy() does. This ensures that the entire destination buffer is set.

Note

If the source string buffer is already guaranteed to be null terminated, then there is no difference between the C
library "strncpy()" function and this implementation. It is only necessary to use this when termination of the source
buffer is not guaranteed.

Parameters

out DestStringPtr Pointer to destination buffer (component of SB message definition) (must not be null)
in SourceStringPtr Pointer to source buffer (must not be null)
in DestMaxSize Size of destination buffer as defined by the message definition
in SourceMaxSize Size of source buffer

Generated by Doxygen
250

Returns

Number of characters copied or error code, see cFE Return Code Defines

Return values

CFE_SB_BAD_ARGUMENT Bad Argument.

9.28.2.5 CFE_SB_SetUserDataLength() void CFE_SB_SetUserDataLength (

CFE_MSG_Message_t ∗ MsgPtr,
size_t DataLength )
Sets the length of user data in a software bus message.

Description

This routine sets the field in the SB message header that determines the size of the user data in a software bus
message. SB message header formats can be different for each deployment of the cFE. So, applications should
use this function rather than trying to poke a length value directly into their SB message buffers.

Assumptions, External Events, and Notes:

• You must set a valid message ID in the SB message header before calling this function.

Parameters

in MsgPtr A pointer to the buffer that contains the software bus message (must not be null). This must
point to the first byte of the message header.
in DataLength The length to set (size of the user data, in bytes).

9.28.2.6 CFE_SB_TimeStampMsg() void CFE_SB_TimeStampMsg (

CFE_MSG_Message_t ∗ MsgPtr )
Sets the time field in a software bus message with the current spacecraft time.

Description

This routine sets the time of a software bus message with the current spacecraft time. This will be the same time
that is returned by the function CFE_TIME_GetTime.

Assumptions, External Events, and Notes:

• If the underlying implementation of software bus messages does not include a time field, then this routine
will do nothing.

Parameters

in MsgPtr A pointer to the buffer that contains the software bus message (must not be null). This must point
to the first byte of the message header.

Generated by Doxygen
9.29 cFE Message ID APIs 251

9.29 cFE Message ID APIs

Functions

• bool CFE_SB_IsValidMsgId (CFE_SB_MsgId_t MsgId)

Identifies whether a given CFE_SB_MsgId_t is valid.
• static bool CFE_SB_MsgId_Equal (CFE_SB_MsgId_t MsgId1, CFE_SB_MsgId_t MsgId2)
Identifies whether two CFE_SB_MsgId_t values are equal.
• static CFE_SB_MsgId_Atom_t CFE_SB_MsgIdToValue (CFE_SB_MsgId_t MsgId)
Converts a CFE_SB_MsgId_t to a normal integer.
• static CFE_SB_MsgId_t CFE_SB_ValueToMsgId (CFE_SB_MsgId_Atom_t MsgIdValue)
Converts a normal integer into a CFE_SB_MsgId_t.
• CFE_SB_MsgId_Atom_t CFE_SB_CmdTopicIdToMsgId (uint16 TopicId, uint16 InstanceNum)
Converts a topic ID and instance number combination into a MsgID value integer.
• CFE_SB_MsgId_Atom_t CFE_SB_TlmTopicIdToMsgId (uint16 TopicId, uint16 InstanceNum)
Converts a topic ID and instance number combination into a MsgID value integer.
• CFE_SB_MsgId_Atom_t CFE_SB_GlobalCmdTopicIdToMsgId (uint16 TopicId)
Converts a topic ID to a MsgID value integer for Global commands.
• CFE_SB_MsgId_Atom_t CFE_SB_GlobalTlmTopicIdToMsgId (uint16 TopicId)
Converts a topic ID to a MsgID value integer for Global telemetry.
• CFE_SB_MsgId_Atom_t CFE_SB_LocalCmdTopicIdToMsgId (uint16 TopicId)
Converts a topic ID to a MsgID value integer for local commands.
• CFE_SB_MsgId_Atom_t CFE_SB_LocalTlmTopicIdToMsgId (uint16 TopicId)
Converts a topic ID to a MsgID value integer for local telemetry.

9.29.1 Detailed Description

9.29.2 Function Documentation

9.29.2.1 CFE_SB_CmdTopicIdToMsgId() CFE_SB_MsgId_Atom_t CFE_SB_CmdTopicIdToMsgId (

uint16 TopicId,
uint16 InstanceNum )
Converts a topic ID and instance number combination into a MsgID value integer.
Description

This function accepts a data pair of topic ID + instance number and returns the corresponding MsgID Value
(integer) for commands.

Assumptions and Notes:

A topic ID identifies a certain data stream from an application, for example the CFE Software bus ground com-
mands (CFE_MISSION_SB_CMD_TOPICID). In contrast to MsgID, the topic ID is consistent across all CPUs in a
system, whereas each CPU instance will have a unique MsgID.
CPU instance numbers are 1-based. The instance number of 0 is reserved for "global" MsgID values that are the same
on all CPUs. The PSP function may be used to obtain the current CPU number for the host processor.
See also

CFE_SB_TlmTopicIdToMsgId(), CFE_PSP_GetProcessorId()

Returns

Integer representation of the CFE_SB_MsgId_t

Generated by Doxygen
252

9.29.2.2 CFE_SB_GlobalCmdTopicIdToMsgId() CFE_SB_MsgId_Atom_t CFE_SB_GlobalCmdTopicIdToMsgId (

uint16 TopicId )
Converts a topic ID to a MsgID value integer for Global commands.
Description

This is a wrapper around CFE_SB_CmdTopicIdToMsgId() for topic IDs which are the same on all CPUs within a
system (i.e. not specific to a certain processor)

Assumptions and Notes:

Global MsgIDs may be used when only a single instance of a service exists within the system. The CFE framework
does not use this feature for commands, but is defined for future use.

See also

CFE_SB_CmdTopicIdToMsgId(), CFE_SB_LocalCmdTopicIdToMsgId()

Returns

Integer representation of the CFE_SB_MsgId_t

9.29.2.3 CFE_SB_GlobalTlmTopicIdToMsgId() CFE_SB_MsgId_Atom_t CFE_SB_GlobalTlmTopicIdToMsgId (

uint16 TopicId )
Converts a topic ID to a MsgID value integer for Global telemetry.
Description

This is a wrapper around CFE_SB_TlmTopicIdToMsgId() for topic IDs which are the same on all CPUs within a
system (i.e. not specific to a certain processor)

Assumptions and Notes:

Global MsgIDs may be used when only a single instance of a service exists within the system. An example for
such telemetry is the time synchronization service published by CFE_TIME.

See also

CFE_SB_TlmTopicIdToMsgId(), CFE_SB_LocalTlmTopicIdToMsgId()

Returns

Integer representation of the CFE_SB_MsgId_t

9.29.2.4 CFE_SB_IsValidMsgId() bool CFE_SB_IsValidMsgId (

CFE_SB_MsgId_t MsgId )
Identifies whether a given CFE_SB_MsgId_t is valid.
Description

Implements a basic sanity check on the value provided

Returns

Boolean message ID validity indicator

Generated by Doxygen
9.29 cFE Message ID APIs 253

Return values
true Message ID is within the valid range
false Message ID is not within the valid range

9.29.2.5 CFE_SB_LocalCmdTopicIdToMsgId() CFE_SB_MsgId_Atom_t CFE_SB_LocalCmdTopicIdToMsgId (

uint16 TopicId )
Converts a topic ID to a MsgID value integer for local commands.

Description

This is a wrapper around CFE_SB_CmdTopicIdToMsgId() for topic IDs which are unique on all CPUs within a
system (i.e. specific to a certain processor)

Assumptions and Notes:

This assumes the caller is referring to a service running on the same processor instance as itself.

See also

CFE_SB_CmdTopicIdToMsgId(), CFE_SB_LocalTlmTopicIdToMsgId()

Returns

Integer representation of the CFE_SB_MsgId_t

9.29.2.6 CFE_SB_LocalTlmTopicIdToMsgId() CFE_SB_MsgId_Atom_t CFE_SB_LocalTlmTopicIdToMsgId (

uint16 TopicId )
Converts a topic ID to a MsgID value integer for local telemetry.

Description

This is a wrapper around CFE_SB_TlmTopicIdToMsgId() for topic IDs which are unique on all CPUs within a
system (i.e. specific to a certain processor)

Assumptions and Notes:

This assumes the caller is referring to a service running on the same processor instance as itself.

See also

CFE_SB_TlmTopicIdToMsgId(), CFE_SB_LocalCmdTopicIdToMsgId()

Returns

Integer representation of the CFE_SB_MsgId_t

Generated by Doxygen
254

9.29.2.7 CFE_SB_MsgId_Equal() static bool CFE_SB_MsgId_Equal (

CFE_SB_MsgId_t MsgId1,
CFE_SB_MsgId_t MsgId2 ) [inline], [static]
Identifies whether two CFE_SB_MsgId_t values are equal.

Description

In cases where the CFE_SB_MsgId_t type is not a simple integer type, it may not be possible to do a direct equality
check. This inline function provides an abstraction for the equality check between two CFE_SB_MsgId_t values.

Applications should transition to using this function to compare MsgId values for equality to remain compatible with
future versions of cFE.
Returns

Boolean message ID equality indicator

Return values
true Message IDs are Equal
false Message IDs are not Equal

Definition at line 791 of file cfe_sb.h.

References CFE_SB_MSGID_UNWRAP_VALUE.

9.29.2.8 CFE_SB_MsgIdToValue() static CFE_SB_MsgId_Atom_t CFE_SB_MsgIdToValue (

CFE_SB_MsgId_t MsgId ) [inline], [static]
Converts a CFE_SB_MsgId_t to a normal integer.

Description

In cases where the CFE_SB_MsgId_t type is not a simple integer type, it is not possible to directly display the
value in a printf-style statement, use it in a switch() statement, or other similar use cases.

This inline function provides the ability to map a CFE_SB_MsgId_t type back into a simple integer value.
Applications should transition to using this function wherever a CFE_SB_MsgId_t type needs to be used as an integer.

Assumptions and Notes:

This negates the type safety that was gained by using a non- integer type for the CFE_SB_MsgId_t value. This
should only be used in specific cases such as UI display (printf, events, etc) where the value is being sent externally.
Any internal API calls should be updated to use the CFE_SB_MsgId_t type directly, rather than an integer type.

Returns

Integer representation of the CFE_SB_MsgId_t

Definition at line 822 of file cfe_sb.h.

References CFE_SB_MSGID_UNWRAP_VALUE.

9.29.2.9 CFE_SB_TlmTopicIdToMsgId() CFE_SB_MsgId_Atom_t CFE_SB_TlmTopicIdToMsgId (

uint16 TopicId,
uint16 InstanceNum )
Converts a topic ID and instance number combination into a MsgID value integer.

Generated by Doxygen
9.29 cFE Message ID APIs 255

Description

This function accepts a data pair of topic ID + instance number and returns the corresponding MsgID Value
(integer) for telemetry.

Assumptions and Notes:

A topic ID identifies a certain data stream from an application, for example the CFE Software bus housekeeping
telemetry (CFE_MISSION_SB_HK_TLM_TOPICID). In contrast to MsgID, the topic ID is consistent across all
CPUs in a system, whereas each CPU instance will have a unique MsgID.

CPU instance numbers are 1-based. The instance number of 0 is reserved for "global" MsgID values that are the same
on all CPUs. The PSP function may be used to obtain the current CPU number for the host processor.

See also

CFE_SB_CmdTopicIdToMsgId(), CFE_PSP_GetProcessorId()

Returns

Integer representation of the CFE_SB_MsgId_t

9.29.2.10 CFE_SB_ValueToMsgId() static CFE_SB_MsgId_t CFE_SB_ValueToMsgId (

CFE_SB_MsgId_Atom_t MsgIdValue ) [inline], [static]
Converts a normal integer into a CFE_SB_MsgId_t.

Description

In cases where the CFE_SB_MsgId_t type is not a simple integer type, it is not possible to directly use an integer
value supplied via a define or similar method.

This inline function provides the ability to map an integer value into a corresponding CFE_SB_MsgId_t value.
Applications should transition to using this function wherever an integer needs to be used for a CFE_SB_MsgId_t.

Assumptions and Notes:

This negates the type safety that was gained by using a non- integer type for the CFE_SB_MsgId_t value. This
should only be used in specific cases where the value is coming from an external source. Any internal API calls
should be updated to return the CFE_SB_MsgId_t type directly, rather than an integer type.

Returns

CFE_SB_MsgId_t representation of the integer

Definition at line 851 of file cfe_sb.h.

References CFE_SB_MSGID_C.

Generated by Doxygen
256

9.30 cFE SB Pipe options

Macros

• #define CFE_SB_PIPEOPTS_IGNOREMINE 0x00000001

Messages sent by the app that owns this pipe will not be sent to this pipe.

9.30.1 Detailed Description

9.30.2 Macro Definition Documentation

9.30.2.1 CFE_SB_PIPEOPTS_IGNOREMINE #define CFE_SB_PIPEOPTS_IGNOREMINE 0x00000001

Messages sent by the app that owns this pipe will not be sent to this pipe.
Definition at line 131 of file cfe_sb_api_typedefs.h.

Generated by Doxygen
9.31 cFE Registration APIs 257

9.31 cFE Registration APIs

Functions

• CFE_Status_t CFE_TBL_Register (CFE_TBL_Handle_t ∗TblHandlePtr, const char ∗Name, size_t Size, uint16
TblOptionFlags, CFE_TBL_CallbackFuncPtr_t TblValidationFuncPtr)
Register a table with cFE to obtain Table Management Services.
• CFE_Status_t CFE_TBL_Share (CFE_TBL_Handle_t ∗TblHandlePtr, const char ∗TblName)
Obtain handle of table registered by another application.
• CFE_Status_t CFE_TBL_Unregister (CFE_TBL_Handle_t TblHandle)
Unregister a table.

9.31.1 Detailed Description

9.31.2 Function Documentation

9.31.2.1 CFE_TBL_Register() CFE_Status_t CFE_TBL_Register (

CFE_TBL_Handle_t ∗ TblHandlePtr,
const char ∗ Name,
size_t Size,
uint16 TblOptionFlags,
CFE_TBL_CallbackFuncPtr_t TblValidationFuncPtr )
Register a table with cFE to obtain Table Management Services.

Description

When an application is created and initialized, it is responsible for creating its table images via the TBL API. The
application must inform the Table Service of the table name, table size and selection of optional table features.

Assumptions, External Events, and Notes:

Note: This function call can block. Therefore, interrupt service routines should NOT create their own tables. An
application should create any table(s) and provide the handle(s) to the interrupt service routine.

Parameters

out TblHandlePtr a pointer to a CFE_TBL_Handle_t type variable (must not be null) that will be
assigned the table's handle. The table handle is required for other API calls when
accessing the data contained in the table. ∗TblHandlePtr is the handle used to
identify table to cFE when performing Table operations. This value is returned at
address specified by TblHandlePtr.
in Name The raw table name. This name will be combined with the name of the application
to produce a name of the form "AppName.RawTableName". This application
specific name will be used in commands for modifying or viewing the contents of
the table.
in Size The size, in bytes, of the table to be created (must not be zero). This is the size
that will be allocated as a shared memory resource between the Table
Management Service and the calling application.

Generated by Doxygen
258

Parameters

in TblOptionFlags Flag bits indicating selected options for table. A bitwise OR of the following option
flags:

• CFE_TBL_OPT_DEFAULT - The default setting for table options is a

combination of CFE_TBL_OPT_SNGL_BUFFER and
CFE_TBL_OPT_LOAD_DUMP. See below for a description of these two
options. This option is mutually exclusive with the
CFE_TBL_OPT_DBL_BUFFER, CFE_TBL_OPT_DUMP_ONLY and
CFE_TBL_OPT_USR_DEF_ADDR options.

• CFE_TBL_OPT_SNGL_BUFFER - When this option is selected, the table

will use a shared session table for performing table modifications and a
memory copy from the session table to the "active" table buffer will occur
when the table is updated. This is the preferred option since it will minimize
memory usage. This option is mutually exclusive with the
CFE_TBL_OPT_DBL_BUFFER option

• CFE_TBL_OPT_DBL_BUFFER - When this option is selected, two

instances of the table are created. One is considered the "active" table and
the other the "inactive" table. Whenever table modifications occur, they do
not require the use of a common session table. Modifications occur in the
"inactive" buffer. Then, when it is time to update the table, the pointer to the
"active" table is changed to point to the "inactive" buffer thus making it the
new "active" buffer. This feature is most useful for time critical applications
(ie - interrupt service routines, etc). This option is mutually exclusive with the
CFE_TBL_OPT_SNGL_BUFFER and CFE_TBL_OPT_DEFAULT option.

• CFE_TBL_OPT_LOAD_DUMP - When this option is selected, the Table

Service is allowed to perform all operations on the specified table. This
option is mutually exclusive with the CFE_TBL_OPT_DUMP_ONLY option.

• CFE_TBL_OPT_DUMP_ONLY - When this option is selected, the Table

Service will not perform table loads to this table. This does not prevent,
however, a task from writing to the table via an address obtained with the
CFE_TBL_GetAddress API function. This option is mutually exclusive with
the CFE_TBL_OPT_LOAD_DUMP and CFE_TBL_OPT_DEFAULT options.
If the Application wishes to specify their own block of memory as the Dump
Only table, they need to also include the CFE_TBL_OPT_USR_DEF_ADDR
option explained below.

• CFE_TBL_OPT_NOT_USR_DEF - When this option is selected, Table

Services allocates memory for the table and, in the case of a double
buffered table, it allocates the same amount of memory again for the second
buffer. This option is mutually exclusive with the
CFE_TBL_OPT_USR_DEF_ADDR option.

• CFE_TBL_OPT_USR_DEF_ADDR- When this option is selected, the Table

Service will not allocate memory for the table. Table Services will require the
Application to identify the location of the active table buffer via the
CFE_TBL_Load function. This option implies the
CFE_TBL_OPT_DUMP_ONLY and the CFE_TBL_OPT_SNGL_BUFFER
options and is mutually exclusive of the CFE_TBL_OPT_DBL_BUFFER
option.

• CFE_TBL_OPT_CRITICAL- When this option is selected, the Table Service

will automatically allocate space in the Critical Data Store (CDS) for the
table and ensure that the contents in the CDS are the same as the contents
of the currently active buffer for the table. This option is mutually exclusive of
Generated by Doxygen
the CFE_TBL_OPT_USR_DEF_ADDR and CFE_TBL_OPT_DUMP_ONLY
options. It should also be noted that the use of this option with double
buffered tables will prevent the update of the double buffered table from
9.31 cFE Registration APIs 259

Parameters

in TblValidationFuncPtr is a pointer to a function that will be executed in the context of the Table
Management Service when the contents of a table need to be validated. If set to
NULL, then the Table Management Service will assume any data is valid. If the
value is not NULL, it must be a pointer to a function with the following prototype:
int32 CallbackFunc(void ∗TblPtr);
where
TblPtr will be a pointer to the table data that is to be verified. When the function
returns CFE_SUCCESS, the data is considered valid and ready for a commit.
When the function returns a negative value, the data is considered invalid and an
Event Message will be issued containing the returned value. If the function should
return a positive number, the table is considered invalid and the return code is
considered invalid. Validation functions must return either CFE_SUCCESS or a
negative number (whose value is at the developer's discretion). The validation
function will be executed in the Application's context so that Event Messages
describing the validation failure are possible from within the function.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_RECOVERED_TBL Recovered Table.
CFE_TBL_ERR_DUPLICATE_DIFF_SIZE Duplicate Table With Different Size.
CFE_TBL_ERR_DUPLICATE_NOT_OWNED Duplicate Table And Not Owned.
CFE_TBL_ERR_REGISTRY_FULL Registry Full.
CFE_TBL_ERR_HANDLES_FULL Handles Full.
CFE_TBL_ERR_INVALID_SIZE Invalid Size.
CFE_TBL_ERR_INVALID_NAME Invalid Name.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_BAD_ARGUMENT Bad Argument.
CFE_TBL_ERR_INVALID_OPTIONS Invalid Options.
CFE_TBL_WARN_DUPLICATE Duplicate Warning.
CFE_TBL_WARN_NOT_CRITICAL Not Critical Warning.

See also

CFE_TBL_Unregister, CFE_TBL_Share

9.31.2.2 CFE_TBL_Share() CFE_Status_t CFE_TBL_Share (

CFE_TBL_Handle_t ∗ TblHandlePtr,
const char ∗ TblName )
Obtain handle of table registered by another application.

Generated by Doxygen
260

Description

After a table has been created, other applications can gain access to that table via the table handle. In order for
two or more applications to share a table, the applications that do not create the table must obtain the handle using
this function.

Assumptions, External Events, and Notes:

None

Parameters

out TblHandlePtr A pointer to a CFE_TBL_Handle_t type variable (must not be null) that will be assigned
the table's handle. The table handle is required for other API calls when accessing the
data contained in the table. ∗TblHandlePtr is the handle used to identify table to cFE when
performing Table operations. This value is returned at the address specified by
TblHandlePtr.
in TblName The application specific name of the table of the form "AppName.RawTableName", where
RawTableName is the name specified in the CFE_TBL_Register API call. Example:
"ACS.TamParams" for a table called "TamParams" that was registered by the application
called "ACS".

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_ERR_HANDLES_FULL Handles Full.
CFE_TBL_ERR_INVALID_NAME Invalid Name.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_BAD_ARGUMENT Bad Argument.

See also

CFE_TBL_Unregister, CFE_TBL_Register

9.31.2.3 CFE_TBL_Unregister() CFE_Status_t CFE_TBL_Unregister (

CFE_TBL_Handle_t TblHandle )
Unregister a table.
Description

When an application is being removed from the system, ES will clean up/free all the application related resources
including tables so apps are not required to call this function.

A valid use-case for this API is to unregister a shared table if access is no longer needed or the owning application was
removed from the system (CS app is an example).
Typically apps should only register tables during initialization and registration/unregistration by the owning application
during operation should be avoided. If unavoidable, special care needs to be taken (especially for shared tables) to
avoid race conditions due to competing requests from multiple tasks.

Generated by Doxygen
9.31 cFE Registration APIs 261

Note the table will not be removed from memory until all table access links have been removed (registration and all
shared access).

Assumptions, External Events, and Notes:

None

Parameters

in TblHandle Handle, previously obtained from CFE_TBL_Register or CFE_TBL_Share, that identifies the
Table to be unregistered.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.

See also

CFE_TBL_Share, CFE_TBL_Register

Generated by Doxygen
262

9.32 cFE Manage Table Content APIs

Functions

• CFE_Status_t CFE_TBL_Load (CFE_TBL_Handle_t TblHandle, CFE_TBL_SrcEnum_t SrcType, const void

∗SrcDataPtr)
Load a specified table with data from specified source.
• CFE_Status_t CFE_TBL_Update (CFE_TBL_Handle_t TblHandle)
Update contents of a specified table, if an update is pending.
• CFE_Status_t CFE_TBL_Validate (CFE_TBL_Handle_t TblHandle)
Perform steps to validate the contents of a table image.
• CFE_Status_t CFE_TBL_Manage (CFE_TBL_Handle_t TblHandle)
Perform standard operations to maintain a table.
• CFE_Status_t CFE_TBL_DumpToBuffer (CFE_TBL_Handle_t TblHandle)
Copies the contents of a Dump Only Table to a shared buffer.
• CFE_Status_t CFE_TBL_Modified (CFE_TBL_Handle_t TblHandle)
Notify cFE Table Services that table contents have been modified by the Application.

9.32.1 Detailed Description

9.32.2 Function Documentation

9.32.2.1 CFE_TBL_DumpToBuffer() CFE_Status_t CFE_TBL_DumpToBuffer (

CFE_TBL_Handle_t TblHandle )
Copies the contents of a Dump Only Table to a shared buffer.

Description

Typically, apps should just call CFE_TBL_Manage as part of routine processing which will perform validation,
update, or dump if pending. This API is provided for the case where just a dump should be performed.

Assumptions, External Events, and Notes:

If the table does not have a dump pending status, nothing will occur (no error, no dump)

Parameters

in TblHandle Handle of Table to be dumped.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.
CFE_TBL_INFO_DUMP_PENDING Dump Pending.

Generated by Doxygen
9.32 cFE Manage Table Content APIs 263

See also

CFE_TBL_Manage

9.32.2.2 CFE_TBL_Load() CFE_Status_t CFE_TBL_Load (

CFE_TBL_Handle_t TblHandle,
CFE_TBL_SrcEnum_t SrcType,
const void ∗ SrcDataPtr )
Load a specified table with data from specified source.

Description

Once an application has created a table (CFE_TBL_Register), it must provide the values that initialize the contents
of that table. The application accomplishes this with one of two different TBL API calls. This function call initializes
the table with values that are held in a data structure.

Assumptions, External Events, and Notes:

This function call can block. Therefore, interrupt service routines should NOT initialize their own tables. An
application should initialize any table(s) prior to providing the handle(s) to the interrupt service routine.

Parameters

in TblHandle Handle, previously obtained from CFE_TBL_Register or CFE_TBL_Share, that identifies the
Table to be loaded.
in SrcType Flag indicating the nature of the given SrcDataPtr below. This value can be any one of the
following:

• CFE_TBL_SRC_FILE - File source When this option is selected, the SrcDataPtr

will be interpreted as a pointer to a null terminated character string. The string should
specify the full path and filename of the file containing the initial data contents of the
table.

• CFE_TBL_SRC_ADDRESS - Address source When this option is selected, the

SrcDataPtr will be interpreted as a pointer to a memory location that is the
beginning of the initialization data for loading the table OR, in the case of a "user
defined" dump only table, the address of the active table itself. The block of memory is
assumed to be of the same size specified in the CFE_TBL_Register function Size
parameter.

in SrcDataPtr Pointer (must not be null) to either a character string specifying a filename or a memory
address of a block of binary data to be loaded into a table or, if the table was registered with
the CFE_TBL_OPT_USR_DEF_ADDR option, the address of the active table buffer.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.

Generated by Doxygen
264

Return values

CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.

CFE_TBL_ERR_DUMP_ONLY Dump Only Error.
CFE_TBL_ERR_ILLEGAL_SRC_TYPE Illegal Source Type.
CFE_TBL_ERR_LOAD_IN_PROGRESS Load In Progress.
CFE_TBL_ERR_LOAD_INCOMPLETE Load Incomplete.
CFE_TBL_ERR_NO_BUFFER_AVAIL No Buffer Available.
CFE_TBL_ERR_ACCESS
CFE_TBL_ERR_FILE_TOO_LARGE File Too Large.
CFE_TBL_ERR_BAD_CONTENT_ID Bad Content ID.
CFE_TBL_ERR_BAD_SUBTYPE_ID Bad Subtype ID.
CFE_TBL_ERR_NO_STD_HEADER No Standard Header.
CFE_TBL_ERR_NO_TBL_HEADER No Table Header.
CFE_TBL_ERR_PARTIAL_LOAD Partial Load Error.
CFE_TBL_BAD_ARGUMENT Bad Argument.

See also

CFE_TBL_Update, CFE_TBL_Validate, CFE_TBL_Manage

9.32.2.3 CFE_TBL_Manage() CFE_Status_t CFE_TBL_Manage (

CFE_TBL_Handle_t TblHandle )
Perform standard operations to maintain a table.

Description

Applications should call this API periodically to process pending requests for update, validation, or dump to buffer.
Typically, the application that created the table would call this function at the start or conclusion of any routine
processing cycle.

Assumptions, External Events, and Notes:

None

Parameters

in TblHandle Handle, previously obtained from CFE_TBL_Register or CFE_TBL_Share, that identifies the
Table to be managed.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_UPDATED Updated.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.

Generated by Doxygen
9.32 cFE Manage Table Content APIs 265

Return values

CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.
CFE_TBL_INFO_DUMP_PENDING Dump Pending.
CFE_TBL_INFO_UPDATE_PENDING Update Pending.
CFE_TBL_INFO_VALIDATION_PENDING

See also

CFE_TBL_Update, CFE_TBL_Validate, CFE_TBL_Load, CFE_TBL_DumpToBuffer

9.32.2.4 CFE_TBL_Modified() CFE_Status_t CFE_TBL_Modified (

CFE_TBL_Handle_t TblHandle )
Notify cFE Table Services that table contents have been modified by the Application.

Description

This API notifies Table Services that the contents of the specified table has been modified by the Application. This
notification is important when a table has been registered as "Critical" because Table Services can then update
the contents of the table kept in the Critical Data Store.

Assumptions, External Events, and Notes:

None

Parameters

in TblHandle Handle of Table that was modified.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.

See also

CFE_TBL_Manage

9.32.2.5 CFE_TBL_Update() CFE_Status_t CFE_TBL_Update (

CFE_TBL_Handle_t TblHandle )
Update contents of a specified table, if an update is pending.

Generated by Doxygen
266

Description

Typically, apps should just call CFE_TBL_Manage as part of routine processing which will perform validation,
update, or dump if pending. This API is provided for the case where just an update should be performed.

Assumptions, External Events, and Notes:

None

Parameters

in TblHandle Handle, previously obtained from CFE_TBL_Register or CFE_TBL_Share, that identifies the
Table to be updated.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_NO_UPDATE_PENDING No Update Pending.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.

See also

CFE_TBL_Load, CFE_TBL_Validate, CFE_TBL_Manage

9.32.2.6 CFE_TBL_Validate() CFE_Status_t CFE_TBL_Validate (

CFE_TBL_Handle_t TblHandle )
Perform steps to validate the contents of a table image.

Description

Typically, apps should just call CFE_TBL_Manage as part of routine processing which will perform validation,
update, or dump if pending. This API is provided for the case where just a validation should be performed.

Assumptions, External Events, and Notes:

None

Parameters

in TblHandle Handle, previously obtained from CFE_TBL_Register or CFE_TBL_Share, that identifies the
Table to be managed.

Generated by Doxygen
9.32 cFE Manage Table Content APIs 267

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_NO_VALIDATION_PENDING
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.

See also

CFE_TBL_Update, CFE_TBL_Manage, CFE_TBL_Load

Generated by Doxygen
268

9.33 cFE Access Table Content APIs

Functions

• CFE_Status_t CFE_TBL_GetAddress (void ∗∗TblPtr, CFE_TBL_Handle_t TblHandle)

Obtain the current address of the contents of the specified table.
• CFE_Status_t CFE_TBL_ReleaseAddress (CFE_TBL_Handle_t TblHandle)
Release previously obtained pointer to the contents of the specified table.
• CFE_Status_t CFE_TBL_GetAddresses (void ∗∗TblPtrs[ ], uint16 NumTables, const CFE_TBL_Handle_t Tbl←-
Handles[ ])
Obtain the current addresses of an array of specified tables.
• CFE_Status_t CFE_TBL_ReleaseAddresses (uint16 NumTables, const CFE_TBL_Handle_t TblHandles[ ])
Release the addresses of an array of specified tables.

9.33.1 Detailed Description

9.33.2 Function Documentation

9.33.2.1 CFE_TBL_GetAddress() CFE_Status_t CFE_TBL_GetAddress (

void ∗∗ TblPtr,
CFE_TBL_Handle_t TblHandle )
Obtain the current address of the contents of the specified table.

Description

When a table has been created and initialized, it is available to any application that can identify it with its
unique handle. In order to view the data contained in the table, an application must call this function or
CFE_TBL_GetAddresses.

Assumptions, External Events, and Notes:

1. This call can be a blocking call when the table is not double buffered and is shared with another application
of lower priority that just happens to be in the middle of a table update of the specific table. If this occurs,
the application performing the table update will automatically have its priority elevated in order to release the
resource as soon as possible.
2. An application must always release the returned table address using the CFE_TBL_ReleaseAddress or
CFE_TBL_ReleaseAddresses function prior to either a CFE_TBL_Update call or any blocking call (e.g. -
pending on software bus message, etc). Table updates cannot occur while table addresses have not been
released.
3. CFE_TBL_ERR_NEVER_LOADED will be returned if the table has never been loaded (either from file or
from a block of memory), but the function will still return a valid table pointer to a table with all zero content.
This pointer must be released with the CFE_TBL_ReleaseAddress API before the table can be loaded with
data.

Parameters

out TblPtr The address of a pointer (must not be null) that will be loaded with the address of the first
byte of the table. This pointer can then be typecast by the calling application to the
appropriate table data structure. ∗TblPtr is the address of the first byte of data associated
with the specified table.
in TblHandle Handle, previously obtained from CFE_TBL_Register or CFE_TBL_Share, that identifies the
Table whose address is to be returned.

Generated by Doxygen
9.33 cFE Access Table Content APIs 269

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_UPDATED Updated.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.
CFE_TBL_ERR_UNREGISTERED Unregistered.
CFE_TBL_ERR_NEVER_LOADED Never Loaded.
CFE_TBL_BAD_ARGUMENT Bad Argument.

See also

CFE_TBL_ReleaseAddress, CFE_TBL_GetAddresses, CFE_TBL_ReleaseAddresses

9.33.2.2 CFE_TBL_GetAddresses() CFE_Status_t CFE_TBL_GetAddresses (

void ∗∗ TblPtrs[ ],
uint16 NumTables,
const CFE_TBL_Handle_t TblHandles[ ] )
Obtain the current addresses of an array of specified tables.

Description

When a table has been created and initialized, it is available to any application that can identify it with its
unique handle. In order to view the data contained in the table, an application must call this function or
CFE_TBL_GetAddress.

Assumptions, External Events, and Notes:

1. This call can be a blocking call when the table is not double buffered and is shared with another application
of lower priority that just happens to be in the middle of a table update of the specific table. If this occurs,
the application performing the table update will automatically have its priority elevated in order to release the
resource as soon as possible.
2. An application must always release the returned table address using the CFE_TBL_ReleaseAddress or
CFE_TBL_ReleaseAddresses function prior to either a CFE_TBL_Update call or any blocking call (e.g. -
pending on software bus message, etc). Table updates cannot occur while table addresses have not been
released.
3. CFE_TBL_ERR_NEVER_LOADED will be returned if the table has never been loaded (either from file or
from a block of memory), but the function will still return a valid table pointer to a table with all zero content.
This pointer must be released with the CFE_TBL_ReleaseAddress API before the table can be loaded with
data.

Parameters

out TblPtrs Array of Pointers (must not be null) to variables that calling Application wishes to hold the
start addresses of the Tables. ∗TblPtrs is an array of addresses of the first byte of data
associated with the specified tables.

Generated by Doxygen
270

Parameters

in NumTables Size of TblPtrs and TblHandles arrays.

in TblHandles Array of Table Handles, previously obtained from CFE_TBL_Register or CFE_TBL_Share,
of those tables whose start addresses are to be obtained.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_UPDATED Updated.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.
CFE_TBL_ERR_UNREGISTERED Unregistered.
CFE_TBL_ERR_NEVER_LOADED Never Loaded.
CFE_TBL_BAD_ARGUMENT Bad Argument.

See also

CFE_TBL_GetAddress, CFE_TBL_ReleaseAddress, CFE_TBL_ReleaseAddresses

9.33.2.3 CFE_TBL_ReleaseAddress() CFE_Status_t CFE_TBL_ReleaseAddress (

CFE_TBL_Handle_t TblHandle )
Release previously obtained pointer to the contents of the specified table.

Description

Each application is required to release a table address obtained through the CFE_TBL_GetAddress function.

Assumptions, External Events, and Notes:

An application must always release the returned table address using the CFE_TBL_ReleaseAddress function prior
to either a CFE_TBL_Update call or any blocking call (e.g. - pending on software bus message, etc). Table updates
cannot occur while table addresses have not been released.

Parameters

in TblHandle Handle, previously obtained from CFE_TBL_Register or CFE_TBL_Share, that identifies the
Table whose address is to be released.

Returns

Execution status, see cFE Return Code Defines

Generated by Doxygen
9.33 cFE Access Table Content APIs 271

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_UPDATED Updated.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.
CFE_TBL_ERR_NEVER_LOADED Never Loaded.

See also

CFE_TBL_GetAddress, CFE_TBL_GetAddresses, CFE_TBL_ReleaseAddresses

9.33.2.4 CFE_TBL_ReleaseAddresses() CFE_Status_t CFE_TBL_ReleaseAddresses (

uint16 NumTables,
const CFE_TBL_Handle_t TblHandles[ ] )
Release the addresses of an array of specified tables.

Description

Each application is required to release a table address obtained through the CFE_TBL_GetAddress function.

Assumptions, External Events, and Notes:

An application must always release the returned table address using the CFE_TBL_ReleaseAddress function prior
to either a CFE_TBL_Update call or any blocking call (e.g. - pending on software bus message, etc). Table updates
cannot occur while table addresses have not been released.

Parameters

in NumTables Size of TblHandles array.

in TblHandles Array of Table Handles (must not be null), previously obtained from CFE_TBL_Register or
CFE_TBL_Share, of those tables whose start addresses are to be released.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_UPDATED Updated.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.
CFE_TBL_ERR_NEVER_LOADED Never Loaded.
CFE_TBL_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
272

See also

CFE_TBL_GetAddress, CFE_TBL_ReleaseAddress, CFE_TBL_GetAddresses

Generated by Doxygen
9.34 cFE Get Table Information APIs 273

9.34 cFE Get Table Information APIs

Functions

• CFE_Status_t CFE_TBL_GetStatus (CFE_TBL_Handle_t TblHandle)

Obtain current status of pending actions for a table.
• CFE_Status_t CFE_TBL_GetInfo (CFE_TBL_Info_t ∗TblInfoPtr, const char ∗TblName)
Obtain characteristics/information of/about a specified table.
• CFE_Status_t CFE_TBL_NotifyByMessage (CFE_TBL_Handle_t TblHandle, CFE_SB_MsgId_t MsgId,
CFE_MSG_FcnCode_t CommandCode, uint32 Parameter)
Instruct cFE Table Services to notify Application via message when table requires management.

9.34.1 Detailed Description

9.34.2 Function Documentation

9.34.2.1 CFE_TBL_GetInfo() CFE_Status_t CFE_TBL_GetInfo (

CFE_TBL_Info_t ∗ TblInfoPtr,
const char ∗ TblName )
Obtain characteristics/information of/about a specified table.

Description

This API provides the registry information associated with the specified table. The function fills the given data
structure with the data found in the Table Registry.

Assumptions, External Events, and Notes:

None

Parameters

out TblInfoPtr A pointer to a CFE_TBL_Info_t data structure (must not be null) that is to be populated with
table characteristics and information. ∗TblInfoPtr is the description of the tables
characteristics and registry information stored in the CFE_TBL_Info_t data structure format.
in TblName The application specific name (must not be null) of the table of the form
"AppName.RawTableName", where RawTableName is the name specified in the
CFE_TBL_Register API call. Example: "ACS.TamParams" for a table called "TamParams"
that was registered by the application called "ACS".

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_ERR_INVALID_NAME Invalid Name.
CFE_TBL_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
274

See also

CFE_TBL_GetStatus

9.34.2.2 CFE_TBL_GetStatus() CFE_Status_t CFE_TBL_GetStatus (

CFE_TBL_Handle_t TblHandle )
Obtain current status of pending actions for a table.

Description

An application is required to perform a periodic check for an update or a validation request for all the tables that
it creates. Typically, the application that created the table would call this function at the start or conclusion of any
routine processing cycle. If a table update or validation request is pending, the Application should follow up with a
call to CFE_TBL_Update or CFE_TBL_Validate respectively.

Assumptions, External Events, and Notes:

None

Parameters

in TblHandle Handle, previously obtained from CFE_TBL_Register or CFE_TBL_Share, that identifies the
Table to be managed.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TBL_INFO_UPDATE_PENDING Update Pending.
CFE_TBL_INFO_VALIDATION_PENDING
CFE_TBL_INFO_DUMP_PENDING Dump Pending.
CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.

Note

Some status return codes are "success" while being non-zero. This behavior will change in the future.

See also

CFE_TBL_Manage, CFE_TBL_Update, CFE_TBL_Validate, CFE_TBL_GetInfo

9.34.2.3 CFE_TBL_NotifyByMessage() CFE_Status_t CFE_TBL_NotifyByMessage (

CFE_TBL_Handle_t TblHandle,
CFE_SB_MsgId_t MsgId,

Generated by Doxygen
9.34 cFE Get Table Information APIs 275

CFE_MSG_FcnCode_t CommandCode,
uint32 Parameter )
Instruct cFE Table Services to notify Application via message when table requires management.

Description

This API instructs Table Services to send a message to the calling Application whenever the specified table re-
quires management by the application. This feature allows applications to avoid polling table services via the
CFE_TBL_Manage call to determine whether a table requires updates, validation, etc. This API should be called
following the CFE_TBL_Register API whenever the owning application requires this feature.

Assumptions, External Events, and Notes:

• Only the application that owns the table is allowed to register a notification message
• Recommend NOT using the ground command MID which typically impacts command counters. The typical
approach is to use a unique MID for inter-task communications similar to how schedulers typically trigger
application housekeeping messages.

Parameters

in TblHandle Handle of Table with which the message should be associated.

in MsgId Message ID to be used in notification message sent by Table Services.
in CommandCode Command Code value to be placed in secondary header of message sent by Table
Services.
in Parameter Application defined value to be passed as a parameter in the message sent by Table
Services. Suggested use includes an application's table index that allows the same
MsgId and Command Code to be used for all table management notifications.

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_ES_ERR_RESOURCEID_NOT_VALID Resource ID is not valid.
CFE_TBL_ERR_NO_ACCESS No Access.
CFE_TBL_ERR_INVALID_HANDLE Invalid Handle.

See also

CFE_TBL_Register

Generated by Doxygen
276

9.35 cFE Table Type Defines

Macros

• #define CFE_TBL_OPT_BUFFER_MSK (0x0001)

Table buffer mask.
• #define CFE_TBL_OPT_SNGL_BUFFER (0x0000)
Single buffer table.
• #define CFE_TBL_OPT_DBL_BUFFER (0x0001)
Double buffer table.
• #define CFE_TBL_OPT_LD_DMP_MSK (0x0002)
Table load/dump mask.
• #define CFE_TBL_OPT_LOAD_DUMP (0x0000)
Load/Dump table.
• #define CFE_TBL_OPT_DUMP_ONLY (0x0002)
Dump only table.
• #define CFE_TBL_OPT_USR_DEF_MSK (0x0004)
Table user defined mask.
• #define CFE_TBL_OPT_NOT_USR_DEF (0x0000)
Not user defined table.
• #define CFE_TBL_OPT_USR_DEF_ADDR (0x0006)
User Defined table,.
• #define CFE_TBL_OPT_CRITICAL_MSK (0x0008)
Table critical mask.
• #define CFE_TBL_OPT_NOT_CRITICAL (0x0000)
Not critical table.
• #define CFE_TBL_OPT_CRITICAL (0x0008)
Critical table.
• #define CFE_TBL_OPT_DEFAULT (CFE_TBL_OPT_SNGL_BUFFER | CFE_TBL_OPT_LOAD_DUMP)
Default table options.

9.35.1 Detailed Description

9.35.2 Macro Definition Documentation

9.35.2.1 CFE_TBL_OPT_BUFFER_MSK #define CFE_TBL_OPT_BUFFER_MSK (0x0001)

Table buffer mask.
Definition at line 48 of file cfe_tbl_api_typedefs.h.

9.35.2.2 CFE_TBL_OPT_CRITICAL #define CFE_TBL_OPT_CRITICAL (0x0008)

Critical table.
Definition at line 63 of file cfe_tbl_api_typedefs.h.

9.35.2.3 CFE_TBL_OPT_CRITICAL_MSK #define CFE_TBL_OPT_CRITICAL_MSK (0x0008)

Table critical mask.
Definition at line 61 of file cfe_tbl_api_typedefs.h.

Generated by Doxygen
9.35 cFE Table Type Defines 277

9.35.2.4 CFE_TBL_OPT_DBL_BUFFER #define CFE_TBL_OPT_DBL_BUFFER (0x0001)

Double buffer table.
Definition at line 50 of file cfe_tbl_api_typedefs.h.

9.35.2.5 CFE_TBL_OPT_DEFAULT #define CFE_TBL_OPT_DEFAULT (CFE_TBL_OPT_SNGL_BUFFER | CFE_TBL_OPT_LOAD_DUMP)

Default table options.
Definition at line 66 of file cfe_tbl_api_typedefs.h.

9.35.2.6 CFE_TBL_OPT_DUMP_ONLY #define CFE_TBL_OPT_DUMP_ONLY (0x0002)

Dump only table.
Definition at line 54 of file cfe_tbl_api_typedefs.h.

9.35.2.7 CFE_TBL_OPT_LD_DMP_MSK #define CFE_TBL_OPT_LD_DMP_MSK (0x0002)

Table load/dump mask.
Definition at line 52 of file cfe_tbl_api_typedefs.h.

9.35.2.8 CFE_TBL_OPT_LOAD_DUMP #define CFE_TBL_OPT_LOAD_DUMP (0x0000)

Load/Dump table.
Definition at line 53 of file cfe_tbl_api_typedefs.h.

9.35.2.9 CFE_TBL_OPT_NOT_CRITICAL #define CFE_TBL_OPT_NOT_CRITICAL (0x0000)

Not critical table.
Definition at line 62 of file cfe_tbl_api_typedefs.h.

9.35.2.10 CFE_TBL_OPT_NOT_USR_DEF #define CFE_TBL_OPT_NOT_USR_DEF (0x0000)

Not user defined table.
Definition at line 57 of file cfe_tbl_api_typedefs.h.

9.35.2.11 CFE_TBL_OPT_SNGL_BUFFER #define CFE_TBL_OPT_SNGL_BUFFER (0x0000)

Single buffer table.
Definition at line 49 of file cfe_tbl_api_typedefs.h.

9.35.2.12 CFE_TBL_OPT_USR_DEF_ADDR #define CFE_TBL_OPT_USR_DEF_ADDR (0x0006)

User Defined table,.

Note

Automatically includes CFE_TBL_OPT_DUMP_ONLY option

Definition at line 58 of file cfe_tbl_api_typedefs.h.

9.35.2.13 CFE_TBL_OPT_USR_DEF_MSK #define CFE_TBL_OPT_USR_DEF_MSK (0x0004)

Table user defined mask.
Definition at line 56 of file cfe_tbl_api_typedefs.h.

Generated by Doxygen
278

9.36 cFE Get Current Time APIs

Functions

• CFE_TIME_SysTime_t CFE_TIME_GetTime (void)

Get the current spacecraft time.
• CFE_TIME_SysTime_t CFE_TIME_GetTAI (void)
Get the current TAI (MET + SCTF) time.
• CFE_TIME_SysTime_t CFE_TIME_GetUTC (void)
Get the current UTC (MET + SCTF - Leap Seconds) time.
• CFE_TIME_SysTime_t CFE_TIME_GetMET (void)
Get the current value of the Mission Elapsed Time (MET).
• uint32 CFE_TIME_GetMETseconds (void)
Get the current seconds count of the mission-elapsed time.
• uint32 CFE_TIME_GetMETsubsecs (void)
Get the current sub-seconds count of the mission-elapsed time.

9.36.1 Detailed Description

9.36.2 Function Documentation

9.36.2.1 CFE_TIME_GetMET() CFE_TIME_SysTime_t CFE_TIME_GetMET (

void )
Get the current value of the Mission Elapsed Time (MET).

Description

This routine returns the current mission-elapsed time (MET). MET is usually derived from a hardware-based clock
that is not adjusted during normal operations. Callers of this routine should not assume that the MET return value
has any specific relationship to any ground-based time standard.

Assumptions, External Events, and Notes:

None

Returns

The current MET

See also

CFE_TIME_GetTime, CFE_TIME_GetTAI, CFE_TIME_GetUTC, CFE_TIME_GetMETseconds, CFE_TIME_GetMETsubsecs,

CFE_TIME_MET2SCTime

9.36.2.2 CFE_TIME_GetMETseconds() uint32 CFE_TIME_GetMETseconds (

void )
Get the current seconds count of the mission-elapsed time.

Description

This routine is the same as CFE_TIME_GetMET, except that it returns only the integer seconds portion of the
MET time.

Generated by Doxygen
9.36 cFE Get Current Time APIs 279

Assumptions, External Events, and Notes:

None

Returns

The current MET seconds

See also

CFE_TIME_GetTime, CFE_TIME_GetTAI, CFE_TIME_GetUTC, CFE_TIME_GetMET, CFE_TIME_GetMETsubsecs,

CFE_TIME_MET2SCTime

9.36.2.3 CFE_TIME_GetMETsubsecs() uint32 CFE_TIME_GetMETsubsecs (

void )
Get the current sub-seconds count of the mission-elapsed time.
Description

This routine is the same as CFE_TIME_GetMET, except that it returns only the integer sub-seconds portion of the
MET time. Each count is equal to 2∧ (-32) seconds.

Assumptions, External Events, and Notes:

None

Returns

The current MET sub-seconds

See also

CFE_TIME_GetTime, CFE_TIME_GetTAI, CFE_TIME_GetUTC, CFE_TIME_GetMET, CFE_TIME_GetMETseconds,

CFE_TIME_MET2SCTime

9.36.2.4 CFE_TIME_GetTAI() CFE_TIME_SysTime_t CFE_TIME_GetTAI (

void )
Get the current TAI (MET + SCTF) time.
Description

This routine returns the current TAI time to the caller. TAI is an international time standard that does not include
leap seconds. This routine should only be used in situations where TAI is absolutely required. Applications that
call CFE_TIME_GetTAI may not be portable to all missions. Maintenance of correct TAI in flight is not guaranteed
under all mission operations scenarios. To maintain re-usability across missions, most applications should be
using CFE_TIME_GetTime, rather than the specific routines for getting UTC/TAI directly.

Assumptions, External Events, and Notes:

1. The "TAI" time returned is referenced to the mission-defined time epoch, which may or may not be the same
as the standard TAI epoch.
2. Even though TAI does not include leap seconds, the time returned by this function can still jump forward or
backward without warning when the spacecraft clock is set or adjusted by operators. Applications using this
function must be able to handle these time discontinuities gracefully.

Generated by Doxygen
280

Returns

The current spacecraft time in TAI

See also

CFE_TIME_GetTime, CFE_TIME_GetUTC, CFE_TIME_GetMET, CFE_TIME_GetMETseconds, CFE_TIME_GetMETsubsecs

9.36.2.5 CFE_TIME_GetTime() CFE_TIME_SysTime_t CFE_TIME_GetTime (

void )
Get the current spacecraft time.
Description

This routine returns the current spacecraft time, which is the amount of time elapsed since the epoch as set in
mission configuration. The time returned is either TAI (no leap seconds) or UTC (including leap seconds). This
choice is made in the mission configuration file by defining either CFE_MISSION_TIME_CFG_DEFAULT_TAI or
CFE_MISSION_TIME_CFG_DEFAULT_UTC as true at compile time. To maintain re-usability across missions,
most applications should be using this function rather than the specific routines for getting UTC/TAI directly.

Assumptions, External Events, and Notes:

None

Returns

The current spacecraft time in default format

See also

CFE_TIME_GetTAI, CFE_TIME_GetUTC, CFE_TIME_GetMET, CFE_TIME_GetMETseconds, CFE_TIME_GetMETsubsecs

9.36.2.6 CFE_TIME_GetUTC() CFE_TIME_SysTime_t CFE_TIME_GetUTC (

void )
Get the current UTC (MET + SCTF - Leap Seconds) time.
Description

This routine returns the current UTC time to the caller. This routine should only be used in situations where UTC is
absolutely required. Applications that call CFE_TIME_GetUTC may not be portable to all missions. Maintenance
of correct UTC in flight is not guaranteed under all mission operations scenarios. If UTC is maintained in flight, it
will jump backwards occasionally due to leap second adjustments. To maintain re-usability across missions, most
applications should be using CFE_TIME_GetTime, rather than the specific routines for getting UTC/TAI directly.

Assumptions, External Events, and Notes:

Note: The "UTC" time returned is referenced to the mission-defined time epoch, which may or may not be the
same as the standard UTC epoch.

Returns

The current spacecraft time in UTC

See also

CFE_TIME_GetTime, CFE_TIME_GetTAI, CFE_TIME_GetMET, CFE_TIME_GetMETseconds, CFE_TIME_GetMETsubsecs

Generated by Doxygen
9.37 cFE Get Time Information APIs 281

9.37 cFE Get Time Information APIs

Functions

• CFE_TIME_SysTime_t CFE_TIME_GetSTCF (void)

Get the current value of the spacecraft time correction factor (STCF).
• int16 CFE_TIME_GetLeapSeconds (void)
Get the current value of the leap seconds counter.
• CFE_TIME_ClockState_Enum_t CFE_TIME_GetClockState (void)
Get the current state of the spacecraft clock.
• uint16 CFE_TIME_GetClockInfo (void)
Provides information about the spacecraft clock.

9.37.1 Detailed Description

9.37.2 Function Documentation

9.37.2.1 CFE_TIME_GetClockInfo() uint16 CFE_TIME_GetClockInfo (

void )
Provides information about the spacecraft clock.

Description

This routine returns information on the spacecraft clock in a bit mask.

Assumptions, External Events, and Notes:

None

Returns

Spacecraft clock information, cFE Clock State Flag Defines. To extract the information from the returned value,
the flags can be used as in the following:
if ((ReturnValue & CFE_TIME_FLAG_xxxxxx) == CFE_TIME_FLAG_xxxxxx) then the fol-
lowing definition of the CFE_TIME_FLAG_xxxxxx is true.

See also

CFE_TIME_GetSTCF, CFE_TIME_GetLeapSeconds, CFE_TIME_GetClockState

9.37.2.2 CFE_TIME_GetClockState() CFE_TIME_ClockState_Enum_t CFE_TIME_GetClockState (

void )
Get the current state of the spacecraft clock.

Description

This routine returns the spacecraft clock state. Applications that are highly dependent on valid time may want to
call this routine before taking actions based on the times returned by the various clock routines

Generated by Doxygen
282

Assumptions, External Events, and Notes:

None

Returns

The current spacecraft clock state

See also

CFE_TIME_GetSTCF, CFE_TIME_GetLeapSeconds, CFE_TIME_GetClockInfo

9.37.2.3 CFE_TIME_GetLeapSeconds() int16 CFE_TIME_GetLeapSeconds (

void )
Get the current value of the leap seconds counter.

Description

This routine returns the current value of the leap seconds counter. This is the delta seconds between international
atomic time (TAI) and universal coordinated time (UTC). There is no API provided to set or adjust leap seconds
or SCTF, those actions should be done by command only. This API is provided for applications to be able to
include leap seconds in their data products to aid in time correlation during downstream science data processing.
Note that some mission operations teams do not maintain the leap seconds count, preferring to adjust the STCF
instead. Users of this function should check with their mission ops team to see how they are planning to handle
leap seconds.

Assumptions, External Events, and Notes:

None

Returns

The current spacecraft leap seconds.

See also

CFE_TIME_GetSTCF, CFE_TIME_GetClockState, CFE_TIME_GetClockInfo

9.37.2.4 CFE_TIME_GetSTCF() CFE_TIME_SysTime_t CFE_TIME_GetSTCF (

void )
Get the current value of the spacecraft time correction factor (STCF).

Description

This routine returns the current value of the spacecraft time correction factor. This is the delta time between the
MET and the TAI time. There is no API provided to set or adjust leap seconds or SCTF, those actions should be
done by command only. This API is provided for applications to be able to include STCF in their data products to
aid in time correlation during downstream science data processing.

Assumptions, External Events, and Notes:

Does not include leap seconds

Generated by Doxygen
9.37 cFE Get Time Information APIs 283

Returns

The current SCTF

See also

CFE_TIME_GetLeapSeconds, CFE_TIME_GetClockState, CFE_TIME_GetClockInfo

Generated by Doxygen
284

9.38 cFE Time Arithmetic APIs

Functions

• CFE_TIME_SysTime_t CFE_TIME_Add (CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Time2)

Adds two time values.
• CFE_TIME_SysTime_t CFE_TIME_Subtract (CFE_TIME_SysTime_t Time1, CFE_TIME_SysTime_t Time2)
Subtracts two time values.
• CFE_TIME_Compare_t CFE_TIME_Compare (CFE_TIME_SysTime_t TimeA, CFE_TIME_SysTime_t TimeB)
Compares two time values.

9.38.1 Detailed Description

9.38.2 Function Documentation

9.38.2.1 CFE_TIME_Add() CFE_TIME_SysTime_t CFE_TIME_Add (

CFE_TIME_SysTime_t Time1,
CFE_TIME_SysTime_t Time2 )
Adds two time values.
Description

This routine adds the two specified times and returns the result. Normally, at least one of the input times should
be a value representing a delta time. Adding two absolute times together will not cause an error, but the result will
probably be meaningless.

Assumptions, External Events, and Notes:

None

Parameters

in Time1 The first time to be added.

in Time2 The second time to be added.

Returns

The sum of the two times. If the sum is greater than the maximum value that can be stored in a
CFE_TIME_SysTime_t, the result will roll over (this is not considered an error).

See also

CFE_TIME_Subtract, CFE_TIME_Compare

9.38.2.2 CFE_TIME_Compare() CFE_TIME_Compare_t CFE_TIME_Compare (

CFE_TIME_SysTime_t TimeA,
CFE_TIME_SysTime_t TimeB )
Compares two time values.

Generated by Doxygen
9.38 cFE Time Arithmetic APIs 285

Description

This routine compares two time values to see which is "greater". It is important that applications use this function
rather than trying to directly compare the component pieces of times. This function will handle roll-over cases
seamlessly, which may not be intuitively obvious. The cFE's internal representation of time "rolls over" when the
32 bit seconds count reaches 0xFFFFFFFF. Also, subtracting a delta time from an absolute time close to the
epoch could result in "roll under". The strange cases that result from these situations can be handled by defining
the comparison function for times as follows: Plot the two times on the circumference of a circle where 0 is at the
top and 0x80000000 is at the bottom. If the shortest arc from time A to time B runs clockwise around the circle,
then time A is less than time B. If the shortest arc from A to B runs counter-clockwise, then time A is greater than
time B.

Assumptions, External Events, and Notes:

None

Parameters

in TimeA The first time to compare.

in TimeB The second time to compare.

Returns

The result of comparing the two times.

Return values

CFE_TIME_EQUAL The two specified times are considered to be equal.

CFE_TIME_A_GT_B The first specified time is considered to be after the second specified time.
CFE_TIME_A_LT_B The first specified time is considered to be before the second specified time.

See also

CFE_TIME_Add, CFE_TIME_Subtract

9.38.2.3 CFE_TIME_Subtract() CFE_TIME_SysTime_t CFE_TIME_Subtract (

CFE_TIME_SysTime_t Time1,
CFE_TIME_SysTime_t Time2 )
Subtracts two time values.
Description

This routine subtracts time2 from time1 and returns the result. The time values can represent either absolute or
delta times, but not all combinations make sense.

• AbsTime - AbsTime = DeltaTime

• AbsTime - DeltaTime = AbsTime
• DeltaTime - DeltaTime = DeltaTime
• DeltaTime - AbsTime = garbage

Generated by Doxygen
286

Assumptions, External Events, and Notes:

None

Parameters
in Time1 The base time.
in Time2 The time to be subtracted from the base time.

Returns

The result of subtracting the two times. If the subtraction results in an underflow, the result will roll over (this is not
considered an error).

See also

CFE_TIME_Add, CFE_TIME_Compare

Generated by Doxygen
9.39 cFE Time Conversion APIs 287

9.39 cFE Time Conversion APIs

Functions

• CFE_TIME_SysTime_t CFE_TIME_MET2SCTime (CFE_TIME_SysTime_t METTime)

Convert specified MET into Spacecraft Time.
• uint32 CFE_TIME_Sub2MicroSecs (uint32 SubSeconds)
Converts a sub-seconds count to an equivalent number of microseconds.
• uint32 CFE_TIME_Micro2SubSecs (uint32 MicroSeconds)
Converts a number of microseconds to an equivalent sub-seconds count.

9.39.1 Detailed Description

9.39.2 Function Documentation

9.39.2.1 CFE_TIME_MET2SCTime() CFE_TIME_SysTime_t CFE_TIME_MET2SCTime (

CFE_TIME_SysTime_t METTime )
Convert specified MET into Spacecraft Time.

Description

This function returns Spacecraft Time given MET. Note that Spacecraft Time is returned as either UTC or T←-
AI depending on whether the mission configuration parameter CFE_MISSION_TIME_CFG_DEFAULT_UTC or
CFE_MISSION_TIME_CFG_DEFAULT_TAI was set to true at compile time.

Assumptions, External Events, and Notes:

None

Parameters
in METTime The MET to be converted.

Returns

Spacecraft Time (UTC or TAI) corresponding to the specified MET

See also

CFE_TIME_GetMET, CFE_TIME_GetMETseconds, CFE_TIME_GetMETsubsecs, CFE_TIME_Sub2MicroSecs,

CFE_TIME_Micro2SubSecs

9.39.2.2 CFE_TIME_Micro2SubSecs() uint32 CFE_TIME_Micro2SubSecs (

uint32 MicroSeconds )
Converts a number of microseconds to an equivalent sub-seconds count.

Description

This routine converts from microseconds (each tick is 1e-06 seconds) to a subseconds count (each tick is 1 / 2∧ 32
seconds).

Generated by Doxygen
288

Assumptions, External Events, and Notes:

None

Parameters

in MicroSeconds The sub-seconds count to convert.

Returns

The equivalent number of subseconds. If the number of microseconds passed in is greater than one second, (i.e.
> 999,999), the return value is equal to 0xffffffff.

See also

CFE_TIME_MET2SCTime, CFE_TIME_Sub2MicroSecs,

9.39.2.3 CFE_TIME_Sub2MicroSecs() uint32 CFE_TIME_Sub2MicroSecs (

uint32 SubSeconds )
Converts a sub-seconds count to an equivalent number of microseconds.

Description

This routine converts from a sub-seconds count (each tick is 1 / 2∧ 32 seconds) to microseconds (each tick is
1e-06 seconds).

Assumptions, External Events, and Notes:

None

Parameters

in SubSeconds The sub-seconds count to convert.

Returns

The equivalent number of microseconds.

See also

CFE_TIME_MET2SCTime, CFE_TIME_Micro2SubSecs,

Generated by Doxygen
9.40 cFE External Time Source APIs 289

9.40 cFE External Time Source APIs

Functions

• void CFE_TIME_ExternalTone (void)

Provides the 1 Hz signal from an external source.
• void CFE_TIME_ExternalMET (CFE_TIME_SysTime_t NewMET)
Provides the Mission Elapsed Time from an external source.
• void CFE_TIME_ExternalGPS (CFE_TIME_SysTime_t NewTime, int16 NewLeaps)
Provide the time from an external source that has data common to GPS receivers.
• void CFE_TIME_ExternalTime (CFE_TIME_SysTime_t NewTime)
Provide the time from an external source that measures time relative to a known epoch.
• CFE_Status_t CFE_TIME_RegisterSynchCallback (CFE_TIME_SynchCallbackPtr_t CallbackFuncPtr)
Registers a callback function that is called whenever time synchronization occurs.
• CFE_Status_t CFE_TIME_UnregisterSynchCallback (CFE_TIME_SynchCallbackPtr_t CallbackFuncPtr)
Unregisters a callback function that is called whenever time synchronization occurs.

9.40.1 Detailed Description

9.40.2 Function Documentation

9.40.2.1 CFE_TIME_ExternalGPS() void CFE_TIME_ExternalGPS (

CFE_TIME_SysTime_t NewTime,
int16 NewLeaps )
Provide the time from an external source that has data common to GPS receivers.
Description

This routine provides a method to provide cFE TIME with current time data acquired from an external source.
There is a presumption that this function will be called at the appropriate time (relative to the tone) such that this
call may be used by cFE TIME as the signal to generate the "time at the tone" data command. The "time at the
tone" data command must arrive within the configuration parameter specified window for tone signal and data
packet verification.

Internally, cFE TIME will calculate a new STCF as the difference between this new time value and the spacecraft
MET value at the tone. This allows cFE TIME to always calculate time as the sum of MET and STCF. The value
of STCF will change only as much as the drift factor between spacecraft MET and the external time source.

Assumptions, External Events, and Notes:

• This routine is included in the API only when 3 specific configuration parameters are set to true. The first is
CFE_PLATFORM_TIME_CFG_SERVER which defines this instantiation of cFE TIME as a time server (not
a client). The second required configuration parameter is CFE_PLATFORM_TIME_CFG_SOURCE which
enables time source selection commands to the cFE TIME task, and further enables configuration definitions
for the selected type of external time data. The third configuration parameter required for this routine is
CFE_PLATFORM_TIME_CFG_SRC_GPS, which indicates that the external time data consists of a time
value relative to a known epoch, plus a leap seconds value.

Parameters

in NewTime The MET value at the next (or previous) 1 Hz tone signal.
in NewLeaps The Leap Seconds value used to calculate time as UTC.

Generated by Doxygen
290

See also

CFE_TIME_ExternalTone, CFE_TIME_ExternalMET, CFE_TIME_ExternalTime

9.40.2.2 CFE_TIME_ExternalMET() void CFE_TIME_ExternalMET (

CFE_TIME_SysTime_t NewMET )
Provides the Mission Elapsed Time from an external source.

Description

This routine provides a method to provide cFE TIME with MET acquired from an external source. There is a
presumption that this function will be called at the appropriate time (relative to the tone) such that this call may
be used by cFE TIME as the signal to generate the "time at the tone" data command. The "time at the tone"
data command must arrive within the configuration parameter specified window for tone signal and data packet
verification.

The MET value at the tone "should" have zero subseconds. Although the interface accepts non-zero values
for sub-seconds, it may be harmful to other applications that expect zero subseconds at the moment of the tone.
Any decision to use non-zero subseconds should be carefully considered.

Assumptions, External Events, and Notes:

• This routine is included in the API only when 3 specific configuration parameters are set to true. The first is
CFE_PLATFORM_TIME_CFG_SERVER which defines this instantiation of cFE TIME as a time server (not
a client). The second required configuration parameter is CFE_PLATFORM_TIME_CFG_SOURCE which
enables time source selection commands to the cFE TIME task, and further enables configuration definitions
for the selected type of external time data. The third configuration parameter required for this routine is
CFE_PLATFORM_TIME_CFG_SRC_MET, which indicates that the external time data consists of MET.

Parameters

in NewMET The MET value at the next (or previous) 1 Hz tone signal.

See also

CFE_TIME_ExternalTone, CFE_TIME_ExternalGPS, CFE_TIME_ExternalTime

9.40.2.3 CFE_TIME_ExternalTime() void CFE_TIME_ExternalTime (

CFE_TIME_SysTime_t NewTime )
Provide the time from an external source that measures time relative to a known epoch.
Description

This routine provides a method to provide cFE TIME with current time data acquired from an external source.
There is a presumption that this function will be called at the appropriate time (relative to the tone) such that
this call may be used by cFE TIME as the signal to generate the "time at the tone" data command. The "time
at the tone" data command must arrive within the configuration specified window for tone signal and data packet
verification.

Internally, cFE TIME will calculate a new STCF as the difference between this new time value and the spacecraft
MET value at the tone. This allows cFE TIME to always calculate time as the sum of MET and STCF. The value
of STCF will change only as much as the drift factor between spacecraft MET and the external time source.

Generated by Doxygen
9.40 cFE External Time Source APIs 291

Assumptions, External Events, and Notes:

• This routine is included in the API only when 3 specific configuration parameters are set to true. The first is
CFE_PLATFORM_TIME_CFG_SERVER which defines this instantiation of cFE TIME as a time server (not
a client). The second required configuration parameter is CFE_PLATFORM_TIME_CFG_SOURCE which
enables time source selection commands to the cFE TIME task, and further enables configuration definitions
for the selected type of external time data. The third configuration parameter required for this routine is
CFE_PLATFORM_TIME_CFG_SRC_TIME, which indicates that the external time data consists of a time
value relative to a known epoch.

Parameters

in NewTime The MET value at the next (or previous) 1 Hz tone signal.

See also

CFE_TIME_ExternalTone, CFE_TIME_ExternalMET, CFE_TIME_ExternalGPS

9.40.2.4 CFE_TIME_ExternalTone() void CFE_TIME_ExternalTone (

void )
Provides the 1 Hz signal from an external source.
Description

This routine provides a method for cFE TIME software to be notified of the occurrence of the 1Hz tone signal
without knowledge of the specific hardware design. Regardless of the source of the tone, this routine should be
called as soon as possible after detection to allow cFE TIME software the opportunity to latch the local clock as
close as possible to the instant of the tone.

Assumptions, External Events, and Notes:

• This routine may be called directly from within the context of an interrupt handler.

See also

CFE_TIME_ExternalMET, CFE_TIME_ExternalGPS, CFE_TIME_ExternalTime

9.40.2.5 CFE_TIME_RegisterSynchCallback() CFE_Status_t CFE_TIME_RegisterSynchCallback (

CFE_TIME_SynchCallbackPtr_t CallbackFuncPtr )
Registers a callback function that is called whenever time synchronization occurs.
Description

This routine passes a callback function pointer for an Application that wishes to be notified whenever a legitimate
time synchronization signal (typically a 1 Hz) is received.

Assumptions, External Events, and Notes:

Only a single callback per application is supported, and this function should only be called from a single thread
within each application (typically the apps main thread). If an application requires triggering multiple child tasks at
1Hz, it should distribute the timing signal internally, rather than registering for multiple callbacks.

Generated by Doxygen
292

Parameters

in CallbackFuncPtr Function to call at synchronization interval (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TIME_TOO_MANY_SYNCH_CALLBACKS Too Many Sync Callbacks.
CFE_TIME_BAD_ARGUMENT Bad Argument.

See also

CFE_TIME_UnregisterSynchCallback

9.40.2.6 CFE_TIME_UnregisterSynchCallback() CFE_Status_t CFE_TIME_UnregisterSynchCallback (

CFE_TIME_SynchCallbackPtr_t CallbackFuncPtr )
Unregisters a callback function that is called whenever time synchronization occurs.

Description

This routine removes the specified callback function pointer from the list of Callback functions that are called
whenever a time synchronization (typically the 1Hz signal) is received.

Assumptions, External Events, and Notes:

Only a single callback per application is supported, and this function should only be called from a single thread
within each application (typically the apps main thread).

Parameters

in CallbackFuncPtr Function to remove from synchronization call list (must not be null)

Returns

Execution status, see cFE Return Code Defines

Return values

CFE_SUCCESS Successful execution.

CFE_TIME_CALLBACK_NOT_REGISTERED Callback Not Registered.
CFE_TIME_BAD_ARGUMENT Bad Argument.

Generated by Doxygen
9.40 cFE External Time Source APIs 293

See also

CFE_TIME_RegisterSynchCallback

Generated by Doxygen
294

9.41 cFE Miscellaneous Time APIs

Functions

• void CFE_TIME_Print (char ∗PrintBuffer, CFE_TIME_SysTime_t TimeToPrint)

Print a time value as a string.
• void CFE_TIME_Local1HzISR (void)
This function is called via a timer callback set up at initialization of the TIME service.

9.41.1 Detailed Description

9.41.2 Function Documentation

9.41.2.1 CFE_TIME_Local1HzISR() void CFE_TIME_Local1HzISR (

void )
This function is called via a timer callback set up at initialization of the TIME service.

Description

Drives the time processing logic from the system PSP layer. This must be called once per second based on a
hardware interrupt or OS kernel signal.

Assumptions, External Events, and Notes:

This will update the global data structures accordingly, incrementing each by the 1Hz amount.

9.41.2.2 CFE_TIME_Print() void CFE_TIME_Print (

char ∗ PrintBuffer,
CFE_TIME_SysTime_t TimeToPrint )
Print a time value as a string.

Description

This routine prints the specified time to the specified string buffer in the following format:

yyyy-ddd-hh:mm:ss.xxxxx\0

where:

• yyyy = year
• ddd = Julian day of the year
• hh = hour of the day (0 to 23)
• mm = minute (0 to 59)
• ss = second (0 to 59)
• xxxxx = subsecond formatted as a decimal fraction (1/4 second = 0.25000)
• \0 = trailing null

Generated by Doxygen
9.41 cFE Miscellaneous Time APIs 295

Assumptions, External Events, and Notes:

• The value of the time argument is simply added to the configuration definitions for the ground epoch and
converted into a fixed length string in the buffer provided by the caller.
• A loss of data during the string conversion will occur if the computed year exceeds 9999. However, a year
that large would require an unrealistic definition for the ground epoch since the maximum amount of time
represented by a CFE_TIME_SysTime structure is approximately 136 years.

Generated by Doxygen
296

Parameters

out PrintBuffer Pointer to a character array (must not be null) of at least

CFE_TIME_PRINTED_STRING_SIZE characters in length. ∗PrintBuffer is the time as a
character string as described above.
in TimeToPrint The time to print into the character array.

Generated by Doxygen
9.42 cFE Resource ID base values 297

9.42 cFE Resource ID base values

Enumerations

• enum {
CFE_RESOURCEID_ES_TASKID_BASE_OFFSET = OS_OBJECT_TYPE_OS_TASK, CFE_RESOURCEID_ES_APPID_BASE_O
= OS_OBJECT_TYPE_USER + 1, CFE_RESOURCEID_ES_LIBID_BASE_OFFSET = OS_OBJECT_TYPE_←-
USER + 2, CFE_RESOURCEID_ES_COUNTID_BASE_OFFSET = OS_OBJECT_TYPE_USER + 3,
CFE_RESOURCEID_ES_POOLID_BASE_OFFSET = OS_OBJECT_TYPE_USER + 4, CFE_RESOURCEID_ES_CDSBLOCKID_B
= OS_OBJECT_TYPE_USER + 5, CFE_RESOURCEID_SB_PIPEID_RESOURCE_BASE_OFFSET = OS_O←-
BJECT_TYPE_USER + 6, CFE_RESOURCEID_CONFIGID_BASE_OFFSET = OS_OBJECT_TYPE_USER + 7
}
• enum {
CFE_ES_TASKID_BASE = CFE_RESOURCEID_MAKE_BASE(CFE_RESOURCEID_ES_TASKID_BASE_O←-
FFSET), CFE_ES_APPID_BASE = CFE_RESOURCEID_MAKE_BASE(CFE_RESOURCEID_ES_APPID_BA←-
SE_OFFSET), CFE_ES_LIBID_BASE = CFE_RESOURCEID_MAKE_BASE(CFE_RESOURCEID_ES_LIBID←-
_BASE_OFFSET), CFE_ES_COUNTID_BASE = CFE_RESOURCEID_MAKE_BASE(CFE_RESOURCEID_E←-
S_COUNTID_BASE_OFFSET),
CFE_ES_POOLID_BASE = CFE_RESOURCEID_MAKE_BASE(CFE_RESOURCEID_ES_POOLID_BASE_O←-
FFSET), CFE_ES_CDSBLOCKID_BASE = CFE_RESOURCEID_MAKE_BASE(CFE_RESOURCEID_ES_CD←-
SBLOCKID_BASE_OFFSET), CFE_SB_PIPEID_BASE = CFE_RESOURCEID_MAKE_BASE(CFE_RESOUR←-
CEID_SB_PIPEID_RESOURCE_BASE_OFFSET), CFE_CONFIGID_BASE = CFE_RESOURCEID_MAKE_B←-
ASE(CFE_RESOURCEID_CONFIGID_BASE_OFFSET) }

9.42.1 Detailed Description

9.42.2 Enumeration Type Documentation

9.42.2.1 anonymous enum anonymous enum

Enumerator

CFE_RESOURCEID_ES_TASKID_BASE_OFFSET
CFE_RESOURCEID_ES_APPID_BASE_OFFSET
CFE_RESOURCEID_ES_LIBID_BASE_OFFSET
CFE_RESOURCEID_ES_COUNTID_BASE_OFFSET
CFE_RESOURCEID_ES_POOLID_BASE_OFFSET
CFE_RESOURCEID_ES_CDSBLOCKID_BASE_OFFSET
CFE_RESOURCEID_SB_PIPEID_RESOURCE_BASE_OFFSET
CFE_RESOURCEID_CONFIGID_BASE_OFFSET

Definition at line 48 of file cfe_core_resourceid_basevalues.h.

9.42.2.2 anonymous enum anonymous enum

Enumerator

CFE_ES_TASKID_BASE
CFE_ES_APPID_BASE
CFE_ES_LIBID_BASE
CFE_ES_COUNTID_BASE

Generated by Doxygen
298

Enumerator

CFE_ES_POOLID_BASE
CFE_ES_CDSBLOCKID_BASE
CFE_SB_PIPEID_BASE
CFE_CONFIGID_BASE

Definition at line 80 of file cfe_core_resourceid_basevalues.h.

Generated by Doxygen
9.43 cFE Clock State Flag Defines 299

9.43 cFE Clock State Flag Defines

Macros

• #define CFE_TIME_FLAG_CLKSET 0x8000

The spacecraft time has been set.
• #define CFE_TIME_FLAG_FLYING 0x4000
This instance of Time Services is flywheeling.
• #define CFE_TIME_FLAG_SRCINT 0x2000
The clock source is set to "internal".
• #define CFE_TIME_FLAG_SIGPRI 0x1000
The clock signal is set to "primary".
• #define CFE_TIME_FLAG_SRVFLY 0x0800
The Time Server is in flywheel mode.
• #define CFE_TIME_FLAG_CMDFLY 0x0400
This instance of Time Services was commanded into flywheel mode.
• #define CFE_TIME_FLAG_ADDADJ 0x0200
One time STCF Adjustment is to be done in positive direction.
• #define CFE_TIME_FLAG_ADD1HZ 0x0100
1 Hz STCF Adjustment is to be done in a positive direction
• #define CFE_TIME_FLAG_ADDTCL 0x0080
Time Client Latency is applied in a positive direction.
• #define CFE_TIME_FLAG_SERVER 0x0040
This instance of Time Services is a Time Server.
• #define CFE_TIME_FLAG_GDTONE 0x0020
The tone received is good compared to the last tone received.
• #define CFE_TIME_FLAG_REFERR 0x0010
GetReference read error, will be set if unable to get a consistent ref value.
• #define CFE_TIME_FLAG_UNUSED 0x000F
Reserved flags - should be zero.

9.43.1 Detailed Description

9.43.2 Macro Definition Documentation

9.43.2.1 CFE_TIME_FLAG_ADD1HZ #define CFE_TIME_FLAG_ADD1HZ 0x0100

1 Hz STCF Adjustment is to be done in a positive direction
Definition at line 44 of file default_cfe_time_msgdefs.h.

9.43.2.2 CFE_TIME_FLAG_ADDADJ #define CFE_TIME_FLAG_ADDADJ 0x0200

One time STCF Adjustment is to be done in positive direction.
Definition at line 43 of file default_cfe_time_msgdefs.h.

9.43.2.3 CFE_TIME_FLAG_ADDTCL #define CFE_TIME_FLAG_ADDTCL 0x0080

Time Client Latency is applied in a positive direction.
Definition at line 45 of file default_cfe_time_msgdefs.h.

Generated by Doxygen
300

9.43.2.4 CFE_TIME_FLAG_CLKSET #define CFE_TIME_FLAG_CLKSET 0x8000

The spacecraft time has been set.
Definition at line 37 of file default_cfe_time_msgdefs.h.

9.43.2.5 CFE_TIME_FLAG_CMDFLY #define CFE_TIME_FLAG_CMDFLY 0x0400

This instance of Time Services was commanded into flywheel mode.
Definition at line 42 of file default_cfe_time_msgdefs.h.

9.43.2.6 CFE_TIME_FLAG_FLYING #define CFE_TIME_FLAG_FLYING 0x4000

This instance of Time Services is flywheeling.
Definition at line 38 of file default_cfe_time_msgdefs.h.

9.43.2.7 CFE_TIME_FLAG_GDTONE #define CFE_TIME_FLAG_GDTONE 0x0020

The tone received is good compared to the last tone received.
Definition at line 47 of file default_cfe_time_msgdefs.h.

9.43.2.8 CFE_TIME_FLAG_REFERR #define CFE_TIME_FLAG_REFERR 0x0010

GetReference read error, will be set if unable to get a consistent ref value.
Definition at line 48 of file default_cfe_time_msgdefs.h.

9.43.2.9 CFE_TIME_FLAG_SERVER #define CFE_TIME_FLAG_SERVER 0x0040

This instance of Time Services is a Time Server.
Definition at line 46 of file default_cfe_time_msgdefs.h.

9.43.2.10 CFE_TIME_FLAG_SIGPRI #define CFE_TIME_FLAG_SIGPRI 0x1000

The clock signal is set to "primary".
Definition at line 40 of file default_cfe_time_msgdefs.h.

9.43.2.11 CFE_TIME_FLAG_SRCINT #define CFE_TIME_FLAG_SRCINT 0x2000

The clock source is set to "internal".
Definition at line 39 of file default_cfe_time_msgdefs.h.

9.43.2.12 CFE_TIME_FLAG_SRVFLY #define CFE_TIME_FLAG_SRVFLY 0x0800

The Time Server is in flywheel mode.
Definition at line 41 of file default_cfe_time_msgdefs.h.

9.43.2.13 CFE_TIME_FLAG_UNUSED #define CFE_TIME_FLAG_UNUSED 0x000F

Reserved flags - should be zero.
Definition at line 50 of file default_cfe_time_msgdefs.h.

Generated by Doxygen
9.44 OSAL Semaphore State Defines 301

9.44 OSAL Semaphore State Defines

Macros

• #define OS_SEM_FULL 1
Semaphore full state.
• #define OS_SEM_EMPTY 0
Semaphore empty state.

9.44.1 Detailed Description

9.44.2 Macro Definition Documentation

9.44.2.1 OS_SEM_EMPTY #define OS_SEM_EMPTY 0

Semaphore empty state.
Definition at line 35 of file osapi-binsem.h.

9.44.2.2 OS_SEM_FULL #define OS_SEM_FULL 1

Semaphore full state.
Definition at line 34 of file osapi-binsem.h.

Generated by Doxygen
302

9.45 OSAL Binary Semaphore APIs

Functions

• int32 OS_BinSemCreate (osal_id_t ∗sem_id, const char ∗sem_name, uint32 sem_initial_value, uint32 options)
Creates a binary semaphore.
• int32 OS_BinSemFlush (osal_id_t sem_id)
Unblock all tasks pending on the specified semaphore.
• int32 OS_BinSemGive (osal_id_t sem_id)
Increment the semaphore value.
• int32 OS_BinSemTake (osal_id_t sem_id)
Decrement the semaphore value.
• int32 OS_BinSemTimedWait (osal_id_t sem_id, uint32 msecs)
Decrement the semaphore value with a timeout.
• int32 OS_BinSemDelete (osal_id_t sem_id)
Deletes the specified Binary Semaphore.
• int32 OS_BinSemGetIdByName (osal_id_t ∗sem_id, const char ∗sem_name)
Find an existing semaphore ID by name.
• int32 OS_BinSemGetInfo (osal_id_t sem_id, OS_bin_sem_prop_t ∗bin_prop)
Fill a property object buffer with details regarding the resource.

9.45.1 Detailed Description

9.45.2 Function Documentation

9.45.2.1 OS_BinSemCreate() int32 OS_BinSemCreate (

osal_id_t ∗ sem_id,
const char ∗ sem_name,
uint32 sem_initial_value,
uint32 options )
Creates a binary semaphore.
Creates a binary semaphore with initial value specified by sem_initial_value and name specified by sem_name. sem_id
will be returned to the caller

Parameters

out sem_id will be set to the non-zero ID of the newly-created resource (must not be null)
in sem_name the name of the new resource to create (must not be null)
in sem_initial_value the initial value of the binary semaphore
in options Reserved for future use, should be passed as 0.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if sen name or sem_id are NULL

Generated by Doxygen
9.45 OSAL Binary Semaphore APIs 303

Return values

OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME

OS_ERR_NO_FREE_IDS if all of the semaphore ids are taken
OS_ERR_NAME_TAKEN if this is already the name of a binary semaphore
OS_SEM_FAILURE if the OS call failed (return value only verified in coverage test)

9.45.2.2 OS_BinSemDelete() int32 OS_BinSemDelete (

osal_id_t sem_id )
Deletes the specified Binary Semaphore.
This is the function used to delete a binary semaphore in the operating system. This also frees the respective sem_id
to be used again when another semaphore is created.

Parameters
in sem←- The object ID to delete
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid binary semaphore
OS_SEM_FAILURE if an unspecified failure occurs (return value only verified in coverage test)

9.45.2.3 OS_BinSemFlush() int32 OS_BinSemFlush (

osal_id_t sem_id )
Unblock all tasks pending on the specified semaphore.
The function unblocks all tasks pending on the specified semaphore. However, this function does not change the state
of the semaphore.

Parameters
in sem←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

Generated by Doxygen
304

Return values

OS_ERR_INVALID_ID if the id passed in is not a binary semaphore

OS_SEM_FAILURE if an unspecified failure occurs (return value only verified in coverage test)

9.45.2.4 OS_BinSemGetIdByName() int32 OS_BinSemGetIdByName (

osal_id_t ∗ sem_id,
const char ∗ sem_name )
Find an existing semaphore ID by name.
This function tries to find a binary sem Id given the name of a bin_sem The id is returned through sem_id

Parameters

out sem_id will be set to the ID of the existing resource

in sem_name the name of the existing resource to find (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER is semid or sem_name are NULL pointers
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_NOT_FOUND if the name was not found in the table

9.45.2.5 OS_BinSemGetInfo() int32 OS_BinSemGetInfo (

osal_id_t sem_id,
OS_bin_sem_prop_t ∗ bin_prop )
Fill a property object buffer with details regarding the resource.
This function will pass back a pointer to structure that contains all of the relevant info( name and creator) about the
specified binary semaphore.

Parameters
in sem_id The object ID to operate on
out bin_prop The property object buffer to fill (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

Generated by Doxygen
9.45 OSAL Binary Semaphore APIs 305

Return values

OS_ERR_INVALID_ID if the id passed in is not a valid semaphore

OS_INVALID_POINTER if the bin_prop pointer is null
OS_ERR_NOT_IMPLEMENTED Not implemented.

9.45.2.6 OS_BinSemGive() int32 OS_BinSemGive (

osal_id_t sem_id )
Increment the semaphore value.
The function unlocks the semaphore referenced by sem_id by performing a semaphore unlock operation on that
semaphore. If the semaphore value resulting from this operation is positive, then no threads were blocked waiting
for the semaphore to become unlocked; the semaphore value is simply incremented for this semaphore.

Parameters
in sem←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a binary semaphore
OS_SEM_FAILURE if an unspecified failure occurs (return value only verified in coverage test)

9.45.2.7 OS_BinSemTake() int32 OS_BinSemTake (

osal_id_t sem_id )
Decrement the semaphore value.
The locks the semaphore referenced by sem_id by performing a semaphore lock operation on that semaphore. If the
semaphore value is currently zero, then the calling thread shall not return from the call until it either locks the semaphore
or the call is interrupted.

Parameters
in sem←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

Generated by Doxygen
306

Return values

OS_ERR_INVALID_ID the Id passed in is not a valid binary semaphore

OS_SEM_FAILURE if an unspecified failure occurs (return value only verified in coverage test)

9.45.2.8 OS_BinSemTimedWait() int32 OS_BinSemTimedWait (

osal_id_t sem_id,
uint32 msecs )
Decrement the semaphore value with a timeout.
The function locks the semaphore referenced by sem_id. However, if the semaphore cannot be locked without waiting
for another process or thread to unlock the semaphore, this wait shall be terminated when the specified timeout, msecs,
expires.

Parameters
in sem←- The object ID to operate on
_id
in msecs The maximum amount of time to block, in milliseconds

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_SEM_TIMEOUT if semaphore was not relinquished in time
OS_ERR_INVALID_ID if the ID passed in is not a valid semaphore ID
OS_SEM_FAILURE if an unspecified failure occurs (return value only verified in coverage test)

Generated by Doxygen
9.46 OSAL BSP low level access APIs 307

9.46 OSAL BSP low level access APIs

These are for OSAL internal BSP information access to pass any BSP-specific boot/command line/startup arguments
through to the application, and return a status code back to the OS after exit.

Functions

• void OS_BSP_SetResourceTypeConfig (uint32 ResourceType, uint32 ConfigOptionValue)

• uint32 OS_BSP_GetResourceTypeConfig (uint32 ResourceType)
• uint32 OS_BSP_GetArgC (void)
• char ∗const ∗ OS_BSP_GetArgV (void)
• void OS_BSP_SetExitCode (int32 code)

9.46.1 Detailed Description

These are for OSAL internal BSP information access to pass any BSP-specific boot/command line/startup arguments
through to the application, and return a status code back to the OS after exit.
Not intended for user application use

9.46.2 Function Documentation

9.46.2.1 OS_BSP_GetArgC() uint32 OS_BSP_GetArgC (

void )

9.46.2.2 OS_BSP_GetArgV() char∗ const ∗ OS_BSP_GetArgV (

void )

9.46.2.3 OS_BSP_GetResourceTypeConfig() uint32 OS_BSP_GetResourceTypeConfig (

uint32 ResourceType )

9.46.2.4 OS_BSP_SetExitCode() void OS_BSP_SetExitCode (

int32 code )

9.46.2.5 OS_BSP_SetResourceTypeConfig() void OS_BSP_SetResourceTypeConfig (

uint32 ResourceType,
uint32 ConfigOptionValue )

Generated by Doxygen
308

9.47 OSAL Real Time Clock APIs

Functions

• int32 OS_GetLocalTime (OS_time_t ∗time_struct)

Get the local time.
• int32 OS_SetLocalTime (const OS_time_t ∗time_struct)
Set the local time.
• static int64 OS_TimeGetTotalSeconds (OS_time_t tm)
Get interval from an OS_time_t object normalized to whole number of seconds.
• static OS_time_t OS_TimeFromTotalSeconds (int64 tm)
Get an OS_time_t interval object from an integer number of seconds.
• static int64 OS_TimeGetTotalMilliseconds (OS_time_t tm)
Get interval from an OS_time_t object normalized to millisecond units.
• static OS_time_t OS_TimeFromTotalMilliseconds (int64 tm)
Get an OS_time_t interval object from a integer number of milliseconds.
• static int64 OS_TimeGetTotalMicroseconds (OS_time_t tm)
Get interval from an OS_time_t object normalized to microsecond units.
• static OS_time_t OS_TimeFromTotalMicroseconds (int64 tm)
Get an OS_time_t interval object from a integer number of microseconds.
• static int64 OS_TimeGetTotalNanoseconds (OS_time_t tm)
Get interval from an OS_time_t object normalized to nanosecond units.
• static OS_time_t OS_TimeFromTotalNanoseconds (int64 tm)
Get an OS_time_t interval object from a integer number of nanoseconds.
• static int64 OS_TimeGetFractionalPart (OS_time_t tm)
Get subseconds portion (fractional part only) from an OS_time_t object.
• static uint32 OS_TimeGetSubsecondsPart (OS_time_t tm)
Get 32-bit normalized subseconds (fractional part only) from an OS_time_t object.
• static uint32 OS_TimeGetMillisecondsPart (OS_time_t tm)
Get milliseconds portion (fractional part only) from an OS_time_t object.
• static uint32 OS_TimeGetMicrosecondsPart (OS_time_t tm)
Get microseconds portion (fractional part only) from an OS_time_t object.
• static uint32 OS_TimeGetNanosecondsPart (OS_time_t tm)
Get nanoseconds portion (fractional part only) from an OS_time_t object.
• static OS_time_t OS_TimeAssembleFromNanoseconds (int64 seconds, uint32 nanoseconds)
Assemble/Convert a number of seconds + nanoseconds into an OS_time_t interval.
• static OS_time_t OS_TimeAssembleFromMicroseconds (int64 seconds, uint32 microseconds)
Assemble/Convert a number of seconds + microseconds into an OS_time_t interval.
• static OS_time_t OS_TimeAssembleFromMilliseconds (int64 seconds, uint32 milliseconds)
Assemble/Convert a number of seconds + milliseconds into an OS_time_t interval.
• static OS_time_t OS_TimeAssembleFromSubseconds (int64 seconds, uint32 subseconds)
Assemble/Convert a number of seconds + subseconds into an OS_time_t interval.
• static OS_time_t OS_TimeAdd (OS_time_t time1, OS_time_t time2)
Computes the sum of two time intervals.
• static OS_time_t OS_TimeSubtract (OS_time_t time1, OS_time_t time2)
Computes the difference between two time intervals.

Generated by Doxygen
9.47 OSAL Real Time Clock APIs 309

9.47.1 Detailed Description

9.47.2 Function Documentation

9.47.2.1 OS_GetLocalTime() int32 OS_GetLocalTime (

OS_time_t ∗ time_struct )
Get the local time.
This function gets the local time from the underlying OS.

Note

Mission time management typically uses the cFE Time Service

Parameters

out time_struct An OS_time_t that will be set to the current time (must not be null)

Returns

Get local time status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if time_struct is null

9.47.2.2 OS_SetLocalTime() int32 OS_SetLocalTime (

const OS_time_t ∗ time_struct )
Set the local time.
This function sets the local time on the underlying OS.

Note

Mission time management typically uses the cFE Time Services

Parameters

in time_struct An OS_time_t containing the current time (must not be null)

Returns

Set local time status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if time_struct is null

Generated by Doxygen
310

9.47.2.3 OS_TimeAdd() static OS_time_t OS_TimeAdd (

OS_time_t time1,
OS_time_t time2 ) [inline], [static]
Computes the sum of two time intervals.

Parameters

in time1 The first interval

in time2 The second interval

Returns

The sum of the two intervals (time1 + time2)

Definition at line 467 of file osapi-clock.h.

References OS_time_t::ticks.

9.47.2.4 OS_TimeAssembleFromMicroseconds() static OS_time_t OS_TimeAssembleFromMicroseconds (

int64 seconds,
uint32 microseconds ) [inline], [static]
Assemble/Convert a number of seconds + microseconds into an OS_time_t interval.
This creates an OS_time_t value using a whole number of seconds and a fractional part in units of microseconds. This
is the inverse of OS_TimeGetTotalSeconds() and OS_TimeGetMicrosecondsPart(), and should recreate the original
OS_time_t value from these separate values (aside from any potential conversion losses due to limited resolution of the
data types/units).

See also

OS_TimeGetTotalSeconds(), OS_TimeGetMicrosecondsPart()

Parameters

in seconds Whole number of seconds

in microseconds Number of microseconds (fractional part only)

Returns

The input arguments represented as an OS_time_t interval

Definition at line 402 of file osapi-clock.h.

References OS_TIME_TICKS_PER_SECOND, OS_TIME_TICKS_PER_USEC, and OS_time_t::ticks.

9.47.2.5 OS_TimeAssembleFromMilliseconds() static OS_time_t OS_TimeAssembleFromMilliseconds (

int64 seconds,
uint32 milliseconds ) [inline], [static]
Assemble/Convert a number of seconds + milliseconds into an OS_time_t interval.
This creates an OS_time_t value using a whole number of seconds and a fractional part in units of milliseconds.
This is the inverse of OS_TimeGetTotalSeconds() and OS_TimeGetMillisecondsPart(), and should recreate the orig-
inal OS_time_t value from these separate values (aside from any potential conversion losses due to limited resolution
of the data types/units).

Generated by Doxygen
9.47 OSAL Real Time Clock APIs 311

See also

OS_TimeGetTotalSeconds(), OS_TimeGetMillisecondsPart()

Parameters

in seconds Whole number of seconds

in milliseconds Number of milliseconds (fractional part only)

Returns

The input arguments represented as an OS_time_t interval

Definition at line 426 of file osapi-clock.h.

References OS_TIME_TICKS_PER_MSEC, OS_TIME_TICKS_PER_SECOND, and OS_time_t::ticks.

9.47.2.6 OS_TimeAssembleFromNanoseconds() static OS_time_t OS_TimeAssembleFromNanoseconds (

int64 seconds,
uint32 nanoseconds ) [inline], [static]
Assemble/Convert a number of seconds + nanoseconds into an OS_time_t interval.
This creates an OS_time_t value using a whole number of seconds and a fractional part in units of nanoseconds. This
is the inverse of OS_TimeGetTotalSeconds() and OS_TimeGetNanosecondsPart(), and should recreate the original
OS_time_t value from these separate values (aside from any potential conversion losses due to limited resolution of the
data types/units).

See also

OS_TimeGetTotalSeconds(), OS_TimeGetNanosecondsPart()

Parameters

in seconds Whole number of seconds

in nanoseconds Number of nanoseconds (fractional part only)

Returns

The input arguments represented as an OS_time_t interval

Definition at line 378 of file osapi-clock.h.

References OS_TIME_TICK_RESOLUTION_NS, OS_TIME_TICKS_PER_SECOND, and OS_time_t::ticks.

9.47.2.7 OS_TimeAssembleFromSubseconds() static OS_time_t OS_TimeAssembleFromSubseconds (

int64 seconds,
uint32 subseconds ) [inline], [static]
Assemble/Convert a number of seconds + subseconds into an OS_time_t interval.
This creates an OS_time_t value using a whole number of seconds and a fractional part in units of sub-seconds (1/2∧ 32).
This is the inverse of OS_TimeGetTotalSeconds() and OS_TimeGetSubsecondsPart(), and should recreate the original
OS_time_t value from these separate values (aside from any potential conversion losses due to limited resolution of the
data types/units).

Generated by Doxygen
312

See also

OS_TimeGetTotalSeconds(), OS_TimeGetNanosecondsPart()

Parameters

in seconds Whole number of seconds

in subseconds Number of subseconds (32 bit fixed point fractional part)

Returns

The input arguments represented as an OS_time_t interval

Definition at line 449 of file osapi-clock.h.

References OS_TIME_TICKS_PER_SECOND, and OS_time_t::ticks.

9.47.2.8 OS_TimeFromTotalMicroseconds() static OS_time_t OS_TimeFromTotalMicroseconds (

int64 tm ) [inline], [static]
Get an OS_time_t interval object from a integer number of microseconds.
This is the inverse operation of OS_TimeGetTotalMicroseconds(), converting the total number of microseconds into an
OS_time_t value.

See also

OS_TimeGetTotalMicroseconds()

Parameters
in tm Time interval value, in microseconds

Returns

OS_time_t value representing the interval

Definition at line 216 of file osapi-clock.h.

References OS_TIME_TICKS_PER_USEC.

9.47.2.9 OS_TimeFromTotalMilliseconds() static OS_time_t OS_TimeFromTotalMilliseconds (

int64 tm ) [inline], [static]
Get an OS_time_t interval object from a integer number of milliseconds.
This is the inverse operation of OS_TimeGetTotalMilliseconds(), converting the total number of milliseconds into an
OS_time_t value.

See also

OS_TimeGetTotalMilliseconds()

Parameters
in tm Time interval value, in milliseconds

Generated by Doxygen
9.47 OSAL Real Time Clock APIs 313

Returns

OS_time_t value representing the interval

Definition at line 182 of file osapi-clock.h.

References OS_TIME_TICKS_PER_MSEC.

9.47.2.10 OS_TimeFromTotalNanoseconds() static OS_time_t OS_TimeFromTotalNanoseconds (

int64 tm ) [inline], [static]
Get an OS_time_t interval object from a integer number of nanoseconds.
This is the inverse operation of OS_TimeGetTotalNanoseconds(), converting the total number of nanoseconds into an
OS_time_t value.

See also

OS_TimeGetTotalNanoseconds()

Parameters
in tm Time interval value, in nanoseconds

Returns

OS_time_t value representing the interval

Definition at line 254 of file osapi-clock.h.

References OS_TIME_TICK_RESOLUTION_NS.

9.47.2.11 OS_TimeFromTotalSeconds() static OS_time_t OS_TimeFromTotalSeconds (

int64 tm ) [inline], [static]
Get an OS_time_t interval object from an integer number of seconds.
This is the inverse operation of OS_TimeGetTotalSeconds(), converting the total number of seconds into an OS_time_t
value.
See also

OS_TimeGetTotalSeconds()

Parameters
in tm Time interval value, in seconds

Returns

OS_time_t value representing the interval

Definition at line 148 of file osapi-clock.h.

References OS_TIME_TICKS_PER_SECOND.

9.47.2.12 OS_TimeGetFractionalPart() static int64 OS_TimeGetFractionalPart (

OS_time_t tm ) [inline], [static]
Get subseconds portion (fractional part only) from an OS_time_t object.

Generated by Doxygen
314

Extracts the fractional part from a given OS_time_t object. Units returned are in ticks, not normalized to any standard
time unit.

Parameters
in tm Time interval value

Returns

Fractional/subsecond portion of time interval in ticks

Definition at line 270 of file osapi-clock.h.

References OS_TIME_TICKS_PER_SECOND, and OS_time_t::ticks.
Referenced by OS_TimeGetMicrosecondsPart(), OS_TimeGetMillisecondsPart(), OS_TimeGetNanosecondsPart(),
and OS_TimeGetSubsecondsPart().

9.47.2.13 OS_TimeGetMicrosecondsPart() static uint32 OS_TimeGetMicrosecondsPart (

OS_time_t tm ) [inline], [static]
Get microseconds portion (fractional part only) from an OS_time_t object.
Extracts the fractional part from a given OS_time_t object normalized to units of microseconds.
This function may be used to adapt applications initially implemented using an older OSAL version where OS_time_t
was a structure containing a "seconds" and "microsecs" field.
This function will obtain a value that is compatible with the "microsecs" field of OS_time_t as it was defined in previous
versions of OSAL, as well as the "tv_usec" field of POSIX-style "struct timeval" values.

See also

OS_TimeGetTotalSeconds()

Parameters
in tm Time interval value

Returns

Number of microseconds in time interval

Definition at line 338 of file osapi-clock.h.

References OS_TIME_TICKS_PER_USEC, and OS_TimeGetFractionalPart().
Here is the call graph for this function:

OS_TimeGetMicrosecondsPart OS_TimeGetFractionalPart

9.47.2.14 OS_TimeGetMillisecondsPart() static uint32 OS_TimeGetMillisecondsPart (

OS_time_t tm ) [inline], [static]

Generated by Doxygen
9.47 OSAL Real Time Clock APIs 315

Get milliseconds portion (fractional part only) from an OS_time_t object.

Extracts the fractional part from a given OS_time_t object normalized to units of milliseconds.

See also

OS_TimeGetTotalSeconds()

Parameters
in tm Time interval value

Returns

Number of milliseconds in time interval

Definition at line 313 of file osapi-clock.h.

References OS_TIME_TICKS_PER_MSEC, and OS_TimeGetFractionalPart().
Here is the call graph for this function:

OS_TimeGetMillisecondsPart OS_TimeGetFractionalPart

9.47.2.15 OS_TimeGetNanosecondsPart() static uint32 OS_TimeGetNanosecondsPart (

OS_time_t tm ) [inline], [static]
Get nanoseconds portion (fractional part only) from an OS_time_t object.
Extracts the only number of nanoseconds from a given OS_time_t object.
This function will obtain a value that is compatible with the "tv_nsec" field of POSIX-style "struct timespec" values.

See also

OS_TimeGetTotalSeconds()

Parameters
in tm Time interval value

Generated by Doxygen
316

Returns

Number of nanoseconds in time interval

Definition at line 357 of file osapi-clock.h.

References OS_TIME_TICK_RESOLUTION_NS, and OS_TimeGetFractionalPart().
Here is the call graph for this function:

OS_TimeGetNanosecondsPart OS_TimeGetFractionalPart

9.47.2.16 OS_TimeGetSubsecondsPart() static uint32 OS_TimeGetSubsecondsPart (

OS_time_t tm ) [inline], [static]
Get 32-bit normalized subseconds (fractional part only) from an OS_time_t object.
Extracts the fractional part from a given OS_time_t object in maximum precision, with units of 2∧ (-32) sec. This is a
base-2 fixed-point fractional value with the point left-justified in the 32-bit value (i.e. left of MSB).
This is (mostly) compatible with the CFE "subseconds" value, where 0x80000000 represents exactly one half second,
and 0 represents a full second.

Parameters
in tm Time interval value

Returns

Fractional/subsecond portion of time interval as 32-bit fixed point value

Definition at line 289 of file osapi-clock.h.

References OS_TIME_TICKS_PER_SECOND, and OS_TimeGetFractionalPart().
Here is the call graph for this function:

OS_TimeGetSubsecondsPart OS_TimeGetFractionalPart

9.47.2.17 OS_TimeGetTotalMicroseconds() static int64 OS_TimeGetTotalMicroseconds (

OS_time_t tm ) [inline], [static]
Get interval from an OS_time_t object normalized to microsecond units.
Note this refers to the complete interval, not just the fractional part.

Generated by Doxygen
9.47 OSAL Real Time Clock APIs 317

See also

OS_TimeFromTotalMicroseconds()

Parameters
in tm Time interval value

Returns

Whole number of microseconds in time interval

Definition at line 199 of file osapi-clock.h.

References OS_TIME_TICKS_PER_USEC, and OS_time_t::ticks.

9.47.2.18 OS_TimeGetTotalMilliseconds() static int64 OS_TimeGetTotalMilliseconds (

OS_time_t tm ) [inline], [static]
Get interval from an OS_time_t object normalized to millisecond units.
Note this refers to the complete interval, not just the fractional part.

See also

OS_TimeFromTotalMilliseconds()

Parameters
in tm Time interval value

Returns

Whole number of milliseconds in time interval

Definition at line 165 of file osapi-clock.h.

References OS_TIME_TICKS_PER_MSEC, and OS_time_t::ticks.

9.47.2.19 OS_TimeGetTotalNanoseconds() static int64 OS_TimeGetTotalNanoseconds (

OS_time_t tm ) [inline], [static]
Get interval from an OS_time_t object normalized to nanosecond units.
Note this refers to the complete interval, not just the fractional part.

Note

There is no protection against overflow of the 64-bit return value. Applications must use caution to ensure that the
interval does not exceed the representable range of a signed 64 bit integer - approximately 140 years.

See also

OS_TimeFromTotalNanoseconds

Parameters
in tm Time interval value

Generated by Doxygen
318

Returns

Whole number of microseconds in time interval

Definition at line 237 of file osapi-clock.h.

References OS_TIME_TICK_RESOLUTION_NS, and OS_time_t::ticks.

9.47.2.20 OS_TimeGetTotalSeconds() static int64 OS_TimeGetTotalSeconds (

OS_time_t tm ) [inline], [static]
Get interval from an OS_time_t object normalized to whole number of seconds.
Extracts the number of whole seconds from a given OS_time_t object, discarding any fractional component.
This may also replace a direct read of the "seconds" field from the OS_time_t object from previous versions of OSAL,
where the structure was defined with separate seconds/microseconds fields.

See also

OS_TimeGetMicrosecondsPart()
OS_TimeFromTotalSeconds()

Parameters
in tm Time interval value

Returns

Whole number of seconds in time interval

Definition at line 131 of file osapi-clock.h.

References OS_TIME_TICKS_PER_SECOND, and OS_time_t::ticks.

9.47.2.21 OS_TimeSubtract() static OS_time_t OS_TimeSubtract (

OS_time_t time1,
OS_time_t time2 ) [inline], [static]
Computes the difference between two time intervals.

Parameters

in time1 The first interval

in time2 The second interval

Returns

The difference of the two intervals (time1 - time2)

Definition at line 482 of file osapi-clock.h.

References OS_time_t::ticks.

Generated by Doxygen
9.48 OSAL Core Operation APIs 319

9.48 OSAL Core Operation APIs

These are for OSAL core operations for startup/initialization, running, and shutdown. Typically only used in bsps, unit
tests, psps, etc.

Functions

• void OS_Application_Startup (void)

Application startup.
• void OS_Application_Run (void)
Application run.
• int32 OS_API_Init (void)
Initialization of API.
• void OS_API_Teardown (void)
Teardown/de-initialization of OSAL API.
• void OS_IdleLoop (void)
Background thread implementation - waits forever for events to occur.
• void OS_DeleteAllObjects (void)
delete all resources created in OSAL.
• void OS_ApplicationShutdown (uint8 flag)
Initiate orderly shutdown.
• void OS_ApplicationExit (int32 Status)
Exit/Abort the application.
• int32 OS_RegisterEventHandler (OS_EventHandler_t handler)
Callback routine registration.

9.48.1 Detailed Description

These are for OSAL core operations for startup/initialization, running, and shutdown. Typically only used in bsps, unit
tests, psps, etc.
Not intended for user application use

9.48.2 Function Documentation

9.48.2.1 OS_API_Init() int32 OS_API_Init (

void )
Initialization of API.
This function returns initializes the internal data structures of the OS Abstraction Layer. It must be called in the applica-
tion startup code before calling any other OS routines.

Returns

Execution status, see OSAL Return Code Defines. Any error code (negative) means the OSAL can not be initial-
ized. Typical platform specific response is to abort since additional OSAL calls will have undefined behavior.

Return values

OS_SUCCESS Successful execution.

OS_ERROR Failed execution. (return value only verified in coverage test)

Generated by Doxygen
320

9.48.2.2 OS_API_Teardown() void OS_API_Teardown (

void )
Teardown/de-initialization of OSAL API.
This is the inverse of OS_API_Init(). It will release all OS resources and return the system to a state similar to what it
was prior to invoking OS_API_Init() initially.
Normally for embedded applications, the OSAL is initialized after boot and will remain initialized in memory until the
processor is rebooted. However for testing and development purposes, it is potentially useful to reset back to initial
conditions.
For testing purposes, this API is designed/intended to be compatible with the UtTest_AddTeardown() routine provided
by the UT-Assert subsystem.

Note

This is a "best-effort" routine and it may not always be possible/guaranteed to recover all resources, particularly in
the case of off-nominal conditions, or if a resource is used outside of OSAL.

For example, while this will attempt to unload all dynamically-loaded modules, doing so may not be possible and/or may
induce undefined behavior if resources are in use by tasks/functions outside of OSAL.

9.48.2.3 OS_Application_Run() void OS_Application_Run (

void )
Application run.
Run abstraction such that the same BSP can be used for operations and testing.

9.48.2.4 OS_Application_Startup() void OS_Application_Startup (

void )
Application startup.
Startup abstraction such that the same BSP can be used for operations and testing.

9.48.2.5 OS_ApplicationExit() void OS_ApplicationExit (

int32 Status )
Exit/Abort the application.
Indicates that the OSAL application should exit and return control to the OS This is intended for e.g. scripted unit testing
where the test needs to end without user intervention.
This function does not return. Production code typically should not ever call this.

Note

This exits the entire process including tasks that have been created.

9.48.2.6 OS_ApplicationShutdown() void OS_ApplicationShutdown (

uint8 flag )
Initiate orderly shutdown.
Indicates that the OSAL application should perform an orderly shutdown of ALL tasks, clean up all resources, and exit
the application.
This allows the task currently blocked in OS_IdleLoop() to wake up, and for that function to return to its caller.
This is preferred over e.g. OS_ApplicationExit() which exits immediately and does not provide for any means to clean
up first.

Parameters

in flag set to true to initiate shutdown, false to cancel

Generated by Doxygen
9.48 OSAL Core Operation APIs 321

9.48.2.7 OS_DeleteAllObjects() void OS_DeleteAllObjects (

void )
delete all resources created in OSAL.
provides a means to clean up all resources allocated by this instance of OSAL. It would typically be used during an
orderly shutdown but may also be helpful for testing purposes.

9.48.2.8 OS_IdleLoop() void OS_IdleLoop (

void )
Background thread implementation - waits forever for events to occur.
This should be called from the BSP main routine or initial thread after all other board and application initialization has
taken place and all other tasks are running.
Typically just waits forever until "OS_shutdown" flag becomes true.

9.48.2.9 OS_RegisterEventHandler() int32 OS_RegisterEventHandler (

OS_EventHandler_t handler )
Callback routine registration.
This hook enables the application code to perform extra platform-specific operations on various system events such as
resource creation/deletion.
Note

Some events are invoked while the resource is "locked" and therefore application-defined handlers for these events
should not block or attempt to access other OSAL resources.

Parameters

in handler The application-provided event handler (must not be null)

Returns

Execution status, see OSAL Return Code Defines.

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if handler is NULL

Generated by Doxygen
322

9.49 OSAL Condition Variable APIs

Functions

• int32 OS_CondVarCreate (osal_id_t ∗var_id, const char ∗var_name, uint32 options)

Creates a condition variable resource.
• int32 OS_CondVarLock (osal_id_t var_id)
Locks/Acquires the underlying mutex associated with a condition variable.
• int32 OS_CondVarUnlock (osal_id_t var_id)
Unlocks/Releases the underlying mutex associated with a condition variable.
• int32 OS_CondVarSignal (osal_id_t var_id)
Signals the condition variable resource referenced by var_id.
• int32 OS_CondVarBroadcast (osal_id_t var_id)
Broadcasts the condition variable resource referenced by var_id.
• int32 OS_CondVarWait (osal_id_t var_id)
Waits on the condition variable object referenced by var_id.
• int32 OS_CondVarTimedWait (osal_id_t var_id, const OS_time_t ∗abs_wakeup_time)
Time-limited wait on the condition variable object referenced by var_id.
• int32 OS_CondVarDelete (osal_id_t var_id)
Deletes the specified condition variable.
• int32 OS_CondVarGetIdByName (osal_id_t ∗var_id, const char ∗var_name)
Find an existing condition variable ID by name.
• int32 OS_CondVarGetInfo (osal_id_t var_id, OS_condvar_prop_t ∗condvar_prop)
Fill a property object buffer with details regarding the resource.

9.49.1 Detailed Description

9.49.2 Function Documentation

9.49.2.1 OS_CondVarBroadcast() int32 OS_CondVarBroadcast (

osal_id_t var_id )
Broadcasts the condition variable resource referenced by var_id.
This function may be used to indicate when the state of a data object has been changed.
If there are threads blocked on the condition variable object referenced by var_id when this function is called, all threads
will be unblocked.
Note that although all threads are unblocked, because the mutex is re-acquired before the wait function returns, only a
single task will be testing the condition at a given time. The order with which each blocked task runs is determined by
the scheduling policy.

Parameters
in var←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Generated by Doxygen
9.49 OSAL Condition Variable APIs 323

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid condition variable

9.49.2.2 OS_CondVarCreate() int32 OS_CondVarCreate (

osal_id_t ∗ var_id,
const char ∗ var_name,
uint32 options )
Creates a condition variable resource.
A condition variable adds a more sophisticated synchronization option for mutexes, such that it can operate on arbitrary
user-defined conditions rather than simply a counter or boolean (as in the case of simple semaphores).
Creating a condition variable resource in OSAL will in turn create both a basic mutex as well as a synchronization
overlay. The underlying mutex is similar to the mutex functionality provided by the OSAL mutex subsystem, and can be
locked and unlocked normally.
This mutex is intended to protect access to any arbitrary user-defined data object that serves as the condition being
tested.
A task that needs a particular state of the object should follow this general flow:

• Lock the underlying mutex

• Test for the condition being waited for (a user-defined check on user-defined data)

• If condition IS NOT met, then call OS_CondVarWait() to wait, then repeat test

• If condition IS met, then unlock the underlying mutex and continue

A task that changes the state of the object should follow this general flow:

• Lock the underlying mutex

• Change the state as necessary

• Call either OS_CondVarSignal() or OS_CondVarBroadcast()

• Unlock the underlying mutex

Parameters

out var_id will be set to the non-zero ID of the newly-created resource (must not be null)
in var_name the name of the new resource to create (must not be null)
in options reserved for future use. Should be passed as 0.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if var_id or var_name are NULL
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME

Generated by Doxygen
324

Return values

OS_ERR_NO_FREE_IDS if there are no more free condition variable Ids

OS_ERR_NAME_TAKEN if there is already a condition variable with the same name

9.49.2.3 OS_CondVarDelete() int32 OS_CondVarDelete (

osal_id_t var_id )
Deletes the specified condition variable.
Delete the condition variable and releases any related system resources.

Parameters
in var←- The object ID to delete
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid condvar

9.49.2.4 OS_CondVarGetIdByName() int32 OS_CondVarGetIdByName (

osal_id_t ∗ var_id,
const char ∗ var_name )
Find an existing condition variable ID by name.
This function tries to find an existing condition variable ID given the name. The id is returned through var_id.

Parameters

out var_id will be set to the ID of the existing resource

in var_name the name of the existing resource to find (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER is var_id or var_name are NULL pointers
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_NOT_FOUND if the name was not found in the table

Generated by Doxygen
9.49 OSAL Condition Variable APIs 325

9.49.2.5 OS_CondVarGetInfo() int32 OS_CondVarGetInfo (

osal_id_t var_id,
OS_condvar_prop_t ∗ condvar_prop )
Fill a property object buffer with details regarding the resource.
This function will fill a structure to contain the information (name and creator) about the specified condition variable.

Parameters
in var_id The object ID to operate on
out condvar_prop The property object buffer to fill (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid semaphore
OS_INVALID_POINTER if the mut_prop pointer is null

9.49.2.6 OS_CondVarLock() int32 OS_CondVarLock (

osal_id_t var_id )
Locks/Acquires the underlying mutex associated with a condition variable.
The mutex should always be locked by a task before reading or modifying the data object associated with a condition
variable.
Note

This lock must be acquired by a task before invoking OS_CondVarWait() or OS_CondVarTimedWait() on the same
condition variable.

Parameters
in var←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid condition variable

Generated by Doxygen
326

9.49.2.7 OS_CondVarSignal() int32 OS_CondVarSignal (

osal_id_t var_id )
Signals the condition variable resource referenced by var_id.
This function may be used to indicate when the state of a data object has been changed.
If there are threads blocked on the condition variable object referenced by var_id when this function is called, one of
those threads will be unblocked, as determined by the scheduling policy.

Parameters
in var←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid condition variable

9.49.2.8 OS_CondVarTimedWait() int32 OS_CondVarTimedWait (

osal_id_t var_id,
const OS_time_t ∗ abs_wakeup_time )
Time-limited wait on the condition variable object referenced by var_id.
Identical in operation to OS_CondVarWait(), except that the maximum amount of time that the task will be blocked is
limited.
The abs_wakeup_time refers to the absolute time of the system clock at which the task should be unblocked to run,
regardless of the state of the condition variable. This refers to the same system clock that is the subject of the
OS_GetLocalTime() API.

Parameters
in var_id The object ID to operate on
in abs_wakeup_time The system time at which the task should be unblocked (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID the id passed in is not a valid condvar

9.49.2.9 OS_CondVarUnlock() int32 OS_CondVarUnlock (

osal_id_t var_id )

Generated by Doxygen
9.49 OSAL Condition Variable APIs 327

Unlocks/Releases the underlying mutex associated with a condition variable.

The mutex should be unlocked by a task once reading or modifying the data object associated with a condition variable
is complete.

Parameters
in var←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid condition variable

9.49.2.10 OS_CondVarWait() int32 OS_CondVarWait (

osal_id_t var_id )
Waits on the condition variable object referenced by var_id.
The calling task will be blocked until another task calls the function OS_CondVarSignal() or OS_CondVarBroadcast() on
the same condition variable.
The underlying mutex associated with the condition variable must be locked and owned by the calling task at the time
this function is invoked. As part of this call, the mutex will be unlocked as the task blocks. This is done in such a way
that there is no possibility that another task could aquire the mutex before the calling task has actually blocked.
This atomicity with respect to blocking the task and unlocking the mutex is a critical difference between condition vari-
ables and other synchronization primitives. It avoids a window of opportunity where inherent in the simpler synchroniza-
tion resource types where the state of the data could change between the time that the calling task tested the state and
the time that the task actually blocks on the sync resource.

Parameters
in var←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID the id passed in is not a valid condvar

Generated by Doxygen
328

9.50 OSAL Counting Semaphore APIs

Functions

• int32 OS_CountSemCreate (osal_id_t ∗sem_id, const char ∗sem_name, uint32 sem_initial_value, uint32 options)
Creates a counting semaphore.
• int32 OS_CountSemGive (osal_id_t sem_id)
Increment the semaphore value.
• int32 OS_CountSemTake (osal_id_t sem_id)
Decrement the semaphore value.
• int32 OS_CountSemTimedWait (osal_id_t sem_id, uint32 msecs)
Decrement the semaphore value with timeout.
• int32 OS_CountSemDelete (osal_id_t sem_id)
Deletes the specified counting Semaphore.
• int32 OS_CountSemGetIdByName (osal_id_t ∗sem_id, const char ∗sem_name)
Find an existing semaphore ID by name.
• int32 OS_CountSemGetInfo (osal_id_t sem_id, OS_count_sem_prop_t ∗count_prop)
Fill a property object buffer with details regarding the resource.

9.50.1 Detailed Description

9.50.2 Function Documentation

9.50.2.1 OS_CountSemCreate() int32 OS_CountSemCreate (

osal_id_t ∗ sem_id,
const char ∗ sem_name,
uint32 sem_initial_value,
uint32 options )
Creates a counting semaphore.
Creates a counting semaphore with initial value specified by sem_initial_value and name specified by sem_name.
sem_id will be returned to the caller.

Note

Underlying RTOS implementations may or may not impose a specific upper limit to the value of a
counting semaphore. If the OS has a specific limit and the sem_initial_value exceeds this limit, then
OS_INVALID_SEM_VALUE is returned. On other implementations, any 32-bit integer value may be accept-
able. For maximum portability, it is recommended to keep counting semaphore values within the range of a "short
int" (i.e. between 0 and 32767). Many platforms do accept larger values, but may not be guaranteed.

Parameters

out sem_id will be set to the non-zero ID of the newly-created resource (must not be null)
in sem_name the name of the new resource to create (must not be null)
in sem_initial_value the initial value of the counting semaphore
in options Reserved for future use, should be passed as 0.

Generated by Doxygen
9.50 OSAL Counting Semaphore APIs 329

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if sen name or sem_id are NULL
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NO_FREE_IDS if all of the semaphore ids are taken
OS_ERR_NAME_TAKEN if this is already the name of a counting semaphore
OS_INVALID_SEM_VALUE if the semaphore value is too high (return value only verified in coverage test)
OS_SEM_FAILURE if an unspecified implementation error occurs (return value only verified in
coverage test)

9.50.2.2 OS_CountSemDelete() int32 OS_CountSemDelete (

osal_id_t sem_id )
Deletes the specified counting Semaphore.

Parameters
in sem←- The object ID to delete
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid counting semaphore
OS_SEM_FAILURE if an unspecified implementation error occurs (return value only verified in coverage test)

9.50.2.3 OS_CountSemGetIdByName() int32 OS_CountSemGetIdByName (

osal_id_t ∗ sem_id,
const char ∗ sem_name )
Find an existing semaphore ID by name.
This function tries to find a counting sem Id given the name of a count_sem The id is returned through sem_id

Parameters

out sem_id will be set to the ID of the existing resource

in sem_name the name of the existing resource to find (must not be null)

Generated by Doxygen
330

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER is semid or sem_name are NULL pointers
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_NOT_FOUND if the name was not found in the table

9.50.2.4 OS_CountSemGetInfo() int32 OS_CountSemGetInfo (

osal_id_t sem_id,
OS_count_sem_prop_t ∗ count_prop )
Fill a property object buffer with details regarding the resource.
This function will pass back a pointer to structure that contains all of the relevant info( name and creator) about the
specified counting semaphore.

Parameters
in sem_id The object ID to operate on
out count_prop The property object buffer to fill (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid semaphore
OS_INVALID_POINTER if the count_prop pointer is null
OS_ERR_NOT_IMPLEMENTED Not implemented.

9.50.2.5 OS_CountSemGive() int32 OS_CountSemGive (

osal_id_t sem_id )
Increment the semaphore value.
The function unlocks the semaphore referenced by sem_id by performing a semaphore unlock operation on that
semaphore. If the semaphore value resulting from this operation is positive, then no threads were blocked waiting
for the semaphore to become unlocked; the semaphore value is simply incremented for this semaphore.

Parameters
in sem←- The object ID to operate on
_id

Generated by Doxygen
9.50 OSAL Counting Semaphore APIs 331

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a counting semaphore
OS_SEM_FAILURE if an unspecified implementation error occurs (return value only verified in coverage test)

9.50.2.6 OS_CountSemTake() int32 OS_CountSemTake (

osal_id_t sem_id )
Decrement the semaphore value.
The locks the semaphore referenced by sem_id by performing a semaphore lock operation on that semaphore. If the
semaphore value is currently zero, then the calling thread shall not return from the call until it either locks the semaphore
or the call is interrupted.

Parameters
in sem←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID the Id passed in is not a valid counting semaphore
OS_SEM_FAILURE if an unspecified implementation error occurs (return value only verified in coverage test)

9.50.2.7 OS_CountSemTimedWait() int32 OS_CountSemTimedWait (

osal_id_t sem_id,
uint32 msecs )
Decrement the semaphore value with timeout.
The function locks the semaphore referenced by sem_id. However, if the semaphore cannot be locked without waiting
for another process or thread to unlock the semaphore, this wait shall be terminated when the specified timeout, msecs,
expires.

Parameters
in sem←- The object ID to operate on
_id
in msecs The maximum amount of time to block, in milliseconds

Generated by Doxygen
332

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_SEM_TIMEOUT if semaphore was not relinquished in time
OS_ERR_INVALID_ID if the ID passed in is not a valid semaphore ID
OS_SEM_FAILURE if an unspecified implementation error occurs (return value only verified in coverage test)

Generated by Doxygen
9.51 OSAL Directory APIs 333

9.51 OSAL Directory APIs

Functions

• int32 OS_DirectoryOpen (osal_id_t ∗dir_id, const char ∗path)

Opens a directory.
• int32 OS_DirectoryClose (osal_id_t dir_id)
Closes an open directory.
• int32 OS_DirectoryRewind (osal_id_t dir_id)
Rewinds an open directory.
• int32 OS_DirectoryRead (osal_id_t dir_id, os_dirent_t ∗dirent)
Reads the next name in the directory.
• int32 OS_mkdir (const char ∗path, uint32 access)
Makes a new directory.
• int32 OS_rmdir (const char ∗path)
Removes a directory from the file system.

9.51.1 Detailed Description

9.51.2 Function Documentation

9.51.2.1 OS_DirectoryClose() int32 OS_DirectoryClose (

osal_id_t dir_id )
Closes an open directory.
The directory referred to by dir_id will be closed

Parameters

in dir←- The handle ID of the directory

_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the directory handle is invalid

9.51.2.2 OS_DirectoryOpen() int32 OS_DirectoryOpen (

osal_id_t ∗ dir_id,
const char ∗ path )
Opens a directory.
Prepares for reading the files within a directory

Generated by Doxygen
334

Parameters

out dir←- Location to store handle ID of the directory (must not be null)
_id
in path The directory to open (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if dir_id or path is NULL
OS_FS_ERR_PATH_TOO_LONG if the path argument exceeds the maximum length
OS_FS_ERR_PATH_INVALID if the path argument is not valid
OS_ERROR if the directory could not be opened

9.51.2.3 OS_DirectoryRead() int32 OS_DirectoryRead (

osal_id_t dir_id,
os_dirent_t ∗ dirent )
Reads the next name in the directory.
Obtains directory entry data for the next file from an open directory

Parameters

in dir←- The handle ID of the directory

_id
out dirent Buffer to store directory entry information (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if dirent argument is NULL
OS_ERR_INVALID_ID if the directory handle is invalid
OS_ERROR at the end of the directory or if the OS call otherwise fails

9.51.2.4 OS_DirectoryRewind() int32 OS_DirectoryRewind (

osal_id_t dir_id )
Rewinds an open directory.
Resets a directory read handle back to the first file.

Generated by Doxygen
9.51 OSAL Directory APIs 335

Parameters

in dir←- The handle ID of the directory

_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the directory handle is invalid

9.51.2.5 OS_mkdir() int32 OS_mkdir (

const char ∗ path,
uint32 access )
Makes a new directory.
Makes a directory specified by path.

Parameters

in path The new directory name (must not be null)

in access The permissions for the directory (reserved for future use)

Note

Current implementations do not utilize the "access" parameter. Applications should still pass the intended value
(OS_READ_WRITE or OS_READ_ONLY) to be compatible with future implementations.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if path is NULL
OS_FS_ERR_PATH_TOO_LONG if the path is too long to be stored locally
OS_FS_ERR_PATH_INVALID if path cannot be parsed
OS_ERROR if the OS call fails (return value only verified in coverage test)

9.51.2.6 OS_rmdir() int32 OS_rmdir (

const char ∗ path )
Removes a directory from the file system.
Removes a directory from the structure. The directory must be empty prior to this operation.

Generated by Doxygen
336

Parameters
in path The directory to remove

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if path is NULL
OS_FS_ERR_PATH_INVALID if path cannot be parsed
OS_FS_ERR_PATH_TOO_LONG
OS_ERROR if the directory remove operation failed (return value only verified in coverage
test)

Generated by Doxygen
9.52 OSAL Return Code Defines 337

9.52 OSAL Return Code Defines

The specific status/return code definitions listed in this section may be extended or refined in future versions of OSAL.

Macros

• #define OS_SUCCESS (0)

Successful execution.
• #define OS_ERROR (-1)
Failed execution.
• #define OS_INVALID_POINTER (-2)
Invalid pointer.
• #define OS_ERROR_ADDRESS_MISALIGNED (-3)
Address misalignment.
• #define OS_ERROR_TIMEOUT (-4)
Error timeout.
• #define OS_INVALID_INT_NUM (-5)
Invalid Interrupt number.
• #define OS_SEM_FAILURE (-6)
Semaphore failure.
• #define OS_SEM_TIMEOUT (-7)
Semaphore timeout.
• #define OS_QUEUE_EMPTY (-8)
Queue empty.
• #define OS_QUEUE_FULL (-9)
Queue full.
• #define OS_QUEUE_TIMEOUT (-10)
Queue timeout.
• #define OS_QUEUE_INVALID_SIZE (-11)
Queue invalid size.
• #define OS_QUEUE_ID_ERROR (-12)
Queue ID error.
• #define OS_ERR_NAME_TOO_LONG (-13)
name length including null terminator greater than OS_MAX_API_NAME
• #define OS_ERR_NO_FREE_IDS (-14)
No free IDs.
• #define OS_ERR_NAME_TAKEN (-15)
Name taken.
• #define OS_ERR_INVALID_ID (-16)
Invalid ID.
• #define OS_ERR_NAME_NOT_FOUND (-17)
Name not found.
• #define OS_ERR_SEM_NOT_FULL (-18)
Semaphore not full.
• #define OS_ERR_INVALID_PRIORITY (-19)
Invalid priority.
• #define OS_INVALID_SEM_VALUE (-20)
Invalid semaphore value.

Generated by Doxygen
338

• #define OS_ERR_FILE (-27)

File error.
• #define OS_ERR_NOT_IMPLEMENTED (-28)
Not implemented.
• #define OS_TIMER_ERR_INVALID_ARGS (-29)
Timer invalid arguments.
• #define OS_TIMER_ERR_TIMER_ID (-30)
Timer ID error.
• #define OS_TIMER_ERR_UNAVAILABLE (-31)
Timer unavailable.
• #define OS_TIMER_ERR_INTERNAL (-32)
Timer internal error.
• #define OS_ERR_OBJECT_IN_USE (-33)
Object in use.
• #define OS_ERR_BAD_ADDRESS (-34)
Bad address.
• #define OS_ERR_INCORRECT_OBJ_STATE (-35)
Incorrect object state.
• #define OS_ERR_INCORRECT_OBJ_TYPE (-36)
Incorrect object type.
• #define OS_ERR_STREAM_DISCONNECTED (-37)
Stream disconnected.
• #define OS_ERR_OPERATION_NOT_SUPPORTED (-38)
Requested operation not support on supplied object(s)
• #define OS_ERR_INVALID_SIZE (-40)
Invalid Size.
• #define OS_ERR_OUTPUT_TOO_LARGE (-41)
Size of output exceeds limit

• #define OS_ERR_INVALID_ARGUMENT (-42)

Invalid argument value (other than ID or size)
• #define OS_FS_ERR_PATH_TOO_LONG (-103)
FS path too long.
• #define OS_FS_ERR_NAME_TOO_LONG (-104)
FS name too long.
• #define OS_FS_ERR_DRIVE_NOT_CREATED (-106)
FS drive not created.
• #define OS_FS_ERR_DEVICE_NOT_FREE (-107)
FS device not free.
• #define OS_FS_ERR_PATH_INVALID (-108)
FS path invalid.

Generated by Doxygen
9.52 OSAL Return Code Defines 339

9.52.1 Detailed Description

The specific status/return code definitions listed in this section may be extended or refined in future versions of OSAL.

Note

Application developers should assume that any OSAL API may return any status value listed here. While the
documentation of each OSAL API function indicates the return/status values that function may directly generate,
functions may also pass through other status codes from related functions, so that list should not be considered
absolute/exhaustive.

The int32 data type should be used to store an OSAL status code. Negative values will always represent errors, while
non-negative values indicate success. Most APIs specifically return OS_SUCCESS (0) upon successful execution, but
some return a nonzero value, such as data size.
Ideally, in order to more easily adapt to future OSAL versions and status code extensions/refinements, applications
should typically check for errors as follows:
int32 status;
status = OS_TaskCreate(...); (or any other API)
if (status < OS_SUCCESS)
{
handle or report error....
may also check for specific codes here.
}
else
{
handle normal/successful status...
}

9.52.2 Macro Definition Documentation

9.52.2.1 OS_ERR_BAD_ADDRESS #define OS_ERR_BAD_ADDRESS (-34)

Bad address.
Definition at line 124 of file osapi-error.h.

9.52.2.2 OS_ERR_FILE #define OS_ERR_FILE (-27)

File error.
Definition at line 117 of file osapi-error.h.

9.52.2.3 OS_ERR_INCORRECT_OBJ_STATE #define OS_ERR_INCORRECT_OBJ_STATE (-35)

Incorrect object state.
Definition at line 125 of file osapi-error.h.

9.52.2.4 OS_ERR_INCORRECT_OBJ_TYPE #define OS_ERR_INCORRECT_OBJ_TYPE (-36)

Incorrect object type.
Definition at line 126 of file osapi-error.h.

9.52.2.5 OS_ERR_INVALID_ARGUMENT #define OS_ERR_INVALID_ARGUMENT (-42)

Invalid argument value (other than ID or size)
Definition at line 131 of file osapi-error.h.

Generated by Doxygen
340

9.52.2.6 OS_ERR_INVALID_ID #define OS_ERR_INVALID_ID (-16)

Invalid ID.
Definition at line 112 of file osapi-error.h.

9.52.2.7 OS_ERR_INVALID_PRIORITY #define OS_ERR_INVALID_PRIORITY (-19)

Invalid priority.
Definition at line 115 of file osapi-error.h.

9.52.2.8 OS_ERR_INVALID_SIZE #define OS_ERR_INVALID_SIZE (-40)

Invalid Size.
Definition at line 129 of file osapi-error.h.

9.52.2.9 OS_ERR_NAME_NOT_FOUND #define OS_ERR_NAME_NOT_FOUND (-17)

Name not found.
Definition at line 113 of file osapi-error.h.

9.52.2.10 OS_ERR_NAME_TAKEN #define OS_ERR_NAME_TAKEN (-15)

Name taken.
Definition at line 111 of file osapi-error.h.

9.52.2.11 OS_ERR_NAME_TOO_LONG #define OS_ERR_NAME_TOO_LONG (-13)

name length including null terminator greater than OS_MAX_API_NAME
Definition at line 109 of file osapi-error.h.

9.52.2.12 OS_ERR_NO_FREE_IDS #define OS_ERR_NO_FREE_IDS (-14)

No free IDs.
Definition at line 110 of file osapi-error.h.

9.52.2.13 OS_ERR_NOT_IMPLEMENTED #define OS_ERR_NOT_IMPLEMENTED (-28)

Not implemented.
Definition at line 118 of file osapi-error.h.

9.52.2.14 OS_ERR_OBJECT_IN_USE #define OS_ERR_OBJECT_IN_USE (-33)

Object in use.
Definition at line 123 of file osapi-error.h.

9.52.2.15 OS_ERR_OPERATION_NOT_SUPPORTED #define OS_ERR_OPERATION_NOT_SUPPORTED (-38)

Requested operation not support on supplied object(s)
Definition at line 128 of file osapi-error.h.

Generated by Doxygen
9.52 OSAL Return Code Defines 341

9.52.2.16 OS_ERR_OUTPUT_TOO_LARGE #define OS_ERR_OUTPUT_TOO_LARGE (-41)

Size of output exceeds limit

Definition at line 130 of file osapi-error.h.

9.52.2.17 OS_ERR_SEM_NOT_FULL #define OS_ERR_SEM_NOT_FULL (-18)

Semaphore not full.
Definition at line 114 of file osapi-error.h.

9.52.2.18 OS_ERR_STREAM_DISCONNECTED #define OS_ERR_STREAM_DISCONNECTED (-37)

Stream disconnected.
Definition at line 127 of file osapi-error.h.

9.52.2.19 OS_ERROR #define OS_ERROR (-1)

Failed execution.
Definition at line 97 of file osapi-error.h.

9.52.2.20 OS_ERROR_ADDRESS_MISALIGNED #define OS_ERROR_ADDRESS_MISALIGNED (-3)

Address misalignment.
Definition at line 99 of file osapi-error.h.

9.52.2.21 OS_ERROR_TIMEOUT #define OS_ERROR_TIMEOUT (-4)

Error timeout.
Definition at line 100 of file osapi-error.h.

9.52.2.22 OS_FS_ERR_DEVICE_NOT_FREE #define OS_FS_ERR_DEVICE_NOT_FREE (-107)

FS device not free.
Definition at line 144 of file osapi-error.h.

9.52.2.23 OS_FS_ERR_DRIVE_NOT_CREATED #define OS_FS_ERR_DRIVE_NOT_CREATED (-106)

FS drive not created.
Definition at line 143 of file osapi-error.h.

9.52.2.24 OS_FS_ERR_NAME_TOO_LONG #define OS_FS_ERR_NAME_TOO_LONG (-104)

FS name too long.
Definition at line 142 of file osapi-error.h.

9.52.2.25 OS_FS_ERR_PATH_INVALID #define OS_FS_ERR_PATH_INVALID (-108)

FS path invalid.
Definition at line 145 of file osapi-error.h.

Generated by Doxygen
342

9.52.2.26 OS_FS_ERR_PATH_TOO_LONG #define OS_FS_ERR_PATH_TOO_LONG (-103)

FS path too long.
Definition at line 141 of file osapi-error.h.

9.52.2.27 OS_INVALID_INT_NUM #define OS_INVALID_INT_NUM (-5)

Invalid Interrupt number.
Definition at line 101 of file osapi-error.h.

9.52.2.28 OS_INVALID_POINTER #define OS_INVALID_POINTER (-2)

Invalid pointer.
Definition at line 98 of file osapi-error.h.

9.52.2.29 OS_INVALID_SEM_VALUE #define OS_INVALID_SEM_VALUE (-20)

Invalid semaphore value.
Definition at line 116 of file osapi-error.h.

9.52.2.30 OS_QUEUE_EMPTY #define OS_QUEUE_EMPTY (-8)

Queue empty.
Definition at line 104 of file osapi-error.h.

9.52.2.31 OS_QUEUE_FULL #define OS_QUEUE_FULL (-9)

Queue full.
Definition at line 105 of file osapi-error.h.

9.52.2.32 OS_QUEUE_ID_ERROR #define OS_QUEUE_ID_ERROR (-12)

Queue ID error.
Definition at line 108 of file osapi-error.h.

9.52.2.33 OS_QUEUE_INVALID_SIZE #define OS_QUEUE_INVALID_SIZE (-11)

Queue invalid size.
Definition at line 107 of file osapi-error.h.

9.52.2.34 OS_QUEUE_TIMEOUT #define OS_QUEUE_TIMEOUT (-10)

Queue timeout.
Definition at line 106 of file osapi-error.h.

9.52.2.35 OS_SEM_FAILURE #define OS_SEM_FAILURE (-6)

Semaphore failure.
Definition at line 102 of file osapi-error.h.

Generated by Doxygen
9.52 OSAL Return Code Defines 343

9.52.2.36 OS_SEM_TIMEOUT #define OS_SEM_TIMEOUT (-7)

Semaphore timeout.
Definition at line 103 of file osapi-error.h.

9.52.2.37 OS_SUCCESS #define OS_SUCCESS (0)

Successful execution.
Definition at line 96 of file osapi-error.h.

9.52.2.38 OS_TIMER_ERR_INTERNAL #define OS_TIMER_ERR_INTERNAL (-32)

Timer internal error.
Definition at line 122 of file osapi-error.h.

9.52.2.39 OS_TIMER_ERR_INVALID_ARGS #define OS_TIMER_ERR_INVALID_ARGS (-29)

Timer invalid arguments.
Definition at line 119 of file osapi-error.h.

9.52.2.40 OS_TIMER_ERR_TIMER_ID #define OS_TIMER_ERR_TIMER_ID (-30)

Timer ID error.
Definition at line 120 of file osapi-error.h.

9.52.2.41 OS_TIMER_ERR_UNAVAILABLE #define OS_TIMER_ERR_UNAVAILABLE (-31)

Timer unavailable.
Definition at line 121 of file osapi-error.h.

Generated by Doxygen
344

9.53 OSAL Error Info APIs

Functions

• static long OS_StatusToInteger (osal_status_t Status)

Convert a status code to a native "long" type.
• int32 OS_GetErrorName (int32 error_num, os_err_name_t ∗err_name)
Convert an error number to a string.
• char ∗ OS_StatusToString (osal_status_t status, os_status_string_t ∗status_string)
Convert status to a string.

9.53.1 Detailed Description

9.53.2 Function Documentation

9.53.2.1 OS_GetErrorName() int32 OS_GetErrorName (

int32 error_num,
os_err_name_t ∗ err_name )
Convert an error number to a string.

Parameters
in error_num Error number to convert
out err_name Buffer to store error string

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS if successfully converted to a string

OS_INVALID_POINTER if err_name is NULL
OS_ERROR if error could not be converted

9.53.2.2 OS_StatusToInteger() static long OS_StatusToInteger (

osal_status_t Status ) [inline], [static]
Convert a status code to a native "long" type.
For printing or logging purposes, this converts the given status code to a "long" (signed integer) value. It should be used
in conjunction with the "%ld" conversion specifier in printf-style statements.

Parameters

in Status Execution status, see OSAL Return Code Defines

Generated by Doxygen
9.53 OSAL Error Info APIs 345

Returns

Same status value converted to the "long" data type

Definition at line 164 of file osapi-error.h.

9.53.2.3 OS_StatusToString() char∗ OS_StatusToString (

osal_status_t status,
os_status_string_t ∗ status_string )
Convert status to a string.

Parameters

in status Status value to convert

out status_string Buffer to store status converted to string

Returns

Passed in string pointer

Generated by Doxygen
346

9.54 OSAL File Access Option Defines

Macros

• #define OS_READ_ONLY 0
• #define OS_WRITE_ONLY 1
• #define OS_READ_WRITE 2

9.54.1 Detailed Description

9.54.2 Macro Definition Documentation

9.54.2.1 OS_READ_ONLY #define OS_READ_ONLY 0

Read only file access
Definition at line 35 of file osapi-file.h.

9.54.2.2 OS_READ_WRITE #define OS_READ_WRITE 2

Read write file access
Definition at line 37 of file osapi-file.h.

9.54.2.3 OS_WRITE_ONLY #define OS_WRITE_ONLY 1

Write only file access
Definition at line 36 of file osapi-file.h.

Generated by Doxygen
9.55 OSAL Reference Point For Seek Offset Defines 347

9.55 OSAL Reference Point For Seek Offset Defines

Macros

• #define OS_SEEK_SET 0
• #define OS_SEEK_CUR 1
• #define OS_SEEK_END 2

9.55.1 Detailed Description

9.55.2 Macro Definition Documentation

9.55.2.1 OS_SEEK_CUR #define OS_SEEK_CUR 1

Seek offset current
Definition at line 44 of file osapi-file.h.

9.55.2.2 OS_SEEK_END #define OS_SEEK_END 2

Seek offset end
Definition at line 45 of file osapi-file.h.

9.55.2.3 OS_SEEK_SET #define OS_SEEK_SET 0

Seek offset set
Definition at line 43 of file osapi-file.h.

Generated by Doxygen
348

9.56 OSAL Standard File APIs

Functions

• int32 OS_OpenCreate (osal_id_t ∗filedes, const char ∗path, int32 flags, int32 access_mode)
Open or create a file.
• int32 OS_close (osal_id_t filedes)
Closes an open file handle.
• int32 OS_read (osal_id_t filedes, void ∗buffer, size_t nbytes)
Read from a file handle.
• int32 OS_write (osal_id_t filedes, const void ∗buffer, size_t nbytes)
Write to a file handle.
• int32 OS_TimedRead (osal_id_t filedes, void ∗buffer, size_t nbytes, int32 timeout)
File/Stream input read with a timeout.
• int32 OS_TimedWrite (osal_id_t filedes, const void ∗buffer, size_t nbytes, int32 timeout)
File/Stream output write with a timeout.
• int32 OS_chmod (const char ∗path, uint32 access_mode)
Changes the permissions of a file.
• int32 OS_stat (const char ∗path, os_fstat_t ∗filestats)
Obtain information about a file or directory.
• int32 OS_lseek (osal_id_t filedes, int32 offset, uint32 whence)
Seeks to the specified position of an open file.
• int32 OS_remove (const char ∗path)
Removes a file from the file system.
• int32 OS_rename (const char ∗old_filename, const char ∗new_filename)
Renames a file.
• int32 OS_cp (const char ∗src, const char ∗dest)
Copies a single file from src to dest.
• int32 OS_mv (const char ∗src, const char ∗dest)
Move a single file from src to dest.
• int32 OS_FDGetInfo (osal_id_t filedes, OS_file_prop_t ∗fd_prop)
Obtain information about an open file.
• int32 OS_FileOpenCheck (const char ∗Filename)
Checks to see if a file is open.
• int32 OS_CloseAllFiles (void)
Close all open files.
• int32 OS_CloseFileByName (const char ∗Filename)
Close a file by filename.

9.56.1 Detailed Description

9.56.2 Function Documentation

9.56.2.1 OS_chmod() int32 OS_chmod (

const char ∗ path,
uint32 access_mode )
Changes the permissions of a file.

Generated by Doxygen
9.56 OSAL Standard File APIs 349

Parameters

in path File to change (must not be null)

in access_mode Desired access mode - see OSAL File Access Option Defines

Note

Some file systems do not implement permissions. If the underlying OS does not support this operation, then
OS_ERR_NOT_IMPLEMENTED is returned.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution. (return value only verified in coverage test)

OS_ERR_NOT_IMPLEMENTED if the filesystem does not support this call
OS_INVALID_POINTER if the path argument is NULL

9.56.2.2 OS_close() int32 OS_close (

osal_id_t filedes )
Closes an open file handle.
This closes regular file handles and any other file-like resource, such as network streams or pipes.

Parameters

in filedes The handle ID to operate on

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the file descriptor passed in is invalid
OS_ERROR if an unexpected/unhandled error occurs (return value only verified in coverage test)

9.56.2.3 OS_CloseAllFiles() int32 OS_CloseAllFiles (

void )
Close all open files.
Closes All open files that were opened through the OSAL

Generated by Doxygen
350

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if one or more file close returned an error (return value only verified in coverage test)

9.56.2.4 OS_CloseFileByName() int32 OS_CloseFileByName (

const char ∗ Filename )
Close a file by filename.
Allows a file to be closed by name. This will only work if the name passed in is the same name used to open the file.

Parameters

in Filename The file to close (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_FS_ERR_PATH_INVALID if the file is not found
OS_ERROR if the file close returned an error (return value only verified in coverage test)
OS_INVALID_POINTER if the filename argument is NULL

9.56.2.5 OS_cp() int32 OS_cp (

const char ∗ src,
const char ∗ dest )
Copies a single file from src to dest.

Note

The behavior of this API on an open file is not defined at the OSAL level due to dependencies on the underlying
OS which may or may not allow the related operation based on a variety of potential configurations. For portability,
it is recommended that applications ensure the file is closed prior to removal.

Parameters

in src The source file to operate on (must not be null)

in dest The destination file (must not be null)

Generated by Doxygen
9.56 OSAL Standard File APIs 351

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if the file could not be accessed
OS_INVALID_POINTER if src or dest are NULL
OS_FS_ERR_PATH_INVALID if path cannot be parsed
OS_FS_ERR_PATH_TOO_LONG if the paths given are too long to be stored locally
OS_FS_ERR_NAME_TOO_LONG if the dest name is too long to be stored locally

9.56.2.6 OS_FDGetInfo() int32 OS_FDGetInfo (

osal_id_t filedes,
OS_file_prop_t ∗ fd_prop )
Obtain information about an open file.
Copies the information of the given file descriptor into a structure passed in

Parameters

in filedes The handle ID to operate on

out fd_prop Storage buffer for file information (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the file descriptor passed in is invalid
OS_INVALID_POINTER if the fd_prop argument is NULL

9.56.2.7 OS_FileOpenCheck() int32 OS_FileOpenCheck (

const char ∗ Filename )
Checks to see if a file is open.
This function takes a filename and determines if the file is open. The function will return success if the file is open.

Parameters

in Filename The file to operate on (must not be null)

Generated by Doxygen
352

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS if the file is open

OS_ERROR if the file is not open
OS_INVALID_POINTER if the filename argument is NULL

9.56.2.8 OS_lseek() int32 OS_lseek (

osal_id_t filedes,
int32 offset,
uint32 whence )
Seeks to the specified position of an open file.
Sets the read/write pointer to a specific offset in a specific file.

Parameters

in filedes The handle ID to operate on

in offset The file offset to seek to
in whence The reference point for offset, see OSAL Reference Point For Seek Offset Defines

Returns

Byte offset from the beginning of the file or appropriate error code, see OSAL Return Code Defines

Return values

OS_ERR_INVALID_ID if the file descriptor passed in is invalid

OS_ERROR if OS call failed (return value only verified in coverage test)

9.56.2.9 OS_mv() int32 OS_mv (

const char ∗ src,
const char ∗ dest )
Move a single file from src to dest.
This first attempts to rename the file, which is faster if the source and destination reside on the same file system.
If this fails, it falls back to copying the file and removing the original.

Note

The behavior of this API on an open file is not defined at the OSAL level due to dependencies on the underlying
OS which may or may not allow the related operation based on a variety of potential configurations. For portability,
it is recommended that applications ensure the file is closed prior to removal.

Generated by Doxygen
9.56 OSAL Standard File APIs 353

Parameters

in src The source file to operate on (must not be null)

in dest The destination file (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if the file could not be renamed.
OS_INVALID_POINTER if src or dest are NULL
OS_FS_ERR_PATH_INVALID if path cannot be parsed
OS_FS_ERR_PATH_TOO_LONG if the paths given are too long to be stored locally
OS_FS_ERR_NAME_TOO_LONG if the dest name is too long to be stored locally

9.56.2.10 OS_OpenCreate() int32 OS_OpenCreate (

osal_id_t ∗ filedes,
const char ∗ path,
int32 flags,
int32 access_mode )
Open or create a file.
Implements the same as OS_open/OS_creat but follows the OSAL paradigm of outputting the ID/descriptor separately
from the return value, rather than relying on the user to convert it back.

Parameters

out filedes The handle ID (OS_OBJECT_ID_UNDEFINED on failure) (must not be null)

in path File name to create or open (must not be null)
in flags The file permissions - see OS_file_flag_t
in access_mode Intended access mode - see OSAL File Access Option Defines

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if the command was not executed properly
OS_INVALID_POINTER if pointer argument was NULL
OS_ERR_NO_FREE_IDS if all available file handles are in use
OS_FS_ERR_NAME_TOO_LONG if the filename portion of the path exceeds OS_MAX_FILE_NAME
OS_FS_ERR_PATH_INVALID if the path argument is not valid
OS_FS_ERR_PATH_TOO_LONG if the path argument exceeds OS_MAX_PATH_LEN

Generated by Doxygen
354

9.56.2.11 OS_read() int32 OS_read (

osal_id_t filedes,
void ∗ buffer,
size_t nbytes )
Read from a file handle.
Reads up to nbytes from a file, and puts them into buffer.
If the file position is at the end of file (or beyond, if the OS allows) then this function will return 0.

Parameters

in filedes The handle ID to operate on

out buffer Storage location for file data (must not be null)
in nbytes Maximum number of bytes to read (must not be zero)

Note

All OSAL error codes are negative int32 values. Failure of this call can be checked by testing if the result is less
than 0.

Returns

A non-negative byte count or appropriate error code, see OSAL Return Code Defines

Return values

OS_INVALID_POINTER if buffer is a null pointer

OS_ERR_INVALID_SIZE if the passed-in size is not valid
OS_ERROR if OS call failed (return value only verified in coverage test)
OS_ERR_INVALID_ID if the file descriptor passed in is invalid
0 if at end of file/stream data

9.56.2.12 OS_remove() int32 OS_remove (

const char ∗ path )
Removes a file from the file system.
Removes a given filename from the drive

Note

The behavior of this API on an open file is not defined at the OSAL level due to dependencies on the underlying
OS which may or may not allow the related operation based on a variety of potential configurations. For portability,
it is recommended that applications ensure the file is closed prior to removal.

Parameters

in path The file to operate on (must not be null)

Generated by Doxygen
9.56 OSAL Standard File APIs 355

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if there is no device or the driver returns error
OS_INVALID_POINTER if path is NULL
OS_FS_ERR_PATH_TOO_LONG if path is too long to be stored locally
OS_FS_ERR_PATH_INVALID if path cannot be parsed
OS_FS_ERR_NAME_TOO_LONG if the name of the file to remove is too long

9.56.2.13 OS_rename() int32 OS_rename (

const char ∗ old_filename,
const char ∗ new_filename )
Renames a file.
Changes the name of a file, where the source and destination reside on the same file system.

Note

The behavior of this API on an open file is not defined at the OSAL level due to dependencies on the underlying
OS which may or may not allow the related operation based on a variety of potential configurations. For portability,
it is recommended that applications ensure the file is closed prior to removal.

Parameters

in old_filename The original filename (must not be null)

in new_filename The desired filename (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if the file could not be opened or renamed.
OS_INVALID_POINTER if old_filename or new_filename are NULL
OS_FS_ERR_PATH_INVALID if path cannot be parsed
OS_FS_ERR_PATH_TOO_LONG if the paths given are too long to be stored locally
OS_FS_ERR_NAME_TOO_LONG if the new name is too long to be stored locally

9.56.2.14 OS_stat() int32 OS_stat (

const char ∗ path,
os_fstat_t ∗ filestats )

Generated by Doxygen
356

Obtain information about a file or directory.

Returns information about a file or directory in an os_fstat_t structure

Parameters

in path The file to operate on (must not be null)

out filestats Buffer to store file information (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if path or filestats is NULL
OS_FS_ERR_PATH_TOO_LONG if the path is too long to be stored locally
OS_FS_ERR_NAME_TOO_LONG if the name of the file is too long to be stored
OS_FS_ERR_PATH_INVALID if path cannot be parsed
OS_ERROR if the OS call failed

9.56.2.15 OS_TimedRead() int32 OS_TimedRead (

osal_id_t filedes,
void ∗ buffer,
size_t nbytes,
int32 timeout )
File/Stream input read with a timeout.
This implements a time-limited read and is primarily intended for use with sockets but may also work with any other
stream-like resource that the underlying OS supports, such as pipes or special devices.
If data is immediately available on the file/socket, this will return that data along with the actual number of bytes that
were immediately available. It will not block.
If the file position is at the end of file or end of stream data (e.g. if the remote end has closed the connection), then this
function will immediately return 0 without blocking for the timeout period.
If no data is immediately available, but the underlying resource/stream is still connected to a peer, this will wait up
to the given timeout for additional data to appear. If no data appears within the timeout period, then this returns the
OS_ERROR_TIMEOUT status code. This allows the caller to differentiate an open (but idle) socket connection from a
connection which has been closed by the remote peer.
In all cases this will return successfully as soon as at least 1 byte of actual data is available. It will not attempt to read
the entire input buffer.
If an EOF condition occurs prior to timeout, this function returns zero.

Parameters

in filedes The handle ID to operate on

out buffer Storage location for file data (must not be null)
in nbytes Maximum number of bytes to read (must not be zero)
in timeout Maximum time to wait, in milliseconds (OS_PEND = forever)

Generated by Doxygen
9.56 OSAL Standard File APIs 357

Returns

Byte count on success or appropriate error code, see OSAL Return Code Defines

Return values

OS_ERROR_TIMEOUT if no data became available during timeout period

OS_ERR_INVALID_ID if the file descriptor passed in is invalid
OS_ERR_INVALID_SIZE if the passed-in size is not valid
OS_INVALID_POINTER if the passed-in buffer is not valid
0 if at end of file/stream data

9.56.2.16 OS_TimedWrite() int32 OS_TimedWrite (

osal_id_t filedes,
const void ∗ buffer,
size_t nbytes,
int32 timeout )
File/Stream output write with a timeout.
This implements a time-limited write and is primarily intended for use with sockets but may also work with any other
stream-like resource that the underlying OS supports.
If output buffer space is immediately available on the file/socket, this will place data into the buffer and return the actual
number of bytes that were queued for output. It will not block.
If no output buffer space is immediately available, this will wait up to the given timeout for space to become available. If
no space becomes available within the timeout period, then this returns an error code (not zero).
In all cases this will return successfully as soon as at least 1 byte of actual data is output. It will not attempt to write the
entire output buffer.
If an EOF condition occurs prior to timeout, this function returns zero.

Parameters

in filedes The handle ID to operate on

in buffer Source location for file data (must not be null)
in nbytes Maximum number of bytes to read (must not be zero)
in timeout Maximum time to wait, in milliseconds (OS_PEND = forever)

Returns

A non-negative byte count or appropriate error code, see OSAL Return Code Defines

Return values

OS_ERROR_TIMEOUT if no data became available during timeout period

OS_ERR_INVALID_ID if the file descriptor passed in is invalid
OS_ERR_INVALID_SIZE if the passed-in size is not valid
OS_INVALID_POINTER if the passed-in buffer is not valid
0 if file/stream cannot accept any more data

Generated by Doxygen
358

9.56.2.17 OS_write() int32 OS_write (

osal_id_t filedes,
const void ∗ buffer,
size_t nbytes )
Write to a file handle.
Writes to a file. copies up to a maximum of nbytes of buffer to the file described in filedes

Parameters

in filedes The handle ID to operate on

in buffer Source location for file data (must not be null)
in nbytes Maximum number of bytes to read (must not be zero)

Note

All OSAL error codes are negative int32 values. Failure of this call can be checked by testing if the result is less
than 0.

Returns

A non-negative byte count or appropriate error code, see OSAL Return Code Defines

Return values

OS_INVALID_POINTER if buffer is NULL

OS_ERR_INVALID_SIZE if the passed-in size is not valid
OS_ERROR if OS call failed (return value only verified in coverage test)
OS_ERR_INVALID_ID if the file descriptor passed in is invalid
0 if file/stream cannot accept any more data

Generated by Doxygen
9.57 OSAL File System Level APIs 359

9.57 OSAL File System Level APIs

Functions

• int32 OS_FileSysAddFixedMap (osal_id_t ∗filesys_id, const char ∗phys_path, const char ∗virt_path)
Create a fixed mapping between an existing directory and a virtual OSAL mount point.
• int32 OS_mkfs (char ∗address, const char ∗devname, const char ∗volname, size_t blocksize, osal_blockcount_t
numblocks)
Makes a file system on the target.
• int32 OS_mount (const char ∗devname, const char ∗mountpoint)
Mounts a file system.
• int32 OS_initfs (char ∗address, const char ∗devname, const char ∗volname, size_t blocksize, osal_blockcount_t
numblocks)
Initializes an existing file system.
• int32 OS_rmfs (const char ∗devname)
Removes a file system.
• int32 OS_unmount (const char ∗mountpoint)
Unmounts a mounted file system.
• int32 OS_FileSysStatVolume (const char ∗name, OS_statvfs_t ∗statbuf)
Obtains information about size and free space in a volume.
• int32 OS_chkfs (const char ∗name, bool repair)
Checks the health of a file system and repairs it if necessary.
• int32 OS_FS_GetPhysDriveName (char ∗PhysDriveName, const char ∗MountPoint)
Obtains the physical drive name associated with a mount point.
• int32 OS_TranslatePath (const char ∗VirtualPath, char ∗LocalPath)
Translates an OSAL Virtual file system path to a host Local path.
• int32 OS_GetFsInfo (os_fsinfo_t ∗filesys_info)
Returns information about the file system.

9.57.1 Detailed Description

9.57.2 Function Documentation

9.57.2.1 OS_chkfs() int32 OS_chkfs (

const char ∗ name,
bool repair )
Checks the health of a file system and repairs it if necessary.
Checks the drives for inconsistencies and optionally also repairs it

Note

not all operating systems implement this function. If the underlying OS does not provide a facility to check the
volume, then OS_ERR_NOT_IMPLEMENTED will be returned.

Parameters

in name The device/path to operate on (must not be null)

in repair Whether to also repair inconsistencies

Generated by Doxygen
360

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution. (return value only verified in coverage test)

OS_INVALID_POINTER Name is NULL
OS_ERR_NOT_IMPLEMENTED Not implemented.
OS_FS_ERR_PATH_TOO_LONG if the name is too long
OS_ERROR Failed execution. (return value only verified in coverage test)

9.57.2.2 OS_FileSysAddFixedMap() int32 OS_FileSysAddFixedMap (

osal_id_t ∗ filesys_id,
const char ∗ phys_path,
const char ∗ virt_path )
Create a fixed mapping between an existing directory and a virtual OSAL mount point.
This mimics the behavior of a "FS_BASED" entry in the VolumeTable but is registered at runtime. It is intended to be
called by the PSP/BSP prior to starting the application.

Note

OSAL virtual mount points are required to be a single, non-empty top-level directory name. Virtual path names al-
ways follow the form /<virt_mount_point>/<relative_path>/<file>. Only the relative path may be omitted/empty
(i.e. /<virt_mount_point>/<file>) but the virtual mount point must be present and not an empty string. In partic-
ular this means it is not possible to directly refer to files in the "root" of the native file system from OSAL. However
it is possible to create a virtual map to the root, such as by calling:

OS_FileSysAddFixedMap(&fs_id, "/", "/root");

Parameters

out filesys_id A buffer to store the ID of the file system mapping (must not be null)
in phys_path The native system directory (an existing mount point) (must not be null)
in virt_path The virtual mount point of this filesystem (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_FS_ERR_PATH_TOO_LONG if the overall phys_path is too long
OS_ERR_NAME_TOO_LONG if the phys_path basename (filesystem name) is too long
OS_INVALID_POINTER if any argument is NULL

Generated by Doxygen
9.57 OSAL File System Level APIs 361

9.57.2.3 OS_FileSysStatVolume() int32 OS_FileSysStatVolume (

const char ∗ name,
OS_statvfs_t ∗ statbuf )
Obtains information about size and free space in a volume.
Populates the supplied OS_statvfs_t structure, which includes the block size and total/free blocks in a file system volume.
This replaces two older OSAL calls:
OS_fsBlocksFree() is determined by reading the blocks_free output struct member OS_fsBytesFree() is determined by
multiplying blocks_free by the block_size member

Parameters

in name The device/path to operate on (must not be null)

out statbuf Output structure to populate (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if name or statbuf is NULL
OS_FS_ERR_PATH_TOO_LONG if the name is too long
OS_ERROR if an unexpected/unhandled OS error occurs (return value only verified in
coverage test)

9.57.2.4 OS_FS_GetPhysDriveName() int32 OS_FS_GetPhysDriveName (

char ∗ PhysDriveName,
const char ∗ MountPoint )
Obtains the physical drive name associated with a mount point.
Returns the name of the physical volume associated with the drive, when given the OSAL mount point of the drive

Parameters

out PhysDriveName Buffer to store physical drive name (must not be null)
in MountPoint OSAL mount point (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if either parameter is NULL
OS_ERR_NAME_NOT_FOUND if the MountPoint is not mounted in OSAL
OS_FS_ERR_PATH_TOO_LONG if the MountPoint is too long

Generated by Doxygen
362

9.57.2.5 OS_GetFsInfo() int32 OS_GetFsInfo (

os_fsinfo_t ∗ filesys_info )
Returns information about the file system.
Returns information about the file system in an os_fsinfo_t. This includes the number of open files and file systems

Parameters

out filesys_info Buffer to store filesystem information (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if filesys_info is NULL

9.57.2.6 OS_initfs() int32 OS_initfs (

char ∗ address,
const char ∗ devname,
const char ∗ volname,
size_t blocksize,
osal_blockcount_t numblocks )
Initializes an existing file system.
Initializes a file system on the target.

Note

The "volname" parameter of RAM disks should always begin with the string "RAM", e.g. "RAMDISK" or "RA←-
M0","RAM1", etc if multiple devices are created. The underlying implementation uses this to select the correct
filesystem type/format, and this may also be used to differentiate between RAM disks and real physical disks.

Parameters

in address The address at which to start the new disk. If address == 0, then space will be allocated by
the OS
in devname The underlying kernel device to use, if applicable. (must not be null)
in volname The name of the volume (see note) (must not be null)
in blocksize The size of a single block on the drive
in numblocks The number of blocks to allocate for the drive

Returns

Execution status, see OSAL Return Code Defines

Generated by Doxygen
9.57 OSAL File System Level APIs 363

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if devname or volname are NULL
OS_FS_ERR_PATH_TOO_LONG if the name is too long
OS_FS_ERR_DEVICE_NOT_FREE if the volume table is full
OS_FS_ERR_DRIVE_NOT_CREATED if an unexpected/unhandled OS error occurs (return value only verified in
coverage test)

9.57.2.7 OS_mkfs() int32 OS_mkfs (

char ∗ address,
const char ∗ devname,
const char ∗ volname,
size_t blocksize,
osal_blockcount_t numblocks )
Makes a file system on the target.
Makes a file system on the target. Highly dependent on underlying OS and dependent on OS volume table definition.

Note

The "volname" parameter of RAM disks should always begin with the string "RAM", e.g. "RAMDISK" or "RA←-
M0","RAM1", etc if multiple devices are created. The underlying implementation uses this to select the correct
filesystem type/format, and this may also be used to differentiate between RAM disks and real physical disks.

Parameters

in address The address at which to start the new disk. If address == 0 space will be allocated by the OS.
in devname The underlying kernel device to use, if applicable. (must not be null)
in volname The name of the volume (see note) (must not be null)
in blocksize The size of a single block on the drive
in numblocks The number of blocks to allocate for the drive

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if devname or volname is NULL
OS_FS_ERR_PATH_TOO_LONG if the overall devname or volname is too long
OS_FS_ERR_DEVICE_NOT_FREE if the volume table is full
OS_FS_ERR_DRIVE_NOT_CREATED if an unexpected/unhandled OS error occurs (return value only verified in
coverage test)

9.57.2.8 OS_mount() int32 OS_mount (

Generated by Doxygen
364

const char ∗ devname,

const char ∗ mountpoint )
Mounts a file system.
Mounts a file system / block device at the given mount point.

Parameters

in devname The name of the drive to mount. devname is the same from OS_mkfs (must not be null)
in mountpoint The name to call this disk from now on (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_NAME_NOT_FOUND if the device name does not exist in OSAL
OS_FS_ERR_PATH_TOO_LONG if the mount point string is too long
OS_INVALID_POINTER if any argument is NULL
OS_ERROR if an unexpected/unhandled OS error occurs (return value only verified in
coverage test)

9.57.2.9 OS_rmfs() int32 OS_rmfs (

const char ∗ devname )
Removes a file system.
This function will remove or un-map the target file system. Note that this is not the same as un-mounting the file system.

Parameters

in devname The name of the "generic" drive (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if devname is NULL
OS_FS_ERR_PATH_TOO_LONG if the devname is too long
OS_ERR_NAME_NOT_FOUND if the devname does not exist in OSAL
OS_ERROR if an unexpected/unhandled OS error occurs (return value only verified in
coverage test)

Generated by Doxygen
9.57 OSAL File System Level APIs 365

9.57.2.10 OS_TranslatePath() int32 OS_TranslatePath (

const char ∗ VirtualPath,
char ∗ LocalPath )
Translates an OSAL Virtual file system path to a host Local path.
Translates a virtual path to an actual system path name

Note

The buffer provided in the LocalPath argument is required to be at least OS_MAX_PATH_LEN characters in length.

Parameters

in VirtualPath OSAL virtual path name (must not be null)

out LocalPath Buffer to store native/translated path name (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if either parameter is NULL
OS_FS_ERR_NAME_TOO_LONG if the filename component is too long
OS_FS_ERR_PATH_INVALID if either parameter cannot be interpreted as a path
OS_FS_ERR_PATH_TOO_LONG if either input or output pathnames are too long

9.57.2.11 OS_unmount() int32 OS_unmount (

const char ∗ mountpoint )
Unmounts a mounted file system.
This function will unmount a drive from the file system and make all open file descriptors useless.

Note

Any open file descriptors referencing this file system should be closed prior to unmounting a drive

Parameters

in mountpoint The mount point to remove from OS_mount (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if name is NULL
OS_FS_ERR_PATH_TOO_LONG if the absolute path given is too long

Generated by Doxygen
366

Return values

OS_ERR_NAME_NOT_FOUND if the mountpoint is not mounted in OSAL

OS_ERROR if an unexpected/unhandled OS error occurs (return value only verified in
coverage test)

Generated by Doxygen
9.58 OSAL Heap APIs 367

9.58 OSAL Heap APIs

Functions

• int32 OS_HeapGetInfo (OS_heap_prop_t ∗heap_prop)

Return current info on the heap.

9.58.1 Detailed Description

9.58.2 Function Documentation

9.58.2.1 OS_HeapGetInfo() int32 OS_HeapGetInfo (

OS_heap_prop_t ∗ heap_prop )
Return current info on the heap.

Parameters

out heap_prop Storage buffer for heap info

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if the heap_prop argument is NULL

Generated by Doxygen
368

9.59 OSAL Object Type Defines

Macros

• #define OS_OBJECT_TYPE_UNDEFINED 0x00

Object type undefined.
• #define OS_OBJECT_TYPE_OS_TASK 0x01
Object task type.
• #define OS_OBJECT_TYPE_OS_QUEUE 0x02
Object queue type.
• #define OS_OBJECT_TYPE_OS_COUNTSEM 0x03
Object counting semaphore type.
• #define OS_OBJECT_TYPE_OS_BINSEM 0x04
Object binary semaphore type.
• #define OS_OBJECT_TYPE_OS_MUTEX 0x05
Object mutex type.
• #define OS_OBJECT_TYPE_OS_STREAM 0x06
Object stream type.
• #define OS_OBJECT_TYPE_OS_DIR 0x07
Object directory type.
• #define OS_OBJECT_TYPE_OS_TIMEBASE 0x08
Object timebase type.
• #define OS_OBJECT_TYPE_OS_TIMECB 0x09
Object timer callback type.
• #define OS_OBJECT_TYPE_OS_MODULE 0x0A
Object module type.
• #define OS_OBJECT_TYPE_OS_FILESYS 0x0B
Object file system type.
• #define OS_OBJECT_TYPE_OS_CONSOLE 0x0C
Object console type.
• #define OS_OBJECT_TYPE_OS_CONDVAR 0x0D
Object condition variable type.
• #define OS_OBJECT_TYPE_USER 0x10
Object user type.

9.59.1 Detailed Description

9.59.2 Macro Definition Documentation

9.59.2.1 OS_OBJECT_TYPE_OS_BINSEM #define OS_OBJECT_TYPE_OS_BINSEM 0x04

Object binary semaphore type.
Definition at line 42 of file osapi-idmap.h.

9.59.2.2 OS_OBJECT_TYPE_OS_CONDVAR #define OS_OBJECT_TYPE_OS_CONDVAR 0x0D

Object condition variable type.
Definition at line 51 of file osapi-idmap.h.

Generated by Doxygen
9.59 OSAL Object Type Defines 369

9.59.2.3 OS_OBJECT_TYPE_OS_CONSOLE #define OS_OBJECT_TYPE_OS_CONSOLE 0x0C

Object console type.
Definition at line 50 of file osapi-idmap.h.

9.59.2.4 OS_OBJECT_TYPE_OS_COUNTSEM #define OS_OBJECT_TYPE_OS_COUNTSEM 0x03

Object counting semaphore type.
Definition at line 41 of file osapi-idmap.h.

9.59.2.5 OS_OBJECT_TYPE_OS_DIR #define OS_OBJECT_TYPE_OS_DIR 0x07

Object directory type.
Definition at line 45 of file osapi-idmap.h.

9.59.2.6 OS_OBJECT_TYPE_OS_FILESYS #define OS_OBJECT_TYPE_OS_FILESYS 0x0B

Object file system type.
Definition at line 49 of file osapi-idmap.h.

9.59.2.7 OS_OBJECT_TYPE_OS_MODULE #define OS_OBJECT_TYPE_OS_MODULE 0x0A

Object module type.
Definition at line 48 of file osapi-idmap.h.

9.59.2.8 OS_OBJECT_TYPE_OS_MUTEX #define OS_OBJECT_TYPE_OS_MUTEX 0x05

Object mutex type.
Definition at line 43 of file osapi-idmap.h.

9.59.2.9 OS_OBJECT_TYPE_OS_QUEUE #define OS_OBJECT_TYPE_OS_QUEUE 0x02

Object queue type.
Definition at line 40 of file osapi-idmap.h.

9.59.2.10 OS_OBJECT_TYPE_OS_STREAM #define OS_OBJECT_TYPE_OS_STREAM 0x06

Object stream type.
Definition at line 44 of file osapi-idmap.h.

9.59.2.11 OS_OBJECT_TYPE_OS_TASK #define OS_OBJECT_TYPE_OS_TASK 0x01

Object task type.
Definition at line 39 of file osapi-idmap.h.

9.59.2.12 OS_OBJECT_TYPE_OS_TIMEBASE #define OS_OBJECT_TYPE_OS_TIMEBASE 0x08

Object timebase type.
Definition at line 46 of file osapi-idmap.h.

Generated by Doxygen
370

9.59.2.13 OS_OBJECT_TYPE_OS_TIMECB #define OS_OBJECT_TYPE_OS_TIMECB 0x09

Object timer callback type.
Definition at line 47 of file osapi-idmap.h.

9.59.2.14 OS_OBJECT_TYPE_UNDEFINED #define OS_OBJECT_TYPE_UNDEFINED 0x00

Object type undefined.
Definition at line 38 of file osapi-idmap.h.

9.59.2.15 OS_OBJECT_TYPE_USER #define OS_OBJECT_TYPE_USER 0x10

Object user type.
Definition at line 52 of file osapi-idmap.h.

Generated by Doxygen
9.60 OSAL Object ID Utility APIs 371

9.60 OSAL Object ID Utility APIs

Functions

• static unsigned long OS_ObjectIdToInteger (osal_id_t object_id)

Obtain an integer value corresponding to an object ID.
• static osal_id_t OS_ObjectIdFromInteger (unsigned long value)
Obtain an osal ID corresponding to an integer value.
• static bool OS_ObjectIdEqual (osal_id_t object_id1, osal_id_t object_id2)
Check two OSAL object ID values for equality.
• static bool OS_ObjectIdDefined (osal_id_t object_id)
Check if an object ID is defined.
• int32 OS_GetResourceName (osal_id_t object_id, char ∗buffer, size_t buffer_size)
Obtain the name of an object given an arbitrary object ID.
• osal_objtype_t OS_IdentifyObject (osal_id_t object_id)
Obtain the type of an object given an arbitrary object ID.
• int32 OS_ConvertToArrayIndex (osal_id_t object_id, osal_index_t ∗ArrayIndex)
Converts an abstract ID into a number suitable for use as an array index.
• int32 OS_ObjectIdToArrayIndex (osal_objtype_t idtype, osal_id_t object_id, osal_index_t ∗ArrayIndex)
Converts an abstract ID into a number suitable for use as an array index.
• void OS_ForEachObject (osal_id_t creator_id, OS_ArgCallback_t callback_ptr, void ∗callback_arg)
call the supplied callback function for all valid object IDs
• void OS_ForEachObjectOfType (osal_objtype_t objtype, osal_id_t creator_id, OS_ArgCallback_t callback_ptr,
void ∗callback_arg)
call the supplied callback function for valid object IDs of a specific type

9.60.1 Detailed Description

9.60.2 Function Documentation

9.60.2.1 OS_ConvertToArrayIndex() int32 OS_ConvertToArrayIndex (

osal_id_t object_id,
osal_index_t ∗ ArrayIndex )
Converts an abstract ID into a number suitable for use as an array index.
This will return a unique zero-based integer number in the range of [0,MAX) for any valid object ID. This may be used
by application code as an array index for indexing into local tables.

Note

This does NOT verify the validity of the ID, that is left to the caller. This is only the conversion logic.

This routine accepts any object type, and returns a value based on the maximum number of objects for that type. This
is equivalent to invoking OS_ObjectIdToArrayIndex() with the idtype set to OS_OBJECT_TYPE_UNDEFINED.

See also

OS_ObjectIdToArrayIndex

Parameters
in object_id The object ID to operate on
out ∗ArrayIndex The Index to return (must not be null)

Generated by Doxygen
372

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the object_id argument is not valid
OS_INVALID_POINTER if the ArrayIndex is NULL

9.60.2.2 OS_ForEachObject() void OS_ForEachObject (

osal_id_t creator_id,
OS_ArgCallback_t callback_ptr,
void ∗ callback_arg )
call the supplied callback function for all valid object IDs
Loops through all defined OSAL objects of all types and calls callback_ptr on each one If creator_id is nonzero then only
objects with matching creator id are processed.

Parameters

in creator_id Filter objects to those created by a specific task This may be passed as
OS_OBJECT_CREATOR_ANY to return all objects
in callback_ptr Function to invoke for each matching object ID
in callback_arg Opaque Argument to pass to callback function (may be NULL)

9.60.2.3 OS_ForEachObjectOfType() void OS_ForEachObjectOfType (

osal_objtype_t objtype,
osal_id_t creator_id,
OS_ArgCallback_t callback_ptr,
void ∗ callback_arg )
call the supplied callback function for valid object IDs of a specific type
Loops through all defined OSAL objects of a specific type and calls callback_ptr on each one If creator_id is nonzero
then only objects with matching creator id are processed.

Parameters

in objtype The type of objects to iterate

in creator_id Filter objects to those created by a specific task This may be passed as
OS_OBJECT_CREATOR_ANY to return all objects
in callback_ptr Function to invoke for each matching object ID
in callback_arg Opaque Argument to pass to callback function (may be NULL)

9.60.2.4 OS_GetResourceName() int32 OS_GetResourceName (

osal_id_t object_id,
char ∗ buffer,

Generated by Doxygen
9.60 OSAL Object ID Utility APIs 373

size_t buffer_size )
Obtain the name of an object given an arbitrary object ID.
All OSAL resources generally have a name associated with them. This allows application code to retrieve the name of
any valid OSAL object ID.

Parameters
in object_id The object ID to operate on
out buffer Buffer in which to store the name (must not be null)
in buffer_size Size of the output storage buffer (must not be zero)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the passed-in ID is not a valid OSAL ID
OS_INVALID_POINTER if the passed-in buffer is invalid
OS_ERR_NAME_TOO_LONG if the name will not fit in the buffer provided

9.60.2.5 OS_IdentifyObject() osal_objtype_t OS_IdentifyObject (

osal_id_t object_id )
Obtain the type of an object given an arbitrary object ID.
Given an arbitrary object ID, get the type of the object

Parameters
in object←- The object ID to operate on
_id

Returns

The object type portion of the object_id, see OSAL Object Type Defines for expected values

9.60.2.6 OS_ObjectIdDefined() static bool OS_ObjectIdDefined (

osal_id_t object_id ) [inline], [static]
Check if an object ID is defined.
The OSAL ID values should be treated as abstract values by applications, and not directly manipulated using standard
C operators.
This returns false if the ID is NOT a defined resource (i.e. free/empty/invalid).

Note

OS_ObjectIdDefined(OS_OBJECT_ID_UNDEFINED) is always guaranteed to be false.

Generated by Doxygen
374

Parameters

in object←- The first object ID

_id

Definition at line 150 of file osapi-idmap.h.

References OS_ObjectIdToInteger().

9.60.2.7 OS_ObjectIdEqual() static bool OS_ObjectIdEqual (

osal_id_t object_id1,
osal_id_t object_id2 ) [inline], [static]
Check two OSAL object ID values for equality.
The OSAL ID values should be treated as abstract values by applications, and not directly manipulated using standard
C operators.
This checks two values for equality, replacing the "==" operator.

Parameters

in object_id1 The first object ID

in object_id2 The second object ID

Returns

true if the object IDs are equal

Definition at line 129 of file osapi-idmap.h.

References OS_ObjectIdToInteger().

9.60.2.8 OS_ObjectIdFromInteger() static osal_id_t OS_ObjectIdFromInteger (

unsigned long value ) [inline], [static]
Obtain an osal ID corresponding to an integer value.
Provides the inverse of OS_ObjectIdToInteger(). Reconstitutes the original osal_id_t type from an integer representation.

Parameters

in value The integer representation of an OSAL ID

Returns

The ID value converted to an osal_id_t

Definition at line 102 of file osapi-idmap.h.

9.60.2.9 OS_ObjectIdToArrayIndex() int32 OS_ObjectIdToArrayIndex (

osal_objtype_t idtype,
osal_id_t object_id,
osal_index_t ∗ ArrayIndex )
Converts an abstract ID into a number suitable for use as an array index.
This will return a unique zero-based integer number in the range of [0,MAX) for any valid object ID. This may be used
by application code as an array index for indexing into local tables.

Generated by Doxygen
9.60 OSAL Object ID Utility APIs 375

This routine operates on a specific object type, and returns a value based on the maximum number of objects for that
type.
If the idtype is passed as OS_OBJECT_TYPE_UNDEFINED, then object type verification is skipped and any object ID
will be accepted and converted to an index. In this mode, the range of the output depends on the actual passed-in object
type.
If the idtype is passed as any other value, the passed-in ID value is first confirmed to be the correct type.
This check will guarantee that the output is within an expected range; for instance, if the type is passed as
OS_OBJECT_TYPE_OS_TASK, then the output index is guaranteed to be between 0 and OS_MAX_TASKS-1 after
successful conversion.

Parameters
in idtype The object type to convert
in object_id The object ID to operate on
out ∗ArrayIndex The Index to return (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the object_id argument is not valid
OS_INVALID_POINTER if the ArrayIndex is NULL

9.60.2.10 OS_ObjectIdToInteger() static unsigned long OS_ObjectIdToInteger (

osal_id_t object_id ) [inline], [static]
Obtain an integer value corresponding to an object ID.
Obtains an integer representation of an object id, generally for the purpose of printing to the console or system logs.
The returned value is of the type "unsigned long" for direct use with printf-style functions. It is recommended to use the
"%lx" conversion specifier as the hexadecimal encoding clearly delineates the internal fields.

Note

This provides the raw integer value and is not suitable for use as an array index, as the result is not zero-based.
See the OS_ConvertToArrayIndex() to obtain a zero-based index value.

Parameters
in object←- The object ID
_id

Returns

integer value representation of object ID

Definition at line 80 of file osapi-idmap.h.

Referenced by OS_ObjectIdDefined(), and OS_ObjectIdEqual().

Generated by Doxygen
376

9.61 OSAL Dynamic Loader and Symbol APIs

Functions

• int32 OS_SymbolLookup (cpuaddr ∗symbol_address, const char ∗symbol_name)

Find the Address of a Symbol.
• int32 OS_ModuleSymbolLookup (osal_id_t module_id, cpuaddr ∗symbol_address, const char ∗symbol_name)
Find the Address of a Symbol within a module.
• int32 OS_SymbolTableDump (const char ∗filename, size_t size_limit)
Dumps the system symbol table to a file.
• int32 OS_ModuleLoad (osal_id_t ∗module_id, const char ∗module_name, const char ∗filename, uint32 flags)
Loads an object file.
• int32 OS_ModuleUnload (osal_id_t module_id)
Unloads the module file.
• int32 OS_ModuleInfo (osal_id_t module_id, OS_module_prop_t ∗module_info)
Obtain information about a module.

9.61.1 Detailed Description

9.61.2 Function Documentation

9.61.2.1 OS_ModuleInfo() int32 OS_ModuleInfo (

osal_id_t module_id,
OS_module_prop_t ∗ module_info )
Obtain information about a module.
Returns information about the loadable module

Parameters

in module_id OSAL ID of the previously the loaded module

out module_info Buffer to store module information (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the module id invalid
OS_INVALID_POINTER if the pointer to the ModuleInfo structure is invalid
OS_ERROR if an other/unspecified error occurs (return value only verified in coverage test)

9.61.2.2 OS_ModuleLoad() int32 OS_ModuleLoad (

osal_id_t ∗ module_id,
const char ∗ module_name,
const char ∗ filename,

Generated by Doxygen
9.61 OSAL Dynamic Loader and Symbol APIs 377

uint32 flags )
Loads an object file.
Loads an object file into the running operating system
The "flags" parameter may influence how the loaded module symbols are made available for use in the application. See
OS_MODULE_FLAG_LOCAL_SYMBOLS and OS_MODULE_FLAG_GLOBAL_SYMBOLS for descriptions.

Parameters

out module_id Non-zero OSAL ID corresponding to the loaded module

in module_name Name of module (must not be null)
in filename File containing the object code to load (must not be null)
in flags Options for the loaded module

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if one of the parameters is NULL
OS_ERR_NO_FREE_IDS if the module table is full
OS_ERR_NAME_TAKEN if the name is in use
OS_ERR_NAME_TOO_LONG if the module_name is too long
OS_FS_ERR_PATH_INVALID if the filename argument is not valid
OS_ERROR if an other/unspecified error occurs (return value only verified in coverage test)

9.61.2.3 OS_ModuleSymbolLookup() int32 OS_ModuleSymbolLookup (

osal_id_t module_id,
cpuaddr ∗ symbol_address,
const char ∗ symbol_name )
Find the Address of a Symbol within a module.
This is similar to OS_SymbolLookup() but for a specific module ID. This should be used to look up a symbol in a module
that has been loaded with the OS_MODULE_FLAG_LOCAL_SYMBOLS flag.

Parameters
in module_id Module ID that should contain the symbol
out symbol_address Set to the address of the symbol (must not be null)
in symbol_name Name of the symbol to look up (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

Generated by Doxygen
378

Return values

OS_ERROR if the symbol could not be found

OS_INVALID_POINTER if one of the pointers passed in are NULL

9.61.2.4 OS_ModuleUnload() int32 OS_ModuleUnload (

osal_id_t module_id )
Unloads the module file.
Unloads the module file from the running operating system

Parameters

in module←- OSAL ID of the previously the loaded module

_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the module id invalid
OS_ERROR if an other/unspecified error occurs (return value only verified in coverage test)

9.61.2.5 OS_SymbolLookup() int32 OS_SymbolLookup (

cpuaddr ∗ symbol_address,
const char ∗ symbol_name )
Find the Address of a Symbol.
This calls to the OS dynamic symbol lookup implementation, and/or checks a static symbol table for a matching symbol
name.
The static table is intended to support embedded targets that do not have module loading capability or have it disabled.

Parameters

out symbol_address Set to the address of the symbol (must not be null)
in symbol_name Name of the symbol to look up (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if the symbol could not be found
OS_INVALID_POINTER if one of the pointers passed in are NULL

Generated by Doxygen
9.61 OSAL Dynamic Loader and Symbol APIs 379

9.61.2.6 OS_SymbolTableDump() int32 OS_SymbolTableDump (

const char ∗ filename,
size_t size_limit )
Dumps the system symbol table to a file.
Dumps the system symbol table to the specified filename

Note

Not all RTOS implementations support this API. If the underlying module subsystem does not provide a facility to
iterate through the symbol table, then the OS_ERR_NOT_IMPLEMENTED status code is returned.

Parameters

in filename File to write to (must not be null)

in size_limit Maximum number of bytes to write

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_NOT_IMPLEMENTED Not implemented.
OS_INVALID_POINTER if the filename argument is NULL
OS_FS_ERR_PATH_INVALID if the filename argument is not valid
OS_ERR_NAME_TOO_LONG if any of the symbol names are too long (return value only verified in coverage
test)
OS_ERR_OUTPUT_TOO_LARGE if the size_limit was reached before completing all symbols (return value only
verified in coverage test)
OS_ERROR if an other/unspecified error occurs (return value only verified in coverage
test)

Generated by Doxygen
380

9.62 OSAL Mutex APIs

Functions

• int32 OS_MutSemCreate (osal_id_t ∗sem_id, const char ∗sem_name, uint32 options)

Creates a mutex semaphore.
• int32 OS_MutSemGive (osal_id_t sem_id)
Releases the mutex object referenced by sem_id.
• int32 OS_MutSemTake (osal_id_t sem_id)
Acquire the mutex object referenced by sem_id.
• int32 OS_MutSemDelete (osal_id_t sem_id)
Deletes the specified Mutex Semaphore.
• int32 OS_MutSemGetIdByName (osal_id_t ∗sem_id, const char ∗sem_name)
Find an existing mutex ID by name.
• int32 OS_MutSemGetInfo (osal_id_t sem_id, OS_mut_sem_prop_t ∗mut_prop)
Fill a property object buffer with details regarding the resource.

9.62.1 Detailed Description

9.62.2 Function Documentation

9.62.2.1 OS_MutSemCreate() int32 OS_MutSemCreate (

osal_id_t ∗ sem_id,
const char ∗ sem_name,
uint32 options )
Creates a mutex semaphore.
Mutex semaphores are always created in the unlocked (full) state.

Parameters

out sem_id will be set to the non-zero ID of the newly-created resource (must not be null)
in sem_name the name of the new resource to create (must not be null)
in options reserved for future use. Should be passed as 0.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if sem_id or sem_name are NULL
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NO_FREE_IDS if there are no more free mutex Ids
OS_ERR_NAME_TAKEN if there is already a mutex with the same name
OS_SEM_FAILURE if the OS call failed (return value only verified in coverage test)

Generated by Doxygen
9.62 OSAL Mutex APIs 381

9.62.2.2 OS_MutSemDelete() int32 OS_MutSemDelete (

osal_id_t sem_id )
Deletes the specified Mutex Semaphore.
Delete the semaphore. This also frees the respective sem_id such that it can be used again when another is created.

Parameters
in sem←- The object ID to delete
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid mutex
OS_SEM_FAILURE if an unspecified error occurs (return value only verified in coverage test)

9.62.2.3 OS_MutSemGetIdByName() int32 OS_MutSemGetIdByName (

osal_id_t ∗ sem_id,
const char ∗ sem_name )
Find an existing mutex ID by name.
This function tries to find a mutex sem Id given the name of a mut_sem. The id is returned through sem_id

Parameters

out sem_id will be set to the ID of the existing resource

in sem_name the name of the existing resource to find (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER is semid or sem_name are NULL pointers
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_NOT_FOUND if the name was not found in the table

9.62.2.4 OS_MutSemGetInfo() int32 OS_MutSemGetInfo (

osal_id_t sem_id,
OS_mut_sem_prop_t ∗ mut_prop )
Fill a property object buffer with details regarding the resource.

Generated by Doxygen
382

This function will pass back a pointer to structure that contains all of the relevant info( name and creator) about the
specified mutex semaphore.

Parameters
in sem_id The object ID to operate on
out mut_prop The property object buffer to fill (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid semaphore
OS_INVALID_POINTER if the mut_prop pointer is null

9.62.2.5 OS_MutSemGive() int32 OS_MutSemGive (

osal_id_t sem_id )
Releases the mutex object referenced by sem_id.
If there are threads blocked on the mutex object referenced by mutex when this function is called, resulting in the mutex
becoming available, the scheduling policy shall determine which thread shall acquire the mutex.

Parameters
in sem←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid mutex
OS_SEM_FAILURE if an unspecified error occurs (return value only verified in coverage test)

9.62.2.6 OS_MutSemTake() int32 OS_MutSemTake (

osal_id_t sem_id )
Acquire the mutex object referenced by sem_id.
If the mutex is already locked, the calling thread shall block until the mutex becomes available. This operation shall
return with the mutex object referenced by mutex in the locked state with the calling thread as its owner.

Generated by Doxygen
9.62 OSAL Mutex APIs 383

Parameters
in sem←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID the id passed in is not a valid mutex
OS_SEM_FAILURE if an unspecified error occurs (return value only verified in coverage test)

Generated by Doxygen
384

9.63 OSAL Network ID APIs

Provides some basic methods to query a network host name and ID.

Functions

• int32 OS_NetworkGetID (void)

Gets the network ID of the local machine.
• int32 OS_NetworkGetHostName (char ∗host_name, size_t name_len)
Gets the local machine network host name.

9.63.1 Detailed Description

Provides some basic methods to query a network host name and ID.

9.63.2 Function Documentation

9.63.2.1 OS_NetworkGetHostName() int32 OS_NetworkGetHostName (

char ∗ host_name,
size_t name_len )
Gets the local machine network host name.
If configured in the underlying network stack, this function retrieves the local hostname of the system.

Parameters

out host_name Buffer to hold name information (must not be null)

in name_len Maximum length of host name buffer (must not be zero)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_SIZE if the name_len is zero
OS_INVALID_POINTER if the host_name is NULL

9.63.2.2 OS_NetworkGetID() int32 OS_NetworkGetID (

void )
Gets the network ID of the local machine.
The ID is an implementation-defined value and may not be consistent in meaning across different platform types.

Note

This API may be removed in a future version of OSAL due to inconsistencies between platforms.

Generated by Doxygen
9.63 OSAL Network ID APIs 385

Returns

The ID or fixed value of -1 if the host id could not be found. Note it is not possible to differentiate between error
codes and valid network IDs here. It is assumed, however, that -1 is never a valid ID.

Generated by Doxygen
386

9.64 OSAL Printf APIs

Functions

• void OS_printf (const char ∗string,...) OS_PRINTF(1

Abstraction for the system printf() call.
• void void OS_printf_disable (void)
This function disables the output from OS_printf.
• void OS_printf_enable (void)
This function enables the output from OS_printf.

9.64.1 Detailed Description

9.64.2 Function Documentation

9.64.2.1 OS_printf() void OS_printf (

const char ∗ string,
... )
Abstraction for the system printf() call.
This function abstracts out the printf type statements. This is useful for using OS- specific thats that will allow non-polled
print statements for the real time systems.
Operates in a manner similar to the printf() call defined by the standard C library and takes all the parameters and
formatting options of printf. This abstraction may implement additional buffering, if necessary, to improve the real-time
performance of the call.
Strings (including terminator) longer than OS_BUFFER_SIZE will be truncated.
The output of this routine also may be dynamically enabled or disabled by the OS_printf_enable() and
OS_printf_disable() calls, respectively.

Parameters

in string Format string, followed by additional arguments

9.64.2.2 OS_printf_disable() void void OS_printf_disable (

void )
This function disables the output from OS_printf.

9.64.2.3 OS_printf_enable() void OS_printf_enable (

void )
This function enables the output from OS_printf.

Generated by Doxygen
9.65 OSAL Message Queue APIs 387

9.65 OSAL Message Queue APIs

Functions

• int32 OS_QueueCreate (osal_id_t ∗queue_id, const char ∗queue_name, osal_blockcount_t queue_depth, size←-
_t data_size, uint32 flags)
Create a message queue.
• int32 OS_QueueDelete (osal_id_t queue_id)
Deletes the specified message queue.
• int32 OS_QueueGet (osal_id_t queue_id, void ∗data, size_t size, size_t ∗size_copied, int32 timeout)
Receive a message on a message queue.
• int32 OS_QueuePut (osal_id_t queue_id, const void ∗data, size_t size, uint32 flags)
Put a message on a message queue.
• int32 OS_QueueGetIdByName (osal_id_t ∗queue_id, const char ∗queue_name)
Find an existing queue ID by name.
• int32 OS_QueueGetInfo (osal_id_t queue_id, OS_queue_prop_t ∗queue_prop)
Fill a property object buffer with details regarding the resource.

9.65.1 Detailed Description

9.65.2 Function Documentation

9.65.2.1 OS_QueueCreate() int32 OS_QueueCreate (

osal_id_t ∗ queue_id,
const char ∗ queue_name,
osal_blockcount_t queue_depth,
size_t data_size,
uint32 flags )
Create a message queue.
This is the function used to create a queue in the operating system. Depending on the underlying operating system, the
memory for the queue will be allocated automatically or allocated by the code that sets up the queue. Queue names
must be unique; if the name already exists this function fails. Names cannot be NULL.

Parameters

out queue_id will be set to the non-zero ID of the newly-created resource (must not be null)
in queue_name the name of the new resource to create (must not be null)
in queue_depth the maximum depth of the queue
in data_size the size of each entry in the queue (must not be zero)
in flags options for the queue (reserved for future use, pass as 0)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if a pointer passed in is NULL
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME

Generated by Doxygen
388

Return values

OS_ERR_NO_FREE_IDS if there are already the max queues created

OS_ERR_NAME_TAKEN if the name is already being used on another queue
OS_ERR_INVALID_SIZE if data_size is 0
OS_QUEUE_INVALID_SIZE if the queue depth exceeds the limit
OS_ERROR if the OS create call fails

9.65.2.2 OS_QueueDelete() int32 OS_QueueDelete (

osal_id_t queue_id )
Deletes the specified message queue.
This is the function used to delete a queue in the operating system. This also frees the respective queue_id to be used
again when another queue is created.

Note

If There are messages on the queue, they will be lost and any subsequent calls to QueueGet or QueuePut to this
queue will result in errors

Parameters
in queue←- The object ID to delete
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in does not exist
OS_ERROR if the OS call returns an unexpected error (return value only verified in coverage test)

9.65.2.3 OS_QueueGet() int32 OS_QueueGet (

osal_id_t queue_id,
void ∗ data,
size_t size,
size_t ∗ size_copied,
int32 timeout )
Receive a message on a message queue.
If a message is pending, it is returned immediately. Otherwise the calling task will block until a message arrives or the
timeout expires.

Parameters
in queue_id The object ID to operate on

Generated by Doxygen
9.65 OSAL Message Queue APIs 389

Parameters

out data The buffer to store the received message (must not be null)
in size The size of the data buffer (must not be zero)
out size_copied Set to the actual size of the message (must not be null)
in timeout The maximum amount of time to block, or OS_PEND to wait forever

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the given ID does not exist
OS_INVALID_POINTER if a pointer passed in is NULL
OS_QUEUE_EMPTY if the Queue has no messages on it to be received
OS_QUEUE_TIMEOUT if the timeout was OS_PEND and the time expired
OS_QUEUE_INVALID_SIZE if the size copied from the queue was not correct
OS_ERROR if the OS call returns an unexpected error (return value only verified in coverage test)

9.65.2.4 OS_QueueGetIdByName() int32 OS_QueueGetIdByName (

osal_id_t ∗ queue_id,
const char ∗ queue_name )
Find an existing queue ID by name.
This function tries to find a queue Id given the name of the queue. The id of the queue is passed back in queue_id.

Parameters

out queue_id will be set to the ID of the existing resource

in queue_name the name of the existing resource to find (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if the name or id pointers are NULL
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_NOT_FOUND the name was not found in the table

9.65.2.5 OS_QueueGetInfo() int32 OS_QueueGetInfo (

Generated by Doxygen
390

osal_id_t queue_id,
OS_queue_prop_t ∗ queue_prop )
Fill a property object buffer with details regarding the resource.
This function will pass back a pointer to structure that contains all of the relevant info (name and creator) about the
specified queue.

Parameters
in queue_id The object ID to operate on
out queue_prop The property object buffer to fill (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if queue_prop is NULL
OS_ERR_INVALID_ID if the ID given is not a valid queue

9.65.2.6 OS_QueuePut() int32 OS_QueuePut (

osal_id_t queue_id,
const void ∗ data,
size_t size,
uint32 flags )
Put a message on a message queue.

Parameters
in queue←- The object ID to operate on
_id
in data The buffer containing the message to put (must not be null)
in size The size of the data buffer (must not be zero)
in flags Currently reserved/unused, should be passed as 0

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the queue id passed in is not a valid queue
OS_INVALID_POINTER if the data pointer is NULL
OS_QUEUE_INVALID_SIZE if the data message is too large for the queue
OS_QUEUE_FULL if the queue cannot accept another message
OS_ERROR if the OS call returns an unexpected error (return value only verified in coverage test)

Generated by Doxygen
9.66 OSAL Select APIs 391

9.66 OSAL Select APIs

Functions

• int32 OS_SelectMultiple (OS_FdSet ∗ReadSet, OS_FdSet ∗WriteSet, int32 msecs)

Wait for events across multiple file handles.
• int32 OS_SelectSingle (osal_id_t objid, uint32 ∗StateFlags, int32 msecs)
Wait for events on a single file handle.
• int32 OS_SelectFdZero (OS_FdSet ∗Set)
Clear a FdSet structure.
• int32 OS_SelectFdAdd (OS_FdSet ∗Set, osal_id_t objid)
Add an ID to an FdSet structure.
• int32 OS_SelectFdClear (OS_FdSet ∗Set, osal_id_t objid)
Clear an ID from an FdSet structure.
• bool OS_SelectFdIsSet (const OS_FdSet ∗Set, osal_id_t objid)
Check if an FdSet structure contains a given ID.

9.66.1 Detailed Description

9.66.2 Function Documentation

9.66.2.1 OS_SelectFdAdd() int32 OS_SelectFdAdd (

OS_FdSet ∗ Set,
osal_id_t objid )
Add an ID to an FdSet structure.
After this call the set will contain the given OSAL ID

Parameters

in,out Set Pointer to OS_FdSet object to operate on (must not be null)

in objid The handle ID to add to the set

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL
OS_ERR_INVALID_ID if the objid is not a valid handle

9.66.2.2 OS_SelectFdClear() int32 OS_SelectFdClear (

OS_FdSet ∗ Set,
osal_id_t objid )
Clear an ID from an FdSet structure.
After this call the set will no longer contain the given OSAL ID

Generated by Doxygen
392

Parameters

in,out Set Pointer to OS_FdSet object to operate on (must not be null)

in objid The handle ID to remove from the set

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL
OS_ERR_INVALID_ID if the objid is not a valid handle

9.66.2.3 OS_SelectFdIsSet() bool OS_SelectFdIsSet (

const OS_FdSet ∗ Set,
osal_id_t objid )
Check if an FdSet structure contains a given ID.

Parameters

in Set Pointer to OS_FdSet object to operate on (must not be null)

in objid The handle ID to check for in the set

Returns

Boolean set status

Return values

true FdSet structure contains ID

false FDSet structure does not contain ID

9.66.2.4 OS_SelectFdZero() int32 OS_SelectFdZero (

OS_FdSet ∗ Set )
Clear a FdSet structure.
After this call the set will contain no OSAL IDs

Parameters

out Set Pointer to OS_FdSet object to clear (must not be null)

Generated by Doxygen
9.66 OSAL Select APIs 393

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL

9.66.2.5 OS_SelectMultiple() int32 OS_SelectMultiple (

OS_FdSet ∗ ReadSet,
OS_FdSet ∗ WriteSet,
int32 msecs )
Wait for events across multiple file handles.
Wait for any of the given sets of IDs to become readable or writable
This function will block until any of the following occurs:

• At least one OSAL ID in the ReadSet is readable

• At least one OSAL ID in the WriteSet is writable

• The timeout has elapsed

The sets are input/output parameters. On entry, these indicate the file handle(s) to wait for. On exit, these are set to the
actual file handle(s) that have activity.
If the timeout occurs this returns an error code and all output sets should be empty.

Note

This does not lock or otherwise protect the file handles in the given sets. If a filehandle supplied via one of the
FdSet arguments is closed or modified by another while this function is in progress, the results are undefined.
Because of this limitation, it is recommended to use OS_SelectSingle() whenever possible.

Parameters

in,out ReadSet Set of handles to check/wait to become readable

in,out WriteSet Set of handles to check/wait to become writable
in msecs Indicates the timeout. Positive values will wait up to that many milliseconds. Zero will not
wait (poll). Negative values will wait forever (pend)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS If any handle in the ReadSet or WriteSet is readable or writable,

respectively
OS_ERROR_TIMEOUT If no handles in the ReadSet or WriteSet became readable or
writable within the timeout
OS_ERR_OPERATION_NOT_SUPPORTED if a specified handle does not support select
OS_ERR_INVALID_ID if no valid handles were contained in the ReadSet/WriteSet

Generated by Doxygen
394

9.66.2.6 OS_SelectSingle() int32 OS_SelectSingle (

osal_id_t objid,
uint32 ∗ StateFlags,
int32 msecs )
Wait for events on a single file handle.
Wait for a single OSAL filehandle to change state
This function can be used to wait for a single OSAL stream ID to become readable or writable. On entry, the "StateFlags"
parameter should be set to the desired state (OS_STREAM_STATE_READABLE and/or OS_STREAM_STATE_WR←-
ITABLE) and upon return the flags will be set to the state actually detected.
As this operates on a single ID, the filehandle is protected during this call, such that another thread accessing the same
handle will return an error. However, it is important to note that once the call returns then other threads may then also
read/write and affect the state before the current thread can service it.
To mitigate this risk the application may prefer to use the OS_TimedRead/OS_TimedWrite calls.

Parameters
in objid The handle ID to select on
in,out StateFlags State flag(s) (readable or writable) (must not be null)
in msecs Indicates the timeout. Positive values will wait up to that many milliseconds. Zero will
not wait (poll). Negative values will wait forever (pend)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS If the handle is readable and/or writable, as requested

OS_ERROR_TIMEOUT If the handle did not become readable or writable within the timeout
OS_INVALID_POINTER if argument is NULL
OS_ERR_INVALID_ID if the objid is not a valid handle

Generated by Doxygen
9.67 OSAL Shell APIs 395

9.67 OSAL Shell APIs

Functions

• int32 OS_ShellOutputToFile (const char ∗Cmd, osal_id_t filedes)

Executes the command and sends output to a file.

9.67.1 Detailed Description

9.67.2 Function Documentation

9.67.2.1 OS_ShellOutputToFile() int32 OS_ShellOutputToFile (

const char ∗ Cmd,
osal_id_t filedes )
Executes the command and sends output to a file.
Takes a shell command in and writes the output of that command to the specified file The output file must be opened
previously with write access (OS_WRITE_ONLY or OS_READ_WRITE).

Parameters

in Cmd Command to pass to shell (must not be null)

in filedes File to send output to.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if the command was not executed properly
OS_INVALID_POINTER if Cmd argument is NULL
OS_ERR_INVALID_ID if the file descriptor passed in is invalid

Generated by Doxygen
396

9.68 OSAL Socket Address APIs

These functions provide a means to manipulate network addresses in a manner that is (mostly) agnostic to the actual
network address type.

Functions

• int32 OS_SocketAddrInit (OS_SockAddr_t ∗Addr, OS_SocketDomain_t Domain)

Initialize a socket address structure to hold an address of the given family.
• int32 OS_SocketAddrToString (char ∗buffer, size_t buflen, const OS_SockAddr_t ∗Addr)
Get a string representation of a network host address.
• int32 OS_SocketAddrFromString (OS_SockAddr_t ∗Addr, const char ∗string)
Set a network host address from a string representation.
• int32 OS_SocketAddrGetPort (uint16 ∗PortNum, const OS_SockAddr_t ∗Addr)
Get the port number of a network address.
• int32 OS_SocketAddrSetPort (OS_SockAddr_t ∗Addr, uint16 PortNum)
Set the port number of a network address.

9.68.1 Detailed Description

These functions provide a means to manipulate network addresses in a manner that is (mostly) agnostic to the actual
network address type.
Every network address should be representable as a string (i.e. dotted decimal IP, etc). This can serve as the "common
denominator" to all address types.

9.68.2 Function Documentation

9.68.2.1 OS_SocketAddrFromString() int32 OS_SocketAddrFromString (

OS_SockAddr_t ∗ Addr,
const char ∗ string )
Set a network host address from a string representation.
The specific format of the output string depends on the address family.
The address structure should have been previously initialized using OS_SocketAddrInit() to set the address family type.

Note

For IPv4, this would typically be the dotted-decimal format (X.X.X.X). It is up to the discretion of the underlying
implementation whether to accept hostnames, as this depends on the availability of DNS services. Since many
embedded deployments do not have name services, this should not be relied upon.

Parameters

out Addr The address buffer to initialize (must not be null)

in string The string to initialize the address from (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Generated by Doxygen
9.68 OSAL Socket Address APIs 397

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL
OS_ERROR if the string cannot be converted to an address

9.68.2.2 OS_SocketAddrGetPort() int32 OS_SocketAddrGetPort (

uint16 ∗ PortNum,
const OS_SockAddr_t ∗ Addr )
Get the port number of a network address.
For network protocols that have the concept of a port number (such as TCP/IP and UDP/IP) this function gets the port
number from the address structure.

Parameters

out PortNum Buffer to store the port number (must not be null)
in Addr The network address buffer (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL
OS_ERR_BAD_ADDRESS if the address domain is not compatible

9.68.2.3 OS_SocketAddrInit() int32 OS_SocketAddrInit (

OS_SockAddr_t ∗ Addr,
OS_SocketDomain_t Domain )
Initialize a socket address structure to hold an address of the given family.
The address is set to a suitable default value for the family.

Parameters

out Addr The address buffer to initialize (must not be null)

in Domain The address family

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

Generated by Doxygen
398

Return values

OS_INVALID_POINTER if Addr argument is NULL

OS_ERR_NOT_IMPLEMENTED if the system does not implement the requested domain

9.68.2.4 OS_SocketAddrSetPort() int32 OS_SocketAddrSetPort (

OS_SockAddr_t ∗ Addr,
uint16 PortNum )
Set the port number of a network address.
For network protocols that have the concept of a port number (such as TCP/IP and UDP/IP) this function sets the port
number from the address structure.

Parameters

out Addr The network address buffer (must not be null)

in PortNum The port number to set

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL
OS_ERR_BAD_ADDRESS if the address domain is not compatible

9.68.2.5 OS_SocketAddrToString() int32 OS_SocketAddrToString (

char ∗ buffer,
size_t buflen,
const OS_SockAddr_t ∗ Addr )
Get a string representation of a network host address.
The specific format of the output string depends on the address family.
This string should be suitable to pass back into OS_SocketAddrFromString() which should recreate the same network
address, and it should also be meaningful to a user of printed or logged as a C string.

Note

For IPv4, this would typically be the dotted-decimal format (X.X.X.X).

Parameters

out buffer Buffer to hold the output string (must not be null)
in buflen Maximum length of the output string (must not be zero)
in Addr The network address buffer to convert (must not be null)

Generated by Doxygen
9.68 OSAL Socket Address APIs 399

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL
OS_ERR_INVALID_SIZE if passed-in buflen is not valid
OS_ERROR if the address cannot be converted to string, or string buffer too small

Generated by Doxygen
400

9.69 OSAL Socket Management APIs

These functions are loosely related to the BSD Sockets API but made to be more consistent with other OSAL API
functions. That is, they operate on OSAL IDs (32-bit opaque number values) and return an OSAL error code.

Functions

• int32 OS_SocketOpen (osal_id_t ∗sock_id, OS_SocketDomain_t Domain, OS_SocketType_t Type)

Opens a socket.
• int32 OS_SocketBind (osal_id_t sock_id, const OS_SockAddr_t ∗Addr)
Binds a socket to a given local address and enter listening (server) mode.
• int32 OS_SocketListen (osal_id_t sock_id)
Places the specified socket into a listening state.
• int32 OS_SocketBindAddress (osal_id_t sock_id, const OS_SockAddr_t ∗Addr)
Binds a socket to a given local address.
• int32 OS_SocketConnect (osal_id_t sock_id, const OS_SockAddr_t ∗Addr, int32 timeout)
Connects a socket to a given remote address.
• int32 OS_SocketShutdown (osal_id_t sock_id, OS_SocketShutdownMode_t Mode)
Implement graceful shutdown of a stream socket.
• int32 OS_SocketAccept (osal_id_t sock_id, osal_id_t ∗connsock_id, OS_SockAddr_t ∗Addr, int32 timeout)
Waits for and accept the next incoming connection on the given socket.
• int32 OS_SocketRecvFrom (osal_id_t sock_id, void ∗buffer, size_t buflen, OS_SockAddr_t ∗RemoteAddr, int32
timeout)
Reads data from a message-oriented (datagram) socket.
• int32 OS_SocketSendTo (osal_id_t sock_id, const void ∗buffer, size_t buflen, const OS_SockAddr_t ∗Remote←-
Addr)
Sends data to a message-oriented (datagram) socket.
• int32 OS_SocketGetIdByName (osal_id_t ∗sock_id, const char ∗sock_name)
Gets an OSAL ID from a given name.
• int32 OS_SocketGetInfo (osal_id_t sock_id, OS_socket_prop_t ∗sock_prop)
Gets information about an OSAL Socket ID.

9.69.1 Detailed Description

These functions are loosely related to the BSD Sockets API but made to be more consistent with other OSAL API
functions. That is, they operate on OSAL IDs (32-bit opaque number values) and return an OSAL error code.
OSAL Socket IDs are very closely related to File IDs and share the same ID number space. Additionally, the file
OS_read() / OS_write() / OS_close() calls also work on sockets.
Note that all of functions may return OS_ERR_NOT_IMPLEMENTED if network support is not configured at compile
time.

9.69.2 Function Documentation

9.69.2.1 OS_SocketAccept() int32 OS_SocketAccept (

osal_id_t sock_id,
osal_id_t ∗ connsock_id,
OS_SockAddr_t ∗ Addr,
int32 timeout )
Waits for and accept the next incoming connection on the given socket.

Generated by Doxygen
9.69 OSAL Socket Management APIs 401

This is used for sockets operating in a "server" role. The socket must be a stream type (connection-oriented) and
previously bound to a local address using OS_SocketBind(). This will block the caller up to the given timeout or until an
incoming connection request occurs, whichever happens first.
The new stream connection is then returned to the caller and the original server socket ID can be reused for the next
connection.

Parameters

in sock_id The server socket ID, previously bound using OS_SocketBind()

out connsock←- The connection socket, a new ID that can be read/written (must not be null)
_id
in Addr The remote address of the incoming connection (must not be null)
in timeout The maximum amount of time to wait, or OS_PEND to wait forever

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL
OS_ERR_INVALID_ID if the sock_id parameter is not valid
OS_ERR_INCORRECT_OBJ_TYPE if the handle is not a socket
OS_ERR_INCORRECT_OBJ_STATE if the socket is not bound or already connected

9.69.2.2 OS_SocketBind() int32 OS_SocketBind (

osal_id_t sock_id,
const OS_SockAddr_t ∗ Addr )
Binds a socket to a given local address and enter listening (server) mode.
This is a convenience/compatibility routine to perform both OS_SocketBindAddress() and OS_SocketListen() operations
in a single call, intended to simplify the setup for a server role.
If the socket is connectionless, then it only binds to the local address.

Parameters
in sock←- The socket ID
_id
in Addr The local address to bind to (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the sock_id parameter is not valid

Generated by Doxygen
402

Return values

OS_INVALID_POINTER if argument is NULL

OS_ERR_INCORRECT_OBJ_STATE if the socket is already bound
OS_ERR_INCORRECT_OBJ_TYPE if the handle is not a socket

9.69.2.3 OS_SocketBindAddress() int32 OS_SocketBindAddress (

osal_id_t sock_id,
const OS_SockAddr_t ∗ Addr )
Binds a socket to a given local address.
The specified socket will be bound to the local address and port, if available. This controls the source address reflected
in network traffic transmitted via this socket.
After binding to the address, a stream socket may be followed by a call to either OS_SocketListen() for a server role or
to OS_SocketConnect() for a client role.

Parameters
in sock←- The socket ID
_id
in Addr The local address to bind to (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the sock_id parameter is not valid
OS_INVALID_POINTER if argument is NULL
OS_ERR_INCORRECT_OBJ_STATE if the socket is already bound
OS_ERR_INCORRECT_OBJ_TYPE if the handle is not a socket

9.69.2.4 OS_SocketConnect() int32 OS_SocketConnect (

osal_id_t sock_id,
const OS_SockAddr_t ∗ Addr,
int32 timeout )
Connects a socket to a given remote address.
The socket will be connected to the remote address and port, if available. This only applies to stream-oriented sockets.
Calling this on a datagram socket will return an error (these sockets should use SendTo/RecvFrom).

Parameters
in sock←- The socket ID
_id
in Addr The remote address to connect to (must not be null)
in timeout The maximum amount of time to wait, or OS_PEND to wait forever

Generated by Doxygen
9.69 OSAL Socket Management APIs 403

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INCORRECT_OBJ_STATE if the socket is already connected
OS_ERR_INVALID_ID if the sock_id parameter is not valid
OS_ERR_INCORRECT_OBJ_TYPE if the handle is not a socket
OS_INVALID_POINTER if Addr argument is NULL

9.69.2.5 OS_SocketGetIdByName() int32 OS_SocketGetIdByName (

osal_id_t ∗ sock_id,
const char ∗ sock_name )
Gets an OSAL ID from a given name.

Note

OSAL Sockets use generated names according to the address and type.

See also

OS_SocketGetInfo()

Parameters

out sock_id Buffer to hold result (must not be null)

in sock_name Name of socket to find (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER is id or name are NULL pointers
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_NOT_FOUND if the name was not found in the table

9.69.2.6 OS_SocketGetInfo() int32 OS_SocketGetInfo (

osal_id_t sock_id,
OS_socket_prop_t ∗ sock_prop )
Gets information about an OSAL Socket ID.
OSAL Sockets use generated names according to the address and type. This allows applications to find the name of a
given socket.

Generated by Doxygen
404

Parameters
in sock_id The socket ID
out sock_prop Buffer to hold socket information (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid semaphore
OS_INVALID_POINTER if the count_prop pointer is null

9.69.2.7 OS_SocketListen() int32 OS_SocketListen (

osal_id_t sock_id )
Places the specified socket into a listening state.
This function only applies to connection-oriented (stream) sockets that are intended to be used in a server-side role.
This places the socket into a state where it can accept incoming connections from clients.

Parameters
in sock←- The socket ID
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the sock_id parameter is not valid
OS_ERR_INCORRECT_OBJ_STATE if the socket is already listening
OS_ERR_INCORRECT_OBJ_TYPE if the handle is not a stream socket

9.69.2.8 OS_SocketOpen() int32 OS_SocketOpen (

osal_id_t ∗ sock_id,
OS_SocketDomain_t Domain,
OS_SocketType_t Type )
Opens a socket.
A new, unconnected and unbound socket is allocated of the given domain and type.

Generated by Doxygen
9.69 OSAL Socket Management APIs 405

Parameters

out sock←- Buffer to hold the non-zero OSAL ID (must not be null)
_id
in Domain The domain / address family of the socket (INET or INET6, etc)
in Type The type of the socket (STREAM or DATAGRAM)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if argument is NULL
OS_ERR_NOT_IMPLEMENTED if the system does not implement the requested socket/address domain

9.69.2.9 OS_SocketRecvFrom() int32 OS_SocketRecvFrom (

osal_id_t sock_id,
void ∗ buffer,
size_t buflen,
OS_SockAddr_t ∗ RemoteAddr,
int32 timeout )
Reads data from a message-oriented (datagram) socket.
If a message is already available on the socket, this should immediately return that data without blocking. Otherwise, it
may block up to the given timeout.

Parameters

in sock_id The socket ID, previously bound using OS_SocketBind()

out buffer Pointer to message data receive buffer (must not be null)
in buflen The maximum length of the message data to receive (must not be zero)
out RemoteAddr Buffer to store the remote network address (may be NULL)
in timeout The maximum amount of time to wait, or OS_PEND to wait forever

Returns

Count of actual bytes received or error status, see OSAL Return Code Defines

Return values

OS_INVALID_POINTER if argument is NULL

OS_ERR_INVALID_SIZE if passed-in buflen is not valid
OS_ERR_INVALID_ID if the sock_id parameter is not valid
OS_ERR_INCORRECT_OBJ_TYPE if the handle is not a socket

Generated by Doxygen
406

9.69.2.10 OS_SocketSendTo() int32 OS_SocketSendTo (

osal_id_t sock_id,
const void ∗ buffer,
size_t buflen,
const OS_SockAddr_t ∗ RemoteAddr )
Sends data to a message-oriented (datagram) socket.
This sends data in a non-blocking mode. If the socket is not currently able to queue the message, such as if its outbound
buffer is full, then this returns an error code.

Parameters

in sock_id The socket ID, which must be of the datagram type

in buffer Pointer to message data to send (must not be null)
in buflen The length of the message data to send (must not be zero)
in RemoteAddr Buffer containing the remote network address to send to

Returns

Count of actual bytes sent or error status, see OSAL Return Code Defines

Return values

OS_INVALID_POINTER if argument is NULL

OS_ERR_INVALID_SIZE if passed-in buflen is not valid
OS_ERR_INVALID_ID if the sock_id parameter is not valid
OS_ERR_INCORRECT_OBJ_TYPE if the handle is not a socket

9.69.2.11 OS_SocketShutdown() int32 OS_SocketShutdown (

osal_id_t sock_id,
OS_SocketShutdownMode_t Mode )
Implement graceful shutdown of a stream socket.
This can be utilized to indicate the end of data stream without immediately closing the socket, giving the remote side an
indication that the data transfer is complete.

Parameters
in sock←- The socket ID
_id
in Mode Whether to shutdown reading, writing, or both.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the sock_id parameter is not valid

Generated by Doxygen
9.69 OSAL Socket Management APIs 407

Return values

OS_ERR_INVALID_ARGUMENT if the Mode argument is not one of the valid options

OS_ERR_INCORRECT_OBJ_TYPE if the handle is not a socket
OS_ERR_INCORRECT_OBJ_STATE if the socket is not connected

Generated by Doxygen
408

9.70 OSAL Task APIs

Functions

• int32 OS_TaskCreate (osal_id_t ∗task_id, const char ∗task_name, osal_task_entry function_pointer,

osal_stackptr_t stack_pointer, size_t stack_size, osal_priority_t priority, uint32 flags)
Creates a task and starts running it.
• int32 OS_TaskDelete (osal_id_t task_id)
Deletes the specified Task.
• void OS_TaskExit (void)
Exits the calling task.
• int32 OS_TaskInstallDeleteHandler (osal_task_entry function_pointer)
Installs a handler for when the task is deleted.
• int32 OS_TaskDelay (uint32 millisecond)
Delay a task for specified amount of milliseconds.
• int32 OS_TaskSetPriority (osal_id_t task_id, osal_priority_t new_priority)
Sets the given task to a new priority.
• osal_id_t OS_TaskGetId (void)
Obtain the task id of the calling task.
• int32 OS_TaskGetIdByName (osal_id_t ∗task_id, const char ∗task_name)
Find an existing task ID by name.
• int32 OS_TaskGetInfo (osal_id_t task_id, OS_task_prop_t ∗task_prop)
Fill a property object buffer with details regarding the resource.
• int32 OS_TaskFindIdBySystemData (osal_id_t ∗task_id, const void ∗sysdata, size_t sysdata_size)
Reverse-lookup the OSAL task ID from an operating system ID.

9.70.1 Detailed Description

9.70.2 Function Documentation

9.70.2.1 OS_TaskCreate() int32 OS_TaskCreate (

osal_id_t ∗ task_id,
const char ∗ task_name,
osal_task_entry function_pointer,
osal_stackptr_t stack_pointer,
size_t stack_size,
osal_priority_t priority,
uint32 flags )
Creates a task and starts running it.
Creates a task and passes back the id of the task created. Task names must be unique; if the name already exists this
function fails. Names cannot be NULL.
Portable applications should always specify the actual stack size in the stack_size parameter, not 0. This size value is not
enforced/checked by OSAL, but is simply passed through to the RTOS for stack creation. Some RTOS implementations
may assume 0 means a default stack size while others may actually create a task with no stack.
Unlike stack_size, the stack_pointer is optional and can be specified as NULL. In that case, a stack of the requested
size will be dynamically allocated from the system heap.

Parameters

out task_id will be set to the non-zero ID of the newly-created resource (must not be null)

Generated by Doxygen
9.70 OSAL Task APIs 409

Parameters

in task_name the name of the new resource to create (must not be null)
in function_pointer the entry point of the new task (must not be null)
in stack_pointer pointer to the stack for the task, or NULL to allocate a stack from the system memory heap
in stack_size the size of the stack (must not be zero)
in priority initial priority of the new task
in flags initial options for the new task

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if any of the necessary pointers are NULL
OS_ERR_INVALID_SIZE if the stack_size argument is zero
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_INVALID_PRIORITY if the priority is bad (return value only verified in coverage test)
OS_ERR_NO_FREE_IDS if there can be no more tasks created
OS_ERR_NAME_TAKEN if the name specified is already used by a task
OS_ERROR if an unspecified/other error occurs (return value only verified in coverage test)

9.70.2.2 OS_TaskDelay() int32 OS_TaskDelay (

uint32 millisecond )
Delay a task for specified amount of milliseconds.
Causes the current thread to be suspended from execution for the period of millisecond. This is a scheduled wait
(clock_nanosleep/rtems_task_wake_after/taskDelay), not a "busy" wait.

Parameters

in millisecond Amount of time to delay

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERROR if an unspecified/other error occurs (return value only verified in coverage test)

9.70.2.3 OS_TaskDelete() int32 OS_TaskDelete (

Generated by Doxygen
410

osal_id_t task_id )
Deletes the specified Task.
The task will be removed from the local tables. and the OS will be configured to stop executing the task at the next
opportunity.

Parameters
in task←- The object ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the ID given to it is invalid
OS_ERROR if the OS delete call fails (return value only verified in coverage test)

9.70.2.4 OS_TaskExit() void OS_TaskExit (

void )
Exits the calling task.
The calling thread is terminated. This function does not return.

9.70.2.5 OS_TaskFindIdBySystemData() int32 OS_TaskFindIdBySystemData (

osal_id_t ∗ task_id,
const void ∗ sysdata,
size_t sysdata_size )
Reverse-lookup the OSAL task ID from an operating system ID.
This provides a method by which an external entity may find the OSAL task ID corresponding to a system-defined
identifier (e.g. TASK_ID, pthread_t, rtems_id, etc).
Normally OSAL does not expose the underlying OS-specific values to the application, but in some circumstances, such
as exception handling, the OS may provide this information directly to a BSP handler outside of the normal OSAL API.

Parameters

out task_id The buffer where the task id output is stored (must not be null)
in sysdata Pointer to the system-provided identification data
in sysdata_size Size of the system-provided identification data

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution. (return value only verified in coverage test)

OS_INVALID_POINTER if a pointer argument is NULL

Generated by Doxygen
9.70 OSAL Task APIs 411

9.70.2.6 OS_TaskGetId() osal_id_t OS_TaskGetId (

void )
Obtain the task id of the calling task.
This function returns the task id of the calling task

Returns

Task ID, or zero if the operation failed (zero is never a valid task ID)

9.70.2.7 OS_TaskGetIdByName() int32 OS_TaskGetIdByName (

osal_id_t ∗ task_id,
const char ∗ task_name )
Find an existing task ID by name.
This function tries to find a task Id given the name of a task

Parameters

out task_id will be set to the ID of the existing resource

in task_name the name of the existing resource to find (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if the pointers passed in are NULL
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_NOT_FOUND if the name wasn't found in the table

9.70.2.8 OS_TaskGetInfo() int32 OS_TaskGetInfo (

osal_id_t task_id,
OS_task_prop_t ∗ task_prop )
Fill a property object buffer with details regarding the resource.
This function will pass back a pointer to structure that contains all of the relevant info (creator, stack size, priority, name)
about the specified task.

Parameters
in task_id The object ID to operate on
out task_prop The property object buffer to fill (must not be null)

Generated by Doxygen
412

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the ID passed to it is invalid
OS_INVALID_POINTER if the task_prop pointer is NULL

9.70.2.9 OS_TaskInstallDeleteHandler() int32 OS_TaskInstallDeleteHandler (

osal_task_entry function_pointer )
Installs a handler for when the task is deleted.
This function is used to install a callback that is called when the task is deleted. The callback is called when OS_Task←-
Delete is called with the task ID. A task delete handler is useful for cleaning up resources that a task creates, before the
task is removed from the system.

Parameters

in function_pointer function to be called when task exits

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_ERR_INVALID_ID if the calling context is not an OSAL task

9.70.2.10 OS_TaskSetPriority() int32 OS_TaskSetPriority (

osal_id_t task_id,
osal_priority_t new_priority )
Sets the given task to a new priority.

Parameters
in task_id The object ID to operate on
in new_priority Set the new priority

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the ID passed to it is invalid

Generated by Doxygen
9.70 OSAL Task APIs 413

Return values

OS_ERR_INVALID_PRIORITY if the priority is greater than the max allowed (return value only verified in
coverage test)
OS_ERROR if an unspecified/other error occurs (return value only verified in coverage test)

Generated by Doxygen
414

9.71 OSAL Time Base APIs

Functions

• int32 OS_TimeBaseCreate (osal_id_t ∗timebase_id, const char ∗timebase_name, OS_TimerSync_t external_←-

sync)
Create an abstract Time Base resource.
• int32 OS_TimeBaseSet (osal_id_t timebase_id, uint32 start_time, uint32 interval_time)
Sets the tick period for simulated time base objects.
• int32 OS_TimeBaseDelete (osal_id_t timebase_id)
Deletes a time base object.
• int32 OS_TimeBaseGetIdByName (osal_id_t ∗timebase_id, const char ∗timebase_name)
Find the ID of an existing time base resource.
• int32 OS_TimeBaseGetInfo (osal_id_t timebase_id, OS_timebase_prop_t ∗timebase_prop)
Obtain information about a timebase resource.
• int32 OS_TimeBaseGetFreeRun (osal_id_t timebase_id, uint32 ∗freerun_val)
Read the value of the timebase free run counter.

9.71.1 Detailed Description

9.71.2 Function Documentation

9.71.2.1 OS_TimeBaseCreate() int32 OS_TimeBaseCreate (

osal_id_t ∗ timebase_id,
const char ∗ timebase_name,
OS_TimerSync_t external_sync )
Create an abstract Time Base resource.
An OSAL time base is an abstraction of a "timer tick" that can, in turn, be used for measurement of elapsed time between
events.
Time bases can be simulated by the operating system using the OS kernel-provided timing facilities, or based on a
hardware timing source if provided by the BSP.
A time base object has a servicing task associated with it, that runs at elevated priority and will thereby interrupt user-
level tasks when timing ticks occur.
If the external_sync function is passed as NULL, the operating system kernel timing resources will be utilized for a
simulated timer tick.
If the external_sync function is not NULL, this should point to a BSP-provided function that will block the calling task
until the next tick occurs. This can be used for synchronizing with hardware events.

Note

When provisioning a tunable RTOS kernel, such as RTEMS, the kernel should be configured to support at least
(OS_MAX_TASKS + OS_MAX_TIMEBASES) threads, to account for the helper threads associated with time base
objects.
This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Parameters

out timebase_id will be set to the non-zero ID of the newly-created resource (must not be null)
in timebase_name The name of the time base (must not be null)
in external_sync A synchronization function for BSP hardware-based timer ticks

Generated by Doxygen
9.71 OSAL Time Base APIs 415

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_NAME_TAKEN if the name specified is already used
OS_ERR_NO_FREE_IDS if there can be no more timebase resources created
OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context
OS_ERR_NAME_TOO_LONG if the timebase_name is too long
OS_INVALID_POINTER if a pointer argument is NULL

9.71.2.2 OS_TimeBaseDelete() int32 OS_TimeBaseDelete (

osal_id_t timebase_id )
Deletes a time base object.
The helper task and any other resources associated with the time base abstraction will be freed.

Note

This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Parameters
in timebase←- The timebase resource to delete
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid timebase
OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context

9.71.2.3 OS_TimeBaseGetFreeRun() int32 OS_TimeBaseGetFreeRun (

osal_id_t timebase_id,
uint32 ∗ freerun_val )
Read the value of the timebase free run counter.
Poll the timer free-running time counter in a lightweight fashion.
The free run count is a monotonically increasing value reflecting the total time elapsed since the timebase inception.
Units are the same as the timebase itself, usually microseconds.
Applications may quickly and efficiently calculate relative time differences by polling this value and subtracting the
previous counter value.

Generated by Doxygen
416

The absolute value of this counter is not relevant, because it will "roll over" after 2∧ 32 units of time. For a timebase with
microsecond units, this occurs approximately every 4294 seconds, or about 1.2 hours.

Note

To ensure consistency of results, the application should sample the value at a minimum of two times the roll over
frequency, and calculate the difference between the consecutive samples.

Parameters
in timebase←- The timebase to operate on
_id
out freerun_val Buffer to store the free run counter (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid timebase
OS_INVALID_POINTER if pointer argument is NULL

9.71.2.4 OS_TimeBaseGetIdByName() int32 OS_TimeBaseGetIdByName (

osal_id_t ∗ timebase_id,
const char ∗ timebase_name )
Find the ID of an existing time base resource.
Given a time base name, find and output the ID associated with it.

Note

This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Parameters

out timebase_id will be set to the non-zero ID of the matching resource (must not be null)
in timebase_name The name of the timebase resource to find (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if timebase_id or timebase_name are NULL pointers
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME

Generated by Doxygen
9.71 OSAL Time Base APIs 417

Return values

OS_ERR_NAME_NOT_FOUND if the name was not found in the table

OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context

9.71.2.5 OS_TimeBaseGetInfo() int32 OS_TimeBaseGetInfo (

osal_id_t timebase_id,
OS_timebase_prop_t ∗ timebase_prop )
Obtain information about a timebase resource.
Fills the buffer referred to by the timebase_prop parameter with relevant information about the time base resource.
This function will pass back a pointer to structure that contains all of the relevant info( name and creator) about the
specified timebase.

Note

This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Parameters
in timebase_id The timebase resource ID
out timebase_prop Buffer to store timebase properties (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid timebase
OS_INVALID_POINTER if the timebase_prop pointer is null
OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context

9.71.2.6 OS_TimeBaseSet() int32 OS_TimeBaseSet (

osal_id_t timebase_id,
uint32 start_time,
uint32 interval_time )
Sets the tick period for simulated time base objects.
This sets the actual tick period for timing ticks that are simulated by the RTOS kernel (i.e. the "external_sync" parameter
on the call to OS_TimeBaseCreate() is NULL).
The RTOS will be configured to wake up the helper thread at the requested interval.
This function has no effect for time bases that are using a BSP-provided external_sync function.
Note

This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Generated by Doxygen
418

Parameters

in timebase_id The timebase resource to configure

in start_time The amount of delay for the first tick, in microseconds.
in interval_time The amount of delay between ticks, in microseconds.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid timebase
OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context
OS_TIMER_ERR_INVALID_ARGS if start_time or interval_time are out of range

Generated by Doxygen
9.72 OSAL Timer APIs 419

9.72 OSAL Timer APIs

Functions

• int32 OS_TimerCreate (osal_id_t ∗timer_id, const char ∗timer_name, uint32 ∗clock_accuracy, OS_TimerCallback_t
callback_ptr)
Create a timer object.
• int32 OS_TimerAdd (osal_id_t ∗timer_id, const char ∗timer_name, osal_id_t timebase_id, OS_ArgCallback_t
callback_ptr, void ∗callback_arg)
Add a timer object based on an existing TimeBase resource.
• int32 OS_TimerSet (osal_id_t timer_id, uint32 start_time, uint32 interval_time)
Configures a periodic or one shot timer.
• int32 OS_TimerDelete (osal_id_t timer_id)
Deletes a timer resource.
• int32 OS_TimerGetIdByName (osal_id_t ∗timer_id, const char ∗timer_name)
Locate an existing timer resource by name.
• int32 OS_TimerGetInfo (osal_id_t timer_id, OS_timer_prop_t ∗timer_prop)
Gets information about an existing timer.

9.72.1 Detailed Description

9.72.2 Function Documentation

9.72.2.1 OS_TimerAdd() int32 OS_TimerAdd (

osal_id_t ∗ timer_id,
const char ∗ timer_name,
osal_id_t timebase_id,
OS_ArgCallback_t callback_ptr,
void ∗ callback_arg )
Add a timer object based on an existing TimeBase resource.
A timer object is a resource that invokes the specified application-provided function upon timer expiration. Timers may
be one-shot or periodic in nature.
This function uses an existing time base object to service this timer, which must exist prior to adding the timer. The
precision of the timer is the same as that of the underlying time base object. Multiple timer objects can be created
referring to a single time base object.
This routine also uses a different callback function prototype from OS_TimerCreate(), allowing a single opaque argument
to be passed to the callback routine. The OSAL implementation does not use this parameter, and may be set NULL.
The callback function for this method should be declared according to the OS_ArgCallback_t function pointer type. The
timer_id is passed in to the function by the OSAL, and the arg parameter is passed through from the callback_arg
argument on this call.

Note

This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

See also

OS_ArgCallback_t

Generated by Doxygen
420

Parameters

out timer_id Will be set to the non-zero resource ID of the timer object (must not be null)
in timer_name Name of the timer object (must not be null)
in timebase←- The time base resource to use as a reference
_id
in callback_ptr Application-provided function to invoke (must not be null)
in callback_arg Opaque argument to pass to callback function, may be NULL

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if any parameters are NULL
OS_ERR_INVALID_ID if the timebase_id parameter is not valid
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_TAKEN if the name is already in use by another timer.
OS_ERR_NO_FREE_IDS if all of the timers are already allocated.
OS_ERR_INCORRECT_OBJ_STATE if invoked from a timer context
OS_TIMER_ERR_INTERNAL if there was an error programming the OS timer (return value only verified
in coverage test)

9.72.2.2 OS_TimerCreate() int32 OS_TimerCreate (

osal_id_t ∗ timer_id,
const char ∗ timer_name,
uint32 ∗ clock_accuracy,
OS_TimerCallback_t callback_ptr )
Create a timer object.
A timer object is a resource that invokes the specified application-provided function upon timer expiration. Timers may
be one-shot or periodic in nature.
This function creates a dedicated (hidden) time base object to service this timer, which is created and deleted with the
timer object itself. The internal time base is configured for an OS simulated timer tick at the same interval as the timer.
The callback function should be declared according to the OS_TimerCallback_t function pointer type. The timer_id value
is passed to the callback function.

Note

clock_accuracy comes from the underlying OS tick value. The nearest integer microsecond value is returned, so
may not be exact.
This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

See also

OS_TimerCallback_t

Generated by Doxygen
9.72 OSAL Timer APIs 421

Parameters

out timer_id Will be set to the non-zero resource ID of the timer object (must not be null)
in timer_name Name of the timer object (must not be null)
out clock_accuracy Expected precision of the timer, in microseconds. This is the underlying tick value
rounded to the nearest microsecond integer. (must not be null)
in callback_ptr The function pointer of the timer callback (must not be null).

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if any parameters are NULL
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_TAKEN if the name is already in use by another timer.
OS_ERR_NO_FREE_IDS if all of the timers are already allocated.
OS_ERR_INCORRECT_OBJ_STATE if invoked from a timer context
OS_TIMER_ERR_INTERNAL if there was an error programming the OS timer (return value only verified
in coverage test)

9.72.2.3 OS_TimerDelete() int32 OS_TimerDelete (

osal_id_t timer_id )
Deletes a timer resource.
The application callback associated with the timer will be stopped, and the resources freed for future use.

Note

This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Parameters
in timer←- The timer ID to operate on
_id

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the timer_id is invalid.
OS_TIMER_ERR_INTERNAL if there was a problem deleting the timer in the host OS (return value only
verified in coverage test)
OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context

Generated by Doxygen
422

9.72.2.4 OS_TimerGetIdByName() int32 OS_TimerGetIdByName (

osal_id_t ∗ timer_id,
const char ∗ timer_name )
Locate an existing timer resource by name.
Outputs the ID associated with the given timer, if it exists.

Note

This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Parameters

out timer_id Will be set to the timer ID corresponding to the name (must not be null)
in timer_name The timer name to find (must not be null)

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_INVALID_POINTER if timer_id or timer_name are NULL pointers
OS_ERR_NAME_TOO_LONG name length including null terminator greater than OS_MAX_API_NAME
OS_ERR_NAME_NOT_FOUND if the name was not found in the table
OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context

9.72.2.5 OS_TimerGetInfo() int32 OS_TimerGetInfo (

osal_id_t timer_id,
OS_timer_prop_t ∗ timer_prop )
Gets information about an existing timer.
This function takes timer_id, and looks it up in the OS table. It puts all of the information known about that timer into a
structure pointer to by timer_prop.

Generated by Doxygen
9.72 OSAL Timer APIs 423

Parameters

Note

This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Parameters
in timer_id The timer ID to operate on
out timer_prop Buffer containing timer properties (must not be null)

• creator: the OS task ID of the task that created this timer

• name: the string name of the timer

• start_time: the start time in microseconds, if any

• interval_time: the interval time in microseconds, if any

• accuracy: the accuracy of the timer in microseconds

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the id passed in is not a valid timer
OS_INVALID_POINTER if the timer_prop pointer is null
OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context

9.72.2.6 OS_TimerSet() int32 OS_TimerSet (

osal_id_t timer_id,
uint32 start_time,
uint32 interval_time )
Configures a periodic or one shot timer.
This function programs the timer with a start time and an optional interval time. The start time is the time in microseconds
when the user callback function will be called. If the interval time is non-zero, the timer will be reprogrammed with that
interval in microseconds to call the user callback function periodically. If the start time and interval time are zero, the
function will return an error.
For a "one-shot" timer, the start_time configures the expiration time, and the interval_time should be passed as zero to
indicate the timer is not to be automatically reset.
Note

The resolution of the times specified is limited to the clock accuracy returned in the OS_TimerCreate call. If the
times specified in the start_msec or interval_msec parameters are less than the accuracy, they will be rounded up
to the accuracy of the timer.
This configuration API must not be used from the context of a timer callback. Timers should only be configured
from the context of normal OSAL tasks.

Generated by Doxygen
424

Parameters
in timer_id The timer ID to operate on
in start_time Time in microseconds to the first expiration
in interval_time Time in microseconds between subsequent intervals, value of zero will only call the user
callback function once after the start_msec time.

Returns

Execution status, see OSAL Return Code Defines

Return values

OS_SUCCESS Successful execution.

OS_ERR_INVALID_ID if the timer_id is not valid.
OS_TIMER_ERR_INTERNAL if there was an error programming the OS timer (return value only verified
in coverage test)
OS_ERR_INCORRECT_OBJ_STATE if called from timer/timebase context
OS_TIMER_ERR_INVALID_ARGS if the start_time or interval_time is out of range, or both 0

Generated by Doxygen
10 Data Structure Documentation 425

10 Data Structure Documentation

10.1 CCSDS_ExtendedHeader Struct Reference
CCSDS packet extended header.
#include <ccsds_hdr.h>

Data Fields

• uint8 Subsystem [2]

subsystem qualifier
• uint8 SystemId [2]
system qualifier

10.1.1 Detailed Description

CCSDS packet extended header.

Definition at line 73 of file ccsds_hdr.h.

10.1.2 Field Documentation

10.1.2.1 Subsystem uint8 CCSDS_ExtendedHeader::Subsystem[2]

subsystem qualifier
Definition at line 75 of file ccsds_hdr.h.

10.1.2.2 SystemId uint8 CCSDS_ExtendedHeader::SystemId[2]

system qualifier
Definition at line 82 of file ccsds_hdr.h.
The documentation for this struct was generated from the following file:

• cfe/modules/msg/fsw/inc/ccsds_hdr.h

10.2 CCSDS_PrimaryHeader Struct Reference

CCSDS packet primary header.
#include <ccsds_hdr.h>

Data Fields

• uint8 StreamId [2]

packet identifier word (stream ID)
• uint8 Sequence [2]
packet sequence word
• uint8 Length [2]
packet length word

10.2.1 Detailed Description

CCSDS packet primary header.

Definition at line 51 of file ccsds_hdr.h.

Generated by Doxygen
426

10.2.2 Field Documentation

10.2.2.1 Length uint8 CCSDS_PrimaryHeader::Length[2]

packet length word
Definition at line 71 of file ccsds_hdr.h.

10.2.2.2 Sequence uint8 CCSDS_PrimaryHeader::Sequence[2]

packet sequence word
Definition at line 66 of file ccsds_hdr.h.

10.2.2.3 StreamId uint8 CCSDS_PrimaryHeader::StreamId[2]

packet identifier word (stream ID)
Definition at line 59 of file ccsds_hdr.h.
The documentation for this struct was generated from the following file:

• cfe/modules/msg/fsw/inc/ccsds_hdr.h

10.3 CFE_ES_AppInfo Struct Reference

Application Information.
#include <default_cfe_es_extern_typedefs.h>

Data Fields

• CFE_ResourceId_t ResourceId
Application or Library ID for this resource.
• uint32 Type
The type of App: CORE or EXTERNAL.
• char Name [CFE_MISSION_MAX_API_LEN]
The Registered Name of the Application.
• char EntryPoint [CFE_MISSION_MAX_API_LEN]
The Entry Point label for the Application.
• char FileName [CFE_MISSION_MAX_PATH_LEN]
The Filename of the file containing the Application.
• CFE_ES_MemOffset_t StackSize
The Stack Size of the Application.
• uint32 AddressesAreValid
Indicates that the Code, Data, and BSS addresses/sizes are valid.
• CFE_ES_MemAddress_t CodeAddress
The Address of the Application Code Segment.
• CFE_ES_MemOffset_t CodeSize
The Code Size of the Application.
• CFE_ES_MemAddress_t DataAddress
The Address of the Application Data Segment.
• CFE_ES_MemOffset_t DataSize
The Data Size of the Application.
• CFE_ES_MemAddress_t BSSAddress

Generated by Doxygen
10.3 CFE_ES_AppInfo Struct Reference 427

The Address of the Application BSS Segment.

• CFE_ES_MemOffset_t BSSSize
The BSS Size of the Application.
• CFE_ES_MemAddress_t StartAddress
The Start Address of the Application.
• CFE_ES_ExceptionAction_Enum_t ExceptionAction
What should occur if Application has an exception (Restart Application OR Restart Processor)
• CFE_ES_TaskPriority_Atom_t Priority
The Priority of the Application.
• CFE_ES_TaskId_t MainTaskId
The Application's Main Task ID.
• uint32 ExecutionCounter
The Application's Main Task Execution Counter.
• char MainTaskName [CFE_MISSION_MAX_API_LEN]
The Application's Main Task ID.
• uint32 NumOfChildTasks
Number of Child tasks for an App.

10.3.1 Detailed Description

Application Information.
Structure that is used to provide information about an app. It is primarily used for the QueryOne and QueryAll Com-
mands.
While this structure is primarily intended for Application info, it can also represent Library information where only a
subset of the information applies.
Definition at line 441 of file default_cfe_es_extern_typedefs.h.

10.3.2 Field Documentation

10.3.2.1 AddressesAreValid uint32 CFE_ES_AppInfo::AddressesAreValid

Indicates that the Code, Data, and BSS addresses/sizes are valid.

Telemetry Mnemonic(s) $sc_$cpu_ES_AddrsValid

Definition at line 457 of file default_cfe_es_extern_typedefs.h.

10.3.2.2 BSSAddress CFE_ES_MemAddress_t CFE_ES_AppInfo::BSSAddress

The Address of the Application BSS Segment.

Telemetry Mnemonic(s) $sc_$cpu_ES_BSSAddress

Definition at line 467 of file default_cfe_es_extern_typedefs.h.

10.3.2.3 BSSSize CFE_ES_MemOffset_t CFE_ES_AppInfo::BSSSize

The BSS Size of the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_BSSSize

Definition at line 469 of file default_cfe_es_extern_typedefs.h.

Generated by Doxygen
428

10.3.2.4 CodeAddress CFE_ES_MemAddress_t CFE_ES_AppInfo::CodeAddress

The Address of the Application Code Segment.

Telemetry Mnemonic(s) $sc_$cpu_ES_CodeAddress

Definition at line 459 of file default_cfe_es_extern_typedefs.h.

10.3.2.5 CodeSize CFE_ES_MemOffset_t CFE_ES_AppInfo::CodeSize

The Code Size of the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_CodeSize

Definition at line 461 of file default_cfe_es_extern_typedefs.h.

10.3.2.6 DataAddress CFE_ES_MemAddress_t CFE_ES_AppInfo::DataAddress

The Address of the Application Data Segment.

Telemetry Mnemonic(s) $sc_$cpu_ES_DataAddress

Definition at line 463 of file default_cfe_es_extern_typedefs.h.

10.3.2.7 DataSize CFE_ES_MemOffset_t CFE_ES_AppInfo::DataSize

The Data Size of the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_DataSize

Definition at line 465 of file default_cfe_es_extern_typedefs.h.

10.3.2.8 EntryPoint char CFE_ES_AppInfo::EntryPoint[CFE_MISSION_MAX_API_LEN]

The Entry Point label for the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_AppEntryPt[OS_MAX_API_NAME]

Definition at line 450 of file default_cfe_es_extern_typedefs.h.

10.3.2.9 ExceptionAction CFE_ES_ExceptionAction_Enum_t CFE_ES_AppInfo::ExceptionAction

What should occur if Application has an exception (Restart Application OR Restart Processor)

Telemetry Mnemonic(s) $sc_$cpu_ES_ExceptnActn

Definition at line 473 of file default_cfe_es_extern_typedefs.h.

10.3.2.10 ExecutionCounter uint32 CFE_ES_AppInfo::ExecutionCounter

The Application's Main Task Execution Counter.

Telemetry Mnemonic(s) $sc_$cpu_ES_ExecutionCtr

Definition at line 480 of file default_cfe_es_extern_typedefs.h.

Generated by Doxygen
10.3 CFE_ES_AppInfo Struct Reference 429

10.3.2.11 FileName char CFE_ES_AppInfo::FileName[CFE_MISSION_MAX_PATH_LEN]

The Filename of the file containing the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_AppFilename[OS_MAX_PATH_LEN]

Definition at line 452 of file default_cfe_es_extern_typedefs.h.

10.3.2.12 MainTaskId CFE_ES_TaskId_t CFE_ES_AppInfo::MainTaskId

The Application's Main Task ID.

Telemetry Mnemonic(s) $sc_$cpu_ES_MainTaskId

Definition at line 478 of file default_cfe_es_extern_typedefs.h.

10.3.2.13 MainTaskName char CFE_ES_AppInfo::MainTaskName[CFE_MISSION_MAX_API_LEN]

The Application's Main Task ID.

Telemetry Mnemonic(s) $sc_$cpu_ES_MainTaskName[OS_MAX_API_NAME]

Definition at line 482 of file default_cfe_es_extern_typedefs.h.

10.3.2.14 Name char CFE_ES_AppInfo::Name[CFE_MISSION_MAX_API_LEN]

The Registered Name of the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_AppName[OS_MAX_API_NAME]

Definition at line 448 of file default_cfe_es_extern_typedefs.h.

10.3.2.15 NumOfChildTasks uint32 CFE_ES_AppInfo::NumOfChildTasks

Number of Child tasks for an App.

Telemetry Mnemonic(s) $sc_$cpu_ES_ChildTasks

Definition at line 484 of file default_cfe_es_extern_typedefs.h.

10.3.2.16 Priority CFE_ES_TaskPriority_Atom_t CFE_ES_AppInfo::Priority

The Priority of the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_Priority

Definition at line 476 of file default_cfe_es_extern_typedefs.h.

10.3.2.17 ResourceId CFE_ResourceId_t CFE_ES_AppInfo::ResourceId

Application or Library ID for this resource.

Telemetry Mnemonic(s) $sc_$cpu_ES_AppID

Definition at line 443 of file default_cfe_es_extern_typedefs.h.

Generated by Doxygen
430

10.3.2.18 StackSize CFE_ES_MemOffset_t CFE_ES_AppInfo::StackSize

The Stack Size of the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_StackSize

Definition at line 455 of file default_cfe_es_extern_typedefs.h.

10.3.2.19 StartAddress CFE_ES_MemAddress_t CFE_ES_AppInfo::StartAddress

The Start Address of the Application.

Telemetry Mnemonic(s) $sc_$cpu_ES_StartAddr

Definition at line 471 of file default_cfe_es_extern_typedefs.h.

10.3.2.20 Type uint32 CFE_ES_AppInfo::Type

The type of App: CORE or EXTERNAL.

Telemetry Mnemonic(s) $sc_$cpu_ES_AppType

Definition at line 445 of file default_cfe_es_extern_typedefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_extern_typedefs.h

10.4 CFE_ES_AppNameCmd_Payload Struct Reference

Generic application name command payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• char Application [CFE_MISSION_MAX_API_LEN]

ASCII text string containing Application or Library Name.

10.4.1 Detailed Description

Generic application name command payload.

For command details, see CFE_ES_STOP_APP_CC, CFE_ES_RESTART_APP_CC, CFE_ES_QUERY_ONE_CC
Definition at line 104 of file default_cfe_es_msgdefs.h.

10.4.2 Field Documentation

10.4.2.1 Application char CFE_ES_AppNameCmd_Payload::Application[CFE_MISSION_MAX_API_LEN]

ASCII text string containing Application or Library Name.
Definition at line 106 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.5 CFE_ES_AppReloadCmd_Payload Struct Reference

Reload Application Command Payload.
#include <default_cfe_es_msgdefs.h>

Generated by Doxygen
10.6 CFE_ES_BlockStats Struct Reference 431

Data Fields

• char Application [CFE_MISSION_MAX_API_LEN]

ASCII text string containing Application Name.
• char AppFileName [CFE_MISSION_MAX_PATH_LEN]
Full path and filename of Application's executable image.

10.5.1 Detailed Description

Reload Application Command Payload.

For command details, see CFE_ES_RELOAD_APP_CC
Definition at line 115 of file default_cfe_es_msgdefs.h.

10.5.2 Field Documentation

10.5.2.1 AppFileName char CFE_ES_AppReloadCmd_Payload::AppFileName[CFE_MISSION_MAX_PATH_LEN]

Full path and filename of Application's executable image.
Definition at line 118 of file default_cfe_es_msgdefs.h.

10.5.2.2 Application char CFE_ES_AppReloadCmd_Payload::Application[CFE_MISSION_MAX_API_LEN]

ASCII text string containing Application Name.
Definition at line 117 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.6 CFE_ES_BlockStats Struct Reference

Block statistics.
#include <default_cfe_es_extern_typedefs.h>

Data Fields

• CFE_ES_MemOffset_t BlockSize
Number of bytes in each of these blocks.
• uint32 NumCreated
Number of Memory Blocks of this size created.
• uint32 NumFree
Number of Memory Blocks of this size that are free.

10.6.1 Detailed Description

Block statistics.
Sub-Structure that is used to provide information about a specific block size/bucket within a memory pool.
Definition at line 538 of file default_cfe_es_extern_typedefs.h.

10.6.2 Field Documentation

Generated by Doxygen
432

10.6.2.1 BlockSize CFE_ES_MemOffset_t CFE_ES_BlockStats::BlockSize

Number of bytes in each of these blocks.
Definition at line 540 of file default_cfe_es_extern_typedefs.h.

10.6.2.2 NumCreated uint32 CFE_ES_BlockStats::NumCreated

Number of Memory Blocks of this size created.
Definition at line 541 of file default_cfe_es_extern_typedefs.h.

10.6.2.3 NumFree uint32 CFE_ES_BlockStats::NumFree

Number of Memory Blocks of this size that are free.
Definition at line 542 of file default_cfe_es_extern_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_extern_typedefs.h

10.7 CFE_ES_CDSRegDumpRec Struct Reference

CDS Register Dump Record.
#include <default_cfe_es_extern_typedefs.h>

Data Fields

• CFE_ES_CDSHandle_t Handle
Handle of CDS.
• CFE_ES_MemOffset_t Size
Size, in bytes, of the CDS memory block.
• bool Table
Flag that indicates whether CDS contains a Critical Table.
• char Name [CFE_MISSION_ES_CDS_MAX_FULL_NAME_LEN]
Processor Unique Name of CDS.
• uint8 ByteAlignSpare [3]
Spare bytes to ensure structure size is multiple of 4 bytes.

10.7.1 Detailed Description

CDS Register Dump Record.

Structure that is used to provide information about a critical data store. It is primarily used for the Dump CDS registry
(CFE_ES_DUMP_CDS_REGISTRY_CC) command.

Note

There is not currently a telemetry message directly containing this data structure, but it does define the format of
the data file generated by the Dump CDS registry command. Therefore it should be considered part of the overall
telemetry interface.

Definition at line 523 of file default_cfe_es_extern_typedefs.h.

10.7.2 Field Documentation

Generated by Doxygen
10.8 CFE_ES_ClearERLogCmd Struct Reference 433

10.7.2.1 ByteAlignSpare uint8 CFE_ES_CDSRegDumpRec::ByteAlignSpare[3]

Spare bytes to ensure structure size is multiple of 4 bytes.
Definition at line 529 of file default_cfe_es_extern_typedefs.h.

10.7.2.2 Handle CFE_ES_CDSHandle_t CFE_ES_CDSRegDumpRec::Handle

Handle of CDS.
Definition at line 525 of file default_cfe_es_extern_typedefs.h.

10.7.2.3 Name char CFE_ES_CDSRegDumpRec::Name[CFE_MISSION_ES_CDS_MAX_FULL_NAME_LEN]

Processor Unique Name of CDS.
Definition at line 528 of file default_cfe_es_extern_typedefs.h.

10.7.2.4 Size CFE_ES_MemOffset_t CFE_ES_CDSRegDumpRec::Size

Size, in bytes, of the CDS memory block.
Definition at line 526 of file default_cfe_es_extern_typedefs.h.

10.7.2.5 Table bool CFE_ES_CDSRegDumpRec::Table

Flag that indicates whether CDS contains a Critical Table.
Definition at line 527 of file default_cfe_es_extern_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_extern_typedefs.h

10.8 CFE_ES_ClearERLogCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.8.1 Detailed Description

Definition at line 68 of file default_cfe_es_msgstruct.h.

10.8.2 Field Documentation

10.8.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_ClearERLogCmd::CommandHeader

Command header.
Definition at line 70 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.9 CFE_ES_ClearSysLogCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Generated by Doxygen
434

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.9.1 Detailed Description

Definition at line 63 of file default_cfe_es_msgstruct.h.

10.9.2 Field Documentation

10.9.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_ClearSysLogCmd::CommandHeader

Command header.
Definition at line 65 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.10 CFE_ES_DeleteCDSCmd Struct Reference

Delete Critical Data Store Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_DeleteCDSCmd_Payload_t Payload
Command payload.

10.10.1 Detailed Description

Delete Critical Data Store Command.

Definition at line 192 of file default_cfe_es_msgstruct.h.

10.10.2 Field Documentation

10.10.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_DeleteCDSCmd::CommandHeader

Command header.
Definition at line 194 of file default_cfe_es_msgstruct.h.

10.10.2.2 Payload CFE_ES_DeleteCDSCmd_Payload_t CFE_ES_DeleteCDSCmd::Payload

Command payload.
Definition at line 195 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

Generated by Doxygen
10.11 CFE_ES_DeleteCDSCmd_Payload Struct Reference 435

10.11 CFE_ES_DeleteCDSCmd_Payload Struct Reference

Delete Critical Data Store Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• char CdsName [CFE_MISSION_ES_CDS_MAX_FULL_NAME_LEN]

ASCII text string containing name of CDS to delete.

10.11.1 Detailed Description

Delete Critical Data Store Command Payload.

For command details, see CFE_ES_DELETE_CDS_CC
Definition at line 140 of file default_cfe_es_msgdefs.h.

10.11.2 Field Documentation

10.11.2.1 CdsName char CFE_ES_DeleteCDSCmd_Payload::CdsName[CFE_MISSION_ES_CDS_MAX_FULL_NAME_LEN]

ASCII text string containing name of CDS to delete.
Definition at line 143 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.12 CFE_ES_DumpCDSRegistryCmd Struct Reference

Dump CDS Registry Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_DumpCDSRegistryCmd_Payload_t Payload
Command payload.

10.12.1 Detailed Description

Dump CDS Registry Command.

Definition at line 246 of file default_cfe_es_msgstruct.h.

10.12.2 Field Documentation

10.12.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_DumpCDSRegistryCmd::CommandHeader

Command header.
Definition at line 248 of file default_cfe_es_msgstruct.h.

Generated by Doxygen
436

10.12.2.2 Payload CFE_ES_DumpCDSRegistryCmd_Payload_t CFE_ES_DumpCDSRegistryCmd::Payload

Command payload.
Definition at line 249 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.13 CFE_ES_DumpCDSRegistryCmd_Payload Struct Reference

Dump CDS Registry Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• char DumpFilename [CFE_MISSION_MAX_PATH_LEN]

ASCII text string of full path and filename of file CDS Registry is to be written.

10.13.1 Detailed Description

Dump CDS Registry Command Payload.

For command details, see CFE_ES_DUMP_CDS_REGISTRY_CC
Definition at line 225 of file default_cfe_es_msgdefs.h.

10.13.2 Field Documentation

10.13.2.1 DumpFilename char CFE_ES_DumpCDSRegistryCmd_Payload::DumpFilename[CFE_MISSION_MAX_PATH_LEN]

ASCII text string of full path and filename of file CDS Registry is to be written.
Definition at line 227 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.14 CFE_ES_FileNameCmd Struct Reference

Generic file name command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_FileNameCmd_Payload_t Payload
Command payload.

10.14.1 Detailed Description

Generic file name command.

Definition at line 96 of file default_cfe_es_msgstruct.h.

10.14.2 Field Documentation

Generated by Doxygen
10.15 CFE_ES_FileNameCmd_Payload Struct Reference 437

10.14.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_FileNameCmd::CommandHeader

Command header.
Definition at line 98 of file default_cfe_es_msgstruct.h.

10.14.2.2 Payload CFE_ES_FileNameCmd_Payload_t CFE_ES_FileNameCmd::Payload

Command payload.
Definition at line 99 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.15 CFE_ES_FileNameCmd_Payload Struct Reference

Generic file name command payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• char FileName [CFE_MISSION_MAX_PATH_LEN]

ASCII text string containing full path and filename of file in which Application data is to be dumped.

10.15.1 Detailed Description

Generic file name command payload.

This format is shared by several executive services commands. For command details, see CFE_ES_QUERY_ALL_CC,
CFE_ES_QUERY_ALL_TASKS_CC, CFE_ES_WRITE_SYS_LOG_CC, and CFE_ES_WRITE_ER_LOG_CC
Definition at line 58 of file default_cfe_es_msgdefs.h.

10.15.2 Field Documentation

10.15.2.1 FileName char CFE_ES_FileNameCmd_Payload::FileName[CFE_MISSION_MAX_PATH_LEN]

ASCII text string containing full path and filename of file in which Application data is to be dumped.
Definition at line 60 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.16 CFE_ES_HousekeepingTlm Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_ES_HousekeepingTlm_Payload_t Payload
Telemetry payload.

10.16.1 Detailed Description

Name Executive Services Housekeeping Packet

Definition at line 279 of file default_cfe_es_msgstruct.h.

Generated by Doxygen
438

10.16.2 Field Documentation

10.16.2.1 Payload CFE_ES_HousekeepingTlm_Payload_t CFE_ES_HousekeepingTlm::Payload

Telemetry payload.
Definition at line 282 of file default_cfe_es_msgstruct.h.

10.16.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_ES_HousekeepingTlm::TelemetryHeader

Telemetry header.
Definition at line 281 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.17 CFE_ES_HousekeepingTlm_Payload Struct Reference

#include <default_cfe_es_msgdefs.h>

Data Fields

• uint8 CommandCounter
The ES Application Command Counter.
• uint8 CommandErrorCounter
The ES Application Command Error Counter.
• uint16 CFECoreChecksum
Checksum of cFE Core Code.
• uint8 CFEMajorVersion
Major Version Number of cFE.
• uint8 CFEMinorVersion
Minor Version Number of cFE.
• uint8 CFERevision
Sub-Minor Version Number of cFE.
• uint8 CFEMissionRevision
Mission Version Number of cFE.
• uint8 OSALMajorVersion
OS Abstraction Layer Major Version Number.
• uint8 OSALMinorVersion
OS Abstraction Layer Minor Version Number.
• uint8 OSALRevision
OS Abstraction Layer Revision Number.
• uint8 OSALMissionRevision
OS Abstraction Layer MissionRevision Number.
• uint8 PSPMajorVersion
Platform Support Package Major Version Number.
• uint8 PSPMinorVersion
Platform Support Package Minor Version Number.
• uint8 PSPRevision
Platform Support Package Revision Number.

Generated by Doxygen
10.17 CFE_ES_HousekeepingTlm_Payload Struct Reference 439

• uint8 PSPMissionRevision
Platform Support Package MissionRevision Number.
• CFE_ES_MemOffset_t SysLogBytesUsed
Total number of bytes used in system log.
• CFE_ES_MemOffset_t SysLogSize
Total size of the system log.
• uint32 SysLogEntries
Number of entries in the system log.
• uint32 SysLogMode
Write/Overwrite Mode.
• uint32 ERLogIndex
Current index of the ER Log (wraps around)
• uint32 ERLogEntries
Number of entries made in the ER Log since the power on.
• uint32 RegisteredCoreApps
Number of Applications registered with ES.
• uint32 RegisteredExternalApps
Number of Applications registered with ES.
• uint32 RegisteredTasks
Number of Tasks ( main AND child tasks ) registered with ES.
• uint32 RegisteredLibs
Number of Libraries registered with ES.
• uint32 ResetType
Reset type ( PROCESSOR or POWERON )
• uint32 ResetSubtype
Reset Sub Type.
• uint32 ProcessorResets
Number of processor resets since last power on.
• uint32 MaxProcessorResets
Max processor resets before a power on is done.
• uint32 BootSource
Boot source ( as provided from BSP )
• uint32 PerfState
Current state of Performance Analyzer.
• uint32 PerfMode
Current mode of Performance Analyzer.
• uint32 PerfTriggerCount
Number of Times Performance Analyzer has Triggered.
• uint32 PerfFilterMask [CFE_MISSION_ES_PERF_MAX_IDS/32]
Current Setting of Performance Analyzer Filter Masks.
• uint32 PerfTriggerMask [CFE_MISSION_ES_PERF_MAX_IDS/32]
Current Setting of Performance Analyzer Trigger Masks.
• uint32 PerfDataStart
Identifies First Stored Entry in Performance Analyzer Log.
• uint32 PerfDataEnd
Identifies Last Stored Entry in Performance Analyzer Log.
• uint32 PerfDataCount

Generated by Doxygen
440

Number of Entries Put Into the Performance Analyzer Log.

• uint32 PerfDataToWrite
Number of Performance Analyzer Log Entries Left to be Written to Log Dump File.
• CFE_ES_MemOffset_t HeapBytesFree
Number of free bytes remaining in the OS heap.
• CFE_ES_MemOffset_t HeapBlocksFree
Number of free blocks remaining in the OS heap.
• CFE_ES_MemOffset_t HeapMaxBlockSize
Number of bytes in the largest free block.

10.17.1 Detailed Description

Name Executive Services Housekeeping Packet

Definition at line 263 of file default_cfe_es_msgdefs.h.

10.17.2 Field Documentation

10.17.2.1 BootSource uint32 CFE_ES_HousekeepingTlm_Payload::BootSource

Boot source ( as provided from BSP )

Telemetry Mnemonic(s) $sc_$cpu_ES_BootSource

Definition at line 329 of file default_cfe_es_msgdefs.h.

10.17.2.2 CFECoreChecksum uint16 CFE_ES_HousekeepingTlm_Payload::CFECoreChecksum

Checksum of cFE Core Code.

Telemetry Mnemonic(s) $sc_$cpu_ES_CKSUM

Definition at line 270 of file default_cfe_es_msgdefs.h.

10.17.2.3 CFEMajorVersion uint8 CFE_ES_HousekeepingTlm_Payload::CFEMajorVersion

Major Version Number of cFE.

Telemetry Mnemonic(s) $sc_$cpu_ES_CFEMAJORVER

Definition at line 272 of file default_cfe_es_msgdefs.h.

10.17.2.4 CFEMinorVersion uint8 CFE_ES_HousekeepingTlm_Payload::CFEMinorVersion

Minor Version Number of cFE.

Telemetry Mnemonic(s) $sc_$cpu_ES_CFEMINORVER

Definition at line 274 of file default_cfe_es_msgdefs.h.

Generated by Doxygen
10.17 CFE_ES_HousekeepingTlm_Payload Struct Reference 441

10.17.2.5 CFEMissionRevision uint8 CFE_ES_HousekeepingTlm_Payload::CFEMissionRevision

Mission Version Number of cFE.

Telemetry Mnemonic(s) $sc_$cpu_ES_CFEMISSIONREV

Definition at line 278 of file default_cfe_es_msgdefs.h.

10.17.2.6 CFERevision uint8 CFE_ES_HousekeepingTlm_Payload::CFERevision

Sub-Minor Version Number of cFE.

Telemetry Mnemonic(s) $sc_$cpu_ES_CFEREVISION

Definition at line 276 of file default_cfe_es_msgdefs.h.

10.17.2.7 CommandCounter uint8 CFE_ES_HousekeepingTlm_Payload::CommandCounter

The ES Application Command Counter.

Telemetry Mnemonic(s) $sc_$cpu_ES_CMDPC

Definition at line 265 of file default_cfe_es_msgdefs.h.

10.17.2.8 CommandErrorCounter uint8 CFE_ES_HousekeepingTlm_Payload::CommandErrorCounter

The ES Application Command Error Counter.

Telemetry Mnemonic(s) $sc_$cpu_ES_CMDEC

Definition at line 267 of file default_cfe_es_msgdefs.h.

10.17.2.9 ERLogEntries uint32 CFE_ES_HousekeepingTlm_Payload::ERLogEntries

Number of entries made in the ER Log since the power on.

Telemetry Mnemonic(s) $sc_$cpu_ES_ERLOGENTRIES

Definition at line 309 of file default_cfe_es_msgdefs.h.

10.17.2.10 ERLogIndex uint32 CFE_ES_HousekeepingTlm_Payload::ERLogIndex

Current index of the ER Log (wraps around)

Telemetry Mnemonic(s) $sc_$cpu_ES_ERLOGINDEX

Definition at line 307 of file default_cfe_es_msgdefs.h.

10.17.2.11 HeapBlocksFree CFE_ES_MemOffset_t CFE_ES_HousekeepingTlm_Payload::HeapBlocksFree

Number of free blocks remaining in the OS heap.

Telemetry Mnemonic(s) $sc_$cpu_ES_HeapBlocksFree

Definition at line 354 of file default_cfe_es_msgdefs.h.

Generated by Doxygen
442

10.17.2.12 HeapBytesFree CFE_ES_MemOffset_t CFE_ES_HousekeepingTlm_Payload::HeapBytesFree

Number of free bytes remaining in the OS heap.

Telemetry Mnemonic(s) $sc_$cpu_ES_HeapBytesFree

Definition at line 352 of file default_cfe_es_msgdefs.h.

10.17.2.13 HeapMaxBlockSize CFE_ES_MemOffset_t CFE_ES_HousekeepingTlm_Payload::HeapMaxBlockSize

Number of bytes in the largest free block.

Telemetry Mnemonic(s) $sc_$cpu_ES_HeapMaxBlkSize

Definition at line 356 of file default_cfe_es_msgdefs.h.

10.17.2.14 MaxProcessorResets uint32 CFE_ES_HousekeepingTlm_Payload::MaxProcessorResets

Max processor resets before a power on is done.

Telemetry Mnemonic(s) $sc_$cpu_ES_MaxProcResets

Definition at line 327 of file default_cfe_es_msgdefs.h.

10.17.2.15 OSALMajorVersion uint8 CFE_ES_HousekeepingTlm_Payload::OSALMajorVersion

OS Abstraction Layer Major Version Number.

Telemetry Mnemonic(s) $sc_$cpu_ES_OSMAJORVER

Definition at line 280 of file default_cfe_es_msgdefs.h.

10.17.2.16 OSALMinorVersion uint8 CFE_ES_HousekeepingTlm_Payload::OSALMinorVersion

OS Abstraction Layer Minor Version Number.

Telemetry Mnemonic(s) $sc_$cpu_ES_OSMINORVER

Definition at line 282 of file default_cfe_es_msgdefs.h.

10.17.2.17 OSALMissionRevision uint8 CFE_ES_HousekeepingTlm_Payload::OSALMissionRevision

OS Abstraction Layer MissionRevision Number.

Telemetry Mnemonic(s) $sc_$cpu_ES_OSMISSIONREV

Definition at line 286 of file default_cfe_es_msgdefs.h.

10.17.2.18 OSALRevision uint8 CFE_ES_HousekeepingTlm_Payload::OSALRevision

OS Abstraction Layer Revision Number.

Telemetry Mnemonic(s) $sc_$cpu_ES_OSREVISION

Definition at line 284 of file default_cfe_es_msgdefs.h.

Generated by Doxygen
10.17 CFE_ES_HousekeepingTlm_Payload Struct Reference 443

10.17.2.19 PerfDataCount uint32 CFE_ES_HousekeepingTlm_Payload::PerfDataCount

Number of Entries Put Into the Performance Analyzer Log.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfDataCnt

Definition at line 347 of file default_cfe_es_msgdefs.h.

10.17.2.20 PerfDataEnd uint32 CFE_ES_HousekeepingTlm_Payload::PerfDataEnd

Identifies Last Stored Entry in Performance Analyzer Log.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfDataEnd

Definition at line 345 of file default_cfe_es_msgdefs.h.

10.17.2.21 PerfDataStart uint32 CFE_ES_HousekeepingTlm_Payload::PerfDataStart

Identifies First Stored Entry in Performance Analyzer Log.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfDataStart

Definition at line 343 of file default_cfe_es_msgdefs.h.

10.17.2.22 PerfDataToWrite uint32 CFE_ES_HousekeepingTlm_Payload::PerfDataToWrite

Number of Performance Analyzer Log Entries Left to be Written to Log Dump File.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfData2Write

Definition at line 350 of file default_cfe_es_msgdefs.h.

10.17.2.23 PerfFilterMask uint32 CFE_ES_HousekeepingTlm_Payload::PerfFilterMask[CFE_MISSION_ES_PERF_MAX_IDS/32]

Current Setting of Performance Analyzer Filter Masks.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfFltrMask[MaskCnt]

Definition at line 338 of file default_cfe_es_msgdefs.h.

10.17.2.24 PerfMode uint32 CFE_ES_HousekeepingTlm_Payload::PerfMode

Current mode of Performance Analyzer.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfMode

Definition at line 334 of file default_cfe_es_msgdefs.h.

10.17.2.25 PerfState uint32 CFE_ES_HousekeepingTlm_Payload::PerfState

Current state of Performance Analyzer.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfState

Definition at line 332 of file default_cfe_es_msgdefs.h.

Generated by Doxygen
444

10.17.2.26 PerfTriggerCount uint32 CFE_ES_HousekeepingTlm_Payload::PerfTriggerCount

Number of Times Performance Analyzer has Triggered.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfTrigCnt

Definition at line 336 of file default_cfe_es_msgdefs.h.

10.17.2.27 PerfTriggerMask uint32 CFE_ES_HousekeepingTlm_Payload::PerfTriggerMask[CFE_MISSION_ES_PERF_MAX_IDS/32]

Current Setting of Performance Analyzer Trigger Masks.

Telemetry Mnemonic(s) $sc_$cpu_ES_PerfTrigMask[MaskCnt]

Definition at line 341 of file default_cfe_es_msgdefs.h.

10.17.2.28 ProcessorResets uint32 CFE_ES_HousekeepingTlm_Payload::ProcessorResets

Number of processor resets since last power on.

Telemetry Mnemonic(s) $sc_$cpu_ES_ProcResetCnt

Definition at line 325 of file default_cfe_es_msgdefs.h.

10.17.2.29 PSPMajorVersion uint8 CFE_ES_HousekeepingTlm_Payload::PSPMajorVersion

Platform Support Package Major Version Number.

Telemetry Mnemonic(s) $sc_$cpu_ES_PSPMAJORVER

Definition at line 289 of file default_cfe_es_msgdefs.h.

10.17.2.30 PSPMinorVersion uint8 CFE_ES_HousekeepingTlm_Payload::PSPMinorVersion

Platform Support Package Minor Version Number.

Telemetry Mnemonic(s) $sc_$cpu_ES_PSPMINORVER

Definition at line 291 of file default_cfe_es_msgdefs.h.

10.17.2.31 PSPMissionRevision uint8 CFE_ES_HousekeepingTlm_Payload::PSPMissionRevision

Platform Support Package MissionRevision Number.

Telemetry Mnemonic(s) $sc_$cpu_ES_PSPMISSIONREV

Definition at line 295 of file default_cfe_es_msgdefs.h.

10.17.2.32 PSPRevision uint8 CFE_ES_HousekeepingTlm_Payload::PSPRevision

Platform Support Package Revision Number.

Telemetry Mnemonic(s) $sc_$cpu_ES_PSPREVISION

Definition at line 293 of file default_cfe_es_msgdefs.h.

Generated by Doxygen
10.17 CFE_ES_HousekeepingTlm_Payload Struct Reference 445

10.17.2.33 RegisteredCoreApps uint32 CFE_ES_HousekeepingTlm_Payload::RegisteredCoreApps

Number of Applications registered with ES.

Telemetry Mnemonic(s) $sc_$cpu_ES_RegCoreApps

Definition at line 312 of file default_cfe_es_msgdefs.h.

10.17.2.34 RegisteredExternalApps uint32 CFE_ES_HousekeepingTlm_Payload::RegisteredExternalApps

Number of Applications registered with ES.

Telemetry Mnemonic(s) $sc_$cpu_ES_RegExtApps

Definition at line 314 of file default_cfe_es_msgdefs.h.

10.17.2.35 RegisteredLibs uint32 CFE_ES_HousekeepingTlm_Payload::RegisteredLibs

Number of Libraries registered with ES.

Telemetry Mnemonic(s) $sc_$cpu_ES_RegLibs

Definition at line 318 of file default_cfe_es_msgdefs.h.

10.17.2.36 RegisteredTasks uint32 CFE_ES_HousekeepingTlm_Payload::RegisteredTasks

Number of Tasks ( main AND child tasks ) registered with ES.

Telemetry Mnemonic(s) $sc_$cpu_ES_RegTasks

Definition at line 316 of file default_cfe_es_msgdefs.h.

10.17.2.37 ResetSubtype uint32 CFE_ES_HousekeepingTlm_Payload::ResetSubtype

Reset Sub Type.

Telemetry Mnemonic(s) $sc_$cpu_ES_ResetSubtype

Definition at line 323 of file default_cfe_es_msgdefs.h.

10.17.2.38 ResetType uint32 CFE_ES_HousekeepingTlm_Payload::ResetType

Reset type ( PROCESSOR or POWERON )

Telemetry Mnemonic(s) $sc_$cpu_ES_ResetType

Definition at line 321 of file default_cfe_es_msgdefs.h.

10.17.2.39 SysLogBytesUsed CFE_ES_MemOffset_t CFE_ES_HousekeepingTlm_Payload::SysLogBytesUsed

Total number of bytes used in system log.

Telemetry Mnemonic(s) $sc_$cpu_ES_SYSLOGBYTEUSED

Definition at line 298 of file default_cfe_es_msgdefs.h.

Generated by Doxygen
446

10.17.2.40 SysLogEntries uint32 CFE_ES_HousekeepingTlm_Payload::SysLogEntries

Number of entries in the system log.

Telemetry Mnemonic(s) $sc_$cpu_ES_SYSLOGENTRIES

Definition at line 302 of file default_cfe_es_msgdefs.h.

10.17.2.41 SysLogMode uint32 CFE_ES_HousekeepingTlm_Payload::SysLogMode

Write/Overwrite Mode.

Telemetry Mnemonic(s) $sc_$cpu_ES_SYSLOGMODE

Definition at line 304 of file default_cfe_es_msgdefs.h.

10.17.2.42 SysLogSize CFE_ES_MemOffset_t CFE_ES_HousekeepingTlm_Payload::SysLogSize

Total size of the system log.

Telemetry Mnemonic(s) $sc_$cpu_ES_SYSLOGSIZE

Definition at line 300 of file default_cfe_es_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.18 CFE_ES_MemPoolStats Struct Reference

Memory Pool Statistics.
#include <default_cfe_es_extern_typedefs.h>

Data Fields

• CFE_ES_MemOffset_t PoolSize
Size of Memory Pool (in bytes)
• uint32 NumBlocksRequested
Number of times a memory block has been allocated.
• uint32 CheckErrCtr
Number of errors detected when freeing a memory block.
• CFE_ES_MemOffset_t NumFreeBytes
Number of bytes never allocated to a block.
• CFE_ES_BlockStats_t BlockStats [CFE_MISSION_ES_POOL_MAX_BUCKETS]
Contains stats on each block size.

10.18.1 Detailed Description

Memory Pool Statistics.

Structure that is used to provide information about a memory pool. Used by the Memory Pool Stats telemetry message.

See also

CFE_ES_SEND_MEM_POOL_STATS_CC

Definition at line 553 of file default_cfe_es_extern_typedefs.h.

Generated by Doxygen
10.19 CFE_ES_MemStatsTlm Struct Reference 447

10.18.2 Field Documentation

10.18.2.1 BlockStats CFE_ES_BlockStats_t CFE_ES_MemPoolStats::BlockStats[CFE_MISSION_ES_POOL_MAX_BUCKETS]

Contains stats on each block size.

Telemetry Mnemonic(s) $sc_$cpu_ES_BlkStats[BLK_SIZES]

Definition at line 563 of file default_cfe_es_extern_typedefs.h.

10.18.2.2 CheckErrCtr uint32 CFE_ES_MemPoolStats::CheckErrCtr

Number of errors detected when freeing a memory block.

Telemetry Mnemonic(s) $sc_$cpu_ES_BlkErrCTR

Definition at line 559 of file default_cfe_es_extern_typedefs.h.

10.18.2.3 NumBlocksRequested uint32 CFE_ES_MemPoolStats::NumBlocksRequested

Number of times a memory block has been allocated.

Telemetry Mnemonic(s) $sc_$cpu_ES_BlksREQ

Definition at line 557 of file default_cfe_es_extern_typedefs.h.

10.18.2.4 NumFreeBytes CFE_ES_MemOffset_t CFE_ES_MemPoolStats::NumFreeBytes

Number of bytes never allocated to a block.

Telemetry Mnemonic(s) $sc_$cpu_ES_FreeBytes

Definition at line 561 of file default_cfe_es_extern_typedefs.h.

10.18.2.5 PoolSize CFE_ES_MemOffset_t CFE_ES_MemPoolStats::PoolSize

Size of Memory Pool (in bytes)

Telemetry Mnemonic(s) $sc_$cpu_ES_PoolSize

Definition at line 555 of file default_cfe_es_extern_typedefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_extern_typedefs.h

10.19 CFE_ES_MemStatsTlm Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_ES_PoolStatsTlm_Payload_t Payload
Telemetry payload.

Generated by Doxygen
448

10.19.1 Detailed Description

Name Memory Pool Statistics Packet

Definition at line 270 of file default_cfe_es_msgstruct.h.

10.19.2 Field Documentation

10.19.2.1 Payload CFE_ES_PoolStatsTlm_Payload_t CFE_ES_MemStatsTlm::Payload

Telemetry payload.
Definition at line 273 of file default_cfe_es_msgstruct.h.

10.19.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_ES_MemStatsTlm::TelemetryHeader

Telemetry header.
Definition at line 272 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.20 CFE_ES_NoopCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.20.1 Detailed Description

Definition at line 53 of file default_cfe_es_msgstruct.h.

10.20.2 Field Documentation

10.20.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_NoopCmd::CommandHeader

Command header.
Definition at line 57 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.21 CFE_ES_OneAppTlm Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_ES_OneAppTlm_Payload_t Payload
Telemetry payload.

Generated by Doxygen
10.22 CFE_ES_OneAppTlm_Payload Struct Reference 449

10.21.1 Detailed Description

Name Single Application Information Packet

Definition at line 261 of file default_cfe_es_msgstruct.h.

10.21.2 Field Documentation

10.21.2.1 Payload CFE_ES_OneAppTlm_Payload_t CFE_ES_OneAppTlm::Payload

Telemetry payload.
Definition at line 264 of file default_cfe_es_msgstruct.h.

10.21.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_ES_OneAppTlm::TelemetryHeader

Telemetry header.
Definition at line 263 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.22 CFE_ES_OneAppTlm_Payload Struct Reference

#include <default_cfe_es_msgdefs.h>

Data Fields

• CFE_ES_AppInfo_t AppInfo
For more information, see CFE_ES_AppInfo_t.

10.22.1 Detailed Description

Name Single Application Information Packet

Definition at line 243 of file default_cfe_es_msgdefs.h.

10.22.2 Field Documentation

10.22.2.1 AppInfo CFE_ES_AppInfo_t CFE_ES_OneAppTlm_Payload::AppInfo

For more information, see CFE_ES_AppInfo_t.
Definition at line 245 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.23 CFE_ES_OverWriteSysLogCmd Struct Reference

Overwrite/Discard System Log Configuration Command Payload.
#include <default_cfe_es_msgstruct.h>

Generated by Doxygen
450

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_OverWriteSysLogCmd_Payload_t Payload
Command payload.

10.23.1 Detailed Description

Overwrite/Discard System Log Configuration Command Payload.

Definition at line 133 of file default_cfe_es_msgstruct.h.

10.23.2 Field Documentation

10.23.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_OverWriteSysLogCmd::CommandHeader

Command header.
Definition at line 135 of file default_cfe_es_msgstruct.h.

10.23.2.2 Payload CFE_ES_OverWriteSysLogCmd_Payload_t CFE_ES_OverWriteSysLogCmd::Payload

Command payload.
Definition at line 136 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.24 CFE_ES_OverWriteSysLogCmd_Payload Struct Reference

Overwrite/Discard System Log Configuration Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• uint32 Mode
CFE_ES_LogMode_DISCARD=Throw away most recent messages, CFE_ES_LogMode_OVERWRITE=Overwrite oldest
with most recent

10.24.1 Detailed Description

Overwrite/Discard System Log Configuration Command Payload.

For command details, see CFE_ES_OVER_WRITE_SYS_LOG_CC
Definition at line 70 of file default_cfe_es_msgdefs.h.

10.24.2 Field Documentation

10.24.2.1 Mode uint32 CFE_ES_OverWriteSysLogCmd_Payload::Mode

CFE_ES_LogMode_DISCARD=Throw away most recent messages, CFE_ES_LogMode_OVERWRITE=Overwrite old-
est with most recent
Definition at line 72 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgdefs.h

Generated by Doxygen
10.25 CFE_ES_PoolAlign Union Reference 451

10.25 CFE_ES_PoolAlign Union Reference

Pool Alignment.
#include <cfe_es_api_typedefs.h>

Data Fields

• void ∗ Ptr
Aligned pointer.
• long long int LongInt
Aligned Long Integer.
• long double LongDouble
Aligned Long Double.

10.25.1 Detailed Description

Pool Alignment.
Union that can be used for minimum memory alignment of ES memory pools on the target. It contains the longest native
data types such that the alignment of this structure should reflect the largest possible alignment requirements for any
data on this processor.
Definition at line 145 of file cfe_es_api_typedefs.h.

10.25.2 Field Documentation

10.25.2.1 LongDouble long double CFE_ES_PoolAlign::LongDouble

Aligned Long Double.
Definition at line 150 of file cfe_es_api_typedefs.h.

10.25.2.2 LongInt long long int CFE_ES_PoolAlign::LongInt

Aligned Long Integer.
Definition at line 149 of file cfe_es_api_typedefs.h.

10.25.2.3 Ptr void∗ CFE_ES_PoolAlign::Ptr

Aligned pointer.
Definition at line 147 of file cfe_es_api_typedefs.h.
The documentation for this union was generated from the following file:

• cfe/modules/core_api/fsw/inc/cfe_es_api_typedefs.h

10.26 CFE_ES_PoolStatsTlm_Payload Struct Reference

#include <default_cfe_es_msgdefs.h>

Data Fields

• CFE_ES_MemHandle_t PoolHandle
Handle of memory pool whose stats are being telemetered.
• CFE_ES_MemPoolStats_t PoolStats
For more info, see CFE_ES_MemPoolStats_t.

Generated by Doxygen
452

10.26.1 Detailed Description

Name Memory Pool Statistics Packet

Definition at line 251 of file default_cfe_es_msgdefs.h.

10.26.2 Field Documentation

10.26.2.1 PoolHandle CFE_ES_MemHandle_t CFE_ES_PoolStatsTlm_Payload::PoolHandle

Handle of memory pool whose stats are being telemetered.

Telemetry Mnemonic(s) $sc_$cpu_ES_PoolHandle

Definition at line 253 of file default_cfe_es_msgdefs.h.

10.26.2.2 PoolStats CFE_ES_MemPoolStats_t CFE_ES_PoolStatsTlm_Payload::PoolStats

For more info, see CFE_ES_MemPoolStats_t.
Definition at line 255 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.27 CFE_ES_QueryAllCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_FileNameCmd_Payload_t Payload
Command payload.

10.27.1 Detailed Description

Definition at line 106 of file default_cfe_es_msgstruct.h.

10.27.2 Field Documentation

10.27.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_QueryAllCmd::CommandHeader

Command header.
Definition at line 108 of file default_cfe_es_msgstruct.h.

10.27.2.2 Payload CFE_ES_FileNameCmd_Payload_t CFE_ES_QueryAllCmd::Payload

Command payload.
Definition at line 109 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

Generated by Doxygen
10.28 CFE_ES_QueryAllTasksCmd Struct Reference 453

10.28 CFE_ES_QueryAllTasksCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_FileNameCmd_Payload_t Payload
Command payload.

10.28.1 Detailed Description

Definition at line 112 of file default_cfe_es_msgstruct.h.

10.28.2 Field Documentation

10.28.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_QueryAllTasksCmd::CommandHeader

Command header.
Definition at line 114 of file default_cfe_es_msgstruct.h.

10.28.2.2 Payload CFE_ES_FileNameCmd_Payload_t CFE_ES_QueryAllTasksCmd::Payload

Command payload.
Definition at line 115 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.29 CFE_ES_QueryOneCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_AppNameCmd_Payload_t Payload
Command payload.

10.29.1 Detailed Description

Definition at line 165 of file default_cfe_es_msgstruct.h.

10.29.2 Field Documentation

10.29.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_QueryOneCmd::CommandHeader

Command header.
Definition at line 167 of file default_cfe_es_msgstruct.h.

Generated by Doxygen
454

10.29.2.2 Payload CFE_ES_AppNameCmd_Payload_t CFE_ES_QueryOneCmd::Payload

Command payload.
Definition at line 168 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.30 CFE_ES_ReloadAppCmd Struct Reference

Reload Application Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_AppReloadCmd_Payload_t Payload
Command payload.

10.30.1 Detailed Description

Reload Application Command.

Definition at line 174 of file default_cfe_es_msgstruct.h.

10.30.2 Field Documentation

10.30.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_ReloadAppCmd::CommandHeader

Command header.
Definition at line 176 of file default_cfe_es_msgstruct.h.

10.30.2.2 Payload CFE_ES_AppReloadCmd_Payload_t CFE_ES_ReloadAppCmd::Payload

Command payload.
Definition at line 177 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.31 CFE_ES_ResetCountersCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.31.1 Detailed Description

Definition at line 58 of file default_cfe_es_msgstruct.h.

Generated by Doxygen
10.32 CFE_ES_ResetPRCountCmd Struct Reference 455

10.31.2 Field Documentation

10.31.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_ResetCountersCmd::CommandHeader

Command header.
Definition at line 60 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.32 CFE_ES_ResetPRCountCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.32.1 Detailed Description

Definition at line 73 of file default_cfe_es_msgstruct.h.

10.32.2 Field Documentation

10.32.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_ResetPRCountCmd::CommandHeader

Command header.
Definition at line 75 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.33 CFE_ES_RestartAppCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_AppNameCmd_Payload_t Payload
Command payload.

10.33.1 Detailed Description

Definition at line 159 of file default_cfe_es_msgstruct.h.

10.33.2 Field Documentation

Generated by Doxygen
456

10.33.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_RestartAppCmd::CommandHeader

Command header.
Definition at line 161 of file default_cfe_es_msgstruct.h.

10.33.2.2 Payload CFE_ES_AppNameCmd_Payload_t CFE_ES_RestartAppCmd::Payload

Command payload.
Definition at line 162 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.34 CFE_ES_RestartCmd Struct Reference

Restart cFE Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_RestartCmd_Payload_t Payload
Command payload.

10.34.1 Detailed Description

Restart cFE Command.

Definition at line 86 of file default_cfe_es_msgstruct.h.

10.34.2 Field Documentation

10.34.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_RestartCmd::CommandHeader

Command header.
Definition at line 88 of file default_cfe_es_msgstruct.h.

10.34.2.2 Payload CFE_ES_RestartCmd_Payload_t CFE_ES_RestartCmd::Payload

Command payload.
Definition at line 89 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.35 CFE_ES_RestartCmd_Payload Struct Reference

Restart cFE Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• uint16 RestartType
CFE_PSP_RST_TYPE_PROCESSOR=Processor Reset or CFE_PSP_RST_TYPE_POWERON=Power-On Reset

Generated by Doxygen
10.36 CFE_ES_SendHkCmd Struct Reference 457

10.35.1 Detailed Description

Restart cFE Command Payload.

For command details, see CFE_ES_RESTART_CC
Definition at line 44 of file default_cfe_es_msgdefs.h.

10.35.2 Field Documentation

10.35.2.1 RestartType uint16 CFE_ES_RestartCmd_Payload::RestartType

CFE_PSP_RST_TYPE_PROCESSOR=Processor Reset or CFE_PSP_RST_TYPE_POWERON=Power-On Reset

Definition at line 46 of file default_cfe_es_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.36 CFE_ES_SendHkCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.36.1 Detailed Description

Definition at line 78 of file default_cfe_es_msgstruct.h.

10.36.2 Field Documentation

10.36.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_SendHkCmd::CommandHeader

Command header.
Definition at line 80 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.37 CFE_ES_SendMemPoolStatsCmd Struct Reference

Send Memory Pool Statistics Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_SendMemPoolStatsCmd_Payload_t Payload
Command payload.

Generated by Doxygen
458

10.37.1 Detailed Description

Send Memory Pool Statistics Command.

Definition at line 237 of file default_cfe_es_msgstruct.h.

10.37.2 Field Documentation

10.37.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_SendMemPoolStatsCmd::CommandHeader

Command header.
Definition at line 239 of file default_cfe_es_msgstruct.h.

10.37.2.2 Payload CFE_ES_SendMemPoolStatsCmd_Payload_t CFE_ES_SendMemPoolStatsCmd::Payload

Command payload.
Definition at line 240 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.38 CFE_ES_SendMemPoolStatsCmd_Payload Struct Reference

Send Memory Pool Statistics Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• char Application [CFE_MISSION_MAX_API_LEN]

– RESERVED - should be all zeroes
• CFE_ES_MemHandle_t PoolHandle
Handle of Pool whose statistics are to be telemetered.

10.38.1 Detailed Description

Send Memory Pool Statistics Command Payload.

For command details, see CFE_ES_SEND_MEM_POOL_STATS_CC
Definition at line 213 of file default_cfe_es_msgdefs.h.

10.38.2 Field Documentation

10.38.2.1 Application char CFE_ES_SendMemPoolStatsCmd_Payload::Application[CFE_MISSION_MAX_API_LEN]

• RESERVED - should be all zeroes

Definition at line 215 of file default_cfe_es_msgdefs.h.

10.38.2.2 PoolHandle CFE_ES_MemHandle_t CFE_ES_SendMemPoolStatsCmd_Payload::PoolHandle

Handle of Pool whose statistics are to be telemetered.
Definition at line 216 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

Generated by Doxygen
10.39 CFE_ES_SetMaxPRCountCmd Struct Reference 459

10.39 CFE_ES_SetMaxPRCountCmd Struct Reference

Set Maximum Processor Reset Count Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_SetMaxPRCountCmd_Payload_t Payload
Command payload.

10.39.1 Detailed Description

Set Maximum Processor Reset Count Command.

Definition at line 183 of file default_cfe_es_msgstruct.h.

10.39.2 Field Documentation

10.39.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_SetMaxPRCountCmd::CommandHeader

Command header.
Definition at line 185 of file default_cfe_es_msgstruct.h.

10.39.2.2 Payload CFE_ES_SetMaxPRCountCmd_Payload_t CFE_ES_SetMaxPRCountCmd::Payload

Command payload.
Definition at line 186 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.40 CFE_ES_SetMaxPRCountCmd_Payload Struct Reference

Set Maximum Processor Reset Count Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• uint16 MaxPRCount
New maximum number of Processor Resets before an automatic Power-On Reset is performed.

10.40.1 Detailed Description

Set Maximum Processor Reset Count Command Payload.

For command details, see CFE_ES_SET_MAX_PR_COUNT_CC
Definition at line 128 of file default_cfe_es_msgdefs.h.

10.40.2 Field Documentation

Generated by Doxygen
460

10.40.2.1 MaxPRCount uint16 CFE_ES_SetMaxPRCountCmd_Payload::MaxPRCount

New maximum number of Processor Resets before an automatic Power-On Reset is performed.
Definition at line 130 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.41 CFE_ES_SetPerfFilterMaskCmd Struct Reference

Set Performance Analyzer Filter Mask Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_SetPerfFilterMaskCmd_Payload_t Payload
Command payload.

10.41.1 Detailed Description

Set Performance Analyzer Filter Mask Command.

Definition at line 219 of file default_cfe_es_msgstruct.h.

10.41.2 Field Documentation

10.41.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_SetPerfFilterMaskCmd::CommandHeader

Command header.
Definition at line 221 of file default_cfe_es_msgstruct.h.

10.41.2.2 Payload CFE_ES_SetPerfFilterMaskCmd_Payload_t CFE_ES_SetPerfFilterMaskCmd::Payload

Command payload.
Definition at line 222 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.42 CFE_ES_SetPerfFilterMaskCmd_Payload Struct Reference

Set Performance Analyzer Filter Mask Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• uint32 FilterMaskNum
Index into array of Filter Masks.
• uint32 FilterMask
New Mask for specified entry in array of Filter Masks.

Generated by Doxygen
10.43 CFE_ES_SetPerfTriggerMaskCmd Struct Reference 461

10.42.1 Detailed Description

Set Performance Analyzer Filter Mask Command Payload.

For command details, see CFE_ES_SET_PERF_FILTER_MASK_CC
Definition at line 189 of file default_cfe_es_msgdefs.h.

10.42.2 Field Documentation

10.42.2.1 FilterMask uint32 CFE_ES_SetPerfFilterMaskCmd_Payload::FilterMask

New Mask for specified entry in array of Filter Masks.
Definition at line 192 of file default_cfe_es_msgdefs.h.

10.42.2.2 FilterMaskNum uint32 CFE_ES_SetPerfFilterMaskCmd_Payload::FilterMaskNum

Index into array of Filter Masks.
Definition at line 191 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.43 CFE_ES_SetPerfTriggerMaskCmd Struct Reference

Set Performance Analyzer Trigger Mask Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_SetPerfTrigMaskCmd_Payload_t Payload
Command payload.

10.43.1 Detailed Description

Set Performance Analyzer Trigger Mask Command.

Definition at line 228 of file default_cfe_es_msgstruct.h.

10.43.2 Field Documentation

10.43.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_SetPerfTriggerMaskCmd::CommandHeader

Command header.
Definition at line 230 of file default_cfe_es_msgstruct.h.

10.43.2.2 Payload CFE_ES_SetPerfTrigMaskCmd_Payload_t CFE_ES_SetPerfTriggerMaskCmd::Payload

Command payload.
Definition at line 231 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

Generated by Doxygen
462

10.44 CFE_ES_SetPerfTrigMaskCmd_Payload Struct Reference

Set Performance Analyzer Trigger Mask Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• uint32 TriggerMaskNum
Index into array of Trigger Masks.
• uint32 TriggerMask
New Mask for specified entry in array of Trigger Masks.

10.44.1 Detailed Description

Set Performance Analyzer Trigger Mask Command Payload.

For command details, see CFE_ES_SET_PERF_TRIGGER_MASK_CC
Definition at line 201 of file default_cfe_es_msgdefs.h.

10.44.2 Field Documentation

10.44.2.1 TriggerMask uint32 CFE_ES_SetPerfTrigMaskCmd_Payload::TriggerMask

New Mask for specified entry in array of Trigger Masks.
Definition at line 204 of file default_cfe_es_msgdefs.h.

10.44.2.2 TriggerMaskNum uint32 CFE_ES_SetPerfTrigMaskCmd_Payload::TriggerMaskNum

Index into array of Trigger Masks.
Definition at line 203 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.45 CFE_ES_StartApp Struct Reference

Start Application Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_StartAppCmd_Payload_t Payload
Command payload.

10.45.1 Detailed Description

Start Application Command.

Definition at line 142 of file default_cfe_es_msgstruct.h.

10.45.2 Field Documentation

Generated by Doxygen
10.46 CFE_ES_StartAppCmd_Payload Struct Reference 463

10.45.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_StartApp::CommandHeader

Command header.
Definition at line 144 of file default_cfe_es_msgstruct.h.

10.45.2.2 Payload CFE_ES_StartAppCmd_Payload_t CFE_ES_StartApp::Payload

Command payload.
Definition at line 145 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.46 CFE_ES_StartAppCmd_Payload Struct Reference

Start Application Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• char Application [CFE_MISSION_MAX_API_LEN]

Name of Application to be started.
• char AppEntryPoint [CFE_MISSION_MAX_API_LEN]
Symbolic name of Application's entry point.
• char AppFileName [CFE_MISSION_MAX_PATH_LEN]
Full path and filename of Application's executable image.
• CFE_ES_MemOffset_t StackSize
Desired stack size for the new application.
• CFE_ES_ExceptionAction_Enum_t ExceptionAction
CFE_ES_ExceptionAction_RESTART_APP=On exception, restart Application, CFE_ES_ExceptionAction_PROC_RESTART=On
exception, perform a Processor Reset
• CFE_ES_TaskPriority_Atom_t Priority
The new Applications runtime priority.

10.46.1 Detailed Description

Start Application Command Payload.

For command details, see CFE_ES_START_APP_CC
Definition at line 82 of file default_cfe_es_msgdefs.h.

10.46.2 Field Documentation

10.46.2.1 AppEntryPoint char CFE_ES_StartAppCmd_Payload::AppEntryPoint[CFE_MISSION_MAX_API_LEN]

Symbolic name of Application's entry point.
Definition at line 85 of file default_cfe_es_msgdefs.h.

10.46.2.2 AppFileName char CFE_ES_StartAppCmd_Payload::AppFileName[CFE_MISSION_MAX_PATH_LEN]

Full path and filename of Application's executable image.
Definition at line 86 of file default_cfe_es_msgdefs.h.

Generated by Doxygen
464

10.46.2.3 Application char CFE_ES_StartAppCmd_Payload::Application[CFE_MISSION_MAX_API_LEN]

Name of Application to be started.
Definition at line 84 of file default_cfe_es_msgdefs.h.

10.46.2.4 ExceptionAction CFE_ES_ExceptionAction_Enum_t CFE_ES_StartAppCmd_Payload::Exception←-

Action
CFE_ES_ExceptionAction_RESTART_APP=On exception, restart Application, CFE_ES_ExceptionAction_PROC_RESTART=On
exception, perform a Processor Reset
Definition at line 91 of file default_cfe_es_msgdefs.h.

10.46.2.5 Priority CFE_ES_TaskPriority_Atom_t CFE_ES_StartAppCmd_Payload::Priority

The new Applications runtime priority.
Definition at line 95 of file default_cfe_es_msgdefs.h.

10.46.2.6 StackSize CFE_ES_MemOffset_t CFE_ES_StartAppCmd_Payload::StackSize

Desired stack size for the new application.
Definition at line 89 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.47 CFE_ES_StartPerfCmd_Payload Struct Reference

Start Performance Analyzer Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• CFE_ES_PerfMode_Enum_t TriggerMode
Desired trigger position (Start, Center, End). Values defined by CFE_ES_PerfMode.

10.47.1 Detailed Description

Start Performance Analyzer Command Payload.

For command details, see CFE_ES_START_PERF_DATA_CC
Definition at line 165 of file default_cfe_es_msgdefs.h.

10.47.2 Field Documentation

10.47.2.1 TriggerMode CFE_ES_PerfMode_Enum_t CFE_ES_StartPerfCmd_Payload::TriggerMode

Desired trigger position (Start, Center, End). Values defined by CFE_ES_PerfMode.
Definition at line 168 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.48 CFE_ES_StartPerfDataCmd Struct Reference

Start Performance Analyzer Command.
#include <default_cfe_es_msgstruct.h>

Generated by Doxygen
10.49 CFE_ES_StopAppCmd Struct Reference 465

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_StartPerfCmd_Payload_t Payload
Command payload.

10.48.1 Detailed Description

Start Performance Analyzer Command.

Definition at line 201 of file default_cfe_es_msgstruct.h.

10.48.2 Field Documentation

10.48.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_StartPerfDataCmd::CommandHeader

Command header.
Definition at line 203 of file default_cfe_es_msgstruct.h.

10.48.2.2 Payload CFE_ES_StartPerfCmd_Payload_t CFE_ES_StartPerfDataCmd::Payload

Command payload.
Definition at line 204 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.49 CFE_ES_StopAppCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_AppNameCmd_Payload_t Payload
Command payload.

10.49.1 Detailed Description

Definition at line 153 of file default_cfe_es_msgstruct.h.

10.49.2 Field Documentation

10.49.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_StopAppCmd::CommandHeader

Command header.
Definition at line 155 of file default_cfe_es_msgstruct.h.

Generated by Doxygen
466

10.49.2.2 Payload CFE_ES_AppNameCmd_Payload_t CFE_ES_StopAppCmd::Payload

Command payload.
Definition at line 156 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.50 CFE_ES_StopPerfCmd_Payload Struct Reference

Stop Performance Analyzer Command Payload.
#include <default_cfe_es_msgdefs.h>

Data Fields

• char DataFileName [CFE_MISSION_MAX_PATH_LEN]

ASCII text string of full path and filename of file Performance Analyzer data is to be written.

10.50.1 Detailed Description

Stop Performance Analyzer Command Payload.

For command details, see CFE_ES_STOP_PERF_DATA_CC
Definition at line 177 of file default_cfe_es_msgdefs.h.

10.50.2 Field Documentation

10.50.2.1 DataFileName char CFE_ES_StopPerfCmd_Payload::DataFileName[CFE_MISSION_MAX_PATH_LEN]

ASCII text string of full path and filename of file Performance Analyzer data is to be written.
Definition at line 179 of file default_cfe_es_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgdefs.h

10.51 CFE_ES_StopPerfDataCmd Struct Reference

Stop Performance Analyzer Command.
#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_StopPerfCmd_Payload_t Payload
Command payload.

10.51.1 Detailed Description

Stop Performance Analyzer Command.

Definition at line 210 of file default_cfe_es_msgstruct.h.

10.51.2 Field Documentation

Generated by Doxygen
10.52 CFE_ES_TaskInfo Struct Reference 467

10.51.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_StopPerfDataCmd::CommandHeader

Command header.
Definition at line 212 of file default_cfe_es_msgstruct.h.

10.51.2.2 Payload CFE_ES_StopPerfCmd_Payload_t CFE_ES_StopPerfDataCmd::Payload

Command payload.
Definition at line 213 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.52 CFE_ES_TaskInfo Struct Reference

Task Information.
#include <default_cfe_es_extern_typedefs.h>

Data Fields

• CFE_ES_TaskId_t TaskId
Task Id.
• uint32 ExecutionCounter
Task Execution Counter.
• char TaskName [CFE_MISSION_MAX_API_LEN]
Task Name.
• CFE_ES_AppId_t AppId
Parent Application ID.
• char AppName [CFE_MISSION_MAX_API_LEN]
Parent Application Name.
• CFE_ES_MemOffset_t StackSize
• CFE_ES_TaskPriority_Atom_t Priority
• uint8 Spare [2]

10.52.1 Detailed Description

Task Information.
Structure that is used to provide information about a task. It is primarily used for the Query All Tasks
(CFE_ES_QUERY_ALL_TASKS_CC) command.
Note

There is not currently a telemetry message directly containing this data structure, but it does define the format of
the data file generated by the Query All Tasks command. Therefore it should be considered part of the overall
telemetry interface.

Definition at line 499 of file default_cfe_es_extern_typedefs.h.

10.52.2 Field Documentation

10.52.2.1 AppId CFE_ES_AppId_t CFE_ES_TaskInfo::AppId

Parent Application ID.
Definition at line 504 of file default_cfe_es_extern_typedefs.h.

Generated by Doxygen
468

10.52.2.2 AppName char CFE_ES_TaskInfo::AppName[CFE_MISSION_MAX_API_LEN]

Parent Application Name.
Definition at line 505 of file default_cfe_es_extern_typedefs.h.

10.52.2.3 ExecutionCounter uint32 CFE_ES_TaskInfo::ExecutionCounter

Task Execution Counter.
Definition at line 502 of file default_cfe_es_extern_typedefs.h.

10.52.2.4 Priority CFE_ES_TaskPriority_Atom_t CFE_ES_TaskInfo::Priority

Priority of task
Definition at line 507 of file default_cfe_es_extern_typedefs.h.

10.52.2.5 Spare uint8 CFE_ES_TaskInfo::Spare[2]

Spare bytes for alignment
Definition at line 508 of file default_cfe_es_extern_typedefs.h.

10.52.2.6 StackSize CFE_ES_MemOffset_t CFE_ES_TaskInfo::StackSize

Size of task stack
Definition at line 506 of file default_cfe_es_extern_typedefs.h.

10.52.2.7 TaskId CFE_ES_TaskId_t CFE_ES_TaskInfo::TaskId

Task Id.
Definition at line 501 of file default_cfe_es_extern_typedefs.h.

10.52.2.8 TaskName char CFE_ES_TaskInfo::TaskName[CFE_MISSION_MAX_API_LEN]

Task Name.
Definition at line 503 of file default_cfe_es_extern_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_extern_typedefs.h

10.53 CFE_ES_WriteERLogCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_FileNameCmd_Payload_t Payload
Command payload.

10.53.1 Detailed Description

Definition at line 124 of file default_cfe_es_msgstruct.h.

Generated by Doxygen
10.54 CFE_ES_WriteSysLogCmd Struct Reference 469

10.53.2 Field Documentation

10.53.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_WriteERLogCmd::CommandHeader

Command header.
Definition at line 126 of file default_cfe_es_msgstruct.h.

10.53.2.2 Payload CFE_ES_FileNameCmd_Payload_t CFE_ES_WriteERLogCmd::Payload

Command payload.
Definition at line 127 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.54 CFE_ES_WriteSysLogCmd Struct Reference

#include <default_cfe_es_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_ES_FileNameCmd_Payload_t Payload
Command payload.

10.54.1 Detailed Description

Definition at line 118 of file default_cfe_es_msgstruct.h.

10.54.2 Field Documentation

10.54.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_ES_WriteSysLogCmd::CommandHeader

Command header.
Definition at line 120 of file default_cfe_es_msgstruct.h.

10.54.2.2 Payload CFE_ES_FileNameCmd_Payload_t CFE_ES_WriteSysLogCmd::Payload

Command payload.
Definition at line 121 of file default_cfe_es_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/es/config/default_cfe_es_msgstruct.h

10.55 CFE_EVS_AddEventFilterCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Generated by Doxygen
470

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameEventIDMaskCmd_Payload_t Payload
Command payload.

10.55.1 Detailed Description

Definition at line 203 of file default_cfe_evs_msgstruct.h.

10.55.2 Field Documentation

10.55.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_AddEventFilterCmd::CommandHeader

Command header.
Definition at line 205 of file default_cfe_evs_msgstruct.h.

10.55.2.2 Payload CFE_EVS_AppNameEventIDMaskCmd_Payload_t CFE_EVS_AddEventFilterCmd::Payload

Command payload.
Definition at line 206 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.56 CFE_EVS_AppDataCmd_Payload Struct Reference

Write Event Services Application Information to File Command Payload.
#include <default_cfe_evs_msgdefs.h>

Data Fields

• char AppDataFilename [CFE_MISSION_MAX_PATH_LEN]

Filename where application data is to be written.

10.56.1 Detailed Description

Write Event Services Application Information to File Command Payload.

For command details, see CFE_EVS_WRITE_APP_DATA_FILE_CC
Definition at line 68 of file default_cfe_evs_msgdefs.h.

10.56.2 Field Documentation

10.56.2.1 AppDataFilename char CFE_EVS_AppDataCmd_Payload::AppDataFilename[CFE_MISSION_MAX_PATH_LEN]

Filename where application data is to be written.
Definition at line 70 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

Generated by Doxygen
10.57 CFE_EVS_AppNameBitMaskCmd_Payload Struct Reference 471

10.57 CFE_EVS_AppNameBitMaskCmd_Payload Struct Reference

Generic App Name and Bitmask Command Payload.
#include <default_cfe_evs_msgdefs.h>

Data Fields

• char AppName [CFE_MISSION_MAX_API_LEN]

Application name to use in the command.
• uint8 BitMask
BitMask to use in the command.
• uint8 Spare
Pad to even byte.

10.57.1 Detailed Description

Generic App Name and Bitmask Command Payload.

For command details, see CFE_EVS_ENABLE_APP_EVENT_TYPE_CC and/or CFE_EVS_DISABLE_APP_EVENT_TYPE_CC
Definition at line 140 of file default_cfe_evs_msgdefs.h.

10.57.2 Field Documentation

10.57.2.1 AppName char CFE_EVS_AppNameBitMaskCmd_Payload::AppName[CFE_MISSION_MAX_API_LEN]

Application name to use in the command.
Definition at line 142 of file default_cfe_evs_msgdefs.h.

10.57.2.2 BitMask uint8 CFE_EVS_AppNameBitMaskCmd_Payload::BitMask

BitMask to use in the command.
Definition at line 143 of file default_cfe_evs_msgdefs.h.

10.57.2.3 Spare uint8 CFE_EVS_AppNameBitMaskCmd_Payload::Spare

Pad to even byte.
Definition at line 144 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.58 CFE_EVS_AppNameCmd_Payload Struct Reference

Generic App Name Command Payload.
#include <default_cfe_evs_msgdefs.h>

Data Fields

• char AppName [CFE_MISSION_MAX_API_LEN]

Application name to use in the command.

Generated by Doxygen
472

10.58.1 Detailed Description

Generic App Name Command Payload.

For command details, see CFE_EVS_ENABLE_APP_EVENTS_CC, CFE_EVS_DISABLE_APP_EVENTS_CC,
CFE_EVS_RESET_APP_COUNTER_CC and/or CFE_EVS_RESET_ALL_FILTERS_CC
Definition at line 117 of file default_cfe_evs_msgdefs.h.

10.58.2 Field Documentation

10.58.2.1 AppName char CFE_EVS_AppNameCmd_Payload::AppName[CFE_MISSION_MAX_API_LEN]

Application name to use in the command.
Definition at line 119 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.59 CFE_EVS_AppNameEventIDCmd_Payload Struct Reference

Generic App Name and Event ID Command Payload.
#include <default_cfe_evs_msgdefs.h>

Data Fields

• char AppName [CFE_MISSION_MAX_API_LEN]

Application name to use in the command.
• uint16 EventID
Event ID to use in the command.

10.59.1 Detailed Description

Generic App Name and Event ID Command Payload.

For command details, see CFE_EVS_RESET_FILTER_CC and CFE_EVS_DELETE_EVENT_FILTER_CC
Definition at line 128 of file default_cfe_evs_msgdefs.h.

10.59.2 Field Documentation

10.59.2.1 AppName char CFE_EVS_AppNameEventIDCmd_Payload::AppName[CFE_MISSION_MAX_API_LEN]

Application name to use in the command.
Definition at line 130 of file default_cfe_evs_msgdefs.h.

10.59.2.2 EventID uint16 CFE_EVS_AppNameEventIDCmd_Payload::EventID

Event ID to use in the command.
Definition at line 131 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.60 CFE_EVS_AppNameEventIDMaskCmd_Payload Struct Reference

Generic App Name, Event ID, Mask Command Payload.
#include <default_cfe_evs_msgdefs.h>

Generated by Doxygen
10.61 CFE_EVS_AppTlmData Struct Reference 473

Data Fields

• char AppName [CFE_MISSION_MAX_API_LEN]

Application name to use in the command.
• uint16 EventID
Event ID to use in the command.
• uint16 Mask
Mask to use in the command.

10.60.1 Detailed Description

Generic App Name, Event ID, Mask Command Payload.

For command details, see CFE_EVS_SET_FILTER_CC, CFE_EVS_ADD_EVENT_FILTER_CC and/or CFE_EVS_DELETE_EVENT_FILT
Definition at line 154 of file default_cfe_evs_msgdefs.h.

10.60.2 Field Documentation

10.60.2.1 AppName char CFE_EVS_AppNameEventIDMaskCmd_Payload::AppName[CFE_MISSION_MAX_API_LEN]

Application name to use in the command.
Definition at line 156 of file default_cfe_evs_msgdefs.h.

10.60.2.2 EventID uint16 CFE_EVS_AppNameEventIDMaskCmd_Payload::EventID

Event ID to use in the command.
Definition at line 157 of file default_cfe_evs_msgdefs.h.

10.60.2.3 Mask uint16 CFE_EVS_AppNameEventIDMaskCmd_Payload::Mask

Mask to use in the command.
Definition at line 158 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.61 CFE_EVS_AppTlmData Struct Reference

#include <default_cfe_evs_msgdefs.h>

Data Fields

• CFE_ES_AppId_t AppID
Numerical application identifier.
• uint16 AppMessageSentCounter
Application message sent counter.
• uint8 AppEnableStatus
Application event service enable status.
• uint8 AppMessageSquelchedCounter
Number of events squelched.

Generated by Doxygen
474

10.61.1 Detailed Description

Definition at line 167 of file default_cfe_evs_msgdefs.h.

10.61.2 Field Documentation

10.61.2.1 AppEnableStatus uint8 CFE_EVS_AppTlmData::AppEnableStatus

Application event service enable status.

Telemetry Mnemonic(s) $sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS].APPENASTAT

Definition at line 173 of file default_cfe_evs_msgdefs.h.

10.61.2.2 AppID CFE_ES_AppId_t CFE_EVS_AppTlmData::AppID

Numerical application identifier.

Telemetry Mnemonic(s) $sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS].APPID

Definition at line 169 of file default_cfe_evs_msgdefs.h.

10.61.2.3 AppMessageSentCounter uint16 CFE_EVS_AppTlmData::AppMessageSentCounter

Application message sent counter.

Telemetry Mnemonic(s) $sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS].APPMSGSENTC

Definition at line 171 of file default_cfe_evs_msgdefs.h.

10.61.2.4 AppMessageSquelchedCounter uint8 CFE_EVS_AppTlmData::AppMessageSquelchedCounter

Number of events squelched.

Telemetry Mnemonic(s) $sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS].SQUELCHEDC

Definition at line 175 of file default_cfe_evs_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.62 CFE_EVS_BinFilter Struct Reference

Event message filter definition structure.
#include <cfe_evs_api_typedefs.h>

Data Fields

• uint16 EventID
Numerical event identifier.
• uint16 Mask
Binary filter mask value.

Generated by Doxygen
10.63 CFE_EVS_BitMaskCmd_Payload Struct Reference 475

10.62.1 Detailed Description

Event message filter definition structure.

Definition at line 60 of file cfe_evs_api_typedefs.h.

10.62.2 Field Documentation

10.62.2.1 EventID uint16 CFE_EVS_BinFilter::EventID

Numerical event identifier.
Definition at line 62 of file cfe_evs_api_typedefs.h.

10.62.2.2 Mask uint16 CFE_EVS_BinFilter::Mask

Binary filter mask value.
Definition at line 63 of file cfe_evs_api_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h

10.63 CFE_EVS_BitMaskCmd_Payload Struct Reference

Generic Bitmask Command Payload.
#include <default_cfe_evs_msgdefs.h>

Data Fields

• uint8 BitMask
BitMask to use in the command.
• uint8 Spare
Pad to even byte.

10.63.1 Detailed Description

Generic Bitmask Command Payload.

For command details, see CFE_EVS_ENABLE_EVENT_TYPE_CC, CFE_EVS_DISABLE_EVENT_TYPE_CC,
CFE_EVS_ENABLE_PORTS_CC and/or CFE_EVS_DISABLE_PORTS_CC
Definition at line 104 of file default_cfe_evs_msgdefs.h.

10.63.2 Field Documentation

10.63.2.1 BitMask uint8 CFE_EVS_BitMaskCmd_Payload::BitMask

BitMask to use in the command.
Definition at line 106 of file default_cfe_evs_msgdefs.h.

10.63.2.2 Spare uint8 CFE_EVS_BitMaskCmd_Payload::Spare

Pad to even byte.
Definition at line 107 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

Generated by Doxygen
476

10.64 CFE_EVS_ClearLogCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.64.1 Detailed Description

Definition at line 60 of file default_cfe_evs_msgstruct.h.

10.64.2 Field Documentation

10.64.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_ClearLogCmd::CommandHeader

Command header.
Definition at line 62 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.65 CFE_EVS_DeleteEventFilterCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameEventIDCmd_Payload_t Payload
Command payload.

10.65.1 Detailed Description

Definition at line 175 of file default_cfe_evs_msgstruct.h.

10.65.2 Field Documentation

10.65.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_DeleteEventFilterCmd::CommandHeader

Command header.
Definition at line 177 of file default_cfe_evs_msgstruct.h.

10.65.2.2 Payload CFE_EVS_AppNameEventIDCmd_Payload_t CFE_EVS_DeleteEventFilterCmd::Payload

Command payload.
Definition at line 178 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

Generated by Doxygen
10.66 CFE_EVS_DisableAppEventsCmd Struct Reference 477

10.66 CFE_EVS_DisableAppEventsCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameCmd_Payload_t Payload
Command payload.

10.66.1 Detailed Description

Definition at line 146 of file default_cfe_evs_msgstruct.h.

10.66.2 Field Documentation

10.66.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_DisableAppEventsCmd::CommandHeader

Command header.
Definition at line 148 of file default_cfe_evs_msgstruct.h.

10.66.2.2 Payload CFE_EVS_AppNameCmd_Payload_t CFE_EVS_DisableAppEventsCmd::Payload

Command payload.
Definition at line 149 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.67 CFE_EVS_DisableAppEventTypeCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameBitMaskCmd_Payload_t Payload
Command payload.

10.67.1 Detailed Description

Definition at line 192 of file default_cfe_evs_msgstruct.h.

10.67.2 Field Documentation

10.67.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_DisableAppEventTypeCmd::CommandHeader

Command header.
Definition at line 194 of file default_cfe_evs_msgstruct.h.

Generated by Doxygen
478

10.67.2.2 Payload CFE_EVS_AppNameBitMaskCmd_Payload_t CFE_EVS_DisableAppEventTypeCmd::Payload

Command payload.
Definition at line 195 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.68 CFE_EVS_DisableEventTypeCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_BitMaskCmd_Payload_t Payload
Command payload.

10.68.1 Detailed Description

Definition at line 129 of file default_cfe_evs_msgstruct.h.

10.68.2 Field Documentation

10.68.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_DisableEventTypeCmd::CommandHeader

Command header.
Definition at line 131 of file default_cfe_evs_msgstruct.h.

10.68.2.2 Payload CFE_EVS_BitMaskCmd_Payload_t CFE_EVS_DisableEventTypeCmd::Payload

Command payload.
Definition at line 132 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.69 CFE_EVS_DisablePortsCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_BitMaskCmd_Payload_t Payload
Command payload.

10.69.1 Detailed Description

Definition at line 117 of file default_cfe_evs_msgstruct.h.

Generated by Doxygen
10.70 CFE_EVS_EnableAppEventsCmd Struct Reference 479

10.69.2 Field Documentation

10.69.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_DisablePortsCmd::CommandHeader

Command header.
Definition at line 119 of file default_cfe_evs_msgstruct.h.

10.69.2.2 Payload CFE_EVS_BitMaskCmd_Payload_t CFE_EVS_DisablePortsCmd::Payload

Command payload.
Definition at line 120 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.70 CFE_EVS_EnableAppEventsCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameCmd_Payload_t Payload
Command payload.

10.70.1 Detailed Description

Definition at line 140 of file default_cfe_evs_msgstruct.h.

10.70.2 Field Documentation

10.70.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_EnableAppEventsCmd::CommandHeader

Command header.
Definition at line 142 of file default_cfe_evs_msgstruct.h.

10.70.2.2 Payload CFE_EVS_AppNameCmd_Payload_t CFE_EVS_EnableAppEventsCmd::Payload

Command payload.
Definition at line 143 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.71 CFE_EVS_EnableAppEventTypeCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Generated by Doxygen
480

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameBitMaskCmd_Payload_t Payload
Command payload.

10.71.1 Detailed Description

Definition at line 186 of file default_cfe_evs_msgstruct.h.

10.71.2 Field Documentation

10.71.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_EnableAppEventTypeCmd::CommandHeader

Command header.
Definition at line 188 of file default_cfe_evs_msgstruct.h.

10.71.2.2 Payload CFE_EVS_AppNameBitMaskCmd_Payload_t CFE_EVS_EnableAppEventTypeCmd::Payload

Command payload.
Definition at line 189 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.72 CFE_EVS_EnableEventTypeCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_BitMaskCmd_Payload_t Payload
Command payload.

10.72.1 Detailed Description

Definition at line 123 of file default_cfe_evs_msgstruct.h.

10.72.2 Field Documentation

10.72.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_EnableEventTypeCmd::CommandHeader

Command header.
Definition at line 125 of file default_cfe_evs_msgstruct.h.

Generated by Doxygen
10.73 CFE_EVS_EnablePortsCmd Struct Reference 481

10.72.2.2 Payload CFE_EVS_BitMaskCmd_Payload_t CFE_EVS_EnableEventTypeCmd::Payload

Command payload.
Definition at line 126 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.73 CFE_EVS_EnablePortsCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_BitMaskCmd_Payload_t Payload
Command payload.

10.73.1 Detailed Description

Definition at line 111 of file default_cfe_evs_msgstruct.h.

10.73.2 Field Documentation

10.73.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_EnablePortsCmd::CommandHeader

Command header.
Definition at line 113 of file default_cfe_evs_msgstruct.h.

10.73.2.2 Payload CFE_EVS_BitMaskCmd_Payload_t CFE_EVS_EnablePortsCmd::Payload

Command payload.
Definition at line 114 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.74 CFE_EVS_HousekeepingTlm Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_EVS_HousekeepingTlm_Payload_t Payload
Telemetry payload.

10.74.1 Detailed Description

Definition at line 221 of file default_cfe_evs_msgstruct.h.

Generated by Doxygen
482

10.74.2 Field Documentation

10.74.2.1 Payload CFE_EVS_HousekeepingTlm_Payload_t CFE_EVS_HousekeepingTlm::Payload

Telemetry payload.
Definition at line 224 of file default_cfe_evs_msgstruct.h.

10.74.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_EVS_HousekeepingTlm::TelemetryHeader

Telemetry header.
Definition at line 223 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.75 CFE_EVS_HousekeepingTlm_Payload Struct Reference

#include <default_cfe_evs_msgdefs.h>

Data Fields

• uint8 CommandCounter
EVS Command Counter.
• uint8 CommandErrorCounter
EVS Command Error Counter.
• uint8 MessageFormatMode
Event message format mode (short/long)
• uint8 MessageTruncCounter
Event message truncation counter.
• uint8 UnregisteredAppCounter
Unregistered application message send counter.
• uint8 OutputPort
Output port mask.
• uint8 LogFullFlag
Local event log full flag.
• uint8 LogMode
Local event logging mode (overwrite/discard)
• uint16 MessageSendCounter
Event message send counter.
• uint16 LogOverflowCounter
Local event log overflow counter.
• uint8 LogEnabled
Current event log enable/disable state.
• uint8 Spare1
Padding for 32 bit boundary.
• uint8 Spare2
Padding for 32 bit boundary.
• uint8 Spare3
Padding for 32 bit boundary.
• CFE_EVS_AppTlmData_t AppData [CFE_MISSION_ES_MAX_APPLICATIONS]
Array of registered application table data.

Generated by Doxygen
10.75 CFE_EVS_HousekeepingTlm_Payload Struct Reference 483

10.75.1 Detailed Description

Name Event Services Housekeeping Telemetry Packet

Definition at line 182 of file default_cfe_evs_msgdefs.h.

10.75.2 Field Documentation

10.75.2.1 AppData CFE_EVS_AppTlmData_t CFE_EVS_HousekeepingTlm_Payload::AppData[CFE_MISSION_ES_MAX_APPLICATIONS]

Array of registered application table data.

Telemetry Mnemonic(s) $sc_$cpu_EVS_APP[CFE_PLATFORM_ES_MAX_APPLICATIONS]

Definition at line 216 of file default_cfe_evs_msgdefs.h.

10.75.2.2 CommandCounter uint8 CFE_EVS_HousekeepingTlm_Payload::CommandCounter

EVS Command Counter.

Telemetry Mnemonic(s) $sc_$cpu_EVS_CMDPC

Definition at line 184 of file default_cfe_evs_msgdefs.h.

10.75.2.3 CommandErrorCounter uint8 CFE_EVS_HousekeepingTlm_Payload::CommandErrorCounter

EVS Command Error Counter.

Telemetry Mnemonic(s) $sc_$cpu_EVS_CMDEC

Definition at line 186 of file default_cfe_evs_msgdefs.h.

10.75.2.4 LogEnabled uint8 CFE_EVS_HousekeepingTlm_Payload::LogEnabled

Current event log enable/disable state.

Telemetry Mnemonic(s) $sc_$cpu_EVS_LOGENABLED

Definition at line 207 of file default_cfe_evs_msgdefs.h.

10.75.2.5 LogFullFlag uint8 CFE_EVS_HousekeepingTlm_Payload::LogFullFlag

Local event log full flag.

Telemetry Mnemonic(s) $sc_$cpu_EVS_LOGFULL

Definition at line 197 of file default_cfe_evs_msgdefs.h.

10.75.2.6 LogMode uint8 CFE_EVS_HousekeepingTlm_Payload::LogMode

Local event logging mode (overwrite/discard)

Telemetry Mnemonic(s) $sc_$cpu_EVS_LOGMODE

Definition at line 199 of file default_cfe_evs_msgdefs.h.

Generated by Doxygen
484

10.75.2.7 LogOverflowCounter uint16 CFE_EVS_HousekeepingTlm_Payload::LogOverflowCounter

Local event log overflow counter.

Telemetry Mnemonic(s) $sc_$cpu_EVS_LOGOVERFLOWC

Definition at line 204 of file default_cfe_evs_msgdefs.h.

10.75.2.8 MessageFormatMode uint8 CFE_EVS_HousekeepingTlm_Payload::MessageFormatMode

Event message format mode (short/long)

Telemetry Mnemonic(s) $sc_$cpu_EVS_MSGFMTMODE

Definition at line 188 of file default_cfe_evs_msgdefs.h.

10.75.2.9 MessageSendCounter uint16 CFE_EVS_HousekeepingTlm_Payload::MessageSendCounter

Event message send counter.

Telemetry Mnemonic(s) $sc_$cpu_EVS_MSGSENTC

Definition at line 202 of file default_cfe_evs_msgdefs.h.

10.75.2.10 MessageTruncCounter uint8 CFE_EVS_HousekeepingTlm_Payload::MessageTruncCounter

Event message truncation counter.

Telemetry Mnemonic(s) $sc_$cpu_EVS_MSGTRUNC

Definition at line 190 of file default_cfe_evs_msgdefs.h.

10.75.2.11 OutputPort uint8 CFE_EVS_HousekeepingTlm_Payload::OutputPort

Output port mask.

Telemetry Mnemonic(s) $sc_$cpu_EVS_OUTPUTPORT

Definition at line 195 of file default_cfe_evs_msgdefs.h.

10.75.2.12 Spare1 uint8 CFE_EVS_HousekeepingTlm_Payload::Spare1

Padding for 32 bit boundary.

Telemetry Mnemonic(s) $sc_$cpu_EVS_HK_SPARE1

Definition at line 209 of file default_cfe_evs_msgdefs.h.

10.75.2.13 Spare2 uint8 CFE_EVS_HousekeepingTlm_Payload::Spare2

Padding for 32 bit boundary.

Telemetry Mnemonic(s) $sc_$cpu_EVS_HK_SPARE2

Definition at line 211 of file default_cfe_evs_msgdefs.h.

Generated by Doxygen
10.76 CFE_EVS_LogFileCmd_Payload Struct Reference 485

10.75.2.14 Spare3 uint8 CFE_EVS_HousekeepingTlm_Payload::Spare3

Padding for 32 bit boundary.

Telemetry Mnemonic(s) $sc_$cpu_EVS_HK_SPARE3

Definition at line 213 of file default_cfe_evs_msgdefs.h.

10.75.2.15 UnregisteredAppCounter uint8 CFE_EVS_HousekeepingTlm_Payload::UnregisteredAppCounter

Unregistered application message send counter.

Telemetry Mnemonic(s) $sc_$cpu_EVS_UNREGAPPC

Definition at line 193 of file default_cfe_evs_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.76 CFE_EVS_LogFileCmd_Payload Struct Reference

Write Event Log to File Command Payload.
#include <default_cfe_evs_msgdefs.h>

Data Fields

• char LogFilename [CFE_MISSION_MAX_PATH_LEN]

Filename where log data is to be written.

10.76.1 Detailed Description

Write Event Log to File Command Payload.

For command details, see CFE_EVS_WRITE_LOG_DATA_FILE_CC
Definition at line 57 of file default_cfe_evs_msgdefs.h.

10.76.2 Field Documentation

10.76.2.1 LogFilename char CFE_EVS_LogFileCmd_Payload::LogFilename[CFE_MISSION_MAX_PATH_LEN]

Filename where log data is to be written.
Definition at line 59 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.77 CFE_EVS_LongEventTlm Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_EVS_LongEventTlm_Payload_t Payload
Telemetry payload.

Generated by Doxygen
486

10.77.1 Detailed Description

Definition at line 227 of file default_cfe_evs_msgstruct.h.

10.77.2 Field Documentation

10.77.2.1 Payload CFE_EVS_LongEventTlm_Payload_t CFE_EVS_LongEventTlm::Payload

Telemetry payload.
Definition at line 230 of file default_cfe_evs_msgstruct.h.

10.77.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_EVS_LongEventTlm::TelemetryHeader

Telemetry header.
Definition at line 229 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.78 CFE_EVS_LongEventTlm_Payload Struct Reference

#include <default_cfe_evs_msgdefs.h>

Data Fields

• CFE_EVS_PacketID_t PacketID
Event packet information.
• char Message [CFE_MISSION_EVS_MAX_MESSAGE_LENGTH]
Event message string.
• uint8 Spare1
Structure padding.
• uint8 Spare2
Structure padding.

10.78.1 Detailed Description

Name Event Message Telemetry Packet (Long format)

Definition at line 239 of file default_cfe_evs_msgdefs.h.

10.78.2 Field Documentation

10.78.2.1 Message char CFE_EVS_LongEventTlm_Payload::Message[CFE_MISSION_EVS_MAX_MESSAGE_LENGTH]

Event message string.

Telemetry Mnemonic(s) $sc_$cpu_EVS_EVENT[CFE_MISSION_EVS_MAX_MESSAGE_LENGTH]

Definition at line 242 of file default_cfe_evs_msgdefs.h.

Generated by Doxygen
10.79 CFE_EVS_NoopCmd Struct Reference 487

10.78.2.2 PacketID CFE_EVS_PacketID_t CFE_EVS_LongEventTlm_Payload::PacketID

Event packet information.
Definition at line 241 of file default_cfe_evs_msgdefs.h.

10.78.2.3 Spare1 uint8 CFE_EVS_LongEventTlm_Payload::Spare1

Structure padding.

Telemetry Mnemonic(s) $sc_$cpu_EVS_SPARE1

Definition at line 244 of file default_cfe_evs_msgdefs.h.

10.78.2.4 Spare2 uint8 CFE_EVS_LongEventTlm_Payload::Spare2

Structure padding.

Telemetry Mnemonic(s) $sc_$cpu_EVS_SPARE2

Definition at line 246 of file default_cfe_evs_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.79 CFE_EVS_NoopCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.79.1 Detailed Description

Definition at line 50 of file default_cfe_evs_msgstruct.h.

10.79.2 Field Documentation

10.79.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_NoopCmd::CommandHeader

Command header.
Definition at line 54 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.80 CFE_EVS_PacketID Struct Reference

#include <default_cfe_evs_msgdefs.h>

Generated by Doxygen
488

Data Fields

• char AppName [CFE_MISSION_MAX_API_LEN]

Application name.
• uint16 EventID
Numerical event identifier.
• uint16 EventType
Numerical event type identifier.
• uint32 SpacecraftID
Spacecraft identifier.
• uint32 ProcessorID
Numerical processor identifier.

10.80.1 Detailed Description

Telemetry packet structures

Definition at line 222 of file default_cfe_evs_msgdefs.h.

10.80.2 Field Documentation

10.80.2.1 AppName char CFE_EVS_PacketID::AppName[CFE_MISSION_MAX_API_LEN]

Application name.

Telemetry Mnemonic(s) $sc_$cpu_EVS_APPNAME[OS_MAX_API_NAME]

Definition at line 224 of file default_cfe_evs_msgdefs.h.

10.80.2.2 EventID uint16 CFE_EVS_PacketID::EventID

Numerical event identifier.

Telemetry Mnemonic(s) $sc_$cpu_EVS_EVENTID

Definition at line 226 of file default_cfe_evs_msgdefs.h.

10.80.2.3 EventType uint16 CFE_EVS_PacketID::EventType

Numerical event type identifier.

Telemetry Mnemonic(s) $sc_$cpu_EVS_EVENTTYPE

Definition at line 228 of file default_cfe_evs_msgdefs.h.

10.80.2.4 ProcessorID uint32 CFE_EVS_PacketID::ProcessorID

Numerical processor identifier.

Telemetry Mnemonic(s) $sc_$cpu_EVS_PROCESSORID

Definition at line 232 of file default_cfe_evs_msgdefs.h.

Generated by Doxygen
10.81 CFE_EVS_ResetAllFiltersCmd Struct Reference 489

10.80.2.5 SpacecraftID uint32 CFE_EVS_PacketID::SpacecraftID

Spacecraft identifier.

Telemetry Mnemonic(s) $sc_$cpu_EVS_SCID

Definition at line 230 of file default_cfe_evs_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.81 CFE_EVS_ResetAllFiltersCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameCmd_Payload_t Payload
Command payload.

10.81.1 Detailed Description

Definition at line 158 of file default_cfe_evs_msgstruct.h.

10.81.2 Field Documentation

10.81.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_ResetAllFiltersCmd::CommandHeader

Command header.
Definition at line 160 of file default_cfe_evs_msgstruct.h.

10.81.2.2 Payload CFE_EVS_AppNameCmd_Payload_t CFE_EVS_ResetAllFiltersCmd::Payload

Command payload.
Definition at line 161 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.82 CFE_EVS_ResetAppCounterCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameCmd_Payload_t Payload
Command payload.

10.82.1 Detailed Description

Definition at line 152 of file default_cfe_evs_msgstruct.h.

Generated by Doxygen
490

10.82.2 Field Documentation

10.82.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_ResetAppCounterCmd::CommandHeader

Command header.
Definition at line 154 of file default_cfe_evs_msgstruct.h.

10.82.2.2 Payload CFE_EVS_AppNameCmd_Payload_t CFE_EVS_ResetAppCounterCmd::Payload

Command payload.
Definition at line 155 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.83 CFE_EVS_ResetCountersCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.83.1 Detailed Description

Definition at line 55 of file default_cfe_evs_msgstruct.h.

10.83.2 Field Documentation

10.83.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_ResetCountersCmd::CommandHeader

Command header.
Definition at line 57 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.84 CFE_EVS_ResetFilterCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameEventIDCmd_Payload_t Payload
Command payload.

10.84.1 Detailed Description

Definition at line 169 of file default_cfe_evs_msgstruct.h.

Generated by Doxygen
10.85 CFE_EVS_SendHkCmd Struct Reference 491

10.84.2 Field Documentation

10.84.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_ResetFilterCmd::CommandHeader

Command header.
Definition at line 171 of file default_cfe_evs_msgstruct.h.

10.84.2.2 Payload CFE_EVS_AppNameEventIDCmd_Payload_t CFE_EVS_ResetFilterCmd::Payload

Command payload.
Definition at line 172 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.85 CFE_EVS_SendHkCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.85.1 Detailed Description

Definition at line 65 of file default_cfe_evs_msgstruct.h.

10.85.2 Field Documentation

10.85.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_SendHkCmd::CommandHeader

Command header.
Definition at line 67 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.86 CFE_EVS_SetEventFormatCode_Payload Struct Reference

Set Event Format Mode Command Payload.
#include <default_cfe_evs_msgdefs.h>

Data Fields

• CFE_EVS_MsgFormat_Enum_t MsgFormat
Mode to use in the command.
• uint8 Spare
Pad to even byte.

Generated by Doxygen
492

10.86.1 Detailed Description

Set Event Format Mode Command Payload.

For command details, see CFE_EVS_SET_EVENT_FORMAT_MODE_CC
Definition at line 91 of file default_cfe_evs_msgdefs.h.

10.86.2 Field Documentation

10.86.2.1 MsgFormat CFE_EVS_MsgFormat_Enum_t CFE_EVS_SetEventFormatCode_Payload::MsgFormat

Mode to use in the command.
Definition at line 93 of file default_cfe_evs_msgdefs.h.

10.86.2.2 Spare uint8 CFE_EVS_SetEventFormatCode_Payload::Spare

Pad to even byte.
Definition at line 94 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.87 CFE_EVS_SetEventFormatModeCmd Struct Reference

Set Event Format Mode Command.
#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_SetEventFormatMode_Payload_t Payload
Command payload.

10.87.1 Detailed Description

Set Event Format Mode Command.

Definition at line 100 of file default_cfe_evs_msgstruct.h.

10.87.2 Field Documentation

10.87.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_SetEventFormatModeCmd::CommandHeader

Command header.
Definition at line 102 of file default_cfe_evs_msgstruct.h.

10.87.2.2 Payload CFE_EVS_SetEventFormatMode_Payload_t CFE_EVS_SetEventFormatModeCmd::Payload

Command payload.
Definition at line 103 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

Generated by Doxygen
10.88 CFE_EVS_SetFilterCmd Struct Reference 493

10.88 CFE_EVS_SetFilterCmd Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppNameEventIDMaskCmd_Payload_t Payload
Command payload.

10.88.1 Detailed Description

Definition at line 209 of file default_cfe_evs_msgstruct.h.

10.88.2 Field Documentation

10.88.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_SetFilterCmd::CommandHeader

Command header.
Definition at line 211 of file default_cfe_evs_msgstruct.h.

10.88.2.2 Payload CFE_EVS_AppNameEventIDMaskCmd_Payload_t CFE_EVS_SetFilterCmd::Payload

Command payload.
Definition at line 212 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.89 CFE_EVS_SetLogMode_Payload Struct Reference

Set Log Mode Command Payload.
#include <default_cfe_evs_msgdefs.h>

Data Fields

• CFE_EVS_LogMode_Enum_t LogMode
Mode to use in the command.
• uint8 Spare
Pad to even byte.

10.89.1 Detailed Description

Set Log Mode Command Payload.

For command details, see CFE_EVS_SET_LOG_MODE_CC
Definition at line 79 of file default_cfe_evs_msgdefs.h.

10.89.2 Field Documentation

Generated by Doxygen
494

10.89.2.1 LogMode CFE_EVS_LogMode_Enum_t CFE_EVS_SetLogMode_Payload::LogMode

Mode to use in the command.
Definition at line 81 of file default_cfe_evs_msgdefs.h.

10.89.2.2 Spare uint8 CFE_EVS_SetLogMode_Payload::Spare

Pad to even byte.
Definition at line 82 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.90 CFE_EVS_SetLogModeCmd Struct Reference

Set Log Mode Command.
#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_SetLogMode_Payload_t Payload
Command payload.

10.90.1 Detailed Description

Set Log Mode Command.

Definition at line 91 of file default_cfe_evs_msgstruct.h.

10.90.2 Field Documentation

10.90.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_SetLogModeCmd::CommandHeader

Command header.
Definition at line 93 of file default_cfe_evs_msgstruct.h.

10.90.2.2 Payload CFE_EVS_SetLogMode_Payload_t CFE_EVS_SetLogModeCmd::Payload

Command payload.
Definition at line 94 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.91 CFE_EVS_ShortEventTlm Struct Reference

#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_EVS_ShortEventTlm_Payload_t Payload
Telemetry payload.

Generated by Doxygen
10.92 CFE_EVS_ShortEventTlm_Payload Struct Reference 495

10.91.1 Detailed Description

Definition at line 233 of file default_cfe_evs_msgstruct.h.

10.91.2 Field Documentation

10.91.2.1 Payload CFE_EVS_ShortEventTlm_Payload_t CFE_EVS_ShortEventTlm::Payload

Telemetry payload.
Definition at line 236 of file default_cfe_evs_msgstruct.h.

10.91.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_EVS_ShortEventTlm::TelemetryHeader

Telemetry header.
Definition at line 235 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.92 CFE_EVS_ShortEventTlm_Payload Struct Reference

#include <default_cfe_evs_msgdefs.h>

Data Fields

• CFE_EVS_PacketID_t PacketID
Event packet information.

10.92.1 Detailed Description

Name Event Message Telemetry Packet (Short format)

Definition at line 253 of file default_cfe_evs_msgdefs.h.

10.92.2 Field Documentation

10.92.2.1 PacketID CFE_EVS_PacketID_t CFE_EVS_ShortEventTlm_Payload::PacketID

Event packet information.
Definition at line 255 of file default_cfe_evs_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgdefs.h

10.93 CFE_EVS_WriteAppDataFileCmd Struct Reference

Write Event Services Application Information to File Command.
#include <default_cfe_evs_msgstruct.h>

Generated by Doxygen
496

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_AppDataCmd_Payload_t Payload
Command payload.

10.93.1 Detailed Description

Write Event Services Application Information to File Command.

Definition at line 82 of file default_cfe_evs_msgstruct.h.

10.93.2 Field Documentation

10.93.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_WriteAppDataFileCmd::CommandHeader

Command header.
Definition at line 84 of file default_cfe_evs_msgstruct.h.

10.93.2.2 Payload CFE_EVS_AppDataCmd_Payload_t CFE_EVS_WriteAppDataFileCmd::Payload

Command payload.
Definition at line 85 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.94 CFE_EVS_WriteLogDataFileCmd Struct Reference

Write Event Log to File Command.
#include <default_cfe_evs_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_EVS_LogFileCmd_Payload_t Payload
Command payload.

10.94.1 Detailed Description

Write Event Log to File Command.

Definition at line 73 of file default_cfe_evs_msgstruct.h.

10.94.2 Field Documentation

10.94.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_EVS_WriteLogDataFileCmd::CommandHeader

Command header.
Definition at line 75 of file default_cfe_evs_msgstruct.h.

Generated by Doxygen
10.95 CFE_FS_FileWriteMetaData Struct Reference 497

10.94.2.2 Payload CFE_EVS_LogFileCmd_Payload_t CFE_EVS_WriteLogDataFileCmd::Payload

Command payload.
Definition at line 76 of file default_cfe_evs_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/evs/config/default_cfe_evs_msgstruct.h

10.95 CFE_FS_FileWriteMetaData Struct Reference

External Metadata/State object associated with background file writes.
#include <cfe_fs_api_typedefs.h>

Data Fields

• volatile bool IsPending

• char FileName [CFE_MISSION_MAX_PATH_LEN]
• uint32 FileSubType
• char Description [CFE_FS_HDR_DESC_MAX_LEN]
• CFE_FS_FileWriteGetData_t GetData
• CFE_FS_FileWriteOnEvent_t OnEvent

10.95.1 Detailed Description

External Metadata/State object associated with background file writes.

Applications intending to schedule background file write jobs should instantiate this object in static/global data memory.
This keeps track of the state of the file write request(s).
Definition at line 124 of file cfe_fs_api_typedefs.h.

10.95.2 Field Documentation

10.95.2.1 Description char CFE_FS_FileWriteMetaData::Description[CFE_FS_HDR_DESC_MAX_LEN]

Description of file (for FS header)
Definition at line 132 of file cfe_fs_api_typedefs.h.

10.95.2.2 FileName char CFE_FS_FileWriteMetaData::FileName[CFE_MISSION_MAX_PATH_LEN]

Name of file to write
Definition at line 128 of file cfe_fs_api_typedefs.h.

10.95.2.3 FileSubType uint32 CFE_FS_FileWriteMetaData::FileSubType

Type of file to write (for FS header)
Definition at line 131 of file cfe_fs_api_typedefs.h.

10.95.2.4 GetData CFE_FS_FileWriteGetData_t CFE_FS_FileWriteMetaData::GetData

Application callback to get a data record
Definition at line 134 of file cfe_fs_api_typedefs.h.

Generated by Doxygen
498

10.95.2.5 IsPending volatile bool CFE_FS_FileWriteMetaData::IsPending

Whether request is pending (volatile as it may be checked outside lock)
Definition at line 126 of file cfe_fs_api_typedefs.h.

10.95.2.6 OnEvent CFE_FS_FileWriteOnEvent_t CFE_FS_FileWriteMetaData::OnEvent

Application callback for abstract event processing
Definition at line 135 of file cfe_fs_api_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h

10.96 CFE_FS_Header Struct Reference

Standard cFE File header structure definition.
#include <default_cfe_fs_filedef.h>

Data Fields

• uint32 ContentType
Identifies the content type (='cFE1'=0x63464531)
• uint32 SubType
Type of ContentType, if necessary.
• uint32 Length
Length of this header to support external processing.
• uint32 SpacecraftID
Spacecraft that generated the file.
• uint32 ProcessorID
Processor that generated the file.
• uint32 ApplicationID
Application that generated the file.
• uint32 TimeSeconds
File creation timestamp (seconds)
• uint32 TimeSubSeconds
File creation timestamp (sub-seconds)
• char Description [CFE_FS_HDR_DESC_MAX_LEN]
File description.

10.96.1 Detailed Description

Standard cFE File header structure definition.

Definition at line 181 of file default_cfe_fs_filedef.h.

10.96.2 Field Documentation

10.96.2.1 ApplicationID uint32 CFE_FS_Header::ApplicationID

Application that generated the file.
Definition at line 190 of file default_cfe_fs_filedef.h.

Generated by Doxygen
10.97 CFE_SB_AllSubscriptionsTlm Struct Reference 499

10.96.2.2 ContentType uint32 CFE_FS_Header::ContentType

Identifies the content type (='cFE1'=0x63464531)
Definition at line 183 of file default_cfe_fs_filedef.h.

10.96.2.3 Description char CFE_FS_Header::Description[CFE_FS_HDR_DESC_MAX_LEN]

File description.
Definition at line 195 of file default_cfe_fs_filedef.h.

10.96.2.4 Length uint32 CFE_FS_Header::Length

Length of this header to support external processing.
Definition at line 187 of file default_cfe_fs_filedef.h.

10.96.2.5 ProcessorID uint32 CFE_FS_Header::ProcessorID

Processor that generated the file.
Definition at line 189 of file default_cfe_fs_filedef.h.

10.96.2.6 SpacecraftID uint32 CFE_FS_Header::SpacecraftID

Spacecraft that generated the file.
Definition at line 188 of file default_cfe_fs_filedef.h.

10.96.2.7 SubType uint32 CFE_FS_Header::SubType

Type of ContentType, if necessary.
Standard SubType definitions can be found here
Definition at line 184 of file default_cfe_fs_filedef.h.

10.96.2.8 TimeSeconds uint32 CFE_FS_Header::TimeSeconds

File creation timestamp (seconds)
Definition at line 192 of file default_cfe_fs_filedef.h.

10.96.2.9 TimeSubSeconds uint32 CFE_FS_Header::TimeSubSeconds

File creation timestamp (sub-seconds)
Definition at line 193 of file default_cfe_fs_filedef.h.
The documentation for this struct was generated from the following file:

• cfe/modules/fs/config/default_cfe_fs_filedef.h

10.97 CFE_SB_AllSubscriptionsTlm Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_SB_AllSubscriptionsTlm_Payload_t Payload
Telemetry payload.

Generated by Doxygen
500

10.97.1 Detailed Description

Definition at line 145 of file default_cfe_sb_msgstruct.h.

10.97.2 Field Documentation

10.97.2.1 Payload CFE_SB_AllSubscriptionsTlm_Payload_t CFE_SB_AllSubscriptionsTlm::Payload

Telemetry payload.
Definition at line 148 of file default_cfe_sb_msgstruct.h.

10.97.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_SB_AllSubscriptionsTlm::TelemetryHeader

Telemetry header.
Definition at line 147 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.98 CFE_SB_AllSubscriptionsTlm_Payload Struct Reference

#include <default_cfe_sb_msgdefs.h>

Data Fields

• uint32 PktSegment
Pkt number(starts at 1) in the series.
• uint32 TotalSegments
Total number of pkts needed to complete the request.
• uint32 Entries
Number of entries in the pkt.
• CFE_SB_SubEntries_t Entry [CFE_SB_SUB_ENTRIES_PER_PKT]
Array of CFE_SB_SubEntries_t entries.

10.98.1 Detailed Description

Name SB Previous Subscriptions Packet

This structure defines the pkt(s) sent by SB that contains a list of all current subscriptions. This pkt is generated on
cmd and intended to be used primarily by the Software Bus Networking Application (SBN). Typically, when the cmd is
received there are more subscriptions than can fit in one pkt. The complete list of subscriptions is sent via a series of
segmented pkts.
Definition at line 274 of file default_cfe_sb_msgdefs.h.

10.98.2 Field Documentation

10.98.2.1 Entries uint32 CFE_SB_AllSubscriptionsTlm_Payload::Entries

Number of entries in the pkt.
Definition at line 278 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
10.99 CFE_SB_DisableRouteCmd Struct Reference 501

10.98.2.2 Entry CFE_SB_SubEntries_t CFE_SB_AllSubscriptionsTlm_Payload::Entry[CFE_SB_SUB_ENTRIES_PER_PKT]

Array of CFE_SB_SubEntries_t entries.
Definition at line 279 of file default_cfe_sb_msgdefs.h.

10.98.2.3 PktSegment uint32 CFE_SB_AllSubscriptionsTlm_Payload::PktSegment

Pkt number(starts at 1) in the series.
Definition at line 276 of file default_cfe_sb_msgdefs.h.

10.98.2.4 TotalSegments uint32 CFE_SB_AllSubscriptionsTlm_Payload::TotalSegments

Total number of pkts needed to complete the request.
Definition at line 277 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.99 CFE_SB_DisableRouteCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_SB_RouteCmd_Payload_t Payload
Command payload.

10.99.1 Detailed Description

Definition at line 117 of file default_cfe_sb_msgstruct.h.

10.99.2 Field Documentation

10.99.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_DisableRouteCmd::CommandHeader

Command header.
Definition at line 119 of file default_cfe_sb_msgstruct.h.

10.99.2.2 Payload CFE_SB_RouteCmd_Payload_t CFE_SB_DisableRouteCmd::Payload

Command payload.
Definition at line 120 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.100 CFE_SB_DisableSubReportingCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader

Generated by Doxygen
502

10.100.1 Detailed Description

Definition at line 67 of file default_cfe_sb_msgstruct.h.

10.100.2 Field Documentation

10.100.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_DisableSubReportingCmd::CommandHeader

Definition at line 69 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.101 CFE_SB_EnableRouteCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_SB_RouteCmd_Payload_t Payload
Command payload.

10.101.1 Detailed Description

Definition at line 111 of file default_cfe_sb_msgstruct.h.

10.101.2 Field Documentation

10.101.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_EnableRouteCmd::CommandHeader

Command header.
Definition at line 113 of file default_cfe_sb_msgstruct.h.

10.101.2.2 Payload CFE_SB_RouteCmd_Payload_t CFE_SB_EnableRouteCmd::Payload

Command payload.
Definition at line 114 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.102 CFE_SB_EnableSubReportingCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader

Generated by Doxygen
10.103 CFE_SB_HousekeepingTlm Struct Reference 503

10.102.1 Detailed Description

Definition at line 62 of file default_cfe_sb_msgstruct.h.

10.102.2 Field Documentation

10.102.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_EnableSubReportingCmd::CommandHeader

Definition at line 64 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.103 CFE_SB_HousekeepingTlm Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_SB_HousekeepingTlm_Payload_t Payload
Telemetry payload.

10.103.1 Detailed Description

Definition at line 127 of file default_cfe_sb_msgstruct.h.

10.103.2 Field Documentation

10.103.2.1 Payload CFE_SB_HousekeepingTlm_Payload_t CFE_SB_HousekeepingTlm::Payload

Telemetry payload.
Definition at line 132 of file default_cfe_sb_msgstruct.h.

10.103.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_SB_HousekeepingTlm::TelemetryHeader

Telemetry header.
Definition at line 131 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.104 CFE_SB_HousekeepingTlm_Payload Struct Reference

#include <default_cfe_sb_msgdefs.h>

Data Fields

• uint8 CommandCounter
Count of valid commands received.
• uint8 CommandErrorCounter

Generated by Doxygen
504

Count of invalid commands received.

• uint8 NoSubscribersCounter
Count pkts sent with no subscribers.
• uint8 MsgSendErrorCounter
Count of message send errors.
• uint8 MsgReceiveErrorCounter
Count of message receive errors.
• uint8 InternalErrorCounter
Count of queue read or write errors.
• uint8 CreatePipeErrorCounter
Count of errors in create pipe API.
• uint8 SubscribeErrorCounter
Count of errors in subscribe API.
• uint8 PipeOptsErrorCounter
Count of errors in set/get pipe options API.
• uint8 DuplicateSubscriptionsCounter
Count of duplicate subscriptions.
• uint8 GetPipeIdByNameErrorCounter
Count of errors in get pipe id by name API.
• uint8 Spare2Align [1]
Spare bytes to ensure alignment.
• uint16 PipeOverflowErrorCounter
Count of pipe overflow errors.
• uint16 MsgLimitErrorCounter
Count of msg id to pipe errors.
• CFE_ES_MemHandle_t MemPoolHandle
Handle to SB's Memory Pool.
• uint32 MemInUse
Memory in use.
• uint32 UnmarkedMem
cfg param CFE_PLATFORM_SB_BUF_MEMORY_BYTES minus Peak Memory in use

10.104.1 Detailed Description

Name Software Bus task housekeeping Packet

Definition at line 67 of file default_cfe_sb_msgdefs.h.

10.104.2 Field Documentation

10.104.2.1 CommandCounter uint8 CFE_SB_HousekeepingTlm_Payload::CommandCounter

Count of valid commands received.

Telemetry Mnemonic(s) $sc_$cpu_SB_CMDPC

Definition at line 71 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
10.104 CFE_SB_HousekeepingTlm_Payload Struct Reference 505

10.104.2.2 CommandErrorCounter uint8 CFE_SB_HousekeepingTlm_Payload::CommandErrorCounter

Count of invalid commands received.

Telemetry Mnemonic(s) $sc_$cpu_SB_CMDEC

Definition at line 73 of file default_cfe_sb_msgdefs.h.

10.104.2.3 CreatePipeErrorCounter uint8 CFE_SB_HousekeepingTlm_Payload::CreatePipeErrorCounter

Count of errors in create pipe API.

Telemetry Mnemonic(s) $sc_$cpu_SB_NewPipeEC

Definition at line 84 of file default_cfe_sb_msgdefs.h.

10.104.2.4 DuplicateSubscriptionsCounter uint8 CFE_SB_HousekeepingTlm_Payload::DuplicateSubscriptions←-

Counter
Count of duplicate subscriptions.

Telemetry Mnemonic(s) $sc_$cpu_SB_DupSubCnt

Definition at line 90 of file default_cfe_sb_msgdefs.h.

10.104.2.5 GetPipeIdByNameErrorCounter uint8 CFE_SB_HousekeepingTlm_Payload::GetPipeIdByName←-

ErrorCounter
Count of errors in get pipe id by name API.

Telemetry Mnemonic(s) $sc_$cpu_SB_GetPipeIDByNameEC

Definition at line 92 of file default_cfe_sb_msgdefs.h.

10.104.2.6 InternalErrorCounter uint8 CFE_SB_HousekeepingTlm_Payload::InternalErrorCounter

Count of queue read or write errors.

Telemetry Mnemonic(s) $sc_$cpu_SB_InternalEC

Definition at line 82 of file default_cfe_sb_msgdefs.h.

10.104.2.7 MemInUse uint32 CFE_SB_HousekeepingTlm_Payload::MemInUse

Memory in use.

Telemetry Mnemonic(s) $sc_$cpu_SB_MemInUse

Definition at line 105 of file default_cfe_sb_msgdefs.h.

10.104.2.8 MemPoolHandle CFE_ES_MemHandle_t CFE_SB_HousekeepingTlm_Payload::MemPoolHandle

Handle to SB's Memory Pool.

Telemetry Mnemonic(s) $sc_$cpu_SB_MemPoolHdl

Definition at line 102 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
506

10.104.2.9 MsgLimitErrorCounter uint16 CFE_SB_HousekeepingTlm_Payload::MsgLimitErrorCounter

Count of msg id to pipe errors.

Telemetry Mnemonic(s) $sc_$cpu_SB_MsgLimEC

Definition at line 99 of file default_cfe_sb_msgdefs.h.

10.104.2.10 MsgReceiveErrorCounter uint8 CFE_SB_HousekeepingTlm_Payload::MsgReceiveErrorCounter

Count of message receive errors.

Telemetry Mnemonic(s) $sc_$cpu_SB_MsgRecEC

Definition at line 80 of file default_cfe_sb_msgdefs.h.

10.104.2.11 MsgSendErrorCounter uint8 CFE_SB_HousekeepingTlm_Payload::MsgSendErrorCounter

Count of message send errors.

Telemetry Mnemonic(s) $sc_$cpu_SB_MsgSndEC

Definition at line 77 of file default_cfe_sb_msgdefs.h.

10.104.2.12 NoSubscribersCounter uint8 CFE_SB_HousekeepingTlm_Payload::NoSubscribersCounter

Count pkts sent with no subscribers.

Telemetry Mnemonic(s) $sc_$cpu_SB_NoSubEC

Definition at line 75 of file default_cfe_sb_msgdefs.h.

10.104.2.13 PipeOptsErrorCounter uint8 CFE_SB_HousekeepingTlm_Payload::PipeOptsErrorCounter

Count of errors in set/get pipe options API.

Telemetry Mnemonic(s) $sc_$cpu_SB_PipeOptsEC

Definition at line 88 of file default_cfe_sb_msgdefs.h.

10.104.2.14 PipeOverflowErrorCounter uint16 CFE_SB_HousekeepingTlm_Payload::PipeOverflowError←-

Counter
Count of pipe overflow errors.

Telemetry Mnemonic(s) $sc_$cpu_SB_PipeOvrEC

Definition at line 97 of file default_cfe_sb_msgdefs.h.

10.104.2.15 Spare2Align uint8 CFE_SB_HousekeepingTlm_Payload::Spare2Align[1]

Spare bytes to ensure alignment.

Telemetry Mnemonic(s) $sc_$cpu_SB_Spare2Align[2]

Definition at line 94 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
10.105 CFE_SB_Msg Union Reference 507

10.104.2.16 SubscribeErrorCounter uint8 CFE_SB_HousekeepingTlm_Payload::SubscribeErrorCounter

Count of errors in subscribe API.
Telemetry Mnemonic(s) $sc_$cpu_SB_SubscrEC
Definition at line 86 of file default_cfe_sb_msgdefs.h.

10.104.2.17 UnmarkedMem uint32 CFE_SB_HousekeepingTlm_Payload::UnmarkedMem

cfg param CFE_PLATFORM_SB_BUF_MEMORY_BYTES minus Peak Memory in use
Telemetry Mnemonic(s) $sc_$cpu_SB_UnMarkedMem
Definition at line 108 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.105 CFE_SB_Msg Union Reference

Software Bus generic message.
#include <cfe_sb_api_typedefs.h>

Data Fields

• CFE_MSG_Message_t Msg
Base message type without enforced alignment.
• long long int LongInt
Align to support Long Integer.
• long double LongDouble
Align to support Long Double.

10.105.1 Detailed Description

Software Bus generic message.

Definition at line 142 of file cfe_sb_api_typedefs.h.

10.105.2 Field Documentation

10.105.2.1 LongDouble long double CFE_SB_Msg::LongDouble

Align to support Long Double.
Definition at line 146 of file cfe_sb_api_typedefs.h.

10.105.2.2 LongInt long long int CFE_SB_Msg::LongInt

Align to support Long Integer.
Definition at line 145 of file cfe_sb_api_typedefs.h.

10.105.2.3 Msg CFE_MSG_Message_t CFE_SB_Msg::Msg

Base message type without enforced alignment.
Definition at line 144 of file cfe_sb_api_typedefs.h.
The documentation for this union was generated from the following file:
• cfe/modules/core_api/fsw/inc/cfe_sb_api_typedefs.h

Generated by Doxygen
508

10.106 CFE_SB_MsgId_t Struct Reference

CFE_SB_MsgId_t type definition.
#include <default_cfe_sb_extern_typedefs.h>

Data Fields

• CFE_SB_MsgId_Atom_t Value

10.106.1 Detailed Description

CFE_SB_MsgId_t type definition.

Software Bus message identifier used in many SB APIs
Currently this is directly mapped to the underlying holding type (not wrapped) for compatibility with existing usage
semantics in apps (mainly switch/case statements)

Note

In a future version it could become a type-safe wrapper similar to the route index, to avoid message IDs getting
mixed between other integer values.

Definition at line 104 of file default_cfe_sb_extern_typedefs.h.

10.106.2 Field Documentation

10.106.2.1 Value CFE_SB_MsgId_Atom_t CFE_SB_MsgId_t::Value

Definition at line 106 of file default_cfe_sb_extern_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_extern_typedefs.h

10.107 CFE_SB_MsgMapFileEntry Struct Reference

SB Map File Entry.
#include <default_cfe_sb_msgdefs.h>

Data Fields

• CFE_SB_MsgId_t MsgId
Message Id which has been subscribed to.
• CFE_SB_RouteId_Atom_t Index
Routing raw index value (0 based, not Route ID)

10.107.1 Detailed Description

SB Map File Entry.

Structure of one element of the map information in response to CFE_SB_WRITE_MAP_INFO_CC
Definition at line 226 of file default_cfe_sb_msgdefs.h.

10.107.2 Field Documentation

Generated by Doxygen
10.108 CFE_SB_NoopCmd Struct Reference 509

10.107.2.1 Index CFE_SB_RouteId_Atom_t CFE_SB_MsgMapFileEntry::Index

Routing raw index value (0 based, not Route ID)
Definition at line 229 of file default_cfe_sb_msgdefs.h.

10.107.2.2 MsgId CFE_SB_MsgId_t CFE_SB_MsgMapFileEntry::MsgId

Message Id which has been subscribed to.
Definition at line 228 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.108 CFE_SB_NoopCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader

10.108.1 Detailed Description

Definition at line 52 of file default_cfe_sb_msgstruct.h.

10.108.2 Field Documentation

10.108.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_NoopCmd::CommandHeader

Definition at line 58 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.109 CFE_SB_PipeDepthStats Struct Reference

SB Pipe Depth Statistics.
#include <default_cfe_sb_msgdefs.h>

Data Fields

• CFE_SB_PipeId_t PipeId
Pipe Id associated with the stats below.
• uint16 MaxQueueDepth
Number of messages the pipe can hold.
• uint16 CurrentQueueDepth
Number of messages currently on the pipe.
• uint16 PeakQueueDepth
Peak number of messages that have been on the pipe.
• uint16 Spare
Spare word to ensure alignment.

Generated by Doxygen
510

10.109.1 Detailed Description

SB Pipe Depth Statistics.

Used in SB Statistics Telemetry Packet CFE_SB_StatsTlm_t
Definition at line 115 of file default_cfe_sb_msgdefs.h.

10.109.2 Field Documentation

10.109.2.1 CurrentQueueDepth uint16 CFE_SB_PipeDepthStats::CurrentQueueDepth

Number of messages currently on the pipe.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDINUSE

Definition at line 121 of file default_cfe_sb_msgdefs.h.

10.109.2.2 MaxQueueDepth uint16 CFE_SB_PipeDepthStats::MaxQueueDepth

Number of messages the pipe can hold.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDDEPTH

Definition at line 119 of file default_cfe_sb_msgdefs.h.

10.109.2.3 PeakQueueDepth uint16 CFE_SB_PipeDepthStats::PeakQueueDepth

Peak number of messages that have been on the pipe.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDPKINUSE

Definition at line 123 of file default_cfe_sb_msgdefs.h.

10.109.2.4 PipeId CFE_SB_PipeId_t CFE_SB_PipeDepthStats::PipeId

Pipe Id associated with the stats below.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDPIPEID

Definition at line 117 of file default_cfe_sb_msgdefs.h.

10.109.2.5 Spare uint16 CFE_SB_PipeDepthStats::Spare

Spare word to ensure alignment.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES].SB_PDSPARE

Definition at line 125 of file default_cfe_sb_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.110 CFE_SB_PipeInfoEntry Struct Reference

SB Pipe Information File Entry.
#include <default_cfe_sb_msgdefs.h>

Generated by Doxygen
10.110 CFE_SB_PipeInfoEntry Struct Reference 511

Data Fields

• CFE_SB_PipeId_t PipeId
• CFE_ES_AppId_t AppId
• char PipeName [CFE_MISSION_MAX_API_LEN]
• char AppName [CFE_MISSION_MAX_API_LEN]
• uint16 MaxQueueDepth
• uint16 CurrentQueueDepth
• uint16 PeakQueueDepth
• uint16 SendErrors
• uint8 Opts
• uint8 Spare [3]

10.110.1 Detailed Description

SB Pipe Information File Entry.

This statistics structure is output as part of the CFE SB "Send Pipe Info" command (CFE_SB_SEND_PIPE_INFO_CC).
Previous versions of CFE simply wrote the internal CFE_SB_PipeD_t object to the file, but this also contains information
such as pointers which are not relevant outside the running CFE process.
By defining the pipe info structure separately, it also provides some independence, such that the internal CFE_SB_←-
PipeD_t definition can evolve without changing the binary format of the information file.
Definition at line 144 of file default_cfe_sb_msgdefs.h.

10.110.2 Field Documentation

10.110.2.1 AppId CFE_ES_AppId_t CFE_SB_PipeInfoEntry::AppId

The runtime ID of the application that owns the pipe
Definition at line 147 of file default_cfe_sb_msgdefs.h.

10.110.2.2 AppName char CFE_SB_PipeInfoEntry::AppName[CFE_MISSION_MAX_API_LEN]

The Name of the application that owns the pipe
Definition at line 149 of file default_cfe_sb_msgdefs.h.

10.110.2.3 CurrentQueueDepth uint16 CFE_SB_PipeInfoEntry::CurrentQueueDepth

The current depth of the pipe
Definition at line 151 of file default_cfe_sb_msgdefs.h.

10.110.2.4 MaxQueueDepth uint16 CFE_SB_PipeInfoEntry::MaxQueueDepth

The allocated depth of the pipe (max capacity)
Definition at line 150 of file default_cfe_sb_msgdefs.h.

10.110.2.5 Opts uint8 CFE_SB_PipeInfoEntry::Opts

Pipe options set (bitmask)
Definition at line 154 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
512

10.110.2.6 PeakQueueDepth uint16 CFE_SB_PipeInfoEntry::PeakQueueDepth

The peak depth of the pipe (high watermark)
Definition at line 152 of file default_cfe_sb_msgdefs.h.

10.110.2.7 PipeId CFE_SB_PipeId_t CFE_SB_PipeInfoEntry::PipeId

The runtime ID of the pipe
Definition at line 146 of file default_cfe_sb_msgdefs.h.

10.110.2.8 PipeName char CFE_SB_PipeInfoEntry::PipeName[CFE_MISSION_MAX_API_LEN]

The Name of the pipe
Definition at line 148 of file default_cfe_sb_msgdefs.h.

10.110.2.9 SendErrors uint16 CFE_SB_PipeInfoEntry::SendErrors

Number of errors when writing to this pipe
Definition at line 153 of file default_cfe_sb_msgdefs.h.

10.110.2.10 Spare uint8 CFE_SB_PipeInfoEntry::Spare[3]

Padding to make this structure a multiple of 4 bytes
Definition at line 155 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.111 CFE_SB_Qos_t Struct Reference

Quality Of Service Type Definition.
#include <default_cfe_sb_extern_typedefs.h>

Data Fields

• uint8 Priority
Specify high(1) or low(0) message priority for off-board routing, currently unused.
• uint8 Reliability
Specify high(1) or low(0) message transfer reliability for off-board routing, currently unused.

10.111.1 Detailed Description

Quality Of Service Type Definition.

Currently an unused parameter in CFE_SB_SubscribeEx Intended to be used for interprocessor communication only
Definition at line 121 of file default_cfe_sb_extern_typedefs.h.

10.111.2 Field Documentation

10.111.2.1 Priority uint8 CFE_SB_Qos_t::Priority

Specify high(1) or low(0) message priority for off-board routing, currently unused.
Definition at line 123 of file default_cfe_sb_extern_typedefs.h.

Generated by Doxygen
10.112 CFE_SB_ResetCountersCmd Struct Reference 513

10.111.2.2 Reliability uint8 CFE_SB_Qos_t::Reliability

Specify high(1) or low(0) message transfer reliability for off-board routing, currently unused.
Definition at line 124 of file default_cfe_sb_extern_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_extern_typedefs.h

10.112 CFE_SB_ResetCountersCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader

10.112.1 Detailed Description

Definition at line 57 of file default_cfe_sb_msgstruct.h.

10.112.2 Field Documentation

10.112.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_ResetCountersCmd::CommandHeader

Definition at line 59 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.113 CFE_SB_RouteCmd_Payload Struct Reference

Enable/Disable Route Command Payload.
#include <default_cfe_sb_msgdefs.h>

Data Fields

• CFE_SB_MsgId_t MsgId
Message ID of route to be enabled or disabled CFE_SB_MsgId_t.
• CFE_SB_PipeId_t Pipe
Pipe ID of route to be enabled or disabled CFE_SB_PipeId_t.
• uint8 Spare
Spare byte to make command even number of bytes.

10.113.1 Detailed Description

Enable/Disable Route Command Payload.

This structure contains a definition used by two SB commands, 'Enable Route' CFE_SB_ENABLE_ROUTE_CC and
'Disable Route' CFE_SB_DISABLE_ROUTE_CC. A route is the destination pipe for a particular message and is there-
fore defined as a MsgId and PipeId combination.
Definition at line 53 of file default_cfe_sb_msgdefs.h.

10.113.2 Field Documentation

Generated by Doxygen
514

10.113.2.1 MsgId CFE_SB_MsgId_t CFE_SB_RouteCmd_Payload::MsgId

Message ID of route to be enabled or disabled CFE_SB_MsgId_t.
Definition at line 55 of file default_cfe_sb_msgdefs.h.

10.113.2.2 Pipe CFE_SB_PipeId_t CFE_SB_RouteCmd_Payload::Pipe

Pipe ID of route to be enabled or disabled CFE_SB_PipeId_t.
Definition at line 56 of file default_cfe_sb_msgdefs.h.

10.113.2.3 Spare uint8 CFE_SB_RouteCmd_Payload::Spare

Spare byte to make command even number of bytes.
Definition at line 57 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.114 CFE_SB_RoutingFileEntry Struct Reference

SB Routing File Entry.
#include <default_cfe_sb_msgdefs.h>

Data Fields

• CFE_SB_MsgId_t MsgId
Message Id portion of the route.
• CFE_SB_PipeId_t PipeId
Pipe Id portion of the route.
• uint8 State
Route Enabled or Disabled.
• uint16 MsgCnt
Number of msgs with this MsgId sent to this PipeId.
• char AppName [CFE_MISSION_MAX_API_LEN]
Pipe Depth Statistics.
• char PipeName [CFE_MISSION_MAX_API_LEN]
Pipe Depth Statistics.

10.114.1 Detailed Description

SB Routing File Entry.

Structure of one element of the routing information in response to CFE_SB_WRITE_ROUTING_INFO_CC
Definition at line 211 of file default_cfe_sb_msgdefs.h.

10.114.2 Field Documentation

10.114.2.1 AppName char CFE_SB_RoutingFileEntry::AppName[CFE_MISSION_MAX_API_LEN]

Pipe Depth Statistics.
Definition at line 217 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
10.115 CFE_SB_SendHkCmd Struct Reference 515

10.114.2.2 MsgCnt uint16 CFE_SB_RoutingFileEntry::MsgCnt

Number of msgs with this MsgId sent to this PipeId.
Definition at line 216 of file default_cfe_sb_msgdefs.h.

10.114.2.3 MsgId CFE_SB_MsgId_t CFE_SB_RoutingFileEntry::MsgId

Message Id portion of the route.
Definition at line 213 of file default_cfe_sb_msgdefs.h.

10.114.2.4 PipeId CFE_SB_PipeId_t CFE_SB_RoutingFileEntry::PipeId

Pipe Id portion of the route.
Definition at line 214 of file default_cfe_sb_msgdefs.h.

10.114.2.5 PipeName char CFE_SB_RoutingFileEntry::PipeName[CFE_MISSION_MAX_API_LEN]

Pipe Depth Statistics.
Definition at line 218 of file default_cfe_sb_msgdefs.h.

10.114.2.6 State uint8 CFE_SB_RoutingFileEntry::State

Route Enabled or Disabled.
Definition at line 215 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.115 CFE_SB_SendHkCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader

10.115.1 Detailed Description

Definition at line 82 of file default_cfe_sb_msgstruct.h.

10.115.2 Field Documentation

10.115.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_SendHkCmd::CommandHeader

Definition at line 84 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.116 CFE_SB_SendPrevSubsCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Generated by Doxygen
516

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader

10.116.1 Detailed Description

Definition at line 77 of file default_cfe_sb_msgstruct.h.

10.116.2 Field Documentation

10.116.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_SendPrevSubsCmd::CommandHeader

Definition at line 79 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.117 CFE_SB_SendSbStatsCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader

10.117.1 Detailed Description

Definition at line 72 of file default_cfe_sb_msgstruct.h.

10.117.2 Field Documentation

10.117.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_SendSbStatsCmd::CommandHeader

Definition at line 74 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.118 CFE_SB_SingleSubscriptionTlm Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_SB_SingleSubscriptionTlm_Payload_t Payload
Telemetry payload.

10.118.1 Detailed Description

Definition at line 139 of file default_cfe_sb_msgstruct.h.

Generated by Doxygen
10.119 CFE_SB_SingleSubscriptionTlm_Payload Struct Reference 517

10.118.2 Field Documentation

10.118.2.1 Payload CFE_SB_SingleSubscriptionTlm_Payload_t CFE_SB_SingleSubscriptionTlm::Payload

Telemetry payload.
Definition at line 142 of file default_cfe_sb_msgstruct.h.

10.118.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_SB_SingleSubscriptionTlm::Telemetry←-

Header
Telemetry header.
Definition at line 141 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.119 CFE_SB_SingleSubscriptionTlm_Payload Struct Reference

#include <default_cfe_sb_msgdefs.h>

Data Fields

• uint8 SubType
Subscription or Unsubscription.
• CFE_SB_MsgId_t MsgId
MsgId subscribed or unsubscribe to.
• CFE_SB_Qos_t Qos
Quality of Service, used only for interprocessor communication.
• CFE_SB_PipeId_t Pipe
Destination pipe id to send above msg id

10.119.1 Detailed Description

Name SB Subscription Report Packet

This structure defines the pkt sent by SB when a subscription or a request to unsubscribe is received while subscription
reporting is enabled. By default subscription reporting is disabled. This feature is intended to be used primarily by
Software Bus Networking Application (SBN)

See also

CFE_SB_ENABLE_SUB_REPORTING_CC, CFE_SB_DISABLE_SUB_REPORTING_CC

Definition at line 242 of file default_cfe_sb_msgdefs.h.

10.119.2 Field Documentation

10.119.2.1 MsgId CFE_SB_MsgId_t CFE_SB_SingleSubscriptionTlm_Payload::MsgId

MsgId subscribed or unsubscribe to.
Definition at line 245 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
518

10.119.2.2 Pipe CFE_SB_PipeId_t CFE_SB_SingleSubscriptionTlm_Payload::Pipe

Destination pipe id to send above msg id

Definition at line 247 of file default_cfe_sb_msgdefs.h.

10.119.2.3 Qos CFE_SB_Qos_t CFE_SB_SingleSubscriptionTlm_Payload::Qos

Quality of Service, used only for interprocessor communication.
Definition at line 246 of file default_cfe_sb_msgdefs.h.

10.119.2.4 SubType uint8 CFE_SB_SingleSubscriptionTlm_Payload::SubType

Subscription or Unsubscription.
Definition at line 244 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.120 CFE_SB_StatsTlm Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_SB_StatsTlm_Payload_t Payload
Telemetry payload.

10.120.1 Detailed Description

Definition at line 133 of file default_cfe_sb_msgstruct.h.

10.120.2 Field Documentation

10.120.2.1 Payload CFE_SB_StatsTlm_Payload_t CFE_SB_StatsTlm::Payload

Telemetry payload.
Definition at line 136 of file default_cfe_sb_msgstruct.h.

10.120.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_SB_StatsTlm::TelemetryHeader

Telemetry header.
Definition at line 135 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.121 CFE_SB_StatsTlm_Payload Struct Reference

#include <default_cfe_sb_msgdefs.h>

Generated by Doxygen
10.121 CFE_SB_StatsTlm_Payload Struct Reference 519

Data Fields

• uint32 MsgIdsInUse
Current number of MsgIds with a destination.
• uint32 PeakMsgIdsInUse
Peak number of MsgIds with a destination.
• uint32 MaxMsgIdsAllowed
cFE Cfg Param CFE_PLATFORM_SB_MAX_MSG_IDS
• uint32 PipesInUse
Number of pipes currently in use.
• uint32 PeakPipesInUse
Peak number of pipes since last reboot.
• uint32 MaxPipesAllowed
cFE Cfg Param CFE_PLATFORM_SB_MAX_PIPES
• uint32 MemInUse
Memory bytes currently in use for SB msg transfers.
• uint32 PeakMemInUse
Peak memory bytes in use for SB msg transfers.
• uint32 MaxMemAllowed
cFE Cfg Param CFE_PLATFORM_SB_BUF_MEMORY_BYTES
• uint32 SubscriptionsInUse
Number of current subscriptions.
• uint32 PeakSubscriptionsInUse
Peak number of subscriptions.
• uint32 MaxSubscriptionsAllowed
product of CFE_PLATFORM_SB_MAX_MSG_IDS and CFE_PLATFORM_SB_MAX_DEST_PER_PKT
• uint32 SBBuffersInUse
Number of SB message buffers currently in use.
• uint32 PeakSBBuffersInUse
Max number of SB message buffers in use.
• uint32 MaxPipeDepthAllowed
Maximum allowed pipe depth.
• CFE_SB_PipeDepthStats_t PipeDepthStats [CFE_MISSION_SB_MAX_PIPES]
Pipe Depth Statistics CFE_SB_PipeDepthStats_t.

10.121.1 Detailed Description

Name SB Statistics Telemetry Packet

SB Statistics packet sent in response to CFE_SB_SEND_SB_STATS_CC

Definition at line 163 of file default_cfe_sb_msgdefs.h.

10.121.2 Field Documentation

10.121.2.1 MaxMemAllowed uint32 CFE_SB_StatsTlm_Payload::MaxMemAllowed

cFE Cfg Param CFE_PLATFORM_SB_BUF_MEMORY_BYTES

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMMBMALW

Definition at line 183 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
520

10.121.2.2 MaxMsgIdsAllowed uint32 CFE_SB_StatsTlm_Payload::MaxMsgIdsAllowed

cFE Cfg Param CFE_PLATFORM_SB_MAX_MSG_IDS

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMMMIDALW

Definition at line 169 of file default_cfe_sb_msgdefs.h.

10.121.2.3 MaxPipeDepthAllowed uint32 CFE_SB_StatsTlm_Payload::MaxPipeDepthAllowed

Maximum allowed pipe depth.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMMPDALW

Definition at line 199 of file default_cfe_sb_msgdefs.h.

10.121.2.4 MaxPipesAllowed uint32 CFE_SB_StatsTlm_Payload::MaxPipesAllowed

cFE Cfg Param CFE_PLATFORM_SB_MAX_PIPES

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMMPALW

Definition at line 176 of file default_cfe_sb_msgdefs.h.

10.121.2.5 MaxSubscriptionsAllowed uint32 CFE_SB_StatsTlm_Payload::MaxSubscriptionsAllowed

product of CFE_PLATFORM_SB_MAX_MSG_IDS and CFE_PLATFORM_SB_MAX_DEST_PER_PKT

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMMSALW

Definition at line 190 of file default_cfe_sb_msgdefs.h.

10.121.2.6 MemInUse uint32 CFE_SB_StatsTlm_Payload::MemInUse

Memory bytes currently in use for SB msg transfers.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMBMIU

Definition at line 179 of file default_cfe_sb_msgdefs.h.

10.121.2.7 MsgIdsInUse uint32 CFE_SB_StatsTlm_Payload::MsgIdsInUse

Current number of MsgIds with a destination.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMMIDIU

Definition at line 165 of file default_cfe_sb_msgdefs.h.

10.121.2.8 PeakMemInUse uint32 CFE_SB_StatsTlm_Payload::PeakMemInUse

Peak memory bytes in use for SB msg transfers.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPBMIU

Definition at line 181 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
10.121 CFE_SB_StatsTlm_Payload Struct Reference 521

10.121.2.9 PeakMsgIdsInUse uint32 CFE_SB_StatsTlm_Payload::PeakMsgIdsInUse

Peak number of MsgIds with a destination.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPMIDIU

Definition at line 167 of file default_cfe_sb_msgdefs.h.

10.121.2.10 PeakPipesInUse uint32 CFE_SB_StatsTlm_Payload::PeakPipesInUse

Peak number of pipes since last reboot.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPPIU

Definition at line 174 of file default_cfe_sb_msgdefs.h.

10.121.2.11 PeakSBBuffersInUse uint32 CFE_SB_StatsTlm_Payload::PeakSBBuffersInUse

Max number of SB message buffers in use.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPSBBIU

Definition at line 196 of file default_cfe_sb_msgdefs.h.

10.121.2.12 PeakSubscriptionsInUse uint32 CFE_SB_StatsTlm_Payload::PeakSubscriptionsInUse

Peak number of subscriptions.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPSIU

Definition at line 188 of file default_cfe_sb_msgdefs.h.

10.121.2.13 PipeDepthStats CFE_SB_PipeDepthStats_t CFE_SB_StatsTlm_Payload::PipeDepthStats[CFE_MISSION_SB_MAX_PIP

Pipe Depth Statistics CFE_SB_PipeDepthStats_t.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPDS[CFE_PLATFORM_SB_MAX_PIPES]

Definition at line 202 of file default_cfe_sb_msgdefs.h.

10.121.2.14 PipesInUse uint32 CFE_SB_StatsTlm_Payload::PipesInUse

Number of pipes currently in use.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMPIU

Definition at line 172 of file default_cfe_sb_msgdefs.h.

10.121.2.15 SBBuffersInUse uint32 CFE_SB_StatsTlm_Payload::SBBuffersInUse

Number of SB message buffers currently in use.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMSBBIU

Definition at line 194 of file default_cfe_sb_msgdefs.h.

Generated by Doxygen
522

10.121.2.16 SubscriptionsInUse uint32 CFE_SB_StatsTlm_Payload::SubscriptionsInUse

Number of current subscriptions.

Telemetry Mnemonic(s) $sc_$cpu_SB_Stat.SB_SMSIU

Definition at line 186 of file default_cfe_sb_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.122 CFE_SB_SubEntries Struct Reference

SB Previous Subscriptions Entry.
#include <default_cfe_sb_msgdefs.h>

Data Fields

• CFE_SB_MsgId_t MsgId
MsgId portion of the subscription.
• CFE_SB_Qos_t Qos
Qos portion of the subscription.
• CFE_SB_PipeId_t Pipe
PipeId portion of the subscription.

10.122.1 Detailed Description

SB Previous Subscriptions Entry.

This structure defines an entry used in the CFE_SB_PrevSubsPkt_t Intended to be used primarily by Software Bus
Networking Application (SBN)
Used in structure definition CFE_SB_AllSubscriptionsTlm_t
Definition at line 258 of file default_cfe_sb_msgdefs.h.

10.122.2 Field Documentation

10.122.2.1 MsgId CFE_SB_MsgId_t CFE_SB_SubEntries::MsgId

MsgId portion of the subscription.
Definition at line 260 of file default_cfe_sb_msgdefs.h.

10.122.2.2 Pipe CFE_SB_PipeId_t CFE_SB_SubEntries::Pipe

PipeId portion of the subscription.
Definition at line 262 of file default_cfe_sb_msgdefs.h.

10.122.2.3 Qos CFE_SB_Qos_t CFE_SB_SubEntries::Qos

Qos portion of the subscription.
Definition at line 261 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

Generated by Doxygen
10.123 CFE_SB_WriteFileInfoCmd_Payload Struct Reference 523

10.123 CFE_SB_WriteFileInfoCmd_Payload Struct Reference

Write File Info Command Payload.
#include <default_cfe_sb_msgdefs.h>

Data Fields

• char Filename [CFE_MISSION_MAX_PATH_LEN]

Path and Filename of data to be loaded.

10.123.1 Detailed Description

Write File Info Command Payload.

This structure contains a generic definition used by SB commands that write to a file
Definition at line 40 of file default_cfe_sb_msgdefs.h.

10.123.2 Field Documentation

10.123.2.1 Filename char CFE_SB_WriteFileInfoCmd_Payload::Filename[CFE_MISSION_MAX_PATH_LEN]

Path and Filename of data to be loaded.
Definition at line 42 of file default_cfe_sb_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgdefs.h

10.124 CFE_SB_WriteMapInfoCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_SB_WriteFileInfoCmd_Payload_t Payload
Command payload.

10.124.1 Detailed Description

Definition at line 102 of file default_cfe_sb_msgstruct.h.

10.124.2 Field Documentation

10.124.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_WriteMapInfoCmd::CommandHeader

Command header.
Definition at line 104 of file default_cfe_sb_msgstruct.h.

Generated by Doxygen
524

10.124.2.2 Payload CFE_SB_WriteFileInfoCmd_Payload_t CFE_SB_WriteMapInfoCmd::Payload

Command payload.
Definition at line 105 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.125 CFE_SB_WritePipeInfoCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_SB_WriteFileInfoCmd_Payload_t Payload
Command payload.

10.125.1 Detailed Description

Definition at line 96 of file default_cfe_sb_msgstruct.h.

10.125.2 Field Documentation

10.125.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_WritePipeInfoCmd::CommandHeader

Command header.
Definition at line 98 of file default_cfe_sb_msgstruct.h.

10.125.2.2 Payload CFE_SB_WriteFileInfoCmd_Payload_t CFE_SB_WritePipeInfoCmd::Payload

Command payload.
Definition at line 99 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.126 CFE_SB_WriteRoutingInfoCmd Struct Reference

#include <default_cfe_sb_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_SB_WriteFileInfoCmd_Payload_t Payload
Command payload.

10.126.1 Detailed Description

Definition at line 90 of file default_cfe_sb_msgstruct.h.

Generated by Doxygen
10.127 CFE_TBL_AbortLoadCmd Struct Reference 525

10.126.2 Field Documentation

10.126.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_SB_WriteRoutingInfoCmd::CommandHeader

Command header.
Definition at line 92 of file default_cfe_sb_msgstruct.h.

10.126.2.2 Payload CFE_SB_WriteFileInfoCmd_Payload_t CFE_SB_WriteRoutingInfoCmd::Payload

Command payload.
Definition at line 93 of file default_cfe_sb_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/sb/config/default_cfe_sb_msgstruct.h

10.127 CFE_TBL_AbortLoadCmd Struct Reference

Abort Load Command.
#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_TBL_AbortLoadCmd_Payload_t Payload
Command payload.

10.127.1 Detailed Description

Abort Load Command.

Definition at line 131 of file default_cfe_tbl_msgstruct.h.

10.127.2 Field Documentation

10.127.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_AbortLoadCmd::CommandHeader

Command header.
Definition at line 133 of file default_cfe_tbl_msgstruct.h.

10.127.2.2 Payload CFE_TBL_AbortLoadCmd_Payload_t CFE_TBL_AbortLoadCmd::Payload

Command payload.
Definition at line 134 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.128 CFE_TBL_AbortLoadCmd_Payload Struct Reference

Abort Load Command Payload.
#include <default_cfe_tbl_msgdefs.h>

Generated by Doxygen
526

Data Fields

• char TableName [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full Name of Table whose load is to be aborted.

10.128.1 Detailed Description

Abort Load Command Payload.

For command details, see CFE_TBL_ABORT_LOAD_CC
Definition at line 147 of file default_cfe_tbl_msgdefs.h.

10.128.2 Field Documentation

10.128.2.1 TableName char CFE_TBL_AbortLoadCmd_Payload::TableName[CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full Name of Table whose load is to be aborted.
ASCII string containing full table name identifier of a table whose load is to be aborted
Definition at line 149 of file default_cfe_tbl_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

10.129 CFE_TBL_ActivateCmd Struct Reference

Activate Table Command.
#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_TBL_ActivateCmd_Payload_t Payload
Command payload.

10.129.1 Detailed Description

Activate Table Command.

Definition at line 95 of file default_cfe_tbl_msgstruct.h.

10.129.2 Field Documentation

10.129.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_ActivateCmd::CommandHeader

Command header.
Definition at line 97 of file default_cfe_tbl_msgstruct.h.

10.129.2.2 Payload CFE_TBL_ActivateCmd_Payload_t CFE_TBL_ActivateCmd::Payload

Command payload.
Definition at line 98 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

Generated by Doxygen
10.130 CFE_TBL_ActivateCmd_Payload Struct Reference 527

10.130 CFE_TBL_ActivateCmd_Payload Struct Reference

Activate Table Command Payload.
#include <default_cfe_tbl_msgdefs.h>

Data Fields

• char TableName [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full Name of Table to be activated.

10.130.1 Detailed Description

Activate Table Command Payload.

For command details, see CFE_TBL_ACTIVATE_CC
Definition at line 94 of file default_cfe_tbl_msgdefs.h.

10.130.2 Field Documentation

10.130.2.1 TableName char CFE_TBL_ActivateCmd_Payload::TableName[CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full Name of Table to be activated.
ASCII string containing full table name identifier of table to be activated
Definition at line 96 of file default_cfe_tbl_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

10.131 CFE_TBL_DelCDSCmd_Payload Struct Reference

Delete Critical Table CDS Command Payload.
#include <default_cfe_tbl_msgdefs.h>

Data Fields

• char TableName [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full Name of Table whose CDS is to be deleted.

10.131.1 Detailed Description

Delete Critical Table CDS Command Payload.

For command details, see CFE_TBL_DELETE_CDS_CC
Definition at line 133 of file default_cfe_tbl_msgdefs.h.

10.131.2 Field Documentation

10.131.2.1 TableName char CFE_TBL_DelCDSCmd_Payload::TableName[CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full Name of Table whose CDS is to be deleted.
ASCII string containing full table name identifier of a critical table whose CDS is to be deleted
Definition at line 135 of file default_cfe_tbl_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

Generated by Doxygen
528

10.132 CFE_TBL_DeleteCDSCmd Struct Reference

Delete Critical Table CDS Command.
#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_TBL_DelCDSCmd_Payload_t Payload
Command payload.

10.132.1 Detailed Description

Delete Critical Table CDS Command.

Definition at line 122 of file default_cfe_tbl_msgstruct.h.

10.132.2 Field Documentation

10.132.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_DeleteCDSCmd::CommandHeader

Command header.
Definition at line 124 of file default_cfe_tbl_msgstruct.h.

10.132.2.2 Payload CFE_TBL_DelCDSCmd_Payload_t CFE_TBL_DeleteCDSCmd::Payload

Command payload.
Definition at line 125 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.133 CFE_TBL_DumpCmd Struct Reference

#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_TBL_DumpCmd_Payload_t Payload
Command payload.

10.133.1 Detailed Description

/brief Dump Table Command

Definition at line 77 of file default_cfe_tbl_msgstruct.h.

10.133.2 Field Documentation

Generated by Doxygen
10.134 CFE_TBL_DumpCmd_Payload Struct Reference 529

10.133.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_DumpCmd::CommandHeader

Command header.
Definition at line 79 of file default_cfe_tbl_msgstruct.h.

10.133.2.2 Payload CFE_TBL_DumpCmd_Payload_t CFE_TBL_DumpCmd::Payload

Command payload.
Definition at line 80 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.134 CFE_TBL_DumpCmd_Payload Struct Reference

Dump Table Command Payload.
#include <default_cfe_tbl_msgdefs.h>

Data Fields

• uint16 ActiveTableFlag
CFE_TBL_BufferSelect_INACTIVE=Inactive Table, CFE_TBL_BufferSelect_ACTIVE=Active Table
• char TableName [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]
Full name of table to be dumped.
• char DumpFilename [CFE_MISSION_MAX_PATH_LEN]
Full Filename where data is to be written.

10.134.1 Detailed Description

Dump Table Command Payload.

For command details, see CFE_TBL_DUMP_CC
Definition at line 55 of file default_cfe_tbl_msgdefs.h.

10.134.2 Field Documentation

10.134.2.1 ActiveTableFlag uint16 CFE_TBL_DumpCmd_Payload::ActiveTableFlag

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
Definition at line 57 of file default_cfe_tbl_msgdefs.h.

10.134.2.2 DumpFilename char CFE_TBL_DumpCmd_Payload::DumpFilename[CFE_MISSION_MAX_PATH_LEN]

Full Filename where data is to be written.
ASCII string containing full path of filename where data is to be dumped
Definition at line 66 of file default_cfe_tbl_msgdefs.h.

Generated by Doxygen
530

10.134.2.3 TableName char CFE_TBL_DumpCmd_Payload::TableName[CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full name of table to be dumped.
ASCII string containing full table name identifier of table to be dumped
Definition at line 63 of file default_cfe_tbl_msgdefs.h.
The documentation for this struct was generated from the following file:
• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

10.135 CFE_TBL_DumpRegistryCmd Struct Reference

Dump Registry Command.
#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_TBL_DumpRegistryCmd_Payload_t Payload
Command payload.

10.135.1 Detailed Description

Dump Registry Command.

Definition at line 104 of file default_cfe_tbl_msgstruct.h.

10.135.2 Field Documentation

10.135.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_DumpRegistryCmd::CommandHeader

Command header.
Definition at line 106 of file default_cfe_tbl_msgstruct.h.

10.135.2.2 Payload CFE_TBL_DumpRegistryCmd_Payload_t CFE_TBL_DumpRegistryCmd::Payload

Command payload.
Definition at line 107 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:
• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.136 CFE_TBL_DumpRegistryCmd_Payload Struct Reference

Dump Registry Command Payload.
#include <default_cfe_tbl_msgdefs.h>

Data Fields

• char DumpFilename [CFE_MISSION_MAX_PATH_LEN]

Full Filename where dumped data is to be written.

10.136.1 Detailed Description

Dump Registry Command Payload.

For command details, see CFE_TBL_DUMP_REGISTRY_CC
Definition at line 106 of file default_cfe_tbl_msgdefs.h.

Generated by Doxygen
10.137 CFE_TBL_File_Hdr Struct Reference 531

10.136.2 Field Documentation

10.136.2.1 DumpFilename char CFE_TBL_DumpRegistryCmd_Payload::DumpFilename[CFE_MISSION_MAX_PATH_LEN]

Full Filename where dumped data is to be written.
ASCII string containing full path of filename where registry is to be dumped
Definition at line 108 of file default_cfe_tbl_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

10.137 CFE_TBL_File_Hdr Struct Reference

The definition of the header fields that are included in CFE Table Data files.
#include <default_cfe_tbl_extern_typedefs.h>

Data Fields

• uint32 Reserved
• uint32 Offset
• uint32 NumBytes
• char TableName [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

10.137.1 Detailed Description

The definition of the header fields that are included in CFE Table Data files.
This header follows the CFE_FS header and precedes the actual table data.

Note

The Offset and NumBytes fields in the table header are to 32 bits for backward compatibility with existing CFE
versions. This means that even on 64-bit CPUs, individual table files will be limited to 4GiB in size.

Definition at line 64 of file default_cfe_tbl_extern_typedefs.h.

10.137.2 Field Documentation

10.137.2.1 NumBytes uint32 CFE_TBL_File_Hdr::NumBytes

Number of bytes to load into table
Definition at line 68 of file default_cfe_tbl_extern_typedefs.h.

10.137.2.2 Offset uint32 CFE_TBL_File_Hdr::Offset

Byte Offset at which load should commence
Definition at line 67 of file default_cfe_tbl_extern_typedefs.h.

10.137.2.3 Reserved uint32 CFE_TBL_File_Hdr::Reserved

Future Use: NumTblSegments in File?

Definition at line 66 of file default_cfe_tbl_extern_typedefs.h.

Generated by Doxygen
532

10.137.2.4 TableName char CFE_TBL_File_Hdr::TableName[CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Fully qualified name of table to load
Definition at line 69 of file default_cfe_tbl_extern_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_extern_typedefs.h

10.138 CFE_TBL_FileDef Struct Reference

Table File summary object.
#include <cfe_tbl_filedef.h>

Data Fields

• char ObjectName [64]

Name of instantiated variable that contains desired table image.
• char TableName [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]
Name of Table as defined onboard.
• char Description [CFE_FS_HDR_DESC_MAX_LEN]
Description of table image that is included in cFE File Header.
• char TgtFilename [CFE_MISSION_MAX_FILE_LEN]
Default filename to be used for output of elf2cfetbl utility.
• uint32 ObjectSize
Size, in bytes, of instantiated object.

10.138.1 Detailed Description

Table File summary object.

The definition of the file definition metadata that can be used by external tools (e.g. elf2cfetbl) to generate CFE table
data files.
Definition at line 58 of file cfe_tbl_filedef.h.

10.138.2 Field Documentation

10.138.2.1 Description char CFE_TBL_FileDef::Description[CFE_FS_HDR_DESC_MAX_LEN]

Description of table image that is included in cFE File Header.
This is a free-form text string that can be any meaningful value
Definition at line 94 of file cfe_tbl_filedef.h.

10.138.2.2 ObjectName char CFE_TBL_FileDef::ObjectName[64]

Name of instantiated variable that contains desired table image.

Note

For consistency and future compatibility with auto-generated table files and table definitions, the "ObjectName"
should match the table struct typedef name without the "_t" suffix. For example, the limit checker action table
(ADT) is defined by a type called "LC_ADT_t", the ObjectName should be "LC_ADT".

This naming convention allows the type name to be inferred from the ObjectName (and vice-versa) without having to
directly specify both the type name and object name here.

Generated by Doxygen
10.139 CFE_TBL_HousekeepingTlm Struct Reference 533

Although the traditional elf2cfetbl tool does not currently do any type checking, future tool versions may add more robust
type verification and therefore need to know the type name as well as the object name.
Definition at line 76 of file cfe_tbl_filedef.h.

10.138.2.3 ObjectSize uint32 CFE_TBL_FileDef::ObjectSize

Size, in bytes, of instantiated object.
This may be used by tools to check for consistency between the actual defined table size and the expected table size.
This is set automatically via the CFE_TBL_FILEDEF macro.
Definition at line 112 of file cfe_tbl_filedef.h.

10.138.2.4 TableName char CFE_TBL_FileDef::TableName[CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Name of Table as defined onboard.
This should be in the form of "APP_NAME.TABLE_NAME" where APP_NAME matches what the app is named
at runtime (the 4th column of cfe_es_startup.scr) and TABLE_NAME matches the 2nd parameter of the call to
CFE_TBL_Register(). Preferably the TABLE_NAME should also match the ObjectName here in this structure, although
this is not strictly required, it helps keep things consistent.
Definition at line 87 of file cfe_tbl_filedef.h.

10.138.2.5 TgtFilename char CFE_TBL_FileDef::TgtFilename[CFE_MISSION_MAX_FILE_LEN]

Default filename to be used for output of elf2cfetbl utility.
This must match the expected table file name, which is the name of the source file but the ".c" extension replaced with
".tbl". This is the filename only - do not include a directory/path name here, it can be copied to any runtime directory on
the target by external scripts, but should not be renamed.
Definition at line 104 of file cfe_tbl_filedef.h.
The documentation for this struct was generated from the following file:

• cfe/modules/core_api/fsw/inc/cfe_tbl_filedef.h

10.139 CFE_TBL_HousekeepingTlm Struct Reference

#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_TBL_HousekeepingTlm_Payload_t Payload
Telemetry payload.

10.139.1 Detailed Description

Definition at line 154 of file default_cfe_tbl_msgstruct.h.

10.139.2 Field Documentation

10.139.2.1 Payload CFE_TBL_HousekeepingTlm_Payload_t CFE_TBL_HousekeepingTlm::Payload

Telemetry payload.
Definition at line 157 of file default_cfe_tbl_msgstruct.h.

Generated by Doxygen
534

10.139.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_TBL_HousekeepingTlm::TelemetryHeader

Telemetry header.
Definition at line 156 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.140 CFE_TBL_HousekeepingTlm_Payload Struct Reference

#include <default_cfe_tbl_msgdefs.h>

Data Fields

• uint8 CommandCounter
Count of valid commands received.
• uint8 CommandErrorCounter
Count of invalid commands received.
• uint16 NumTables
Number of Tables Registered.
• uint16 NumLoadPending
Number of Tables pending on Applications for their update.
• uint16 ValidationCounter
Number of completed table validations.
• uint32 LastValCrc
Data Integrity Value computed for last table validated.
• int32 LastValStatus
Returned status from validation function for last table validated.
• bool ActiveBuffer
Indicator of whether table buffer validated was 0=Inactive, 1=Active.
• char LastValTableName [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]
Name of last table validated.
• uint8 SuccessValCounter
Total number of successful table validations.
• uint8 FailedValCounter
Total number of unsuccessful table validations.
• uint8 NumValRequests
Number of times Table Services has requested validations from Apps.
• uint8 NumFreeSharedBufs
Number of free Shared Working Buffers.
• uint8 ByteAlignPad1
Spare byte to ensure longword alignment.
• CFE_ES_MemHandle_t MemPoolHandle
Handle to TBL's memory pool.
• CFE_TIME_SysTime_t LastUpdateTime
Time of last table update.
• char LastUpdatedTable [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]
Name of the last table updated.
• char LastFileLoaded [CFE_MISSION_MAX_PATH_LEN]
Path and Name of last table image file loaded.

Generated by Doxygen
10.140 CFE_TBL_HousekeepingTlm_Payload Struct Reference 535

• char LastFileDumped [CFE_MISSION_MAX_PATH_LEN]

Path and Name of last file dumped to.
• char LastTableLoaded [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]
Name of the last table loaded.

10.140.1 Detailed Description

Name Table Services Housekeeping Packet

Definition at line 178 of file default_cfe_tbl_msgdefs.h.

10.140.2 Field Documentation

10.140.2.1 ActiveBuffer bool CFE_TBL_HousekeepingTlm_Payload::ActiveBuffer

Indicator of whether table buffer validated was 0=Inactive, 1=Active.

Telemetry Mnemonic(s) $sc_$cpu_TBL_LastValBuf

Definition at line 205 of file default_cfe_tbl_msgdefs.h.

10.140.2.2 ByteAlignPad1 uint8 CFE_TBL_HousekeepingTlm_Payload::ByteAlignPad1

Spare byte to ensure longword alignment.

Telemetry Mnemonic(s) $sc_$cpu_TBL_ByteAlignPad1

Definition at line 221 of file default_cfe_tbl_msgdefs.h.

10.140.2.3 CommandCounter uint8 CFE_TBL_HousekeepingTlm_Payload::CommandCounter

Count of valid commands received.

Telemetry Mnemonic(s) $sc_$cpu_TBL_CMDPC

Definition at line 183 of file default_cfe_tbl_msgdefs.h.

10.140.2.4 CommandErrorCounter uint8 CFE_TBL_HousekeepingTlm_Payload::CommandErrorCounter

Count of invalid commands received.

Telemetry Mnemonic(s) $sc_$cpu_TBL_CMDEC

Definition at line 185 of file default_cfe_tbl_msgdefs.h.

10.140.2.5 FailedValCounter uint8 CFE_TBL_HousekeepingTlm_Payload::FailedValCounter

Total number of unsuccessful table validations.

Telemetry Mnemonic(s) $sc_$cpu_TBL_ValFailedCtr

Definition at line 211 of file default_cfe_tbl_msgdefs.h.

Generated by Doxygen
536

10.140.2.6 LastFileDumped char CFE_TBL_HousekeepingTlm_Payload::LastFileDumped[CFE_MISSION_MAX_PATH_LEN]

Path and Name of last file dumped to.

Telemetry Mnemonic(s) $sc_$cpu_TBL_LastFileDumped[OS_MAX_PATH_LEN]

Definition at line 231 of file default_cfe_tbl_msgdefs.h.

10.140.2.7 LastFileLoaded char CFE_TBL_HousekeepingTlm_Payload::LastFileLoaded[CFE_MISSION_MAX_PATH_LEN]

Path and Name of last table image file loaded.

Telemetry Mnemonic(s) $sc_$cpu_TBL_LastFileLoaded[OS_MAX_PATH_LEN]

Definition at line 229 of file default_cfe_tbl_msgdefs.h.

10.140.2.8 LastTableLoaded char CFE_TBL_HousekeepingTlm_Payload::LastTableLoaded[CFE_MISSION_TBL_MAX_FULL_NAME_LE

Name of the last table loaded.

Telemetry Mnemonic(s) $sc_$cpu_TBL_LastTableLoaded[CFE_TBL_MAX_FULL_NAME_LEN]

Definition at line 233 of file default_cfe_tbl_msgdefs.h.

10.140.2.9 LastUpdatedTable char CFE_TBL_HousekeepingTlm_Payload::LastUpdatedTable[CFE_MISSION_TBL_MAX_FULL_NAME_

Name of the last table updated.

Telemetry Mnemonic(s) $sc_$cpu_TBL_LastUpdTblName[CFE_TB_MAX_FULL_NAME_LEN]

Definition at line 227 of file default_cfe_tbl_msgdefs.h.

10.140.2.10 LastUpdateTime CFE_TIME_SysTime_t CFE_TBL_HousekeepingTlm_Payload::LastUpdateTime

Time of last table update.

Telemetry Mnemonic(s) $sc_$cpu_TBL_LastUpdTime, $sc_$cpu_TBL_SECONDS, $sc_$cpu_TBL_SUBSECONDS

Definition at line 225 of file default_cfe_tbl_msgdefs.h.

10.140.2.11 LastValCrc uint32 CFE_TBL_HousekeepingTlm_Payload::LastValCrc

Data Integrity Value computed for last table validated.

Telemetry Mnemonic(s) $sc_$cpu_TBL_LastValCRC

Definition at line 201 of file default_cfe_tbl_msgdefs.h.

10.140.2.12 LastValStatus int32 CFE_TBL_HousekeepingTlm_Payload::LastValStatus

Returned status from validation function for last table validated.

Telemetry Mnemonic(s) $sc_$cpu_TBl_LastValS

Definition at line 203 of file default_cfe_tbl_msgdefs.h.

Generated by Doxygen
10.140 CFE_TBL_HousekeepingTlm_Payload Struct Reference 537

10.140.2.13 LastValTableName char CFE_TBL_HousekeepingTlm_Payload::LastValTableName[CFE_MISSION_TBL_MAX_FULL_NAME

Name of last table validated.

Telemetry Mnemonic(s) $sc_$cpu_TBL_LastValTblName[CFE_TB_MAX_FULL_NAME_LEN]

Definition at line 207 of file default_cfe_tbl_msgdefs.h.

10.140.2.14 MemPoolHandle CFE_ES_MemHandle_t CFE_TBL_HousekeepingTlm_Payload::MemPoolHandle

Handle to TBL's memory pool.

Telemetry Mnemonic(s) $sc_$cpu_TBL_MemPoolHandle

Definition at line 223 of file default_cfe_tbl_msgdefs.h.

10.140.2.15 NumFreeSharedBufs uint8 CFE_TBL_HousekeepingTlm_Payload::NumFreeSharedBufs

Number of free Shared Working Buffers.

Telemetry Mnemonic(s) $sc_$cpu_TBL_NumFreeShrBuf

Definition at line 219 of file default_cfe_tbl_msgdefs.h.

10.140.2.16 NumLoadPending uint16 CFE_TBL_HousekeepingTlm_Payload::NumLoadPending

Number of Tables pending on Applications for their update.

Telemetry Mnemonic(s) $sc_$cpu_TBL_NumUpdatesPend

Definition at line 193 of file default_cfe_tbl_msgdefs.h.

10.140.2.17 NumTables uint16 CFE_TBL_HousekeepingTlm_Payload::NumTables

Number of Tables Registered.

Telemetry Mnemonic(s) $sc_$cpu_TBL_NumTables

Definition at line 191 of file default_cfe_tbl_msgdefs.h.

10.140.2.18 NumValRequests uint8 CFE_TBL_HousekeepingTlm_Payload::NumValRequests

Number of times Table Services has requested validations from Apps.

Telemetry Mnemonic(s) $sc_$cpu_TBL_ValReqCtr

Definition at line 213 of file default_cfe_tbl_msgdefs.h.

10.140.2.19 SuccessValCounter uint8 CFE_TBL_HousekeepingTlm_Payload::SuccessValCounter

Total number of successful table validations.

Telemetry Mnemonic(s) $sc_$cpu_TBL_ValSuccessCtr

Definition at line 209 of file default_cfe_tbl_msgdefs.h.

Generated by Doxygen
538

10.140.2.20 ValidationCounter uint16 CFE_TBL_HousekeepingTlm_Payload::ValidationCounter

Number of completed table validations.

Telemetry Mnemonic(s) $sc_$cpu_TBL_ValCompltdCtr

Definition at line 199 of file default_cfe_tbl_msgdefs.h.

The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

10.141 CFE_TBL_Info Struct Reference

Table Info.
#include <cfe_tbl_api_typedefs.h>

Data Fields

• size_t Size
Size, in bytes, of Table.
• uint32 NumUsers
Number of Apps with access to the table.
• CFE_TIME_SysTime_t FileTime
File creation time from last file loaded into table.
• uint32 Crc
Most recently calculated CRC by TBL services on table contents.
• CFE_TIME_SysTime_t TimeOfLastUpdate
Time when Table was last updated.
• bool TableLoadedOnce
Flag indicating whether table has been loaded once or not.
• bool DumpOnly
Flag indicating Table is NOT to be loaded.
• bool DoubleBuffered
Flag indicating Table has a dedicated inactive buffer.
• bool UserDefAddr
Flag indicating Table address was defined by Owner Application.
• bool Critical
Flag indicating Table contents are maintained in a CDS.
• char LastFileLoaded [CFE_MISSION_MAX_PATH_LEN]
Filename of last file loaded into table.

10.141.1 Detailed Description

Table Info.
Definition at line 109 of file cfe_tbl_api_typedefs.h.

10.141.2 Field Documentation

10.141.2.1 Crc uint32 CFE_TBL_Info::Crc

Most recently calculated CRC by TBL services on table contents.
Definition at line 114 of file cfe_tbl_api_typedefs.h.

Generated by Doxygen
10.141 CFE_TBL_Info Struct Reference 539

10.141.2.2 Critical bool CFE_TBL_Info::Critical

Flag indicating Table contents are maintained in a CDS.
Definition at line 120 of file cfe_tbl_api_typedefs.h.

10.141.2.3 DoubleBuffered bool CFE_TBL_Info::DoubleBuffered

Flag indicating Table has a dedicated inactive buffer.
Definition at line 118 of file cfe_tbl_api_typedefs.h.

10.141.2.4 DumpOnly bool CFE_TBL_Info::DumpOnly

Flag indicating Table is NOT to be loaded.
Definition at line 117 of file cfe_tbl_api_typedefs.h.

10.141.2.5 FileTime CFE_TIME_SysTime_t CFE_TBL_Info::FileTime

File creation time from last file loaded into table.
Definition at line 113 of file cfe_tbl_api_typedefs.h.

10.141.2.6 LastFileLoaded char CFE_TBL_Info::LastFileLoaded[CFE_MISSION_MAX_PATH_LEN]

Filename of last file loaded into table.
Definition at line 121 of file cfe_tbl_api_typedefs.h.

10.141.2.7 NumUsers uint32 CFE_TBL_Info::NumUsers

Number of Apps with access to the table.
Definition at line 112 of file cfe_tbl_api_typedefs.h.

10.141.2.8 Size size_t CFE_TBL_Info::Size

Size, in bytes, of Table.
Definition at line 111 of file cfe_tbl_api_typedefs.h.

10.141.2.9 TableLoadedOnce bool CFE_TBL_Info::TableLoadedOnce

Flag indicating whether table has been loaded once or not.
Definition at line 116 of file cfe_tbl_api_typedefs.h.

10.141.2.10 TimeOfLastUpdate CFE_TIME_SysTime_t CFE_TBL_Info::TimeOfLastUpdate

Time when Table was last updated.
Definition at line 115 of file cfe_tbl_api_typedefs.h.

10.141.2.11 UserDefAddr bool CFE_TBL_Info::UserDefAddr

Flag indicating Table address was defined by Owner Application.
Definition at line 119 of file cfe_tbl_api_typedefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/core_api/fsw/inc/cfe_tbl_api_typedefs.h

Generated by Doxygen
540

10.142 CFE_TBL_LoadCmd Struct Reference

Load Table Command.
#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_TBL_LoadCmd_Payload_t Payload
Command payload.

10.142.1 Detailed Description

Load Table Command.

Definition at line 68 of file default_cfe_tbl_msgstruct.h.

10.142.2 Field Documentation

10.142.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_LoadCmd::CommandHeader

Command header.
Definition at line 70 of file default_cfe_tbl_msgstruct.h.

10.142.2.2 Payload CFE_TBL_LoadCmd_Payload_t CFE_TBL_LoadCmd::Payload

Command payload.
Definition at line 71 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.143 CFE_TBL_LoadCmd_Payload Struct Reference

Load Table Command Payload.
#include <default_cfe_tbl_msgdefs.h>

Data Fields

• char LoadFilename [CFE_MISSION_MAX_PATH_LEN]

Filename (and path) of data to be loaded.

10.143.1 Detailed Description

Load Table Command Payload.

For command details, see CFE_TBL_LOAD_CC
Definition at line 45 of file default_cfe_tbl_msgdefs.h.

10.143.2 Field Documentation

Generated by Doxygen
10.144 CFE_TBL_NoopCmd Struct Reference 541

10.143.2.1 LoadFilename char CFE_TBL_LoadCmd_Payload::LoadFilename[CFE_MISSION_MAX_PATH_LEN]

Filename (and path) of data to be loaded.
Definition at line 47 of file default_cfe_tbl_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

10.144 CFE_TBL_NoopCmd Struct Reference

#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.144.1 Detailed Description

Definition at line 50 of file default_cfe_tbl_msgstruct.h.

10.144.2 Field Documentation

10.144.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_NoopCmd::CommandHeader

Command header.
Definition at line 54 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.145 CFE_TBL_NotifyCmd Struct Reference

#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_TBL_NotifyCmd_Payload_t Payload
Command payload.

10.145.1 Detailed Description

/brief Table Management Notification Command

Definition at line 142 of file default_cfe_tbl_msgstruct.h.

10.145.2 Field Documentation

10.145.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_NotifyCmd::CommandHeader

Command header.
Definition at line 144 of file default_cfe_tbl_msgstruct.h.

Generated by Doxygen
542

10.145.2.2 Payload CFE_TBL_NotifyCmd_Payload_t CFE_TBL_NotifyCmd::Payload

Command payload.
Definition at line 145 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.146 CFE_TBL_NotifyCmd_Payload Struct Reference

Table Management Notification Command Payload.
#include <default_cfe_tbl_msgdefs.h>

Data Fields

• uint32 Parameter
Application specified command parameter.

10.146.1 Detailed Description

Table Management Notification Command Payload.

Description

Whenever an application that owns a table calls the CFE_TBL_NotifyByMessage API following the table regis-
tration, Table services will generate the following command message with the application specified message ID,
command code and parameter whenever the table requires management (e.g. - loads and validations).

Definition at line 165 of file default_cfe_tbl_msgdefs.h.

10.146.2 Field Documentation

10.146.2.1 Parameter uint32 CFE_TBL_NotifyCmd_Payload::Parameter

Application specified command parameter.
Definition at line 167 of file default_cfe_tbl_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

10.147 CFE_TBL_ResetCountersCmd Struct Reference

#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.147.1 Detailed Description

Definition at line 55 of file default_cfe_tbl_msgstruct.h.

10.147.2 Field Documentation

Generated by Doxygen
10.148 CFE_TBL_SendHkCmd Struct Reference 543

10.147.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_ResetCountersCmd::CommandHeader

Command header.
Definition at line 57 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.148 CFE_TBL_SendHkCmd Struct Reference

#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.

10.148.1 Detailed Description

Definition at line 60 of file default_cfe_tbl_msgstruct.h.

10.148.2 Field Documentation

10.148.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_SendHkCmd::CommandHeader

Command header.
Definition at line 62 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.149 CFE_TBL_SendRegistryCmd Struct Reference

Send Table Registry Command.
#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_CommandHeader_t CommandHeader
Command header.
• CFE_TBL_SendRegistryCmd_Payload_t Payload
Command payload.

10.149.1 Detailed Description

Send Table Registry Command.

Definition at line 113 of file default_cfe_tbl_msgstruct.h.

10.149.2 Field Documentation

Generated by Doxygen
544

10.149.2.1 CommandHeader CFE_MSG_CommandHeader_t CFE_TBL_SendRegistryCmd::CommandHeader

Command header.
Definition at line 115 of file default_cfe_tbl_msgstruct.h.

10.149.2.2 Payload CFE_TBL_SendRegistryCmd_Payload_t CFE_TBL_SendRegistryCmd::Payload

Command payload.
Definition at line 116 of file default_cfe_tbl_msgstruct.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgstruct.h

10.150 CFE_TBL_SendRegistryCmd_Payload Struct Reference

Send Table Registry Command Payload.
#include <default_cfe_tbl_msgdefs.h>

Data Fields

• char TableName [CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full Name of Table whose registry entry is to be telemetered.

10.150.1 Detailed Description

Send Table Registry Command Payload.

For command details, see CFE_TBL_SEND_REGISTRY_CC
Definition at line 119 of file default_cfe_tbl_msgdefs.h.

10.150.2 Field Documentation

10.150.2.1 TableName char CFE_TBL_SendRegistryCmd_Payload::TableName[CFE_MISSION_TBL_MAX_FULL_NAME_LEN]

Full Name of Table whose registry entry is to be telemetered.
ASCII string containing full table name identifier of table whose registry entry is to be telemetered via
CFE_TBL_TableRegistryTlm_t
Definition at line 121 of file default_cfe_tbl_msgdefs.h.
The documentation for this struct was generated from the following file:

• cfe/modules/tbl/config/default_cfe_tbl_msgdefs.h

10.151 CFE_TBL_TableRegistryTlm Struct Reference

#include <default_cfe_tbl_msgstruct.h>

Data Fields

• CFE_MSG_TelemetryHeader_t TelemetryHeader
Telemetry header.
• CFE_TBL_TblRegPacket_Payload_t Payload
Telemetry payload.

10.151.1 Detailed Description

Definition at line 160 of file default_cfe_tbl_msgstruct.h.

Generated by Doxygen
10.152 CFE_TBL_TblRegPacket_Payload Struct Reference 545

10.151.2 Field Documentation

10.151.2.1 Payload CFE_TBL_TblRegPacket_Payload_t CFE_TBL_TableRegistryTlm::Payload

Telemetry payload.
Definition at line 163 of file default_cfe_tbl_msgstruct.h.

10.151.2.2 TelemetryHeader CFE_MSG_TelemetryHeader_t CFE_TBL_TableRegistryTlm::TelemetryHeader

Telemetry header.
Definition at line 162 of f