RKH
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
rkhtrc_stream.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 
38 /* -------------------------- Development history -------------------------- */
39 /*
40  * 2017.04.15 LeFr v2.4.05 Initial version
41  */
42 
43 /* -------------------------------- Authors -------------------------------- */
44 /*
45  * LeFr Leandro Francucci francuccilea@gmail.com
46  */
47 
48 /* --------------------------------- Notes --------------------------------- */
49 /* --------------------------------- Module -------------------------------- */
50 #ifndef __RKHTRC_STREAM_H__
51 #define __RKHTRC_STREAM_H__
52 
53 /* ----------------------------- Include files ----------------------------- */
54 #include "rkhtrc_out.h"
55 
56 /* ---------------------- External C language linkage ---------------------- */
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60 
61 /* --------------------------------- Macros -------------------------------- */
62 /* -------------------------------- Constants ------------------------------ */
63 /* ------------------------------- Data types ------------------------------ */
64 /* -------------------------- External variables --------------------------- */
65 /* -------------------------- Function prototypes -------------------------- */
73 void rkh_trcStream_init(void);
74 
89 rui8_t *rkh_trc_get(void);
90 
118 rui8_t *rkh_trc_get_block(TRCQTY_T *nget);
119 
131 void rkh_trc_put(rui8_t b);
132 
133 /* -------------------- External C language linkage end -------------------- */
134 #ifdef __cplusplus
135 }
136 #endif
137 
138 /* ------------------------------ Module end ------------------------------- */
139 #endif
140 
141 /* ------------------------------ End of file ------------------------------ */
void rkh_trc_put(rui8_t b)
Put a data byte into the trace stream.
Specifies the interface to get out the trace records from the instrumented application.
void rkh_trcStream_init(void)
Initializes the RKH's trace stream.
rui8_t * rkh_trc_get(void)
Retrieves a pointer to oldest stored byte in the trace stream. Frequently, this function is used by t...
rui8_t * rkh_trc_get_block(TRCQTY_T *nget)
Retrieves a pointer to a contiguous block of data from the trace stream.