1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
/****************************************************************************
*
* Copyright (c) 2006 Dave Hylands <dhylands@gmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* Alternatively, this software may be distributed under the terms of BSD
* license.
*
* See README and COPYING for more details.
*
****************************************************************************/
/**
*
* @file Log.cpp
*
* @brief This file contains the implementation of the logging functions.
*
****************************************************************************/
// ---- Include Files -------------------------------------------------------
#include "Log.h"
#if CFG_LOG_USE_STDIO
# include <stdio.h>
#else
# include "Str.h"
# include "UART.h"
#endif
// ---- Public Variables ----------------------------------------------------
// ---- Private Constants and Types -----------------------------------------
#if defined( AVR )
#undef Log
#undef LogError
#undef vLog
#define Log Log_P
#define LogError LogError_P
#define vLog vLog_P
#define LogBuf LogBuf_P
#define char prog_char
#else
#define PSTR(str) str
int gVerbose = 0;
int gDebug = 0;
int gQuiet = 0;
#endif
#if CFG_LOG_TO_BUFFER
volatile LOG_Buffer_t LOG_gBuffer;
#endif
// ---- Private Variables ---------------------------------------------------
#if CFG_LOG_USE_STDIO
FILE *gLogFs = NULL;
#endif
// ---- Private Function Prototypes -----------------------------------------
// ---- Functions -----------------------------------------------------------
/**
* @addtogroup Log
* @{
*/
#if !defined( AVR )
void DefaultLogFunc( int logLevel, const char *fmt, va_list args )
{
FILE *fs;
if ( gQuiet && ( logLevel == LOG_LEVEL_NORMAL ))
{
return;
}
if ( gLogFs == NULL )
{
fs = stderr;
}
else
{
fs = gLogFs;
}
if ( logLevel == LOG_LEVEL_ERROR )
{
fprintf( fs, "ERROR: " );
}
vfprintf( fs, fmt, args );
fflush( fs );
} // DefaultLogFunc
static LogFunc_t gLogFunc = DefaultLogFunc;
void SetLogFunc( LogFunc_t logFunc )
{
gLogFunc = logFunc;
} // SetLogFunc
#endif
//***************************************************************************
/**
* Sets the logging stream
*/
#if CFG_LOG_USE_STDIO
void LogInit( FILE *logFs )
{
gLogFs = logFs;
} // LogInit
#else
static int LogToUartFunc( void *outParm, int ch )
{
UART0_PutChar( ch );
return 1;
}
#endif
//***************************************************************************
/**
* Logs a string using printf like semantics
*/
void Log
(
const char *fmt, ///< printf style format specifier
... ///< variable list of arguments
)
{
va_list args;
va_start( args, fmt );
vLog( fmt, args );
va_end( args );
}
//***************************************************************************
/**
* Logs a string using printf like semantics
*/
void vLog
(
const char *fmt, ///< printf style format specified
va_list args ///< variable list of arguments
)
{
// For now we call printf directly. A better way would be to install
// a callback which does the real work
#if defined( AVR )
# if CFG_LOG_USE_STDIO
if ( gLogFs != NULL )
{
vfprintf_P( gLogFs, fmt, args );
}
# else
vStrXPrintf_P( LogToUartFunc, NULL, fmt, args );
# endif
#else
if ( gLogFunc != NULL )
{
gLogFunc( LOG_LEVEL_NORMAL, fmt, args );
}
#endif
}
#if !defined( AVR )
//***************************************************************************
/**
* Logs an error.
*/
void vLogError
(
const char *fmt, ///< printf style format specified
va_list args ///< variable list of arguments
)
{
if ( gLogFunc != NULL )
{
gLogFunc( LOG_LEVEL_ERROR, fmt, args );
}
}
#endif
/***************************************************************************/
/**
* Logs an error
*/
void LogError
(
const char *fmt, ///< printf style format specifier
... ///< variable list of arguments
)
{
va_list args;
#if defined( AVR )
//Log( "ERROR: " );
//Log_P( PSTR( "ERROR: " ));
va_start( args, fmt );
vLog( fmt, args );
va_end( args );
#else
va_start( args, fmt );
vLogError( fmt, args );
va_end( args );
#endif
} // LogError
/***************************************************************************/
/**
* Logs an entry to the log buffer
*/
#if CFG_LOG_TO_BUFFER
void LogBuf( const char *fmt, uint8_t arg1, uint8_t arg2 LOG_EXTRA_PARAMS_DECL )
{
#if defined( AVR )
uint8_t sreg = SREG;
cli();
#endif
if ( CBUF_IsFull( LOG_gBuffer ))
{
volatile LOG_Entry_t *entry = CBUF_GetLastEntryPtr( LOG_gBuffer );
entry->fmt = PSTR( "*** Lost Messages ***\n" );
}
else
{
volatile LOG_Entry_t *entry = CBUF_GetPushEntryPtr( LOG_gBuffer );
entry->fmt = fmt;
entry->param1 = arg1;
entry->param2 = arg2;
#if CFG_LOG_EXTRA_PARAMS
entry->param3 = arg3;
entry->param4 = arg4;
#endif
CBUF_AdvancePushIdx( LOG_gBuffer );
}
#if defined( AVR )
SREG = sreg;
#endif
} // LogBuf
#endif // CFG_LOG_TO_BUFFER
/***************************************************************************/
/**
* Dumps any unlogged entries from the log buffer
*/
#if CFG_LOG_TO_BUFFER
void LogBufDump( void )
{
while ( !CBUF_IsEmpty( LOG_gBuffer ))
{
volatile LOG_Entry_t *entry = CBUF_GetPopEntryPtr( LOG_gBuffer );
#if CFG_LOG_EXTRA_PARAMS
Log( entry->fmt, entry->param1, entry->param2, entry->param3, entry->param4 );
#else
Log( entry->fmt, entry->param1, entry->param2 );
#endif
CBUF_AdvancePopIdx( LOG_gBuffer );
}
} // LogBufDump
#endif // CFG_LOG_TO_BUFFER
/** @} */
|
