RKH
rkhcfg.h
Go to the documentation of this file.
1 /*
2  * --------------------------------------------------------------------------
3  *
4  * Framework RKH
5  * -------------
6  *
7  * State-machine framework for reactive embedded systems
8  *
9  * Copyright (C) 2010 Leandro Francucci.
10  * All rights reserved. Protected by international copyright laws.
11  *
12  *
13  * RKH is free software: you can redistribute it and/or modify it under the
14  * terms of the GNU General Public License as published by the Free Software
15  * Foundation, either version 3 of the License, or (at your option) any
16  * later version.
17  *
18  * RKH is distributed in the hope that it will be useful, but WITHOUT ANY
19  * WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
21  * more details.
22  *
23  * You should have received a copy of the GNU General Public License along
24  * with RKH, see copying.txt file.
25  *
26  * Contact information:
27  * RKH site: http://vortexmakes.com/que-es/
28  * RKH GitHub: https://github.com/vortexmakes/RKH
29  * RKH Sourceforge: https://sourceforge.net/projects/rkh-reactivesys/
30  * e-mail: lf@vortexmakes.com
31  * ---------------------------------------------------------------------------
32  */
33 
44 /* -------------------------- Development history -------------------------- */
45 /*
46  * 2015.10.24 LeFr v2.4.05 Initial version
47  */
48 
49 /* -------------------------------- Authors -------------------------------- */
50 /*
51  * LeFr Leandro Francucci lf@vortexmakes.com
52  */
53 
54 /* --------------------------------- Notes --------------------------------- */
55 /* --------------------------------- Module -------------------------------- */
56 
57 #ifndef __RKHCFG_H__
58 #define __RKHCFG_H__
59 
60 /* ----------------------------- Include files ----------------------------- */
61 
62 #include "rkhdef.h"
63 
64 /* ---------------------- External C language linkage ---------------------- */
65 
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
70 /* --------------------------------- Macros -------------------------------- */
71 /* -------------------------------- Constants ------------------------------ */
72 
88 #define RKH_CFG_FWK_MAX_SMA 4u
89 
100 #define RKH_CFG_FWK_DYN_EVT_EN RKH_ENABLED
101 
114 #define RKH_CFG_FWK_MAX_EVT_POOL 0u
115 
127 #define RKH_CFG_FWK_SIZEOF_EVT 8u
128 
138 #define RKH_CFG_FWK_MAX_SIGNALS 16u
139 
151 #define RKH_CFG_FWK_SIZEOF_EVT_SIZE 8u
152 
163 #define RKH_CFG_FWK_DEFER_EVT_EN RKH_ENABLED
164 
179 #define RKH_CFG_FWK_ASSERT_EN RKH_ENABLED
180 
190 #define RKH_CFG_FWK_PUBSUB_EN RKH_ENABLED
191 
201 #define RKH_CFG_FWK_MAX_SUBS_CHANNELS 16
202 
214 #define RKH_CFG_HOOK_DISPATCH_EN RKH_ENABLED
215 
227 #define RKH_CFG_HOOK_SIGNAL_EN RKH_ENABLED
228 
241 #define RKH_CFG_HOOK_TIMEOUT_EN RKH_ENABLED
242 
255 #define RKH_CFG_HOOK_START_EN RKH_ENABLED
256 
269 #define RKH_CFG_HOOK_EXIT_EN RKH_ENABLED
270 
289 #define RKH_CFG_HOOK_TIMETICK_EN RKH_ENABLED
290 
304 #define RKH_CFG_HOOK_PUT_TRCEVT_EN RKH_DISABLED
305 
318 #define RKH_CFG_FWK_TICK_RATE_HZ 100u
319 
334 #define RKH_CFG_FWK_AWARE_ISR_PRIO 0
335 
353 #define RKH_CFG_SMA_GET_INFO_EN RKH_ENABLED
354 
369 #define RKH_CFG_SMA_PPRO_EN RKH_ENABLED
370 
382 #define RKH_CFG_SMA_HCAL_EN RKH_ENABLED
383 
395 #define RKH_CFG_SMA_MAX_HCAL_DEPTH 4u
396 
408 #define RKH_CFG_SMA_MAX_TRC_SEGS 4u
409 
419 #define RKH_CFG_SMA_PSEUDOSTATE_EN RKH_ENABLED
420 
430 #define RKH_CFG_SMA_DEEP_HIST_EN RKH_ENABLED
431 
441 #define RKH_CFG_SMA_SHALLOW_HIST_EN RKH_ENABLED
442 
452 #define RKH_CFG_SMA_CHOICE_EN RKH_ENABLED
453 
463 #define RKH_CFG_SMA_CONDITIONAL_EN RKH_ENABLED
464 
474 #define RKH_CFG_SMA_SUBMACHINE_EN RKH_ENABLED
475 
485 #define RKH_CFG_SMA_TRC_SNDR_EN RKH_ENABLED
486 
498 #define RKH_CFG_SMA_INIT_EVT_EN RKH_ENABLED
499 
518 #define RKH_CFG_SMA_ENT_ARG_SMA_EN RKH_ENABLED
519 
530 #define RKH_CFG_SMA_ENT_ARG_STATE_EN RKH_DISABLED
531 
542 #define RKH_CFG_SMA_EXT_ARG_SMA_EN RKH_ENABLED
543 
554 #define RKH_CFG_SMA_EXT_ARG_STATE_EN RKH_DISABLED
555 
566 #define RKH_CFG_SMA_ACT_ARG_SMA_EN RKH_ENABLED
567 
578 #define RKH_CFG_SMA_ACT_ARG_EVT_EN RKH_ENABLED
579 
590 #define RKH_CFG_SMA_GRD_ARG_EVT_EN RKH_ENABLED
591 
602 #define RKH_CFG_SMA_GRD_ARG_SMA_EN RKH_ENABLED
603 
615 #define RKH_CFG_SMA_PPRO_ARG_SMA_EN RKH_ENABLED
616 
634 #define RKH_CFG_SMA_SM_CONST_EN RKH_ENABLED
635 
646 #define RKH_CFG_SMA_RT_CTOR_EN RKH_DISABLED
647 
659 #define RKH_CFG_SMA_VFUNCT_EN RKH_DISABLED
660 
673 #define RKH_CFG_SMA_ORTHREG_EN RKH_DISABLED
674 
693 #define RKH_CFG_TRC_EN RKH_ENABLED
694 
709 #define RKH_CFG_TRC_RTFIL_EN RKH_ENABLED
710 
721 #define RKH_CFG_TRC_RTFIL_SMA_EN RKH_ENABLED
722 
733 #define RKH_CFG_TRC_RTFIL_SIGNAL_EN RKH_ENABLED
734 
745 #define RKH_CFG_TRC_USER_TRACE_EN RKH_ENABLED
746 
756 #define RKH_CFG_TRC_ALL_EN RKH_ENABLED
757 
767 #define RKH_CFG_TRC_MP_EN RKH_ENABLED
768 
778 #define RKH_CFG_TRC_QUE_EN RKH_ENABLED
779 
789 #define RKH_CFG_TRC_SMA_EN RKH_ENABLED
790 
800 #define RKH_CFG_TRC_TMR_EN RKH_ENABLED
801 
812 #define RKH_CFG_TRC_SM_EN RKH_ENABLED
813 
823 #define RKH_CFG_TRC_FWK_EN RKH_ENABLED
824 
834 #define RKH_CFG_TRC_ASSERT_EN RKH_ENABLED
835 
845 #define RKH_CFG_TRC_SM_INIT_EN RKH_ENABLED
846 
856 #define RKH_CFG_TRC_SM_DCH_EN RKH_ENABLED
857 
867 #define RKH_CFG_TRC_SM_CLRH_EN RKH_ENABLED
868 
878 #define RKH_CFG_TRC_SM_TRN_EN RKH_ENABLED
879 
889 #define RKH_CFG_TRC_SM_STATE_EN RKH_ENABLED
890 
900 #define RKH_CFG_TRC_SM_ENSTATE_EN RKH_ENABLED
901 
911 #define RKH_CFG_TRC_SM_EXSTATE_EN RKH_ENABLED
912 
923 #define RKH_CFG_TRC_SM_NENEX_EN RKH_ENABLED
924 
935 #define RKH_CFG_TRC_SM_NTRNACT_EN RKH_ENABLED
936 
947 #define RKH_CFG_TRC_SM_TS_STATE_EN RKH_ENABLED
948 
958 #define RKH_CFG_TRC_SM_PROCESS_EN RKH_ENABLED
959 
970 #define RKH_CFG_TRC_SM_EXE_ACT_EN RKH_ENABLED
971 
982 #define RKH_CFG_TRC_NSEQ_EN RKH_ENABLED
983 
993 #define RKH_CFG_TRC_CHK_EN RKH_ENABLED
994 
1005 #define RKH_CFG_TRC_TSTAMP_EN RKH_ENABLED
1006 
1016 #define RKH_CFG_TRC_SIZEOF_STREAM 128u
1017 
1035 #define RKH_CFG_QUE_EN RKH_ENABLED
1036 
1047 #define RKH_CFG_QUE_SIZEOF_NELEM 8u
1048 
1060 #define RKH_CFG_QUE_GET_LWMARK_EN RKH_ENABLED
1061 
1072 #define RKH_CFG_QUE_GET_INFO_EN RKH_ENABLED
1073 
1084 #define RKH_CFG_QUE_READ_EN RKH_ENABLED
1085 
1097 #define RKH_CFG_QUE_DEPLETE_EN RKH_ENABLED
1098 
1109 #define RKH_CFG_QUE_IS_FULL_EN RKH_ENABLED
1110 
1122 #define RKH_CFG_QUE_GET_NELEMS_EN RKH_ENABLED
1123 
1135 #define RKH_CFG_QUE_PUT_LIFO_EN RKH_ENABLED
1136 
1154 #define RKH_CFG_MP_EN RKH_ENABLED
1155 
1165 #define RKH_CFG_MP_REDUCED_EN RKH_DISABLED
1166 
1176 #define RKH_CFG_MP_SIZEOF_BSIZE 8u
1177 
1187 #define RKH_CFG_MP_SIZEOF_NBLOCK 8u
1188 
1199 #define RKH_CFG_MP_GET_BSIZE_EN RKH_ENABLED
1200 
1212 #define RKH_CFG_MP_GET_NFREE_EN RKH_ENABLED
1213 
1226 #define RKH_CFG_MP_GET_LWM_EN RKH_ENABLED
1227 
1238 #define RKH_CFG_MP_GET_INFO_EN RKH_ENABLED
1239 
1257 #define RKH_CFG_TMR_EN RKH_ENABLED
1258 
1269 #define RKH_CFG_TMR_SIZEOF_NTIMER 8u
1270 
1281 #define RKH_CFG_TMR_HOOK_EN RKH_ENABLED
1282 
1293 #define RKH_CFG_TMR_GET_INFO_EN RKH_ENABLED
1294 
1297 /* ------------------------------- Data types ------------------------------ */
1298 /* -------------------------- External variables --------------------------- */
1299 /* -------------------------- Function prototypes -------------------------- */
1300 /* -------------------- External C language linkage end -------------------- */
1301 #ifdef __cplusplus
1302 }
1303 #endif
1304 
1305 /* ------------------------------ Module end ------------------------------- */
1306 #endif
1309 /* ------------------------------ End of file ------------------------------ */
Defines constants and macros.