RKH
Loading...
Searching...
No Matches
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 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
40/* -------------------------- Development history -------------------------- */
41/*
42 * 2017.04.15 LeFr v2.4.05 Initial version
43 */
44
45/* -------------------------------- Authors -------------------------------- */
46/*
47 * LeFr Leandro Francucci lf@vortexmakes.com
48 */
49
50/* --------------------------------- Notes --------------------------------- */
51/* --------------------------------- Module -------------------------------- */
52#ifndef __RKHTRC_STREAM_H__
53#define __RKHTRC_STREAM_H__
54
55/* ----------------------------- Include files ----------------------------- */
56#include "rkhtrc_out.h"
57
58/* ---------------------- External C language linkage ---------------------- */
59#ifdef __cplusplus
60extern "C" {
61#endif
62
63/* --------------------------------- Macros -------------------------------- */
64/* -------------------------------- Constants ------------------------------ */
65/* ------------------------------- Data types ------------------------------ */
66/* -------------------------- External variables --------------------------- */
67/* -------------------------- Function prototypes -------------------------- */
76
91rui8_t *rkh_trc_get(void);
92
120rui8_t *rkh_trc_get_block(TRCQTY_T *nget);
121
133void rkh_trc_put(rui8_t b);
134
156TRCQTY_T rkh_trc_getWholeBlock(rui8_t *destBlock, TRCQTY_T nElem);
157
158/* -------------------- External C language linkage end -------------------- */
159#ifdef __cplusplus
160}
161#endif
162
163/* ------------------------------ Module end ------------------------------- */
164#endif
165
166/* ------------------------------ End of file ------------------------------ */
Specifies the interface to get out the trace records from the instrumented application.
rui8_t * rkh_trc_get_block(TRCQTY_T *nget)
Retrieves a pointer to a contiguous block of data from the trace stream.
TRCQTY_T rkh_trc_getWholeBlock(rui8_t *destBlock, TRCQTY_T nElem)
Copies the last nElem bytes of the stream to destBlock. Frequently, this function is used by the ca...
void rkh_trc_put(rui8_t b)
Put a data byte into the 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...
void rkh_trcStream_init(void)
Initializes the RKH's trace stream.