-
Notifications
You must be signed in to change notification settings - Fork 1
/
utils.c
527 lines (465 loc) · 14.7 KB
/
utils.c
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
/*
* Copyright (c) 2015, Swiss Federal Institute of Technology (ETH Zurich).
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authors: Reto Da Forno, Felix Sutton
*/
/*
* util.c
* utility functions
*/
#include "main.h"
#if defined(DEBUG) || defined(ERROR_LOGGING_TO_FRAM)
int8_t debugBuffer[DEBUG_BUFFER_SIZE]; // define a globally valid buffer for debugging (UART output)
#endif
#ifndef DEBUG
#pragma DATA_SECTION(lastErrorMsg, ".sysmem")
int8_t lastErrorMsg[ERROR_BUFFER_SIZE] = { 0 };
#endif // DEBUG
// clear a memory region in the SRAM or FRAM (copies the word fillValue [numWords] times, beginning at startAddress)
void fillRAM(const uint16_t fillValue,
uint16_t *startAddress,
uint16_t numWords)
{
ASSERT(((uint16_t)startAddress >= FRAM_START && ((uint16_t)startAddress + numWords * 2) <= FRAM_END) ||
((uint16_t)startAddress >= SRAM_START && ((uint16_t)startAddress + numWords * 2) <= SRAM_END));
while (numWords > 0)
{
*startAddress++ = fillValue; // write to FRAM (++ increments the address by 2 after the assignment operation)
numWords--;
}
}
// prints a string (zero-terminated char array with a newline appended) to the UART interface with polling
void printLine(int8_t* string)
{
if (!string)
{
return;
}
for (; 0 != *string; string++) // print each character in array to USART1
{
UART_SEND_BYTE(*string); // send 1 byte
}
UART_SEND_BYTE('\r');
UART_SEND_BYTE('\n'); // print a newline and carriage return
}
// prints a string (zero-terminated char array WITHOUT a newline appended) to the UART interface with polling
void printString(int8_t* string)
{
if (!string)
{
return;
}
for (; 0 != *string; string++) // print each character in array to USART1
{
UART_SEND_BYTE(*string); // send 1 byte
}
}
// prints each character of a zero-terminated char array in hex format to the UART interface with polling (e.g. 65 = 'A' is printed as '0x41 '); a newline is appended at the end
void printAsHexString(uint8_t* string)
{
uint8_t upper, lower;
if (!string)
{
return;
}
for (; 0 != *string; string++) // print each character in array to USART1
{
UART_SEND_BYTE('0');
UART_SEND_BYTE('x');
upper = (*string >> 4);
lower = (*string & 0x0f);
UART_SEND_BYTE((upper > 9) ? ('a' + upper - 10) : ('0' + upper));
UART_SEND_BYTE((lower > 9) ? ('a' + lower - 10) : ('0' + lower));
UART_SEND_BYTE(' ');
}
UART_SEND_BYTE('\n'); // print a newline and carriage return
UART_SEND_BYTE('\r');
}
/*
* composes a string according to the given format, takes up to 2 arguments (integers)
* the resulting string will be in outBuffer
*
* valid format specifiers:
* %s signed integer (16-bit)
* %u unsigned integer (16-bit)
* %S signed integer (32-bit)
* %U unsigned integer (32-bit)
* %h unsigned integer (16-bit) in hex format
* %H unsigned integer (32-bit) in hex format
*
* Note: The user is responsible for allocating enough memory for the output buffer!
*/
int8_t* composeString(int8_t* format, const uint32_t arg1, const uint32_t arg2, int8_t* outBuffer)
{
int8_t* tmp = outBuffer;
int8_t currArg = 0;
if (!outBuffer)
{
return 0;
}
for (; 0 != *format; format++)
{
if (*format == '%' && currArg < 2)
{
format++;
if (*format == '%')
{
*tmp = '%';
tmp++;
} else
{
if (*format == 's' || *format == 'u') // signed / unsigned integer
{
tmp += int16ToStr(currArg ? arg2 : arg1, (*format == 's') > 0, tmp);
} else if (*format == 'h')
{
tmp += int16ToHexStr(currArg ? arg2 : arg1, tmp);
} else if (*format == 'H')
{
tmp += int32ToHexStr(currArg ? arg2 : arg1, tmp);
} else if (*format == 'S' || *format == 'U')
{
tmp += int32ToStr(currArg ? arg2 : arg1, (*format == 'S') > 0, tmp);
} else
{
LOG_INFO("WARNING: Invalid format identifier found in composeString()");
}
currArg++;
}
} else
{
*tmp = *format;
tmp++;
}
}
*tmp = 0;
return outBuffer;
}
/*
* combines two strings (zero-terminated char arrays) into a new string according to the given format
* the resulting string will be in outBuffer
*
* use % as place holders for the strings (arg1 and arg2)
*/
int8_t* concatStrings(int8_t* format, const int8_t* arg1, const int8_t* arg2, int8_t* const outBuffer, uint16_t maxLength)
{
int8_t* tmp = outBuffer;
int8_t currArg = 0;
if (!outBuffer || !arg1 || maxLength < 16)
{
return 0;
}
maxLength--; // reserve 1 byte for the 0
for (; (0 != *format) && (0 != maxLength); format++)
{
if ('%' == *format && currArg < 2)
{
if (1 == currArg && !arg2)
{
LOG_INFO("WARNING: Not enough input arguments provided for concatStrings()");
break; // stop decoding
}
// copy the string
while ( (0 != maxLength) && (0 != *(currArg ? arg2 : arg1)) )
{
*tmp = (currArg ? *arg2 : *arg1);
(currArg ? arg2++ : arg1++);
tmp++;
maxLength--;
}
currArg++;
} else
{
*tmp = *format;
tmp++;
maxLength--;
}
}
*tmp = 0;
return outBuffer;
}
// returns a string containing the given file name and line number (outBuffer must be big enough!)
int8_t* getFileAndLineString(int8_t* outBuffer, const int8_t* f, const uint16_t l)
{
static const int8_t* format = (const int8_t*)"(file %, line %)";
int8_t* tmp = outBuffer;
int8_t currArg = 0;
if (!outBuffer)
{
return 0;
}
for (; 0 != *format; format++)
{
if ('%' == *format)
{
if (0 == currArg)
{
// skip dots and slashes at beginning (if present)
while ('/' == *f || '.' == *f) f++;
// copy the string
while (0 != *f)
{
*tmp = *f;
f++;
tmp++;
}
} else
tmp += int16ToStr(l, 0, tmp);
currArg++;
} else
{
*tmp = *format;
tmp++;
}
}
*tmp = 0;
return outBuffer;
}
// converts a 32-bit integer value to a string (Notes: outBuffer must be at least 16 bytes long! Besides, this function is relatively slow and should only be used for debugging purposes)
int8_t int32ToStr(uint32_t input, const int8_t sign, int8_t* outBuffer)
{
int8_t acTmp[16];
uint8_t i = 0, r, neg = 0;
if (!outBuffer)
{
return 0;
}
if (input == 0)
{
outBuffer[0] = '0';
outBuffer[1] = 0;
return 1;
}
if (sign && (input & 0x80000000))
{
neg = 1;
input &= ~0x80000000;
input = 0x80000000 - input;
}
while (input > 0)
{
r = input % 10;
acTmp[i++] = r + '0';
input /= 10;
}
// copy to output buffer
r = 0;
if (neg)
{
outBuffer[r++] = '-';
}
while (i != 0)
{
outBuffer[r++] = acTmp[--i];
}
outBuffer[r] = 0; // end of string
return r;
}
// converts a 16-bit integer value to a string (Notes: outBuffer must be at least 16 bytes long! Besides, this function is relatively slow and should only be used for debugging purposes)
int8_t int16ToStr(uint16_t input, const int8_t sign, int8_t* outBuffer)
{
int8_t acTmp[8];
uint8_t i = 0, r, neg = 0;
if (!outBuffer)
{
return 0;
}
if (!input)
{
outBuffer[0] = '0';
outBuffer[1] = 0;
return 1;
}
if (sign && (input & 0x8000))
{
neg = 1;
input &= ~0x8000;
input = 0x8000 - input;
}
while (input)
{
r = input % 10;
acTmp[i++] = r + '0';
input /= 10;
}
// copy to output buffer
r = 0;
if (neg)
{
outBuffer[r++] = '-';
}
while (i != 0)
{
outBuffer[r++] = acTmp[--i];
}
outBuffer[r] = 0; // end of string
return r;
}
// converts a 32-bit integer value to a string in hex format (Notes: outBuffer must be at least 11 bytes long!)
int8_t int32ToHexStr(uint32_t input, int8_t* outBuffer)
{
uint8_t i, r;
if (!outBuffer)
{
return 0;
}
//outBuffer[0] = '0'; // don't add '0x' at the beginning
//outBuffer[1] = 'x';
outBuffer[8] = 0; // end of string (it's pos. 10 with '0x' at the beginning)
for (i = 8; i != 0; i--)
{
r = (input & 0xf);
if (r < 10)
{
outBuffer[i - 1] = r + '0'; // it's +1 with '0x' at the beginning
} else
{
outBuffer[i - 1] = r - 10 + 'a'; // it's +1 with '0x' at the beginning
}
input >>= 4; // divide by 16
}
return 8; // 10 with '0x' at the beginning
}
// converts a 16-bit integer value to a string in hex format (Notes: outBuffer must be at least 7 bytes long!)
int8_t int16ToHexStr(uint16_t input, int8_t* outBuffer)
{
uint8_t i, r;
if (!outBuffer)
{
return 0;
}
//outBuffer[0] = '0'; // don't add '0x' at the beginning
//outBuffer[1] = 'x';
outBuffer[4] = 0; // end of string (it's pos. 6 with '0x' at the beginning)
for (i = 4; i != 0; i--)
{
r = (input & 0xf);
if (r < 10)
{
outBuffer[i - 1] = r + '0'; // it's +1 with '0x' at the beginning
} else
{
outBuffer[i - 1] = r - 10 + 'a'; // it's +1 with '0x' at the beginning
}
input >>= 4; // divide by 16
}
return 4; // 6 with '0x' at the beginning
}
// prints out the whole memory content over the UART interface with polling (in hex format, one line per 16-bit memory word)
void printFRAM()
{
// read application start address:
uint16_t *startAddr = (uint16_t*)0x4400;
UART_ENABLE;
while ((uint16_t)startAddr != 0)
{
printLine(composeString("%h: %h", (uint32_t)startAddr, *startAddr, debugBuffer));
startAddr++;
}
}
#ifndef DEBUG
// stores the given string in the FRAM (does not overwrite an existing error message)
void saveErrorMsg(const int8_t* string)
{
int8_t* dst = lastErrorMsg;
uint16_t count = ERROR_BUFFER_SIZE;
if (!string || *lastErrorMsg != 0x00)
{
return;
}
while (*string && count)
{
*dst++ = *string++; // copy byte by byte
count--;
}
lastErrorMsg[ERROR_BUFFER_SIZE - 1] = 0; // make sure it is a zero-terminated string
}
// clears the previous error message (if any)
void eraseErrorMsg()
{
int8_t* dst = lastErrorMsg;
uint16_t count = ERROR_BUFFER_SIZE;
while (count)
{
*dst++ = 0x00;
count--;
}
}
#endif // DEBUG
// note: str must be zero-terminated!
uint16_t getStringLength(const int8_t* str)
{
const int8_t* start = str;
while (0 != *str)
{
str++;
}
return (uint16_t)str - (uint16_t)start;
}
// returns the address of the zero-byte of a string
int8_t* getEOS(int8_t* str)
{
while (0 != *str)
{
str++;
}
return str;
}
// print out the statistics and some information over UART
void logStats()
{
// print out system information
printLine((int8_t*)"\r\nBOLT - (c) 2015, ETH Zurich");
printLine((int8_t*)"\r\nMCU: " MCU_DESC);
printLine(composeString((int8_t*)("Firmware version: %u (" COMPILE_DATE ")\r\nCompiler version: %u"), CODE_VS, COMPILER_VS / 1000, debugBuffer));
printLine(composeString((int8_t*)"Message size: %u", MESSAGE_SIZE, 0, debugBuffer));
printLine(composeString((int8_t*)"Power-on count: %U\r\nPower failure count: %U", systemStats.powerOnCount, systemStats.powerLossCount, debugBuffer));
printLine(composeString((int8_t*)"Crash count: %U\r\nInvalid state transitions: %u", systemStats.crashCount, systemStats.invStateCount, debugBuffer));
printLine(composeString((int8_t*)"Max. number of messages: %u A, %u C", MAX_NUM_OF_MSG_A_TO_C, MAX_NUM_OF_MSG_C_TO_A, debugBuffer));
printLine(composeString((int8_t*)"Queue full count: %U A, %U C", systemStats.fullCountA, systemStats.fullCountC, debugBuffer));
printLine(composeString((int8_t*)"Read count: %U A, %U C", systemStats.readCountA, systemStats.readCountC, debugBuffer));
printLine(composeString((int8_t*)"Write count: %U A, %U C", systemStats.writeCountA, systemStats.writeCountC, debugBuffer));
printLine(composeString((int8_t*)"Abort count: %U A, %U C", systemStats.abortCountA, systemStats.abortCountC, debugBuffer));
printLine(composeString((int8_t*)"Byte count (write): %U A, %U C", systemStats.writeByteCountA, systemStats.writeByteCountC, debugBuffer));
// print random seed (could be used as an ID)
printString(composeString((int8_t*)"Random seed: %h-%h", *(uint16_t*)RAND_SEED_ADDR, *(uint16_t*)(RAND_SEED_ADDR + 2), debugBuffer));
printString(composeString((int8_t*)"-%h-%h", *(uint16_t*)(RAND_SEED_ADDR + 4), *(uint16_t*)(RAND_SEED_ADDR + 6), debugBuffer));
printString(composeString((int8_t*)"-%h-%h", *(uint16_t*)(RAND_SEED_ADDR + 8), *(uint16_t*)(RAND_SEED_ADDR + 10), debugBuffer));
printLine(composeString((int8_t*)"-%h-%h", *(uint16_t*)(RAND_SEED_ADDR + 12), *(uint16_t*)(RAND_SEED_ADDR + 14), debugBuffer));
#ifndef DEBUG
if (*lastErrorMsg == 0x00)
{
printLine((int8_t*)"Last error: -");
} else
{
printString((int8_t*)"Last error: ");
printLine((int8_t*)lastErrorMsg);
}
#endif // DEBUG
}