-
Notifications
You must be signed in to change notification settings - Fork 204
/
cfe_es_msg.h
1631 lines (1531 loc) · 64.7 KB
/
cfe_es_msg.h
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
/*
** 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.
*/
/*
** File: cfe_es_msg.h
**
** Purpose:
** cFE Executive Services (ES) Command and Telemetry packet definition file.
**
** References:
** Flight Software Branch C Coding Standard Version 1.0a
** cFE Flight Software Application Developers Guide
**
** Notes:
**
*/
/*************************************************************************/
#ifndef _cfe_es_msg_
#define _cfe_es_msg_
/*
** Includes
*/
#include "cfe.h"
#include "cfe_es.h"
/*
** ES task command packet command codes
*/
/** \name Executive Services Command Codes */
/** \{ */
/** \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
**
** \sa
*/
#define CFE_ES_NOOP_CC 0
/** \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
*/
#define CFE_ES_RESET_COUNTERS_CC 1
/** \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_PLATFORM_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_Payload_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<BR>
** NOTE: Verification of a Power-On Reset is shown through the loss of
** data nominally retained through a Processor Reset<BR>
** 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_Payload_t 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
*/
#define CFE_ES_RESTART_CC 2
#ifndef CFE_OMIT_DEPRECATED_6_7
/** \cfeescmd DEPRECATED: Executive Services O/S Shell Command
** \deprecated
**
** \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_PLATFORM_ES_DEFAULT_SHELL_FILENAME will be used as the filename.
**
** \cfecmdmnemonic \ES_SHELL
**
** \par Command Structure
** #CFE_ES_Shell_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 <tt> ES_ </tt> 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.
**
** \sa
*/
#define CFE_ES_SHELL_CC 3
#endif /* CFE_OMIT_DEPRECATED_6_7 */
/** \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_StartApp_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_PLATFORM_ES_DEFAULT_STACK_SIZE
** - The specified priority is greater than MAX_PRIORITY (as defined in osapi.c)
** - 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
*/
#define CFE_ES_START_APP_CC 4
/** \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
** - The #CFE_ES_STOP_DBG_EID debug event message will be
** generated. NOTE: This event message only identifies that the
** stop has been started, not that is has completed.
** - Once the stop has successfully completed, the list of Applications
** and Tasks created in response to the \b \c \ES_WRITEAPPINFO2FILE,
** \b \c \ES_WRITETASKINFO2FILE should no longer contain the
** specified application.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - The specified application name is not recognized as an active application
** - The specified application is one of the cFE's Core applications (ES, EVS, SB, TBL, TIME)
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
** - Additional information on the reason for command failure may be found
** in the System Log
**
** \par Criticality
** This command is not inherently dangerous, however the removal of certain
** applications (e.g. - Spacecraft Attitude and Control) may have a detrimental effect
** on the spacecraft.
**
** \sa #CFE_ES_START_APP_CC, #CFE_ES_RESTART_APP_CC, #CFE_ES_RELOAD_APP_CC
*/
#define CFE_ES_STOP_APP_CC 5
/** \cfeescmd Stops and Restarts an Application
**
** \par Description
** This command halts and restarts the specified Application.
** This command does \b NOT reload the application from the onboard
** filesystem.
**
** \cfecmdmnemonic \ES_RESTARTAPP
**
** \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
** - The #CFE_ES_RESTART_APP_DBG_EID debug event message will be
** generated. NOTE: This event message only identifies that the
** act of stopping the application has begun, not that is has completed.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - The specified application name is not recognized as an active application
** - The specified application is one of the cFE's Core applications (ES, EVS, SB, TBL, TIME)
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
** - Additional information on the reason for command failure may be found
** in the System Log
**
** \par Criticality
** This command is not inherently dangerous, however the restarting of certain
** applications (e.g. - Spacecraft Attitude and Control) may have a detrimental effect
** on the spacecraft.
**
** \sa #CFE_ES_START_APP_CC, #CFE_ES_STOP_APP_CC, #CFE_ES_RELOAD_APP_CC
*/
#define CFE_ES_RESTART_APP_CC 6
/** \cfeescmd Stops, Unloads, Loads from a File and Restarts an Application
**
** \par Description
** This command halts and removes the specified Application
** from the system. Then it immediately loads the Application from
** the command specified file and restarts it. This command is
** especially useful for restarting a Command Ingest Application
** since once it has been stopped, no further commands can come in
** to restart it.
**
** \cfecmdmnemonic \ES_RELOADAPP
**
** \par Command Structure
** #CFE_ES_ReloadApp_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_RELOAD_APP_DBG_EID debug event message will be
** generated. NOTE: This event message only identifies that the
** act of stopping the application has begun, not that is has completed.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - The specified application name is not recognized as an active application
** - The specified application is one of the cFE's Core applications (ES, EVS, SB, TBL, TIME)
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
** - Additional information on the reason for command failure may be found
** in the System Log
**
** \par Criticality
** This command is not inherently dangerous, however the restarting of certain
** applications (e.g. - Spacecraft Attitude and Control) may have a detrimental effect
** on the spacecraft.
**
** \sa #CFE_ES_START_APP_CC, #CFE_ES_STOP_APP_CC, #CFE_ES_RESTART_APP_CC
*/
#define CFE_ES_RELOAD_APP_CC 7
/** \cfeescmd Request Executive Services Information on a Specified Application
**
** \par Description
** This command takes the information kept by Executive Services on the
** specified application and telemeters it to the ground.
**
** \cfecmdmnemonic \ES_QUERYAPP
**
** \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
** - The #CFE_ES_ONE_APP_EID debug event message will be
** generated. NOTE: This event message only identifies that the
** act of stopping the application has begun, not that is has completed.
** - Receipt of the #CFE_ES_OneAppTlm_t telemetry packet
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - The specified application name is not recognized as an active application
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** None
**
** \sa #CFE_ES_QUERY_ALL_CC, #CFE_ES_QUERY_ALL_TASKS_CC
*/
#define CFE_ES_QUERY_ONE_CC 8
/** \cfeescmd Writes all Executive Services Information on All Applications to a File
**
** \par Description
** This command takes the information kept by Executive Services on all of the
** registered applications and writes it to the specified file.
**
** \cfecmdmnemonic \ES_WRITEAPPINFO2FILE
**
** \par Command Structure
** #CFE_ES_FileNameCmd_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_ALL_APPS_EID debug event message will be
** generated.
** - The file specified in the command (or the default specified
** by the #CFE_PLATFORM_ES_DEFAULT_APP_LOG_FILE configuration parameter) will be
** updated with the lastest information.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - An Error occurs while trying to write to the file
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not inherently dangerous. It will create a new
** file in the file system (or overwrite an existing one) and could,
** if performed repeatedly without sufficient file management by the
** operator, fill the file system.
**
** \sa #CFE_ES_QUERY_ONE_CC, #CFE_ES_QUERY_ALL_TASKS_CC
*/
#define CFE_ES_QUERY_ALL_CC 9
/** \cfeescmd Clear Executive Services System Log
**
** \par Description
** This command clears the contents of the Executive Services System Log.
**
** \cfecmdmnemonic \ES_CLEARSYSLOG
**
** \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_SYSLOG1_INF_EID informational event message will be
** generated.
** - \b \c \ES_SYSLOGBYTEUSED - System Log Bytes Used will go to zero
** - \b \c \ES_SYSLOGENTRIES - Number of System Log Entries will go to zero
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not dangerous. However, any previously logged data
** will be lost.
**
** \sa #CFE_ES_WRITE_SYSLOG_CC, #CFE_ES_CLEAR_ER_LOG_CC, #CFE_ES_WRITE_ER_LOG_CC,
** #CFE_ES_OVER_WRITE_SYSLOG_CC
*/
#define CFE_ES_CLEAR_SYSLOG_CC 10
/** \cfeescmd Writes contents of Executive Services System Log to a File
**
** \par Description
** This command causes the contents of the Executive Services System Log
** to be written to a log file.
**
** \cfecmdmnemonic \ES_WRITESYSLOG2FILE
**
** \par Command Structure
** #CFE_ES_FileNameCmd_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_SYSLOG2_EID debug event message will be
** generated.
** - The file specified in the command (or the default specified
** by the #CFE_PLATFORM_ES_DEFAULT_SYSLOG_FILE configuration parameter) will be
** updated with the lastest information.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - An Error occurs while trying to write to the file
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not inherently dangerous. It will create a new
** file in the file system (or overwrite an existing one) and could,
** if performed repeatedly without sufficient file management by the
** operator, fill the file system.
**
** \sa #CFE_ES_CLEAR_SYSLOG_CC, #CFE_ES_CLEAR_ER_LOG_CC, #CFE_ES_WRITE_ER_LOG_CC,
** #CFE_ES_OVER_WRITE_SYSLOG_CC
*/
#define CFE_ES_WRITE_SYSLOG_CC 11
/** \cfeescmd Clears the contents of the Exeception and Reset Log
**
** \par Description
** This command causes the contents of the Executive Services Exception
** and Reset Log to be cleared.
**
** \cfecmdmnemonic \ES_CLEARERLOG
**
** \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_ERLOG1_INF_EID informational event message will be
** generated.
** - \b \c \ES_ERLOGINDEX - Index into Exception Reset Log goes to zero
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not dangerous. However, any previously logged data
** will be lost.
**
** \sa #CFE_ES_CLEAR_SYSLOG_CC, #CFE_ES_WRITE_SYSLOG_CC, #CFE_ES_WRITE_ER_LOG_CC
*/
#define CFE_ES_CLEAR_ER_LOG_CC 12
/** \cfeescmd Writes Exeception and Reset Log to a File
**
** \par Description
** This command causes the contents of the Executive Services Exception
** and Reset Log to be written to the specified file.
**
** \cfecmdmnemonic \ES_WRITEERLOG2FILE
**
** \par Command Structure
** #CFE_ES_FileNameCmd_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_ERLOG2_EID debug event message will be
** generated.
** - The file specified in the command (or the default specified
** by the #CFE_PLATFORM_ES_DEFAULT_ER_LOG_FILE configuration parameter) will be
** updated with the lastest information.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - An Error occurs while trying to write to the file
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not inherently dangerous. It will create a new
** file in the file system (or overwrite an existing one) and could,
** if performed repeatedly without sufficient file management by the
** operator, fill the file system.
**
** \sa #CFE_ES_CLEAR_SYSLOG_CC, #CFE_ES_WRITE_SYSLOG_CC, #CFE_ES_CLEAR_ER_LOG_CC
*/
#define CFE_ES_WRITE_ER_LOG_CC 13
/** \cfeescmd Start Performance Analyzer
**
** \par Description
** This command causes the Performance Analyzer to begin collecting data using the specified trigger mode.
**
** \cfecmdmnemonic \ES_STARTLADATA
**
** \par Command Structure
** #CFE_ES_StartPerfData_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
** - \b \c \ES_PERFSTATE - Current performance analyzer state will change to
** either WAITING FOR TRIGGER or, if conditions are appropriate fast enough,
** TRIGGERED.
** - \b \c \ES_PERFMODE - Performance Analyzer Mode will change to the commanded trigger mode (TRIGGER START,
** TRIGGER CENTER, or TRIGGER END).
** - \b \c \ES_PERFTRIGCNT - Performance Trigger Count will go to zero
** - \b \c \ES_PERFDATASTART - Data Start Index will go to zero
** - \b \c \ES_PERFDATAEND - Data End Index will go to zero
** - \b \c \ES_PERFDATACNT - Performance Data Counter will go to zero
** - The #CFE_ES_PERF_STARTCMD_EID debug event message will be
** generated.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - A previous #CFE_ES_STOP_PERF_DATA_CC command has not completely finished.
** - An invalid trigger mode is requested.
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not inherently dangerous but may cause a small increase in CPU
** utilization as the performance analyzer data is collected.
**
** \sa #CFE_ES_STOP_PERF_DATA_CC, #CFE_ES_SET_PERF_FILTER_MASK_CC, #CFE_ES_SET_PERF_TRIGGER_MASK_CC
*/
#define CFE_ES_START_PERF_DATA_CC 14
/** \cfeescmd Stop Performance Analyzer
**
** \par Description
** This command stops the Performance Analyzer from collecting any more data.
**
** \cfecmdmnemonic \ES_STOPLADATA
**
** \par Command Structure
** #CFE_ES_StopPerfData_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
** - \b \c \ES_PERFSTATE - Current performance analyzer state will change to
** IDLE.
** - The #CFE_ES_PERF_STOPCMD_EID debug event message will be
** generated.
** - The file specified in the command (or the default specified
** by the #CFE_PLATFORM_ES_DEFAULT_PERF_DUMP_FILENAME configuration parameter) will be
** updated with the lastest information.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - A previous Stop Performance Analyzer command is still in process
** - An error occurred while spawning the child task responsible for
** dumping the Performance Analyzer data to a file
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not inherently dangerous. An additional low priority child
** task will be spawned, however, to dump the performance analyzer data to a file.
**
** \sa #CFE_ES_START_PERF_DATA_CC, #CFE_ES_SET_PERF_FILTER_MASK_CC, #CFE_ES_SET_PERF_TRIGGER_MASK_CC
*/
#define CFE_ES_STOP_PERF_DATA_CC 15
/** \cfeescmd Set Performance Analyzer's Filter Masks
**
** \par Description
** This command sets the Performance Analyzer's Filter Masks.
**
** \cfecmdmnemonic \ES_LAFILTERMASK
**
** \par Command Structure
** #CFE_ES_SetPerfFilterMask_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
** - \b \c \ES_PERFFLTRMASK - the current performance filter mask
** value(s) should reflect the commanded value
** - The #CFE_ES_PERF_FILTMSKCMD_EID debug event message will be
** generated.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - The Filter Mask ID number is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** Changing the filter masks may cause a small change in the Performance
** Analyzer's CPU utilization.
**
** \sa #CFE_ES_START_PERF_DATA_CC, #CFE_ES_STOP_PERF_DATA_CC, #CFE_ES_SET_PERF_TRIGGER_MASK_CC
*/
#define CFE_ES_SET_PERF_FILTER_MASK_CC 16
/** \cfeescmd Set Performance Analyzer's Trigger Masks
**
** \par Description
** This command sets the Performance Analyzer's Trigger Masks.
**
** \cfecmdmnemonic \ES_LATRIGGERMASK
**
** \par Command Structure
** #CFE_ES_SetPerfTriggerMask_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
** - \b \c \ES_PERFTRIGMASK - the current performance trigger mask
** value(s) should reflect the commanded value
** - The #CFE_ES_PERF_TRIGMSKCMD_EID debug event message will be
** generated.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - The Trigger Mask ID number is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** Changing the trigger masks may cause a small change in the Performance
** Analyzer's CPU utilization.
**
** \sa #CFE_ES_START_PERF_DATA_CC, #CFE_ES_STOP_PERF_DATA_CC, #CFE_ES_SET_PERF_FILTER_MASK_CC
*/
#define CFE_ES_SET_PERF_TRIGGER_MASK_CC 17
/** \cfeescmd Set Executive Services System Log Mode to Discard/Overwrite
**
** \par Description
** This command allows the user to configure the Executive Services
** to either discard new System Log messages when it is full or to
** overwrite the oldest messages.
**
** \cfecmdmnemonic \ES_OVERWRITESYSLOGMODE
**
** \par Command Structure
** #CFE_ES_OverWriteSyslog_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
** - \b \c \ES_SYSLOGMODE - Current System Log Mode should reflect
** the commanded value
** - The #CFE_ES_SYSLOGMODE_EID debug event message will be
** generated.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - The desired mode is neither #CFE_ES_LogMode_OVERWRITE or #CFE_ES_LogMode_DISCARD
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** None. (It should be noted that "Overwrite" mode would allow a message
** identifying the cause of a problem to be lost by a subsequent flood of
** additional messages).
**
** \sa #CFE_ES_CLEAR_SYSLOG_CC, #CFE_ES_WRITE_SYSLOG_CC
*/
#define CFE_ES_OVER_WRITE_SYSLOG_CC 18
/** \cfeescmd Resets the Processor Reset Counter to Zero
**
** \par Description
** This command allows the user to reset the Processor Reset Counter to zero.
** The Processor Reset Counter counts the number of Processor Resets that
** have occurred so as to identify when a Processor Reset should automatically
** be upgraded to a full Power-On Reset.
**
** \cfecmdmnemonic \ES_RESETPRCNT
**
** \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
** - \b \c \ES_PROCRESETCNT - Current number of processor resets will go to zero
** - The #CFE_ES_RESET_PR_COUNT_EID informational event message will be
** generated.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not critical. The only impact would be that the system
** would have to have more processor resets before an automatic power-on reset
** occurred.
**
** \sa #CFE_ES_SET_MAX_PR_COUNT_CC, #CFE_ES_RESET_COUNTERS_CC
*/
#define CFE_ES_RESET_PR_COUNT_CC 19
/** \cfeescmd Configure the Maximum Number of Processor Resets before a Power-On Reset
**
** \par Description
** This command allows the user to specify the number of Processor Resets that
** are allowed before the next Processor Reset is upgraded to a Power-On Reset.
**
** \cfecmdmnemonic \ES_SETMAXPRCNT
**
** \par Command Structure
** #CFE_ES_SetMaxPRCount_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
** - \b \c \ES_MAXPROCRESETS - Current maximum number of processor resets
** before an automatic power-on reset will go to the command specified value.
** - The #CFE_ES_SET_MAX_PR_COUNT_EID informational event message will be
** generated.
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** If the operator were to set the Maximum Processor Reset Count to too high a value,
** the processor would require an inordinate number of consecutive processor resets
** before an automatic power-on reset would occur. This could potentially leave the
** spacecraft without any control for a significant amount of time if a processor reset
** fails to clear a problem.
**
** \sa #CFE_ES_RESET_PR_COUNT_CC
*/
#define CFE_ES_SET_MAX_PR_COUNT_CC 20
/** \cfeescmd Delete Critical Data Store
**
** \par Description
** This command allows the user to delete a Critical Data Store that was created
** by an Application that is now no longer executing.
**
** \cfecmdmnemonic \ES_DELETECDS
**
** \par Command Structure
** #CFE_ES_DeleteCDS_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_CDS_DELETED_INFO_EID informational event message will be
** generated.
** - The specified CDS should no longer appear in a CDS Registry dump generated
** upon receipt of the #CFE_ES_DUMP_CDS_REGISTRY_CC command
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - The command packet length is incorrect
** - The specified CDS is the CDS portion of a Critical Table. See #CFE_TBL_DELETE_CDS_CC.
** - The specified CDS is not found in the CDS Registry
** - The specified CDS is associated with an Application that is still active
** - An error occurred while accessing the CDS memory (see the System Log for more details)
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \ES_CMDEC - command error counter will increment
** - A command specific error event message is issued for all error
** cases
**
** \par Criticality
** This command is not critical because it is not possible to delete a CDS that is
** associated with an active application. However, deleting a CDS does eliminate
** any "history" that an application may be wishing to keep.
**
** \sa #CFE_ES_DUMP_CDS_REGISTRY_CC, #CFE_TBL_DELETE_CDS_CC
*/
#define CFE_ES_DELETE_CDS_CC 21
/** \cfeescmd Telemeter Memory Pool Statistics
**
** \par Description
** This command allows the user to obtain a snapshot of the statistics maintained
** for a specified memory pool.
**
** \cfecmdmnemonic \ES_TLMPOOLSTATS
**
** \par Command Structure
** #CFE_ES_SendMemPoolStats_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_TLM_POOL_STATS_INFO_EID debug event message will be
** generated.
** - The \link #CFE_ES_MemStatsTlm_t Memory Pool Statistics Telemetry Packet \endlink
** is produced
**
** \par Error Conditions