RKH
rkh.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 web site: http://sourceforge.net/projects/rkh-reactivesys/
28  * e-mail: francuccilea@gmail.com
29  * ---------------------------------------------------------------------------
30  */
31 
84 /* -------------------------- Development history -------------------------- */
85 /*
86  * 2017.17.05 LeFr v2.4.05 Initial version
87  */
88 
89 /* -------------------------------- Authors -------------------------------- */
90 /*
91  * LeFr Leandro Francucci francuccilea@gmail.com
92  */
93 
94 /* --------------------------------- Notes --------------------------------- */
95 /*
96  * (1) This header file must be included in all modules (*.c) that use RKH.
97  */
98 
99 /* --------------------------------- Module -------------------------------- */
100 #ifndef __RKH_H__
101 #define __RKH_H__
102 
103 /* ----------------------------- Include files ----------------------------- */
104 #include "rkhtrc.h"
105 #include "rkhsma.h"
106 #include "rkhqueue.h"
107 #include "rkhmempool.h"
108 #include "rkhtmr.h"
109 #include "rkhassert.h"
110 #include "rkhfwk_hook.h"
111 #include "rkhfwk_bittbl.h"
112 #include "rkhfwk_module.h"
113 #include "rkhfwk_cast.h"
114 #include "rkhfwk_version.h"
115 #include "rkhfwk_dynevt.h"
116 #include "rkhfwk_sched.h"
117 
118 /* ---------------------- External C language linkage ---------------------- */
119 #ifdef __cplusplus
120 extern "C" {
121 #endif
122 
123 /* --------------------------------- Macros -------------------------------- */
124 /* -------------------------------- Constants ------------------------------ */
125 /* ------------------------------- Data types ------------------------------ */
126 /* -------------------------- External variables --------------------------- */
127 /* -------------------------- Function prototypes -------------------------- */
128 /* -------------------- External C language linkage end -------------------- */
129 #ifdef __cplusplus
130 }
131 #endif
132 
133 /* ------------------------------ Module end ------------------------------- */
134 #endif
135 
136 /* ------------------------------ End of file ------------------------------ */
rkhtrc.h
Specifies the interface of trace facility.
rkhfwk_module.h
Specifies the macros to identify file modules.
rkhtmr.h
Specifies the interface of software timer services.
rkhfwk_version.h
Defines the RKH version.
rkhfwk_bittbl.h
Specifies the interface of the mapping table manager to deal with native priority algorithm...
rkhassert.h
Specifies the assertion macros.
rkhmempool.h
Specifies the interface of the fixed-size memory blocks facility.
rkhfwk_sched.h
Specifies the interface of RKH control operations.
rkhfwk_hook.h
Specifies the interface of hook functions.
rkhfwk_cast.h
Defines casting operations which are internally used by RKH.
rkhsma.h
Specifies the interface of the acive object (SMA state machine applications) manager.
rkhqueue.h
Specifies the interface of the queue services.
rkhfwk_dynevt.h
Specifies the interface of dynamic event support.