-
Notifications
You must be signed in to change notification settings - Fork 0
/
cfe_es.xml
2079 lines (1731 loc) · 89.2 KB
/
cfe_es.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
GSC-18128-1, "Core Flight Executive Version 6.7"
Copyright (c) 2006-2019 United States Government as represented by
the Administrator of the National Aeronautics and Space Administration.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
This document adheres to the Electronic Data Sheet (EDS) XML schema
as prescribed in CCSDS book 876.0.
Purpose:
This describes all interface objects for the Executive Services (CFE_ES)
core application
-->
<PackageFile xmlns="http://www.ccsds.org/schema/sois/seds">
<Package name="CFE_ES" shortDescription="NASA Core Flight System Executive Services">
<DataTypeSet>
<EnumeratedDataType name="LogMode" shortDescription="Identifies handling of log messages after storage is filled" >
<IntegerDataEncoding sizeInBits="8" encoding="unsigned" />
<EnumerationList>
<Enumeration label="OVERWRITE" value="0" shortDescription="Overwrite Log Mode" />
<Enumeration label="DISCARD" value="1" shortDescription="Discard Log Mode" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="ExceptionAction" shortDescription="Identifies action to take if exception occurs" >
<IntegerDataEncoding sizeInBits="8" encoding="unsigned" />
<EnumerationList>
<Enumeration label="RESTART_APP" value="0" shortDescription="Restart application if exception occurs" />
<Enumeration label="PROC_RESTART" value="1" shortDescription="Restart processor if exception occurs" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="AppType" shortDescription="Identifies type of CFE application">
<IntegerDataEncoding sizeInBits="8" encoding="unsigned" />
<EnumerationList>
<Enumeration label="CORE" value="1" shortDescription="CFE core application" />
<Enumeration label="EXTERNAL" value="2" shortDescription="CFE external application" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="RunStatus" shortDescription="Run Status and Exit Status identifiers">
<IntegerDataEncoding sizeInBits="32" encoding="unsigned" />
<EnumerationList>
<Enumeration label="APP_RUN" value="1" shortDescription="Indicates that the Application should continue to run" />
<Enumeration label="APP_EXIT" value="2" shortDescription="Indicates that the Application wants to exit normally" />
<Enumeration label="APP_ERROR" value="3" shortDescription="Indicates that the Application is quitting with an error" />
<Enumeration label="SYS_EXCEPTION" value="4" shortDescription="The cFE App caused an exception" />
<Enumeration label="SYS_RESTART" value="5" shortDescription="The system is requesting a restart of the cFE App" />
<Enumeration label="SYS_RELOAD" value="6" shortDescription="The system is requesting a reload of the cFE App" />
<Enumeration label="SYS_DELETE" value="7" shortDescription="The system is requesting that the cFE App is stopped" />
<Enumeration label="CORE_APP_INIT_ERROR" value="8" shortDescription="Indicates that the Core Application could not Init" />
<Enumeration label="CORE_APP_RUNTIME_ERROR" value="9" shortDescription="Indicates that the Core Application had a runtime failure" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="LogEntryType" shortDescription="Type of entry in the Error and Reset (ER) Log">
<IntegerDataEncoding sizeInBits="8" encoding="unsigned" />
<EnumerationList>
<Enumeration label="CORE" value="1" shortDescription="Log entry from a core subsystem" />
<Enumeration label="APPLICATION" value="2" shortDescription="Log entry from an application" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="SystemState" shortDescription="The overall cFE System State">
<LongDescription>
These values are used with the CFE_ES_WaitForSystemState() API call to synchronize application startup.
@note These are defined in order so that relational comparisons e.g. if (STATEA < STATEB) are possible
</LongDescription>
<IntegerDataEncoding sizeInBits="32" encoding="unsigned" />
<EnumerationList>
<Enumeration label="UNDEFINED" value="0" shortDescription="reserved" />
<Enumeration label="EARLY_INIT" value="1" shortDescription="single threaded mode while setting up CFE itself" />
<Enumeration label="CORE_STARTUP" value="2" shortDescription="core apps (CFE_ES_ObjectTable) are starting (multi-threaded)" />
<Enumeration label="CORE_READY" value="3" shortDescription="core is ready, starting other external apps/libraries (if any)" />
<Enumeration label="APPS_INIT" value="4" shortDescription="startup apps have all completed their early init, but not necessarily operational yet" />
<Enumeration label="OPERATIONAL" value="5" shortDescription="normal operation mode; all apps are RUNNING" />
<Enumeration label="SHUTDOWN" value="6" shortDescription="reserved for future use, all apps would be STOPPED" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="AppState" shortDescription="Application Run State">
<LongDescription>
The normal progression of APP states:
UNDEFINED -> EARLY_INIT -> LATE_INIT -> RUNNING -> WAITING -> STOPPED
@note These are defined in order so that relational comparisons e.g. if (STATEA < STATEB) are possible
</LongDescription>
<IntegerDataEncoding sizeInBits="32" encoding="unsigned" />
<EnumerationList>
<Enumeration label="UNDEFINED" value="0" shortDescription="Initial state before app thread is started" />
<Enumeration label="EARLY_INIT" value="1" shortDescription="App thread has started, app performing early initialization of its own data" />
<Enumeration label="LATE_INIT" value="2" shortDescription="Early/Local initialization is complete. First sync point." />
<Enumeration label="RUNNING" value="3" shortDescription="All initialization is complete. Second sync point." />
<Enumeration label="WAITING" value="4" shortDescription="Application is waiting on a Restart/Reload/Delete request" />
<Enumeration label="STOPPED" value="5" shortDescription="Application is stopped" />
<Enumeration label="MAX" value="6" shortDescription="Reserved, placeholder for maximum value" />
</EnumerationList>
</EnumeratedDataType>
<StringDataType name="char_x_CFE_ES_MAX_SHELL_CMD" length="${CFE_MISSION/ES_MAX_SHELL_CMD}" />
<StringDataType name="char_x_CFE_ES_CDS_MAX_FULL_NAME_LEN" length="${CFE_MISSION/ES_CDS_MAX_FULL_NAME_LEN}" />
<StringDataType name="char_x_CFE_ES_MAX_SHELL_PKT" length="${CFE_MISSION/ES_MAX_SHELL_PKT}" />
<ArrayDataType name="boolean_x_CFE_ES_PERF_MAX_IDS" dataTypeRef="BASE_TYPES/StatusBit">
<DimensionList>
<Dimension size="${CFE_MISSION/ES_PERF_MAX_IDS}" />
</DimensionList>
</ArrayDataType>
<ContainerDataType name="MemAddOff">
<LongDescription>
CFE_ES_MemAddOff_t is a structure used to store/group information
about a memory address and a memory offset.
</LongDescription>
<EntryList>
<Entry name="Address" type="BASE_TYPES/CpuAddress" shortDescription="See #CFE_ES_MemAddress_t.">
<LongDescription>
\cfetlmmnemonic \ES_ADDR
</LongDescription>
</Entry>
<Entry name="Size" type="BASE_TYPES/CpuAddress" shortDescription="See #CFE_ES_MemOffset_t.">
<LongDescription>
\cfetlmmnemonic \ES_ADDR
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppInfo">
<LongDescription>
CFE_ES_AppInfo_t is a structure that is used to provide
information about an app. It is primarily used for the QueryOne and
QueryAll Commands.
</LongDescription>
<EntryList>
<Entry name="AppId" type="BASE_TYPES/uint32" shortDescription="Application ID for this Application">
<LongDescription>
\cfetlmmnemonic \ES_APP_ID
</LongDescription>
</Entry>
<Entry name="Type" type="AppType" shortDescription="The type of App: CORE or EXTERNAL">
<LongDescription>
\cfetlmmnemonic \ES_APPTYPE
</LongDescription>
</Entry>
<Entry name="Name" type="BASE_TYPES/ApiName" shortDescription="The Registered Name of the Application">
<LongDescription>
\cfetlmmnemonic \ES_APPNAME
</LongDescription>
</Entry>
<Entry name="EntryPoint" type="BASE_TYPES/ApiName" shortDescription="The Entry Point label for the Application">
<LongDescription>
\cfetlmmnemonic \ES_APPENTRYPT
</LongDescription>
</Entry>
<Entry name="FileName" type="BASE_TYPES/PathName" shortDescription="The Filename of the file containing the Application">
<LongDescription>
\cfetlmmnemonic \ES_APPFILENAME
</LongDescription>
</Entry>
<Entry name="StackSize" type="BASE_TYPES/uint32" shortDescription="The Stack Size of the Application">
<LongDescription>
\cfetlmmnemonic \ES_STACKSIZE
</LongDescription>
</Entry>
<Entry name="ModuleId" type="BASE_TYPES/uint32" shortDescription="The ID of the Loadable Module for the Application">
<LongDescription>
\cfetlmmnemonic \ES_MODULEID
</LongDescription>
</Entry>
<Entry name="AddressesAreValid" type="BASE_TYPES/uint32" shortDescription="Indicates that the Code, Data, and BSS addresses/sizes are valid">
<LongDescription>
\cfetlmmnemonic \ES_ADDRVALID
</LongDescription>
</Entry>
<Entry name="Code" type="" shortDescription="Struct containing the Address of the Application Code Segment and the Code Size of the Application">
<LongDescription>
\cfetlmmnemonic \ES_CODE
</LongDescription>
</Entry>
<Entry name="Data" type="" shortDescription="Struct containing the Address of the Application Data Segment and the Data Size of the Application">
<LongDescription>
\cfetlmmnemonic \ES_DATA
</LongDescription>
</Entry>
<Entry name="BSS" type="" shortDescription="Struct containing the Address of the Application BSS Segment and the BSS Size of the Application">
<LongDescription>
\cfetlmmnemonic \ES_BSS
</LongDescription>
</Entry>
<Entry name="StartAddress" type="BASE_TYPES/CpuAddress" shortDescription="The Start Address of the Application">
<LongDescription>
\cfetlmmnemonic \ES_STARTADDR
</LongDescription>
</Entry>
<Entry name="ExceptionAction" type="ExceptionAction" shortDescription="What should occur if Application has an exception (Restart Application OR Restart Processor)">
<LongDescription>
\cfetlmmnemonic \ES_EXCEPTNACTN
</LongDescription>
</Entry>
<Entry name="Priority" type="BASE_TYPES/uint16" shortDescription="The Priority of the Application">
<LongDescription>
\cfetlmmnemonic \ES_PRIORITY
</LongDescription>
</Entry>
<Entry name="MainTaskId" type="BASE_TYPES/uint32" shortDescription="The Application's Main Task ID">
<LongDescription>
\cfetlmmnemonic \ES_MAINTASKID
</LongDescription>
</Entry>
<Entry name="ExecutionCounter" type="BASE_TYPES/uint32" shortDescription="The Application's Main Task Execution Counter">
<LongDescription>
\cfetlmmnemonic \ES_MAINTASKEXECNT
</LongDescription>
</Entry>
<Entry name="MainTaskName" type="BASE_TYPES/ApiName" shortDescription="The Application's Main Task Name">
<LongDescription>
\cfetlmmnemonic \ES_MAINTASKNAME
</LongDescription>
</Entry>
<Entry name="NumOfChildTasks" type="BASE_TYPES/uint32" shortDescription="Number of Child tasks for an App">
<LongDescription>
\cfetlmmnemonic \ES_CHILDTASKS
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="BlockStats" shortDescription="Memory Pool Statistics data type">
<EntryList>
<Entry name="BlockSize" type="BASE_TYPES/uint32" shortDescription="Number of bytes in each of these blocks" />
<Entry name="NumCreated" type="BASE_TYPES/uint32" shortDescription="Number of Memory Blocks of this size created" />
<Entry name="NumFree" type="BASE_TYPES/uint32" shortDescription="Number of Memory Blocks of this size that are free" />
</EntryList>
</ContainerDataType>
<ArrayDataType name="BlockStats_x_CFE_MAX_MEMPOOL_BLOCKS" dataTypeRef="BlockStats">
<DimensionList>
<Dimension size="${CFE_MISSION/MAX_MEMPOOL_BLOCKS}" />
</DimensionList>
</ArrayDataType>
<ContainerDataType name="MemPoolStats">
<EntryList>
<Entry name="PoolSize" type="BASE_TYPES/uint32" shortDescription="Size of Memory Pool (in bytes)">
<LongDescription>
\cfetlmmnemonic \ES_POOLSIZE
</LongDescription>
</Entry>
<Entry name="NumBlocksRequested" type="BASE_TYPES/uint32" shortDescription="Number of times a memory block has been allocated">
<LongDescription>
\cfetlmmnemonic \ES_BLKSREQ
</LongDescription>
</Entry>
<Entry name="CheckErrCtr" type="BASE_TYPES/uint32" shortDescription="Number of errors detected when freeing a memory block">
<LongDescription>
\cfetlmmnemonic \ES_BLKERRCTR
</LongDescription>
</Entry>
<Entry name="NumFreeBytes" type="BASE_TYPES/uint32" shortDescription="Number of bytes never allocated to a block">
<LongDescription>
\cfetlmmnemonic \ES_FREEBYTES
</LongDescription>
</Entry>
<Entry name="BlockStats" type="BlockStats_x_CFE_MAX_MEMPOOL_BLOCKS" shortDescription="Contains stats on each block size">
<LongDescription>
\cfetlmmnemonic \ES_BLKSTATS
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="RestartCmd_Payload" shortDescription="Reset cFE Command">
<LongDescription>
For command details, see #CFE_ES_RESTART_CC
</LongDescription>
<EntryList>
<Entry name="RestartType" type="BASE_TYPES/uint16" shortDescription="#CFE_ES_PROCESSOR_RESET=Processor Reset or #CFE_ES_POWERON_RESET=Power-On Reset" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="ShellCmd_Payload" shortDescription="Shell Command">
<LongDescription>
For command details, see #CFE_ES_SHELL_CMD_CC
</LongDescription>
<EntryList>
<Entry name="CmdString" type="char_x_CFE_ES_MAX_SHELL_CMD" shortDescription="ASCII text string containing shell command to be executed" />
<Entry name="OutputFilename" type="BASE_TYPES/PathName" shortDescription="Filename where shell command output is to be written" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="FileNameCmd_Payload" shortDescription="Generic message payload for messages that require only a filename">
<EntryList>
<Entry name="FileName" type="BASE_TYPES/PathName" shortDescription="ASCII text string of full path and filename of file" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="OverWriteSysLogCmd_Payload" shortDescription="Overwrite/Discard System Log Configuration Command">
<LongDescription>
For command details, see #CFE_ES_OVERWRITE_SYSLOG_CC
</LongDescription>
<EntryList>
<Entry name="Mode" type="LogMode">
<LongDescription>
\brief #CFE_ES_LogMode_DISCARD=Throw away most recent messages,
#CFE_ES_LogMode_OVERWRITE=Overwrite oldest with most recent
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="StartAppCmd_Payload" shortDescription="Start Application Command">
<LongDescription>
For command details, see #CFE_ES_START_APP_CC.
</LongDescription>
<EntryList>
<Entry name="Application" type="BASE_TYPES/ApiName" shortDescription="Name of Application to be started" />
<Entry name="AppEntryPoint" type="BASE_TYPES/ApiName" shortDescription="Symbolic name of Application's entry point" />
<Entry name="AppFileName" type="BASE_TYPES/PathName" shortDescription="Full path and filename of Application's executable image" />
<Entry name="StackSize" type="BASE_TYPES/uint32" shortDescription="Desired stack size for the new application" />
<Entry name="ExceptionAction" type="ExceptionAction">
<LongDescription>
\brief #CFE_ES_ExceptionAction_RESTART_APP=On exception, restart Application,
#CFE_ES_ExceptionAction_PROC_RESTART=On exception, perform a Processor Reset
</LongDescription>
</Entry>
<Entry name="Priority" type="BASE_TYPES/uint16" shortDescription="The new Applications runtime priority." />
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppNameCmd_Payload" shortDescription="Command Structure for Commands requiring just an Application Name">
<LongDescription>
For command details, see #CFE_ES_STOP_APP_CC, #CFE_ES_RESTART_APP_CC, #CFE_ES_QUERY_ONE_CC
</LongDescription>
<EntryList>
<Entry name="Application" type="BASE_TYPES/ApiName" shortDescription="ASCII text string containing Application Name" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppReloadCmd_Payload" shortDescription="Reload Application Command">
<LongDescription>
For command details, see #CFE_ES_RELOAD_APP_CC
</LongDescription>
<EntryList>
<Entry name="Application" type="BASE_TYPES/ApiName" shortDescription="ASCII text string containing Application Name" />
<Entry name="AppFileName" type="BASE_TYPES/PathName" shortDescription="Full path and filename of Application's executable image" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="SetMaxPRCountCmd_Payload" shortDescription="Set Maximum Processor Reset Count Command">
<LongDescription>
For command details, see #CFE_ES_SET_MAX_PR_COUNT_CC
</LongDescription>
<EntryList>
<Entry name="MaxPRCount" type="BASE_TYPES/uint16" shortDescription="New maximum number of Processor Resets before an automatic Power-On Reset is performed" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="DeleteCDSCmd_Payload" shortDescription="Delete Critical Data Store Command">
<LongDescription>
For command details, see #CFE_ES_DELETE_CDS_CC
</LongDescription>
<EntryList>
<Entry name="CdsName" type="char_x_CFE_ES_CDS_MAX_FULL_NAME_LEN" shortDescription="ASCII text string containing name of CDS to delete" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="StartPerfCmd_Payload" shortDescription="Start Performance Analyzer Command">
<LongDescription>
For command details, see #CFE_ES_PERF_STARTDATA_CC
</LongDescription>
<EntryList>
<Entry name="TriggerMode" type="BASE_TYPES/uint32" shortDescription="Desired trigger position (Start, Center, End)" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="StopPerfCmd_Payload" shortDescription="Stop Performance Analyzer Command">
<LongDescription>
For command details, see #CFE_ES_PERF_STOPDATA_CC
</LongDescription>
<EntryList>
<Entry name="DataFileName" type="BASE_TYPES/PathName" shortDescription="ASCII text string of full path and filename of file Performance Analyzer data is to be written" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="SetPerfFilterMaskCmd_Payload" shortDescription="Set Performance Analyzer Filter Mask Command">
<LongDescription>
For command details, see #CFE_ES_PERF_SETFILTERMASK_CC
</LongDescription>
<EntryList>
<Entry name="FilterMaskNum" type="BASE_TYPES/uint32" shortDescription="Index into array of Filter Masks" />
<Entry name="FilterMask" type="BASE_TYPES/uint32" shortDescription="New Mask for specified entry in array of Filter Masks" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="SetPerfTrigMaskCmd_Payload" shortDescription="Set Performance Analyzer Trigger Mask Command" >
<LongDescription>
For command details, see #CFE_ES_PERF_SETTRIGMASK_CC
</LongDescription>
<EntryList>
<Entry name="TriggerMaskNum" type="BASE_TYPES/uint32" shortDescription="Index into array of Trigger Masks" />
<Entry name="TriggerMask" type="BASE_TYPES/uint32" shortDescription="New Mask for specified entry in array of Trigger Masks" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="SendMemPoolStatsCmd_Payload" shortDescription="">
<LongDescription>
\brief Telemeter Memory Pool Statistics Command.
For command details, see #CFE_ES_TLM_POOL_STATS_CC
</LongDescription>
<EntryList>
<Entry name="Application" type="BASE_TYPES/ApiName" shortDescription="RESERVED - should be all zeroes" />
<Entry name="PoolHandle" type="BASE_TYPES/CpuAddress" shortDescription="Handle of Pool whose statistics are to be telemetered" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="DumpCDSRegistryCmd_Payload" shortDescription="Dump CDS Registry Command">
<LongDescription>
For command details, see #CFE_ES_DUMP_CDS_REG_CC
</LongDescription>
<EntryList>
<Entry name="DumpFilename" type="BASE_TYPES/PathName" shortDescription="ASCII text string of full path and filename of file CDS Registry is to be written" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="OneAppTlm_Payload" shortDescription="Single Application Information Packet">
<EntryList>
<Entry name="AppInfo" type="AppInfo" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="PoolStatsTlm_Payload" shortDescription="Memory Pool Statistics Packet">
<EntryList>
<Entry name="PoolHandle" type="BASE_TYPES/CpuAddress" shortDescription="Handle of memory pool whose stats are being telemetered">
<LongDescription>
\cfetlmmnemonic \ES_POOLHANDLE
</LongDescription>
</Entry>
<Entry name="PoolStats" type="MemPoolStats" shortDescription="For more info, see #CFE_ES_MemPoolStats_t" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="HousekeepingTlm_Payload">
<EntryList>
<Entry name="CommandCounter" type="BASE_TYPES/uint8" shortDescription="The ES Application Command Counter">
<LongDescription>
\cfetlmmnemonic \ES_CMDPC
</LongDescription>
</Entry>
<Entry name="CommandErrorCounter" type="BASE_TYPES/uint8" shortDescription="The ES Application Command Error Counter">
<LongDescription>
\cfetlmmnemonic \ES_CMDEC
</LongDescription>
</Entry>
<Entry name="CFECoreChecksum" type="BASE_TYPES/uint16" shortDescription="Checksum of cFE Core Code">
<LongDescription>
\cfetlmmnemonic \ES_CKSUM
</LongDescription>
</Entry>
<Entry name="CFEMajorVersion" type="BASE_TYPES/uint8" shortDescription="Major Version Number of cFE">
<LongDescription>
\cfetlmmnemonic \ES_CFEMAJORVER
</LongDescription>
</Entry>
<Entry name="CFEMinorVersion" type="BASE_TYPES/uint8" shortDescription="Minor Version Number of cFE">
<LongDescription>
\cfetlmmnemonic \ES_CFEMINORVER
</LongDescription>
</Entry>
<Entry name="CFERevision" type="BASE_TYPES/uint8" shortDescription="Sub-Minor Version Number of cFE">
<LongDescription>
\cfetlmmnemonic \ES_CFEREVISION
</LongDescription>
</Entry>
<Entry name="CFEMissionRevision" type="BASE_TYPES/uint8" shortDescription="Mission Version Number of cFE">
<LongDescription>
\cfetlmmnemonic \ES_CFEMISSIONREV
</LongDescription>
</Entry>
<Entry name="OSALMajorVersion" type="BASE_TYPES/uint8" shortDescription="OS Abstraction Layer Major Version Number">
<LongDescription>
\cfetlmmnemonic \ES_OSMAJORVER
</LongDescription>
</Entry>
<Entry name="OSALMinorVersion" type="BASE_TYPES/uint8" shortDescription="OS Abstraction Layer Minor Version Number">
<LongDescription>
\cfetlmmnemonic \ES_OSMINORVER
</LongDescription>
</Entry>
<Entry name="OSALRevision" type="BASE_TYPES/uint8" shortDescription="OS Abstraction Layer Revision Number">
<LongDescription>
\cfetlmmnemonic \ES_OSREVISION
</LongDescription>
</Entry>
<Entry name="OSALMissionRevision" type="BASE_TYPES/uint8" shortDescription="OS Abstraction Layer MissionRevision Number">
<LongDescription>
\cfetlmmnemonic \ES_OSMISSIONREV
</LongDescription>
</Entry>
<Entry name="PSPMajorVersion" type="BASE_TYPES/uint8" shortDescription="Platform Support Package Major Version Number">
<LongDescription>
\cfetlmmnemonic \ES_PSPMAJORVER
</LongDescription>
</Entry>
<Entry name="PSPMinorVersion" type="BASE_TYPES/uint8" shortDescription="Platform Support Package Minor Version Number">
<LongDescription>
\cfetlmmnemonic \ES_PSPMINORVER
</LongDescription>
</Entry>
<Entry name="PSPRevision" type="BASE_TYPES/uint8" shortDescription="Platform Support Package Revision Number">
<LongDescription>
\cfetlmmnemonic \ES_PSPREVISION
</LongDescription>
</Entry>
<Entry name="PSPMissionRevision" type="BASE_TYPES/uint8" shortDescription="Platform Support Package MissionRevision Number">
<LongDescription>
\cfetlmmnemonic \ES_PSPMISSIONREV
</LongDescription>
</Entry>
<Entry name="SysLogBytesUsed" type="BASE_TYPES/uint32" shortDescription="Total number of bytes used in system log">
<LongDescription>
\cfetlmmnemonic \ES_SYSLOGBYTEUSED
</LongDescription>
</Entry>
<Entry name="SysLogSize" type="BASE_TYPES/uint32" shortDescription="Total size of the system log">
<LongDescription>
\cfetlmmnemonic \ES_SYSLOGSIZE
</LongDescription>
</Entry>
<Entry name="SysLogEntries" type="BASE_TYPES/uint32" shortDescription="Number of entries in the system log">
<LongDescription>
\cfetlmmnemonic \ES_SYSLOGENTRIES
</LongDescription>
</Entry>
<Entry name="SysLogMode" type="LogMode" shortDescription="Write/Overwrite Mode">
<LongDescription>
\cfetlmmnemonic \ES_SYSLOGMODE
</LongDescription>
</Entry>
<Entry name="ERLogIndex" type="BASE_TYPES/uint32" shortDescription="Current index of the ER Log (wraps around)">
<LongDescription>
\cfetlmmnemonic \ES_ERLOGINDEX
</LongDescription>
</Entry>
<Entry name="ERLogEntries" type="BASE_TYPES/uint32" shortDescription="Number of entries made in the ER Log since the power on">
<LongDescription>
\cfetlmmnemonic \ES_ERLOGENTRIES
</LongDescription>
</Entry>
<Entry name="RegisteredCoreApps" type="BASE_TYPES/uint32" shortDescription="Number of Applications registered with ES">
<LongDescription>
\cfetlmmnemonic \ES_REGCOREAPPS
</LongDescription>
</Entry>
<Entry name="RegisteredExternalApps" type="BASE_TYPES/uint32" shortDescription="Number of Applications registered with ES">
<LongDescription>
\cfetlmmnemonic \ES_REGEXTAPPS
</LongDescription>
</Entry>
<Entry name="RegisteredTasks" type="BASE_TYPES/uint32" shortDescription="Number of Tasks ( main AND child tasks ) registered with ES">
<LongDescription>
\cfetlmmnemonic \ES_REGTASKS
</LongDescription>
</Entry>
<Entry name="RegisteredLibs" type="BASE_TYPES/uint32" shortDescription="Number of Libraries registered with ES">
<LongDescription>
\cfetlmmnemonic \ES_REGLIBS
</LongDescription>
</Entry>
<Entry name="ResetType" type="BASE_TYPES/uint32" shortDescription="Reset type ( PROCESSOR or POWERON )">
<LongDescription>
\cfetlmmnemonic \ES_RESETTYPE
</LongDescription>
</Entry>
<Entry name="ResetSubtype" type="BASE_TYPES/uint32" shortDescription="Reset Sub Type">
<LongDescription>
\cfetlmmnemonic \ES_RESETSUBTYPE
</LongDescription>
</Entry>
<Entry name="ProcessorResets" type="BASE_TYPES/uint32" shortDescription="Number of processor resets since last power on">
<LongDescription>
\cfetlmmnemonic \ES_PROCRESETCNT
</LongDescription>
</Entry>
<Entry name="MaxProcessorResets" type="BASE_TYPES/uint32" shortDescription="Max processor resets before a power on is done">
<LongDescription>
\cfetlmmnemonic \ES_MAXPROCRESETS
</LongDescription>
</Entry>
<Entry name="BootSource" type="BASE_TYPES/uint32" shortDescription="Boot source ( as provided from BSP )">
<LongDescription>
\cfetlmmnemonic \ES_BOOTSOURCE
</LongDescription>
</Entry>
<Entry name="PerfState" type="BASE_TYPES/uint32" shortDescription="Current state of Performance Analyzer">
<LongDescription>
\cfetlmmnemonic \ES_PERFSTATE
</LongDescription>
</Entry>
<Entry name="PerfMode" type="BASE_TYPES/uint32" shortDescription="Current mode of Performance Analyzer">
<LongDescription>
\cfetlmmnemonic \ES_PERFMODE
</LongDescription>
</Entry>
<Entry name="PerfTriggerCount" type="BASE_TYPES/uint32" shortDescription="Number of Times Perfomance Analyzer has Triggered">
<LongDescription>
\cfetlmmnemonic \ES_PERFTRIGCNT
</LongDescription>
</Entry>
<Entry name="PerfFilterMask" type="boolean_x_CFE_ES_PERF_MAX_IDS" shortDescription="Current Setting of Performance Analyzer Filter Masks">
<LongDescription>
\cfetlmmnemonic \ES_PERFFLTRMASK
</LongDescription>
</Entry>
<Entry name="PerfTriggerMask" type="boolean_x_CFE_ES_PERF_MAX_IDS" shortDescription="Current Setting of Performance Analyzer Trigger Masks">
<LongDescription>
\cfetlmmnemonic \ES_PERFTRIGMASK
</LongDescription>
</Entry>
<Entry name="PerfDataStart" type="BASE_TYPES/uint32" shortDescription="Identifies First Stored Entry in Performance Analyzer Log">
<LongDescription>
\cfetlmmnemonic \ES_PERFDATASTART
</LongDescription>
</Entry>
<Entry name="PerfDataEnd" type="BASE_TYPES/uint32" shortDescription="Identifies Last Stored Entry in Performance Analyzer Log">
<LongDescription>
\cfetlmmnemonic \ES_PERFDATAEND
</LongDescription>
</Entry>
<Entry name="PerfDataCount" type="BASE_TYPES/uint32" shortDescription="Number of Entries Put Into the Performance Analyzer Log">
<LongDescription>
\cfetlmmnemonic \ES_PERFDATACNT
</LongDescription>
</Entry>
<Entry name="PerfDataToWrite" type="BASE_TYPES/uint32" shortDescription="Number of Performance Analyzer Log Entries Left to be Written to Log Dump File">
<LongDescription>
\cfetlmmnemonic \ES_PERFDATA2WRITE
</LongDescription>
</Entry>
<Entry name="HeapBytesFree" type="BASE_TYPES/uint32" shortDescription="Number of free bytes remaining in the OS heap">
<LongDescription>
\cfetlmmnemonic \ES_HEAPBYTESFREE
</LongDescription>
</Entry>
<Entry name="HeapBlocksFree" type="BASE_TYPES/uint32" shortDescription="Number of free blocks remaining in the OS heap">
<LongDescription>
\cfetlmmnemonic \ES_HEAPBLKSFREE
</LongDescription>
</Entry>
<Entry name="HeapMaxBlockSize" type="BASE_TYPES/uint32" shortDescription="Number of bytes in the largest free block">
<LongDescription>
\cfetlmmnemonic \ES_HEAPMAXBLK
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="ShellPacket_Payload">
<EntryList>
<Entry name="ShellOutput" type="char_x_CFE_ES_MAX_SHELL_PKT">
<LongDescription>
\brief ASCII text string containing output from OS Shell
that was received in response to an OS Shell Command
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="CommandBase" baseType="CCSDS/CommandPacket">
</ContainerDataType>
<ContainerDataType name="HousekeepingTlm" baseType="CCSDS/TelemetryPacket">
<EntryList>
<Entry type="HousekeepingTlm_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="OneAppTlm" baseType="CCSDS/TelemetryPacket">
<EntryList>
<Entry type="OneAppTlm_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="ShellTlm" baseType="CCSDS/TelemetryPacket">
<EntryList>
<Entry type="ShellPacket_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="MemStatsTlm" baseType="CCSDS/TelemetryPacket">
<EntryList>
<Entry type="PoolStatsTlm_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="Noop" baseType="CommandBase">
<LongDescription>
\cfeescmd Executive Services No-Op
\par Description
This command performs no other function than to increment the
command execution counter. The command may be used to verify
general aliveness of the Executive Services task.
\cfecmdmnemonic \ES_NOOP
\par Command Structure
#CFE_ES_NoArgsCmd_t
\par Command Verification
Successful execution of this command may be verified with the
following telemetry:
- \b \c \ES_CMDPC - command execution counter will
increment
- The #CFE_ES_NOOP_INF_EID informational event message will
be generated
\par Error Conditions
This command may fail for the following reason(s):
- The command packet length is incorrect
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- the #CFE_ES_LEN_ERR_EID error event message will be generated
\par Criticality
None
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.Command" value="0" />
</ConstraintSet>
</ContainerDataType>
<ContainerDataType name="ResetCounters" baseType="CommandBase">
<LongDescription>
\cfeescmd Executive Services Reset Counters
\par Description
This command resets the following counters within the Executive
Services housekeeping telemetry:
- Command Execution Counter
- Command Error Counter
\cfecmdmnemonic \ES_RESETCTRS
\par Command Structure
#CFE_ES_NoArgsCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \ES_CMDPC - command execution counter will
increment
- The #CFE_ES_RESET_INF_EID informational event message will be
generated
\par Error Conditions
This command may fail for the following reason(s):
- The command packet length is incorrect
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- the #CFE_ES_LEN_ERR_EID error event message will be generated
\par Criticality
This command is not inherently dangerous. However, it is
possible for ground systems and on-board safing procedures
to be designed such that they react to changes in the counter
values that are reset by this command.
\sa #CFE_ES_RESET_PR_COUNT_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.Command" value="1" />
</ConstraintSet>
</ContainerDataType>
<ContainerDataType name="Restart" baseType="CommandBase">
<LongDescription>
\cfeescmd Executive Services Processor / Power-On Reset
\par Description
This command restarts the cFE in one of two modes. The Power-On Reset
will cause the cFE to restart as though the power were first applied
to the processor. The Processor Reset will attempt to retain the contents
of the volatile disk and the contents of the Critical Data Store.
NOTE: If a requested Processor Reset should cause the
Processor Reset Counter (\b \c \ES_PROCRESETCNT)
to exceed OR EQUAL the limit #CFE_ES_MAX_PROCESSOR_RESETS (which is reported in
housekeeping telemetry as \b \c \ES_MAXPROCRESETS),
the command is \b AUTOMATICALLY upgraded to a Power-On Reset.
\cfecmdmnemonic \ES_RESET
\par Command Structure
#CFE_ES_RestartCmd_t
\par Command Verification
Successful execution of this command (as a Processor Reset)
may be verified with the following telemetry:
- \b \c \ES_PROCRESETCNT - processor reset counter will increment
- New entries in the Exception Reset Log and System Log can be found
NOTE: Verification of a Power-On Reset is shown through the loss of
data nominally retained through a Processor Reset
NOTE: Since the reset of the processor resets the command execution
counter (\b \c \ES_CMDPC), this counter \b CANNOT be used to verify
command execution.
\par Error Conditions
This command may fail for the following reason(s):
- The command packet length is incorrect
- The \link #CFE_ES_RestartCmd_t.RestartType Restart Type \endlink was
not a recognized value.
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- the #CFE_ES_BOOT_ERR_EID error event message will be generated
\par Criticality
This command is, by definition, dangerous. Significant loss of
data will occur. All processes and the cFE itself will be stopped
and restarted. With the Power-On reset option, all data on the
volatile disk and the contents of the Critical Data Store will be
lost.
\sa #CFE_ES_RESET_PR_COUNT_CC, #CFE_ES_SET_MAX_PR_COUNT_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.Command" value="2" />
</ConstraintSet>
<EntryList>
<Entry type="RestartCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="Shell" baseType="CommandBase">
<LongDescription>
\cfeescmd Executive Services O/S Shell Command
\par Description
This command passes an ASCII string as a command line to the
underlying realtime operating system shell. Any response to
the command is both written to the shell command output file
and sent as a series of shell command output telemetry packets.
If the shell command output filename argument is empty, then
#CFE_ES_DEFAULT_SHELL_FILENAME will be used as the filename.
\cfecmdmnemonic \ES_SHELL
\par Command Structure
#CFE_ES_ShellCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \ES_CMDPC - command execution counter will
increment
- The #CFE_ES_SHELL_INF_EID informational event message will be
generated
\par Error Conditions
This command may fail for the following reason(s):
- The command packet length is incorrect
- Failure to create the shell command output file
- The shell command started with ES_ but was not one of the
recognized cFE shell commands
- There was an error while performing a #OS_lseek on the shell command output file
- There was an error while redirecting the shell command response to the
shell command output file
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- the #CFE_ES_SHELL_ERR_EID error event message will be generated
- Additional information on the error should be found in the System Log
\par Criticality
This command should be used with caution. Interfering with the
operation of the underlying realtime operating system can cause
significant problems.
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.Command" value="3" />
</ConstraintSet>
<EntryList>
<Entry type="ShellCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="StartApp" baseType="CommandBase">
<LongDescription>
\cfeescmd Load and Start an Application
\par Description
This command starts the specified application with the
specified start address, stack size, etc options.
\cfecmdmnemonic \ES_STARTAPP
\par Command Structure
#CFE_ES_StartAppCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \ES_CMDPC - command execution counter will
increment
- The #CFE_ES_START_INF_EID informational event message will be
generated
\par Error Conditions
This command may fail for the following reason(s):
- The command packet length is incorrect
- The specified application filename string is either a NULL string
or less than four characters in length
- The specified application entry point is a NULL string
- The specified application name is a NULL string
- The specified stack size is less than #CFE_ES_DEFAULT_STACK_SIZE
- The specified priority is greater than #OS_MAX_PRIORITY
- The specified exception action is neither #CFE_ES_ExceptionAction_RESTART_APP (0) or
#CFE_ES_ExceptionAction_PROC_RESTART (1)
- The Operating System was unable to load the specified application file
Evidence of failure may be found in the following telemetry:
- \b \c \ES_CMDEC - command error counter will increment
- A command specific error event message is issued for all error
cases
\par Criticality
This command is not inherently dangerous although system resources
could be taxed beyond their limits with the starting of erroneous
or invalid applications.
\sa #CFE_ES_STOP_APP_CC, #CFE_ES_RESTART_APP_CC, #CFE_ES_RELOAD_APP_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.Command" value="4" />
</ConstraintSet>
<EntryList>
<Entry type="StartAppCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="StopApp" baseType="CommandBase">
<LongDescription>
\cfeescmd Stop and Unload Application
\par Description
This command halts and removes the specified Application
from the system. \b NOTE: This command should never be used
on the Command Ingest application. This would prevent further
commands from entering the system. If Command Ingest needs to
be stopped and restarted, use #CFE_ES_RESTART_APP_CC or
#CFE_ES_RELOAD_APP_CC.
\cfecmdmnemonic \ES_STOPAPP
\par Command Structure
#CFE_ES_AppNameCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \ES_CMDPC - command execution counter will
increment