-
Notifications
You must be signed in to change notification settings - Fork 204
/
cfe_evs_msg.h
1287 lines (1212 loc) · 48.8 KB
/
cfe_evs_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
*
* Title: Event Services Message definition header file Header File
*
* Purpose:
* Unit specification for Event services command codes and data structures.
*
* Design Notes:
*
* References:
* Flight Software Branch C Coding Standard Version 1.0a
*
*/
#ifndef CFE_EVS_MSG_H
#define CFE_EVS_MSG_H
/********************************** Include Files ************************************/
#include "common_types.h" /* Basic data types */
#include "cfe_msg_hdr.h" /* for header definitions */
#include "cfe_evs_extern_typedefs.h" /* for EVS-specific types such as CFE_EVS_LogMode_Enum_t */
#include "cfe_es_extern_typedefs.h" /* for CFE_ES_AppId_t type */
/** \name Event Services Command Codes */
/** \{ */
/** \cfeevscmd Event 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 Event Services task.
**
** \cfecmdmnemonic \EVS_NOOP
**
** \par Command Structure
** #CFE_EVS_NoopCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with the
** following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The #CFE_EVS_NOOP_EID informational event message will
** be generated
**
** \par Error Conditions
** There are no error conditions for this command. If the Event
** Services receives the command, the event is sent (although it
** may be filtered by EVS itself) and the counter is incremented
** unconditionally.
**
** \par Criticality
** None
**
** \sa
*/
#define CFE_EVS_NOOP_CC 0
/** \cfeevscmd Event Services Reset Counters
**
** \par Description
** This command resets the following counters within the Event
** Services housekeeping telemetry:
** - Command Execution Counter (\EVS_CMDPC)
** - Command Error Counter (\EVS_CMDEC)
**
** \cfecmdmnemonic \EVS_RESETCTRS
**
** \par Command Structure
** #CFE_EVS_ResetCountersCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The #CFE_EVS_RSTCNT_EID debug event message will be
** generated
**
** \par Error Conditions
** There are no error conditions for this command. If the Event
** Services receives the command, the event is sent (although it
** may be filtered by EVS) and the counter is incremented
** unconditionally.
**
** \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_EVS_RESET_APP_COUNTER_CC
*/
#define CFE_EVS_RESET_COUNTERS_CC 1
/** \cfeevscmd Enable Event Type
**
** \par Description
** This command enables the command specified Event Type allowing event
** messages of this type to be sent through Event Service. An Event Type
** is defined to be a classification of an Event Message such as debug,
** informational, error and critical. This command is a global enable of a
** particular event type, it applies to all applications.
**
** \cfecmdmnemonic \EVS_ENAEVENTTYPE
**
** \par Command Structure
** #CFE_EVS_EnableEventTypeCmd_t
** The following bit positions apply to structure member named 'BitMask'.
** Bit 0 - Debug
** Bit 1 - Informational
** Bit 2 - Error
** Bit 3 - Critical
** A one in a bit position means the event type will be enabled (or unfiltered).
** A zero in a bit position means the filtering state is unchanged.
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
**
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_ENAEVTTYPE_EID debug message
**
** \par Error Conditions
** This command may fail for the following reason(s):
**
** Invalid Event Type selection
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Enabling an event type is not particularly hazardous, as the result may
** be turning on necessary event messages and communication to the ground
** system. However, inappropriately enabling an event type could result
** in flooding of the system.
**
** \sa #CFE_EVS_DISABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
** #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
*/
#define CFE_EVS_ENABLE_EVENT_TYPE_CC 2
/** \cfeevscmd Disable Event Type
**
** \par Description
** This command disables the command specified Event Type preventing event
** messages of this type to be sent through Event Service. An Event Type
** is defined to be a classification of an Event Message such as debug,
** informational, error and critical. This command is a global disable of a
** particular event type, it applies to all applications.
**
** \cfecmdmnemonic \EVS_DISEVENTTYPE
**
** \par Command Structure
** #CFE_EVS_DisableEventTypeCmd_t
** The following bit positions apply to structure member named 'BitMask'.
** Bit 0 - Debug
** Bit 1 - Informational
** Bit 2 - Error
** Bit 3 - Critical
** A one in a bit position means the event type will be disabled (or filtered).
** A zero in a bit position means the filtering state is unchanged.
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
**
** - \b \c \EVS_CMDPC - command execution counter will
** increment
- The generation of #CFE_EVS_DISEVTTYPE_EID debug message
**
** \par Error Conditions
** This command may fail for the following reason(s):
**
** - Invalid Event Type selection
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Disabling an event type is not particularly hazardous, as the result
** may be shutting off unnecessary event messages and possible event
** flooding of the system. However, inappropriately disabling an event
** type could result in a loss of critical information and missed
** behavior for the ground system.
**
** \sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
** #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
*/
#define CFE_EVS_DISABLE_EVENT_TYPE_CC 3
/** \cfeevscmd Set Event Format Mode
**
** \par Description
** This command sets the event format mode to the command specified value.
** The event format mode may be either short or long. A short event format
** detaches the Event Data from the event message and only includes the
** following information in the event packet: Processor ID, Application ID,
** Event ID, and Event Type. Refer to section 5.3.3.4 for a description of
** the Event Service event packet contents. Event Data is defined to be data
** describing an Event that is supplied to the cFE Event Service. ASCII text
** strings are used as the primary format for Event Data because heritage
** ground systems use string compares as the basis for their automated alert
** systems. Two systems, ANSR and SERS were looked at for interface
** definitions. The short event format is used to accommodate experiences
** with limited telemetry bandwidth. The long event format includes all event
** information included within the short format along with the Event Data.
**
** \cfecmdmnemonic \EVS_SETEVTFMT
**
** \par Command Structure
** #CFE_EVS_SetEventFormatModeCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
**
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_SETEVTFMTMOD_EID debug message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** Invalid SB message (command) length
** Invalid MODE selection
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Setting the event format mode is not particularly hazardous, as the
** result may be saving necessary bandwidth. However, inappropriately
** setting the event format mode could result in a loss of information
** and missed behavior for the ground system
** \sa
*/
#define CFE_EVS_SET_EVENT_FORMAT_MODE_CC 4
/** \cfeevscmd Enable Application Event Type
**
** \par Description
** This command enables the command specified event type for the command
** specified application, allowing the application to send event messages
** of the command specified event type through Event Service. An Event
** Type is defined to be a classification of an Event Message such as
** debug, informational, critical, and error.
** Note: In order for this command to take effect, applications must be
** registered for Event Service.
**
** \cfecmdmnemonic \EVS_ENAAPPEVTTYPE
**
** \par Command Structure
** #CFE_EVS_EnableAppEventTypeCmd_t
** The following bit positions apply to structure member named 'BitMask'.
** Bit 0 - Debug
** Bit 1 - Informational
** Bit 2 - Error
** Bit 3 - Critical
** A one in a bit position means the event type will be enabled (or
** unfiltered) for the specified application.
** A zero in a bit position means the filtering state is unchanged for
** the specified application.
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_ENAAPPEVTTYPE_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid Event Type Selection
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Enabling an application event type is not particularly hazardous, as
** the result may be turning on necessary event messages and
** communication to the ground system. However, inappropriately enabling
** an application's event type could result in flooding of the ground system.
**
** \sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC,
** #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
*/
#define CFE_EVS_ENABLE_APP_EVENT_TYPE_CC 5
/** \cfeevscmd Disable Application Event Type
**
** \par Description
** This command disables the command specified event type for the command
** specified application, preventing the application from sending event
** messages of the command specified event type through Event Service.
** An Event Type is defined to be a classification of an Event Message such
** as debug, informational, critical, and error. Note: In order for this
** command to take effect, applications must be registered for Event Service.
**
** \cfecmdmnemonic \EVS_DISAPPEVTTYPE
**
** \par Command Structure
** #CFE_EVS_DisableAppEventTypeCmd_t
** The following bit positions apply to structure member named 'BitMask'.
** Bit 0 - Debug
** Bit 1 - Informational
** Bit 2 - Error
** Bit 3 - Critical
** A one in a bit position means the event type will be disabled (or
** filtered) for the specified application.
** A zero in a bit position means the filtering state is unchanged for
** the specified application.
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_DISAPPENTTYPE_EID debug event message
** - The clearing of the Event Type Active Flag in The Event Type Active Flag in EVS App Data File
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid Event Type Selection
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Disabling an application's event type is not particularly hazardous,
** as the result may be shutting off unnecessary event messages and
** possible event flooding of the system. However, inappropriately
** disabling an application's event type could result in a loss of critical
** information and missed behavior for the ground system.
**
** \sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
** #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
*/
#define CFE_EVS_DISABLE_APP_EVENT_TYPE_CC 6
/** \cfeevscmd Enable Event Services for an Application
**
** \par Description
** This command enables the command specified application to send events
** through the Event Service. Note: In order for this command to take
** effect, applications must be registered for Event Service.
**
** \cfecmdmnemonic \EVS_ENAAPPEVGEN
**
** \par Command Structure
** #CFE_EVS_EnableAppEventsCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_ENAAPPEVT_EID debug event message
** - The setting of the Active Flag in The Active Flag in EVS App Data File
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Application selected is not registered to receive Event Service
** - Application ID is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Enabling an application events is not particularly hazardous,
** as the result may be turning on necessary event messages and
** communication to the ground system. However, inappropriately enabling
** an application's events could result in flooding of the ground system.
**
** \sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
** #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
*/
#define CFE_EVS_ENABLE_APP_EVENTS_CC 7
/** \cfeevscmd Disable Event Services for an Application
**
** \par Description
** This command disables the command specified application from sending
** events through Event Service. Note: In order for this command to take
** effect, applications must be registered for Event Service.
**
** \cfecmdmnemonic \EVS_DISAPPEVGEN
**
** \par Command Structure
** #CFE_EVS_DisableAppEventsCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_DISAPPEVT_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Application selected is not registered to receive Event Service
** - Application ID is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Disabling an application's events is not particularly hazardous, as the
** result may be shutting off unnecessary event messages and possible event
** flooding of the system. However, inappropriately disabling an
** application's events could result in a loss of critical information and
** missed behavior for the ground system.
**
** \sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
** #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENTS_CC
*/
#define CFE_EVS_DISABLE_APP_EVENTS_CC 8
/** \cfeevscmd Reset Application Event Counters
**
** \par Description
** This command sets the command specified application's event counter to zero.
** Note: In order for this command to take effect, applications must be registered
** for Event Service.
**
** \cfecmdmnemonic \EVS_RSTAPPCTRS
**
** \par Command Structure
** #CFE_EVS_ResetAppCounterCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_RSTEVTCNT_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Application selected is not registered to receive Event Service
** - Application ID is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \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 value that is reset by this command.
**
** \sa #CFE_EVS_RESET_COUNTERS_CC
*/
#define CFE_EVS_RESET_APP_COUNTER_CC 9
/** \cfeevscmd Set Application Event Filter
**
** \par Description
** This command sets the command specified application's event filter mask
** to the command specified value for the command specified event. Note:
** In order for this command to take effect, applications must be
** registered for Event Service.
**
** \cfecmdmnemonic \EVS_SETBINFLTRMASK
**
** \par Command Structure
** #CFE_EVS_SetFilterCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_SETFILTERMSK_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Application selected is not registered to receive Event Service
** - Application ID is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Setting an application event filter mask is not particularly hazardous,
** as the result may be shutting off unnecessary event messages and possible
** event flooding of the system. However, inappropriately setting an
** application's event filter mask could result in a loss of critical
** information and missed behavior for the ground system or flooding of the
** ground system.
**
** \sa #CFE_EVS_RESET_FILTER_CC, #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_ADD_EVENT_FILTER_CC,
*#CFE_EVS_DELETE_EVENT_FILTER_CC
*/
#define CFE_EVS_SET_FILTER_CC 10
/** \cfeevscmd Enable Event Services Output Ports
**
** \par Description
** This command enables the command specified port to output event messages
**
** \cfecmdmnemonic \EVS_ENAPORT
**
** \par Command Structure
** #CFE_EVS_EnablePortsCmd_t
** The following bit positions apply to structure member named 'BitMask'.
** Bit 0 - Port 1
** Bit 1 - Port 2
** Bit 2 - Port 3
** Bit 3 - Port 4
** A one in a bit position means the port will be enabled.
** A zero in a bit position means the port state is unchanged.
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_ENAPORT_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Invalid PORT selection
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** None.
**
** \sa #CFE_EVS_DISABLE_PORTS_CC
*/
#define CFE_EVS_ENABLE_PORTS_CC 11
/** \cfeevscmd Disable Event Services Output Ports
**
** \par Description
** This command disables the specified port from outputting event messages.
**
** \cfecmdmnemonic \EVS_DISPORT
**
** \par Command Structure
** #CFE_EVS_DisablePortsCmd_t
** The following bit positions apply to structure member named 'BitMask'.
** Bit 0 - Port 1
** Bit 1 - Port 2
** Bit 2 - Port 3
** Bit 3 - Port 4
** A one in a bit position means the port will be disabled.
** A zero in a bit position means the port state is unchanged.
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_DISPORT_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Invalid PORT selection
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** None.
**
** \sa #CFE_EVS_ENABLE_PORTS_CC
*/
#define CFE_EVS_DISABLE_PORTS_CC 12
/** \cfeevscmd Reset an Event Filter for an Application
**
** \par Description
** This command resets the command specified application's event filter for
** the command specified event ID. Note: In order for this command to take
** effect, applications must be registered for Event Service.
**
** \cfecmdmnemonic \EVS_RSTBINFLTRCTR
**
** \par Command Structure
** #CFE_EVS_ResetFilterCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_RSTFILTER_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Application selected is not registered to receive Event Service
** - Application ID is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** None.
**
** \sa #CFE_EVS_SET_FILTER_CC, #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_ADD_EVENT_FILTER_CC,
*#CFE_EVS_DELETE_EVENT_FILTER_CC
*/
#define CFE_EVS_RESET_FILTER_CC 13
/** \cfeevscmd Reset All Event Filters for an Application
**
** \par Description
** This command resets all of the command specified applications event
** filters. Note: In order for this command to take effect, applications
** must be registered for Event Service.
**
** \cfecmdmnemonic \EVS_RSTALLFLTRS
**
** \par Command Structure
** #CFE_EVS_ResetAllFiltersCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_RSTALLFILTER_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Application selected is not registered to receive Event Service
** - Application ID is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** None.
**
** \sa #CFE_EVS_SET_FILTER_CC, #CFE_EVS_RESET_FILTER_CC, #CFE_EVS_ADD_EVENT_FILTER_CC, #CFE_EVS_DELETE_EVENT_FILTER_CC
*/
#define CFE_EVS_RESET_ALL_FILTERS_CC 14
/** \cfeevscmd Add Application Event Filter
**
** \par Description
** This command adds the given filter for the given application identifier and event identifier.
** Note: In order for this command to take effect, applications
** must be registered for Event Service.
**
** \cfecmdmnemonic \EVS_ADDEVTFLTR
**
** \par Command Structure
** #CFE_EVS_AddEventFilterCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_ADDFILTER_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Application selected is not registered to receive Event Service
** - Application ID is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** None.
**
** \sa #CFE_EVS_SET_FILTER_CC, #CFE_EVS_RESET_FILTER_CC, #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_DELETE_EVENT_FILTER_CC
*/
#define CFE_EVS_ADD_EVENT_FILTER_CC 15
/** \cfeevscmd Delete Application Event Filter
**
** \par Description
** This command removes the given filter for the given application identifier and event identifier.
** Note: In order for this command to take effect, applications
** must be registered for Event Service.
**
** \cfecmdmnemonic \EVS_DELEVTFLTR
**
** \par Command Structure
** #CFE_EVS_DeleteEventFilterCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_DELFILTER_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Application selected is not registered to receive Event Service
** - Application ID is out of range
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** None.
**
** \sa #CFE_EVS_SET_FILTER_CC, #CFE_EVS_RESET_FILTER_CC, #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_ADD_EVENT_FILTER_CC
*/
#define CFE_EVS_DELETE_EVENT_FILTER_CC 16
/** \cfeevscmd Write Event Services Application Information to File
**
** \par Description
** This command writes all application data to a file for all applications that
** have registered with the EVS. The application data includes the Application ID,
** Active Flag, Event Count, Event Types Active Flag, and Filter Data.
**
** \cfecmdmnemonic \EVS_WRITEAPPDATA2FILE
**
** \par Command Structure
** #CFE_EVS_WriteAppDataFileCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_WRDAT_EID debug event message
** - The generation of the file written to
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Writing a file is not particularly hazardous, but if proper file management is not
** taken, then the file system can fill up if this command is used repeatedly.
**
** \sa #CFE_EVS_WRITE_LOG_DATA_FILE_CC, #CFE_EVS_SET_LOG_MODE_CC
*/
#define CFE_EVS_WRITE_APP_DATA_FILE_CC 17
/** \cfeevscmd Write Event Log to File
**
** \par Description
** This command requests the Event Service to generate a file containing
** the contents of the local event log.
**
** \cfecmdmnemonic \EVS_WRITELOG2FILE
**
** \par Command Structure
** #CFE_EVS_WriteLogDataFileCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_WRLOG_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Writing a file is not particularly hazardous, but if proper file management is not
** taken, then the file system can fill up if this command is used repeatedly.
**
** \sa #CFE_EVS_WRITE_APP_DATA_FILE_CC, #CFE_EVS_SET_LOG_MODE_CC, #CFE_EVS_CLEAR_LOG_CC
*/
#define CFE_EVS_WRITE_LOG_DATA_FILE_CC 18
/** \cfeevscmd Set Logging Mode
**
** \par Description
** This command sets the logging mode to the command specified value.
**
** \cfecmdmnemonic \EVS_SETLOGMODE
**
** \par Command Structure
** #CFE_EVS_SetLogModeCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
** - The generation of #CFE_EVS_LOGMODE_EID debug event message
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
** - Invalid MODE selected
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Setting the event logging mode is not particularly hazardous, as the
** result may be saving valuable event data. However, inappropriately
** setting the log mode could result in a loss of critical information.
** Note: the event log is a back-up log to the on-board recorder.
**
** \sa #CFE_EVS_WRITE_LOG_DATA_FILE_CC, #CFE_EVS_CLEAR_LOG_CC
*/
#define CFE_EVS_SET_LOG_MODE_CC 19
/** \cfeevscmd Clear Event Log
**
** \par Description
** This command clears the contents of the local event log.
**
** \cfecmdmnemonic \EVS_CLRLOG
**
** \par Command Structure
** #CFE_EVS_ClearLogCmd_t
**
** \par Command Verification
** Successful execution of this command may be verified with
** the following telemetry:
** - \b \c \EVS_CMDPC - command execution counter will
** increment
**
** \par Error Conditions
** This command may fail for the following reason(s):
** - Invalid SB message (command) length
**
** Evidence of failure may be found in the following telemetry:
** - \b \c \EVS_CMDEC - command error counter will increment
** - An Error specific event message
**
** \par Criticality
** Clearing the local event log is not particularly hazardous, as the
** result may be making available space to record valuable event data.
** However, inappropriately clearing the local event log could result
** in a loss of critical information. Note: the event log is a back-up
** log to the on-board recorder.
**
** \sa #CFE_EVS_WRITE_LOG_DATA_FILE_CC, #CFE_EVS_SET_LOG_MODE_CC
*/
#define CFE_EVS_CLEAR_LOG_CC 20
/** \} */
/* Event Type bit masks */
#define CFE_EVS_DEBUG_BIT 0x0001
#define CFE_EVS_INFORMATION_BIT 0x0002
#define CFE_EVS_ERROR_BIT 0x0004
#define CFE_EVS_CRITICAL_BIT 0x0008
/* Output Port bit masks */
#define CFE_EVS_PORT1_BIT 0x0001
#define CFE_EVS_PORT2_BIT 0x0002
#define CFE_EVS_PORT3_BIT 0x0004
#define CFE_EVS_PORT4_BIT 0x0008
/* EVS Log Modes */
#define CFE_EVS_LOG_OVERWRITE 0
#define CFE_EVS_LOG_DISCARD 1
/****************** Structure Definitions *********************/
/**
** \brief Command with no additional arguments
**/
typedef struct CFE_EVS_NoArgsCmd
{
CFE_MSG_CommandHeader_t CmdHeader; /**< \brief Command header */
} CFE_EVS_NoArgsCmd_t;
/*
* The NoArgsCmd is shared by several EVS command handlers.
* Create a unique type for each one so the prototypes will follow the naming pattern,
* allowing each command to evolve independently.
*/
typedef CFE_EVS_NoArgsCmd_t CFE_EVS_NoopCmd_t;
typedef CFE_EVS_NoArgsCmd_t CFE_EVS_ResetCountersCmd_t;
typedef CFE_EVS_NoArgsCmd_t CFE_EVS_ClearLogCmd_t;
/**
** \brief Write Event Log to File Command Payload
**
** For command details, see #CFE_EVS_WRITE_LOG_DATA_FILE_CC
**
**/
typedef struct CFE_EVS_LogFileCmd_Payload
{
char LogFilename[CFE_MISSION_MAX_PATH_LEN]; /**< \brief Filename where log data is to be written */
} CFE_EVS_LogFileCmd_Payload_t;
/**
* \brief Write Event Log to File Command
*/
typedef struct CFE_EVS_WriteLogDataFileCmd
{
CFE_MSG_CommandHeader_t CmdHeader; /**< \brief Command header */
CFE_EVS_LogFileCmd_Payload_t Payload; /**< \brief Command payload */
} CFE_EVS_WriteLogDataFileCmd_t;
/**
** \brief Write Event Services Application Information to File Command Payload
**
** For command details, see #CFE_EVS_WRITE_APP_DATA_FILE_CC
**
**/
typedef struct CFE_EVS_AppDataCmd_Payload
{
char AppDataFilename[CFE_MISSION_MAX_PATH_LEN]; /**< \brief Filename where applicaton data is to be written */
} CFE_EVS_AppDataCmd_Payload_t;
/**
* \brief Write Event Services Application Information to File Command
*/
typedef struct CFE_EVS_WriteAppDataFileCmd
{
CFE_MSG_CommandHeader_t CmdHeader; /**< \brief Command header */
CFE_EVS_AppDataCmd_Payload_t Payload; /**< \brief Command payload */
} CFE_EVS_WriteAppDataFileCmd_t;
/**
** \brief Set Log Mode Command Payload
**
** For command details, see #CFE_EVS_SET_LOG_MODE_CC
**
**/
typedef struct CFE_EVS_SetLogMode_Payload
{
CFE_EVS_LogMode_Enum_t LogMode; /**< \brief Mode to use in the command*/
uint8 Spare; /**< \brief Pad to even byte*/
} CFE_EVS_SetLogMode_Payload_t;
/**
* \brief Set Log Mode Command
*/
typedef struct CFE_EVS_SetLogModeCmd
{
CFE_MSG_CommandHeader_t CmdHeader; /**< \brief Command header */
CFE_EVS_SetLogMode_Payload_t Payload; /**< \brief Command payload */
} CFE_EVS_SetLogModeCmd_t;
/**
** \brief Set Event Format Mode Command Payload
**
** For command details, see #CFE_EVS_SET_EVENT_FORMAT_MODE_CC
**
**/
typedef struct CFE_EVS_SetEventFormatCode_Payload