RKH
rkhtrc_out.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 
41 /* -------------------------- Development history -------------------------- */
42 /*
43  * 2017.04.15 LeFr v2.4.05 Initial version
44  */
45 
46 /* -------------------------------- Authors -------------------------------- */
47 /*
48  * LeFr Leandro Francucci lf@vortexmakes.com
49  */
50 
51 /* --------------------------------- Notes --------------------------------- */
52 /* --------------------------------- Module -------------------------------- */
53 #ifndef __RKHTRC_OUT_H__
54 #define __RKHTRC_OUT_H__
55 
56 /* ----------------------------- Include files ----------------------------- */
57 #include "rkhtrc_define.h"
58 
59 /* ---------------------- External C language linkage ---------------------- */
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63 
64 /* --------------------------------- Macros -------------------------------- */
106 #if RKH_CFG_TRC_EN == RKH_ENABLED
107  #define RKH_TRC_OPEN() rkh_trc_open()
108 #else
109  #define RKH_TRC_OPEN() (void)0
110 #endif
111 
137 #if RKH_CFG_TRC_EN == RKH_ENABLED
138  #define RKH_TRC_CLOSE() rkh_trc_close()
139 #else
140  #define RKH_TRC_CLOSE() (void)0
141 #endif
142 
190 #if RKH_CFG_TRC_EN == RKH_ENABLED
191  #define RKH_TRC_FLUSH() rkh_trc_flush()
192 #else
193  #define RKH_TRC_FLUSH() (void)0
194 #endif
195 
220 #if RKH_CFG_TRC_EN == RKH_ENABLED
221  #define RKH_TRC_SEND_CFG(ts_hz) \
222  RKH_TR_FWK_TCFG(ts_hz)
223 #else
224  #define RKH_TRC_SEND_CFG(ts_hz) (void)0
225 #endif
226 
227 /* -------------------------------- Constants ------------------------------ */
228 /* ------------------------------- Data types ------------------------------ */
229 /* -------------------------- External variables --------------------------- */
230 /* -------------------------- Function prototypes -------------------------- */
237 void rkh_trc_open(void);
238 
245 void rkh_trc_close(void);
246 
253 void rkh_trc_flush(void);
254 
279 
280 /* -------------------- External C language linkage end -------------------- */
281 #ifdef __cplusplus
282 }
283 #endif
284 
285 /* ------------------------------ Module end ------------------------------- */
286 #endif
287 
288 /* ------------------------------ End of file ------------------------------ */
void rkh_trc_open(void)
Open the tracing session.
void rkh_trc_flush(void)
Platform-dependent macro flushing the trace stream.
void rkh_trc_close(void)
Close the tracing session.
RKH_TS_T rkh_trc_getts(void)
Retrieves a timestamp to be placed in a trace event.
Defines constants and macros which are internally used by RKH trace facility.
rui32_t RKH_TS_T
Defines the size of trace timestamp.