-
Notifications
You must be signed in to change notification settings - Fork 207
/
cfe_es_events.h
1494 lines (1374 loc) · 56 KB
/
cfe_es_events.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_events.h
**
** Purpose:
** cFE Executive Services (ES) Event IDs
**
** References:
** Flight Software Branch C Coding Standard Version 1.0a
** cFE Flight Software Application Developers Guide
**
** Notes:
**
*/
/*************************************************************************/
#ifndef _cfe_es_events_
#define _cfe_es_events_
/* **************************
** ****** Maximum EID. ******
** **************************
** The EID's below may not necessarily be in order, so it can be difficult to
** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1
** and when you're done adding, set this to the highest EID you used. It may
** be worthwhile to, on occasion, re-number the EID's to put them back in order.
*/
#define CFE_ES_MAX_EID 92
/*
** ES task event message ID's.
*/
/** \brief <tt> 'cFE ES Initialized' </tt>
** \event <tt> 'cFE ES Initialized' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is always automatically issued when the Executive Services
** Task completes its Initialization.
**/
#define CFE_ES_INIT_INF_EID 1 /* start up message "informational" */
/** \brief <tt> 'cFE Version \%d.\%d.\%d chksm \%d, OSAL Version \%d.\%d' </tt>
** \event <tt> 'cFE Version \%d.\%d.\%d chksm \%d, OSAL Version \%d.\%d' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is always automatically issued when the Executive Services
** Task completes its Initialization.
**
** The \c Version field identifies the tagged version for the cFE Build, the \c chksm field
** provides the 16-bit checksum of the cFE Build and the \c OSAL \c Version field identifies
** the version of the OS Abstraction Layer on which this particular version of the cFE was built.
**/
#define CFE_ES_INITSTATS_INF_EID 2
/** \brief <tt> 'No-op command' </tt>
** \event <tt> 'No-op command' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is always automatically issued in response
** to a cFE Executive Services \link #CFE_ES_NOOP_CC NO-OP command \endlink
**/
#define CFE_ES_NOOP_INF_EID 3 /* processed command "informational" */
/** \brief <tt> 'Reset Counters command' </tt>
** \event <tt> 'Reset Counters command' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is always automatically issued in response
** to a cFE Executive Services \link #CFE_ES_RESET_COUNTERS_CC Reset Counters command \endlink
**/
#define CFE_ES_RESET_INF_EID 4
/** \brief <tt> 'Started \%s from \%s, AppID = \%d' </tt>
** \event <tt> 'Started \%s from \%s, AppID = \%d' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is automatically issued upon successful completion of
** a cFE Executive Services \link #CFE_ES_START_APP_CC Start Application command \endlink
**
** The first \c 's' string identifies the name of the started Application, the
** second \c 's' string identifies the filename from which the Application was
** loaded and the \c AppId field specifies the Application ID assigned to the
** newly started Application by the cFE Executive Services.
**/
#define CFE_ES_START_INF_EID 6
/** \brief <tt> 'Stop Application \%s Initiated.' </tt>
** \event <tt> 'Stop Application \%s Initiated.' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is issued upon successful processing of the
** cFE Executive Services \link #CFE_ES_STOP_APP_CC Stop Application command \endlink
** Note that when this event is displayed, the Application is not deleted. ES has
** accepted the request to delete the application, and it will be deleted after the app exits
** it's main loop, or times out.
**
** The \c 's' field identifies the name of the Application that will be stopped.
**/
#define CFE_ES_STOP_DBG_EID 7
/** \brief <tt> 'Stop Application \%s Completed.' </tt>
** \event <tt> 'Stop Application \%s Completed.' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is issued when the cFE finishes deleting the cFE Application
** That was started when the \link #CFE_ES_STOP_APP_CC Stop Application command \endlink
** was issued.
**
** The \c 's' field identifies the name of the Application that was stopped.
*/
#define CFE_ES_STOP_INF_EID 8
/** \brief <tt> 'Restart Application \%s Initiated.' </tt>
** \event <tt> 'Restart Application \%s Initiated.' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is issued upon successful processing of the
** cFE Executive Services \link #CFE_ES_RESTART_APP_CC Restart Application command \endlink
** Note that when this event is displayed, the Application is not restarted. ES has
** accepted the request to restart the application, and it will be restarted after the app exits
** it's main loop, or times out.
**
** The \c 's' field identifies the name of the Application that will be restarted.
**/
#define CFE_ES_RESTART_APP_DBG_EID 9
/** \brief <tt> 'Restart Application \%s Completed.' </tt>
** \event <tt> 'Restart Application \%s Completed.' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is issued when the cFE finishes Restarting the cFE Application
** That was started when the \link #CFE_ES_RESTART_APP_CC Restart Application command \endlink
** was issued.
**
** The \c 's' field identifies the name of the Application that was reloaded.
*/
#define CFE_ES_RESTART_APP_INF_EID 10
/** \brief <tt> 'Reload Application \%s Initiated.' </tt>
** \event <tt> 'Reload Application \%s Initiated.' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is issued upon successful processing of the
** cFE Executive Services \link #CFE_ES_RELOAD_APP_CC Reload Application command \endlink
** Note that when this event is displayed, the Application is not reloaded. ES has
** accepted the request to reload the application, and it will be reloaded after the app exits
** it's main loop, or times out.
**
**
** The \c 's' field identifies the name of the Application that will be reloaded.
**/
#define CFE_ES_RELOAD_APP_DBG_EID 11
/** \brief <tt> 'Reload Application \%s Completed.' </tt>
** \event <tt> 'Reload Application \%s Completed.' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is issued when the cFE finishes Reloading the cFE Application
** That was started when the \link #CFE_ES_RELOAD_APP_CC Restart Application command \endlink
** was issued.
**
** The \c 's' field identifies the name of the Application that was reloaded.
*/
#define CFE_ES_RELOAD_APP_INF_EID 12
/** \brief <tt> 'Exit Application \%s Completed.' </tt>
** \event <tt> 'Exit Application \%s Completed.' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is issued when the cFE finishes exiting/cleaning up an
** application that called the CFE_ES_ExitApp API with the CFE_ES_RunStatus_APP_EXIT parameter.
** When an App calls this API, the request is recorded and the Executive Services App will
** actually delete cFE Application before issuing this event message.
**
** The \c 's' field identifies the name of the Application that was exited.
*/
#define CFE_ES_EXIT_APP_INF_EID 13
/** \brief <tt> 'Exit Application \%s Completed.' </tt>
** \event <tt> 'Exit Application \%s Completed.' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is issued when the cFE finishes exiting/cleaning up an
** application that called the CFE_ES_ExitApp API with an ERROR condition.
** When an App calls this API, with the CFE_ES_RunStatus_APP_ERROR parameter, it indicates
** that the Application exited due to an error condition. The details of the
** error that occurred should be given by the Application through an event message,
** System Log entry, or both.
** The request is recorded and the Executive Services App will actually delete
** cFE Application before issuing this event message.
**
** The \c 's' field identifies the name of the Application that was exited.
*/
#define CFE_ES_ERREXIT_APP_INF_EID 14
/** \brief <tt> 'Sent \%s application data' </tt>
** \event <tt> 'Sent \%s application data' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is issued upon successful completion of the
** cFE Executive Services \link #CFE_ES_QUERY_ONE_CC Query One Application command \endlink
**
** The \c 's' field identifies the name of the Application whose Executive Services
** Application information has been telemetered.
**/
#define CFE_ES_ONE_APP_EID 15
/** \brief <tt> 'App Info file written to \%s, Entries=\%d, FileSize=\%d' </tt>
** \event <tt> 'App Info file written to \%s, Entries=\%d, FileSize=\%d' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is issued upon successful completion of the cFE Executive
** Services \link #CFE_ES_QUERY_ALL_CC Query All Applications command \endlink
**
** The \c 's' field identifies the name of the file to which all Executive Services Application
** data has been written. The \c Entries field identifies, in decimal, the number of Applications
** whose data was written and the \c FileSize field gives the total number of bytes written to the
** file.
**/
#define CFE_ES_ALL_APPS_EID 16
/** \brief <tt> 'Cleared Executive Services log data' </tt>
** \event <tt> 'Cleared Executive Services log data' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is generated upon successful completion of the cFE Executive
** Services \link #CFE_ES_CLEAR_SYSLOG_CC Clear System Log command \endlink
**/
#define CFE_ES_SYSLOG1_INF_EID 17
/** \brief <tt> '\%s written:Size=\%d,Entries=\%d' </tt>
** \event <tt> '\%s written:Size=\%d,Entries=\%d' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is generated when the System Log has been successfully written
** to a file after receiving the cFE Executive Services \link #CFE_ES_CLEAR_SYSLOG_CC Write Executive
** Services System Log command \endlink
**
** The \c 's' field identifies the name of the file written to, the \c Size field specifies, in decimal,
** the number of bytes written to the file and the \c Entries field identifies the number of System Log
** messages that were written.
**/
#define CFE_ES_SYSLOG2_EID 18
/** \brief <tt> 'Cleared mode log data' </tt>
** \event <tt> 'Cleared mode log data' </tt>
**
** \par Type: INFORMATION
**
** \par Cause:
**
** This event message is generated upon successful completion of the cFE Executive
** Services \link #CFE_ES_CLEAR_ER_LOG_CC Clear Exception Reset Log command \endlink
**/
#define CFE_ES_ERLOG1_INF_EID 19
/** \brief <tt> '\%s written:Size=\%d' </tt>
** \event <tt> '\%s written:Size=\%d' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is generated when the Exception Reset Log has been successfully written
** to a file after receiving the cFE Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Write Executive
** Services Exception Reset Log command \endlink
**
** The \c 's' field identifies the name of the file written to and the \c Size field specifies, in decimal,
** the number of bytes written to the file.
**/
#define CFE_ES_ERLOG2_EID 20
/** \brief <tt> 'Invalid command pipe message ID: 0x\%X' </tt>
** \event <tt> 'Invalid command pipe message ID: 0x\%X' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when a message has arrived on
** the cFE Executive Services Application's Message Pipe that has a
** Message ID that is neither #CFE_ES_SEND_HK_MID or #CFE_ES_CMD_MID.
** Most likely, the cFE Software Bus routing table has become corrupt
** and is sending messages targeted for other Applications to the cFE
** Executive Services Application.
**
** The \c ID field in the event message identifies
** the message ID (in hex) that was found in the message.
**/
#define CFE_ES_MID_ERR_EID 21 /* invalid command packet "error" */
/** \brief <tt> 'Invalid ground command code: ID = 0x\%X, CC = \%d' </tt>
** \event <tt> 'Invalid ground command code: ID = 0x\%X, CC = \%d' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when a message with the #CFE_ES_CMD_MID
** message ID has arrived but whose Command Code is not one of the command
** codes specified in \link #CFE_ES_NOOP_CC cfe_es.h \endlink. This
** problem is most likely to occur when:
** -# A Message ID meant for another Application became corrupted and was
** set equal to #CFE_ES_CMD_MID.
** -# The Command Code field in the Message became corrupted.
** -# The command database at the ground station has been corrupted.
**
** The \c ID field in the event message specifies the Message ID (in hex) and the
** \c CC field specifies the Command Code (in decimal) found in the message.
**/
#define CFE_ES_CC1_ERR_EID 22
/** \brief <tt> 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d' </tt>
** \event <tt> 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when a message with the #CFE_ES_CMD_MID
** message ID has arrived but whose packet length does not match the expected
** length for the specified command code.
**
** The \c ID field in the event message specifies the Message ID (in hex), the \c CC field
** specifies the Command Code (in decimal), the \c Exp Len field specified the Expected
** Length (in decimal ), and \c Len specifies the message Length (in decimal)
** found in the message.
**/
#define CFE_ES_LEN_ERR_EID 23
/** \brief <tt> 'Invalid cFE restart type \%d' </tt>
** \event <tt> 'Invalid cFE restart type \%d' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is issued when the cFE Executive Services receives a
** \link #CFE_ES_RESTART_CC cFE Restart Command \endlink whose parameter
** identifying the restart type is not equal to either #CFE_PSP_RST_TYPE_PROCESSOR
** or #CFE_PSP_RST_TYPE_POWERON.
**
** The 'd' field identifies the numeric, in decimal, of the restart type found
** in the received cFE Restart Command Packet.
**/
#define CFE_ES_BOOT_ERR_EID 24 /* command specific "error" */
/** \brief <tt> 'Failed to start \%s from \%s, RC = \%08X' </tt>
** \event <tt> 'Failed to start \%s from \%s, RC = \%08X' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated for an error encountered in response
** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
**
** This message is a general failure when the command passes the parameter validation, but
** fails when a call to CFE_ES_AppCreate is called.
**
** The \c 's' term identifies the name of the Application that was attempted to start.
** The second \c 's' field specifies the file from which the Application was loaded.
** The \c 'X' field is the return code returned by the CFE_ES_AppCreate.
**/
#define CFE_ES_START_ERR_EID 26
/** \brief <tt> 'CFE_ES_StartAppCmd: invalid filename: \%s' </tt>
** \event <tt> 'CFE_ES_StartAppCmd: invalid filename: \%s' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated for an error encountered in response
** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
**
** This message reports a command failure when the Start Appplication Command is given
** an invalid filename. ( Either NULL or too short to be a valid cFE file name ).
**
** The \c 's' term identifies the invalid filename that was sent with the command.
**/
#define CFE_ES_START_INVALID_FILENAME_ERR_EID 27
/** \brief <tt> 'CFE_ES_StartAppCmd: App Entry Point is NULL.' </tt>
** \event <tt> 'CFE_ES_StartAppCmd: App Entry Point is NULL.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated for an error encountered in response
** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
**
** This message reports a command failure when the Start Appplication Command is given
** a NULL Application Entry Point parameter. The command must contain an application entry
** point string. ( Example: "SC_AppMain" ).
**
**/
#define CFE_ES_START_INVALID_ENTRY_POINT_ERR_EID 28
/** \brief <tt> 'CFE_ES_StartAppCmd: App Name is NULL.' </tt>
** \event <tt> 'CFE_ES_StartAppCmd: App Name is NULL.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated for an error encountered in response
** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
**
** This message reports a command failure when the Start Appplication Command is given
** a NULL Application Name parameter. The command must contain an application name string.
**/
#define CFE_ES_START_NULL_APP_NAME_ERR_EID 29
/** \brief <tt> 'CFE_ES_StartAppCmd: Stack size is less than system Minimum: \%d.' </tt>
** \event <tt> 'CFE_ES_StartAppCmd: Stack size is less than system Minimum: \%d.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated for an error encountered in response
** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
**
** This message reports a command failure when the Application Stack Size parameter is
** less than the default stack size defined in the cfe_platform_cfg.h file: CFE_PLATFORM_ES_DEFAULT_STACK_SIZE.
**
** The \c 'd' term identifies the size of the stack that was given in the command.
**/
#define CFE_ES_START_STACK_ERR_EID 30
/** \brief <tt> 'CFE_ES_StartAppCmd: Priority is too large: \%d.' </tt>
** \event <tt> 'CFE_ES_StartAppCmd: Priority is too large: \%d.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated for an error encountered in response
** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
**
** This message reports a command failure when the Application priority greater than the
** maximum priority for a Task defined by the OS Abstraction Layer ( 256 ).
**
** The \c 'd' term identifies the priority that was given in the command.
**/
#define CFE_ES_START_PRIORITY_ERR_EID 31
/** \brief <tt> 'CFE_ES_StartAppCmd: Invalid Exception Action: \%d.' </tt>
** \event <tt> 'CFE_ES_StartAppCmd: Invalid Exception Action: \%d.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated for an error encountered in response
** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink.
**
** This message reports a command failure when the Application Exception Action parameter is
** invalid. The valid options for this parameter are: 0 = Application will restart on an exception
** 1 = Application cause a processor restart on
** exception.
**
** The \c 'd' term identifies the Exception Action parameter that was given in the command.
**/
#define CFE_ES_START_EXC_ACTION_ERR_EID 32
/** \brief <tt> 'Exit Application \%s on Error Failed: CleanUpApp Error 0x\%08X.' </tt>
** \event <tt> 'Exit Application \%s on Error Failed: CleanUpApp Error 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when ES is completing the processing of the
** CFE_ES_ExitApp API call with the CFE_ES_RunStatus_APP_ERROR parameter and the call to CFE_ES_CleanUpApp fails.
** At this point the Application will likely be stopped or deleted, but it may be in an unknown state.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** reloaded and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_ERREXIT_APP_ERR_EID 33
/** \brief <tt> 'Stop Application \%s Failed, RC = 0x\%08X' </tt>
** \event <tt> 'Stop Application \%s Failed, RC = 0x\%08X' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** stopped and the \c rc field identifies the error code, in hex, that may identify
** the precise reason for the failure.
**/
#define CFE_ES_STOP_ERR1_EID 35
/** \brief <tt> 'Stop Application \%s, GetAppIDByName failed. RC = 0x\%08X.' </tt>
** \event <tt> 'Stop Application \%s, GetAppIDByName failed. RC = 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails. This message
** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application
** will not be deleted at this point.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** stopped and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_STOP_ERR2_EID 36
/*
** "Stop Application \%s Failed: CleanUpApp Error 0x\%08X."
*/
/** \brief <tt> 'Stop Application \%s Failed: CleanUpApp Error 0x\%08X.' </tt>
** \event <tt> 'Stop Application \%s Failed: CleanUpApp Error 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails. This message
** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application
** will not be deleted at this point.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** stopped and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_STOP_ERR3_EID 37
/** \brief <tt> 'Restart Application \%s Failed, RC = 0x\%08X' </tt>
** \event <tt> 'Restart Application \%s Failed, RC = 0x\%08X' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_RESTART_APP_CC Restart Application
** Command \endlink fails.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** reset and the \c rc field identifies the error code, in hex, that may identify
** the precise reason for the failure.
**/
#define CFE_ES_RESTART_APP_ERR1_EID 38
/** \brief <tt> 'Restart Application \%s, GetAppIDByName failed. RC = 0x\%08X.' </tt>
** \event <tt> 'Restart Application \%s, GetAppIDByName failed. RC = 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message
** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application
** will not be restarted at this point.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** restarted and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_RESTART_APP_ERR2_EID 39
/*
** "Restart Application \%s Failed: AppCreate Error 0x\%08X."
*/
/** \brief <tt> 'Restart Application \%s Failed: AppCreate Error 0x\%08X.' </tt>
** \event <tt> 'Restart Application \%s Failed: AppCreate Error 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message
** is for a specific failure when the call to CFE_ES_AppCreate fails. The application
** will not be restarted at this point.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** restarted and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_RESTART_APP_ERR3_EID 40
/** \brief <tt> 'Restart Application \%s Failed: CleanUpApp Error 0x\%08X.' </tt>
** \event <tt> 'Restart Application \%s Failed: CleanUpApp Error 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message
** is for a specific failure when the call to CFE_ES_CleanUpApp fails. The application
** will not be restarted at this point, but will likely be deleted or in an unknown state.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** restarted and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_RESTART_APP_ERR4_EID 41
/** \brief <tt> 'Failed to reload Application \%s, rc = \%08X' </tt>
** \event <tt> 'Failed to reload Application \%s, rc = \%08X' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_RELOAD_APP_CC Reload Application
** Command \endlink fails.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** reloaded and the \c rc field identifies the error code, in hex, that may identify
** the precise reason for the failure.
**/
#define CFE_ES_RELOAD_APP_ERR1_EID 42
/** \brief <tt> 'Reload Application \%s, GetAppIDByName failed. RC = 0x\%08X.' </tt>
** \event <tt> 'Reload Application \%s, GetAppIDByName failed. RC = 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message
** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application
** will not be reloaded at this point.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** reloaded and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_RELOAD_APP_ERR2_EID 43
/** \brief <tt> 'Reload Application \%s Failed: AppCreate Error 0x\%08X.' </tt>
** \event <tt> 'Reload Application \%s Failed: AppCreate Error 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message
** is for a specific failure when the call to CFE_ES_AppCreate fails. The application
** will not be reloaded at this point.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** reloaded and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_RELOAD_APP_ERR3_EID 44
/** \brief <tt> 'Reload Application \%s Failed: CleanUpApp Error 0x\%08X.' </tt>
** \event <tt> 'Reload Application \%s Failed: CleanUpApp Error 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an Executive Services
** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message
** is for a specific failure when the call to CFE_ES_CleanUpApp fails. The application
** will not be reloaded at this point, and will likely be deleted or in an unknown state.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** reloaded and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_RELOAD_APP_ERR4_EID 45
/** \brief <tt> 'Exit Application \%s Failed: CleanUpApp Error 0x\%08X.' </tt>
** \event <tt> 'Exit Application \%s Failed: CleanUpApp Error 0x\%08X.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when ES is completing the processing of the
** CFE_ES_ExitApp API call and the call to CFE_ES_CleanUpApp fails. At this point the Application will
** likely be stopped or deleted, but it may be in an unknown state.
**
** The \c 's' field identifies the name of the Application which was attempted to be
** reloaded and the \c RC field identifies the error code, in hex, that will identify
** the precise reason for the failure.
**/
#define CFE_ES_EXIT_APP_ERR_EID 46
/** \brief <tt> 'ES_ProcControlReq: Invalid State (EXCEPTION) Application \%s.' </tt>
** \event <tt> 'ES_ProcControlReq: Invalid State (EXCEPTION) Application \%s.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when ES is processing it's internal Application table and encounters
** an App with the EXCEPTION state. Because exceptions are supposed to be processed immediately, this is
** an invalid state and should not happen. It may indicate some sort of memory corruption or other problem.
**/
#define CFE_ES_PCR_ERR1_EID 47
/*
** "CFE_ES_CleanUpApp: Unknown State ( \%d ) Application \%s."
*/
/** \brief <tt> 'ES_ProcControlReq: Unknown State ( \%d ) Application \%s.' </tt>
** \event <tt> 'ES_ProcControlReq: Unknown State ( \%d ) Application \%s.' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when ES is processing it's internal Application table and encounters
** an App with an unknown state. If this message occurs, it might be an indication of a memory corruption
** or other problem.
**/
#define CFE_ES_PCR_ERR2_EID 48
/** \brief <tt> 'Failed to send \%s application data, RC = \%08X' </tt>
** \event <tt> 'Failed to send \%s application data, RC = \%08X' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ONE_CC Request Application
** Data Command \endlink failed.
**
** The \c 's' field identifies the name of the Application whose data was attempted
** to be telemetered and the \c rc field identifies the error code, in hex, that may identify
** the precise reason for the failure.
**/
#define CFE_ES_ONE_ERR_EID 49
/** \brief <tt> 'Failed to send \%s application data: GetAppIDByName Failed, RC = 0x\%08X' </tt>
** \event <tt> 'Failed to send \%s application data: GetAppIDByName Failed, RC = 0x\%08X' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ONE_CC Request Application
** Data Command \endlink failed.
**
** The \c 's' field identifies the name of the Application whose data was attempted
** to be telemetered and the \c rc field identifies the error code, in hex, that may identify
** the precise reason for the failure.
**/
#define CFE_ES_ONE_APPID_ERR_EID 50
/** \brief <tt> 'Failed to write App Info file, OS_creat returned \%d' </tt>
** \event <tt> 'Failed to write App Info file, OS_creat returned \%d' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application
** Data Command \endlink fails to create the dump file.
**
** The \c 'd' parameter identifies, in decimal, the error code returned by #OS_creat when the attempt was made
** to create the file.
**/
#define CFE_ES_OSCREATE_ERR_EID 51
/** \brief <tt> 'Failed to write App Info file, WriteHdr rtnd \%08X, exp \%d' </tt>
** \event <tt> 'Failed to write App Info file, WriteHdr rtnd \%08X, exp \%d' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application
** Data Command \endlink fails while writing the cFE Standard File Header.
**
** The \c rtnd field contains the error code returned by the #CFE_FS_WriteHeader API. Nominally, the
** returned result should have been equal to the \c exp field (i.e. - sizeof(#CFE_FS_Header_t)).
**/
#define CFE_ES_WRHDR_ERR_EID 52
/** \brief <tt> 'Failed to write App Info file, Task write RC = 0x\%08X, exp \%d' </tt>
** \event <tt> 'Failed to write App Info file, Task write RC = 0x\%08X, exp \%d' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated whenever an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application
** Data Command \endlink fails while writing Application data to the specified file.
**
** The \c rtnd field contains, in hex, the error code returned from the #OS_write API. The expected return
** value is identified, in decimal, in the \c exp field.
**/
#define CFE_ES_TASKWR_ERR_EID 53
/** \brief <tt> 'Error creating file \%s, stat=0x\%x' </tt>
** \event <tt> 'Error creating file \%s, stat=0x\%x' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_WRITE_SYSLOG_CC Dump System Log
** Command \endlink fails while attempting to create the specified file.
**
** The \c 's' field identifies the name of the file that was attempted to be created and the \c stat field
** specifies, in hex, the error code returned by the #OS_creat API.
**/
#define CFE_ES_SYSLOG2_ERR_EID 55
/** \brief <tt> 'Error creating file \%s, stat=0x\%x' </tt>
** \event <tt> 'Error creating file \%s, stat=0x\%x' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Dump Exception Reset Log
** Command \endlink fails while attempting to create the specified file.
**
** The \c 's' field identifies the name of the file that was attempted to be created and the \c stat field
** specifies, in hex, the error code returned by the #OS_creat API.
**/
#define CFE_ES_ERLOG2_ERR_EID 56
/** \brief <tt> 'Start collecting performance data command, trigger mode = %d' </tt>
** \event <tt> 'Start collecting performance data command, trigger mode = %d' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is generated in response to receiving an Executive Services
** \link #CFE_ES_START_PERF_DATA_CC Start Performance Analyzer Data Collection Command \endlink
**
** The \c 'd' field identifies the requested trigger mode as defined by CFE_ES_PerfMode_t.
**/
#define CFE_ES_PERF_STARTCMD_EID 57
/** \brief <tt> 'Cannot start collecting performance data,perf data write in progress' </tt>
** \event <tt> 'Cannot start collecting performance data,perf data write in progress' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated in response to receiving an Executive Services
** \link #CFE_ES_START_PERF_DATA_CC Start Performance Analyzer Data Collection Command \endlink
**/
#define CFE_ES_PERF_STARTCMD_ERR_EID 58
/** \brief <tt> 'Cannot start collecting performance data, trigger mode (%d) out of range (%d to %d)' </tt>
** \event <tt> 'Cannot start collecting performance data, trigger mode (%d) out of range (%d to %d)' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated when an Executive Services \link #CFE_ES_START_PERF_DATA_CC
** Start Performance Analyzer Data Collection Command \endlink command is received with a bad
** value for the requested trigger mode.
**
** The first \c 'd' field identifies the received trigger mode value as defined by CFE_ES_PerfMode_t.
** The second and third \c 'd' fields specify the valid range of values for the trigger mode.
**/
#define CFE_ES_PERF_STARTCMD_TRIG_ERR_EID 59
/** \brief <tt> 'Perf Stop Cmd Rcvd,\%s will write \%d entries.\%dmS dly every \%d entries' </tt>
** \event <tt> 'Perf Stop Cmd Rcvd,\%s will write \%d entries.\%dmS dly every \%d entries' </tt>
**
** \par Type: DEBUG
**
** \par Cause:
**
** This event message is generated upon receipt of a successful Performance Data Stop
** Command after receiving the cFE Executive Services \link #CFE_ES_STOP_PERF_DATA_CC Stop
** Performance Analyzer Data Collection Command \endlink
**
** The \c 's' field identifies the name of the file write task that has begun execution.
** The first \c 'd' identifies the total number of performance entries(in decimal) that will be written to the file.
** A performance data entry is defined by an unsigned 32 bit data point and an unsigned 64 bit time stamp.
** The second \c 'd' identifies the millisecond delay between writes and the
** third \c 'd' identifies the number of entries written (in decimal) between delays.
**/
#define CFE_ES_PERF_STOPCMD_EID 60
/** \brief <tt> 'Stop performance data cmd ignored,perf data write in progress' </tt>
** \event <tt> 'Stop performance data cmd ignored,perf data write in progress' </tt>
**
** \par Type: ERROR
**
** \par Cause:
**
** This event message is generated upon receipt of an unsuccessful Performance Data Stop
** Command after receiving the cFE Executive Services \link #CFE_ES_STOP_PERF_DATA_CC Stop
** Performance Analyzer Data Collection Command \endlink
**
**/
#define CFE_ES_PERF_STOPCMD_ERR2_EID 62