You've already forked crosspoint-reader
mirror of
https://github.com/crosspoint-reader/crosspoint-reader.git
synced 2026-02-13 15:13:44 -08:00
cb24947477
## Summary
* Definition and use of a central LOG function, that can later be
extended or completely be removed (for public use where debugging
information may not be required) to save flash by suppressing the
-DENABLE_SERIAL_LOG like in the slim branch
* **What changes are included?**
## Additional Context
* By using the central logger the usual:
```
#include <HardwareSerial.h>
...
Serial.printf("[%lu] [WCS] Obfuscating/deobfuscating %zu bytes\n", millis(), data.size());
```
would then become
```
#include <Logging.h>
...
LOG_DBG("WCS", "Obfuscating/deobfuscating %zu bytes", data.size());
```
You do have ``LOG_DBG`` for debug messages, ``LOG_ERR`` for error
messages and ``LOG_INF`` for informational messages. Depending on the
verbosity level defined (see below) soe of these message types will be
suppressed/not-compiled.
* The normal compilation (default) will create a firmware.elf file of
42.194.356 bytes, the same code via slim will create 42.024.048 bytes -
170.308 bytes less
* Firmware.bin : 6.469.984 bytes for default, 6.418.672 bytes for slim -
51.312 bytes less
### AI Usage
While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.
Did you use AI tools to help write this code? _NO_
---------
Co-authored-by: Xuan Son Nguyen <son@huggingface.co>
48 lines
1.2 KiB
C++
48 lines
1.2 KiB
C++
#include "Logging.h"
|
|
|
|
// Since logging can take a large amount of flash, we want to make the format string as short as possible.
|
|
// This logPrintf prepend the timestamp, level and origin to the user-provided message, so that the user only needs to
|
|
// provide the format string for the message itself.
|
|
void logPrintf(const char* level, const char* origin, const char* format, ...) {
|
|
if (!logSerial) {
|
|
return; // Serial not initialized, skip logging
|
|
}
|
|
va_list args;
|
|
va_start(args, format);
|
|
char buf[256];
|
|
char* c = buf;
|
|
// add the timestamp
|
|
{
|
|
unsigned long ms = millis();
|
|
int len = snprintf(c, sizeof(buf), "[%lu] ", ms);
|
|
if (len < 0) {
|
|
return; // encoding error, skip logging
|
|
}
|
|
c += len;
|
|
}
|
|
// add the level
|
|
{
|
|
const char* p = level;
|
|
size_t remaining = sizeof(buf) - (c - buf);
|
|
while (*p && remaining > 1) {
|
|
*c++ = *p++;
|
|
remaining--;
|
|
}
|
|
if (remaining > 1) {
|
|
*c++ = ' ';
|
|
}
|
|
}
|
|
// add the origin
|
|
{
|
|
int len = snprintf(c, sizeof(buf) - (c - buf), "[%s] ", origin);
|
|
if (len < 0) {
|
|
return; // encoding error, skip logging
|
|
}
|
|
c += len;
|
|
}
|
|
// add the user message
|
|
vsnprintf(c, sizeof(buf) - (c - buf), format, args);
|
|
va_end(args);
|
|
logSerial.print(buf);
|
|
}
|