Decouple usb log sink from oled sink and expose them via macros.

Author: kareltucek

device/src/shell/shell_commands.c

@@ -379,23 +379,35 @@ static int cmd_uhk_logPriority(const struct shell *shell, size_t argc, char *arg
     return 0;
 }
 
-static int cmd_uhk_logs(const struct shell *shell, size_t argc, char *argv[])
+static int cmd_uhk_usbLog(const struct shell *shell, size_t argc, char *argv[])
 {
     if (argc > 1 && argv[1][0] == '1') {
-        WormCfg->UsbLogEnabled = true;
+        WormCfg->LogUsbSinkEnabled = true;
     } else if (argc > 1 && argv[1][0] == '0') {
-        WormCfg->UsbLogEnabled = false;
+        WormCfg->LogUsbSinkEnabled = false;
     }
 
     uint16_t usbBufferFill, usbBufferSize;
     UsbLogBuffer_GetFill(&usbBufferFill, &usbBufferSize);
 
-    printk("Usb logging enabled: %d\n", WormCfg->UsbLogEnabled);
+    printk("Usb log sink enabled: %d\n", WormCfg->LogUsbSinkEnabled);
     printk("Has log: %d\n", UsbLogBuffer_HasLog);
     printk("Usb log buffer fill: %d / %d\n", usbBufferFill, usbBufferSize);
     return 0;
 }
 
+static int cmd_uhk_oledLog(const struct shell *shell, size_t argc, char *argv[])
+{
+    if (argc > 1 && argv[1][0] == '1') {
+        WormCfg->LogOledSinkEnabled = true;
+    } else if (argc > 1 && argv[1][0] == '0') {
+        WormCfg->LogOledSinkEnabled = false;
+    }
+
+    printk("Oled log sink enabled: %d\n", WormCfg->LogOledSinkEnabled);
+    return 0;
+}
+
 static int cmd_uhk_useShellSinks(const struct shell *shell, size_t argc, char *argv[])
 {
     if (argc == 1) {
@@ -421,7 +433,8 @@ static int cmd_uhk_logStatus(const struct shell *shell, size_t argc, char *argv[
     uint16_t usbBufferFill, usbBufferSize;
     UsbLogBuffer_GetFill(&usbBufferFill, &usbBufferSize);
 
-    printk("Usb logging enabled: %d\n", WormCfg->UsbLogEnabled);
+    printk("Usb log sink enabled: %d\n", WormCfg->LogUsbSinkEnabled);
+    printk("Oled log sink enabled: %d\n", WormCfg->LogOledSinkEnabled);
     printk("Has log: %d\n", UsbLogBuffer_HasLog);
     printk("Usb log buffer fill: %d / %d\n", usbBufferFill, usbBufferSize);
     printk("UseShellSinks: %d\n", ShellConfig_UseShellSinks ? 1 : 0);
@@ -492,7 +505,8 @@ void InitShellCommands(void)
 {
 
     SHELL_STATIC_SUBCMD_SET_CREATE(uhk_log_cmds,
-        SHELL_CMD_ARG(usbLog, NULL, "Set/get USB log enabled", cmd_uhk_logs, 1, 1),
+        SHELL_CMD_ARG(usbSink, NULL, "Set/get USB log sink enabled", cmd_uhk_usbLog, 1, 1),
+        SHELL_CMD_ARG(oledSink, NULL, "Set/get OLED log sink enabled", cmd_uhk_oledLog, 1, 1),
         SHELL_CMD_ARG(priority, NULL, "set log priority", cmd_uhk_logPriority, 2, 0),
         SHELL_CMD_ARG(snapshot, NULL, "Snap log buffer to status buffer", cmd_uhk_snaplog, 1, 0),
         SHELL_CMD_ARG(status, NULL, "print log status overview", cmd_uhk_logStatus, 1, 0),

device/src/shell/sinks.c

@@ -20,8 +20,8 @@ static shell_sinks_t emptyConfig() {
 
 static shell_sinks_t activeConfig() {
     return (shell_sinks_t){
-        .toUsbBuffer = WormCfg->UsbLogEnabled,
-        .toOled = WormCfg->UsbLogEnabled,
+        .toUsbBuffer = WormCfg->LogUsbSinkEnabled,
+        .toOled = WormCfg->LogOledSinkEnabled,
         .toStatusBuffer = ShellConfig_IsInPanicMode,
     };
 }

doc-dev/reference-manual.md

@@ -322,6 +322,8 @@ COMMAND = set bluetooth.peripheralConnectionCount INT
 COMMAND = set bluetooth.minAdvertisingDelay INT
 COMMAND = set bluetooth.directedAdvertisingAllowed BOOL
 COMMAND = set devMode BOOL
+COMMAND = set log.sink.usb BOOL
+COMMAND = set log.sink.oled BOOL
 COMMAND = set maxVoltage INT
 COMMAND = powerMode autoShutdown
 COMMAND = testLeakage

right/src/config_manager.c

@@ -306,7 +306,8 @@ worm_config_t* WormCfg = &StateWormhole.WormCfg;
 
 const worm_config_t DefaultWormCfg = {
     .devMode = false,
-    .UsbLogEnabled = false,
+    .LogUsbSinkEnabled = false,
+    .LogOledSinkEnabled = false,
 };
 
 void ConfigManager_ResetWormConfiguration(void) {

right/src/macros/set_command.c

@@ -145,7 +145,10 @@ static macro_variable_t floatVar(float value)
 
 static macro_variable_t boolVar(bool value)
 {
-    return (macro_variable_t) { .asBool = value, .type = MacroVariableType_Bool };
+    // sanitize the bool and prevent compiler from optimizing it away
+    uint8_t raw;
+    __builtin_memcpy(&raw, &value, 1);
+    return (macro_variable_t) { .asBool = raw != 0, .type = MacroVariableType_Bool };
 }
 
 static int32_t coalesce_int32_t(int32_t lowerBound, int32_t val, int32_t upperBound) {
@@ -960,6 +963,32 @@ static macro_variable_t setMaxVoltage(parser_context_t* ctx, set_command_action_
     return noneVar();
 }
 
+static macro_variable_t logSinks(parser_context_t* ctx, set_command_action_t action)
+{
+    if (ConsumeToken(ctx, "usb")) {
+        ASSIGN_BOOL(WormCfg->LogUsbSinkEnabled);
+    }
+    else if (ConsumeToken(ctx, "oled")) {
+        ASSIGN_BOOL(WormCfg->LogOledSinkEnabled);
+    }
+    else if (action == SetCommandAction_Write) {
+        Macros_ReportErrorTok(ctx, "Parameter not recognized:");
+    }
+    return noneVar();
+}
+
+static macro_variable_t logCommand(parser_context_t* ctx, set_command_action_t action)
+{
+    if (ConsumeToken(ctx, "sink") || ConsumeToken(ctx, "sinks")) {
+        ConsumeUntilDot(ctx);
+        return logSinks(ctx, action);
+    }
+    else if (action == SetCommandAction_Write) {
+        Macros_ReportErrorTok(ctx, "Parameter not recognized:");
+    }
+    return noneVar();
+}
+
 static macro_variable_t root(parser_context_t* ctx, set_command_action_t action)
 {
     if (ConsumeToken(ctx, "module")) {
@@ -1019,6 +1048,10 @@ static macro_variable_t root(parser_context_t* ctx, set_command_action_t action)
         ASSIGN_BOOL(Cfg.DevMode);
         WormCfg->devMode = Cfg.DevMode;
     }
+    else if (ConsumeToken(ctx, "log")) {
+        ConsumeUntilDot(ctx);
+        return logCommand(ctx, action);
+    }
     else if (ConsumeToken(ctx, "stickyModifiers")) {
         return stickyModifiers(ctx, action);
     }

right/src/usb_commands/usb_command_get_variable.c

@@ -41,7 +41,7 @@ void UsbCommand_GetVariable(const uint8_t *GenericHidOutBuffer, uint8_t *Generic
             }
             break;
         case UsbVariable_ShellEnabled:
-            SetUsbTxBufferUint8(1, WormCfg->UsbLogEnabled);
+            SetUsbTxBufferUint8(1, WormCfg->LogUsbSinkEnabled);
             break;
         case UsbVariable_ShellBuffer:
             UsbLogBuffer_Consume(GenericHidInBuffer + 1, USB_COMMAND_BUFFER_LENGTH - 1);

right/src/usb_commands/usb_command_set_variable.c

@@ -51,7 +51,8 @@ void UsbCommand_SetVariable(const uint8_t *GenericHidOutBuffer, uint8_t *Generic
 #endif
             break;
         case UsbVariable_ShellEnabled:
-            WormCfg->UsbLogEnabled = GetUsbRxBufferUint8(2);
+            WormCfg->LogUsbSinkEnabled = GetUsbRxBufferUint8(2);
+            WormCfg->LogOledSinkEnabled = GetUsbRxBufferUint8(2);
             break;
         case UsbVariable_FirmwareVersionCheckEnabled:
             #ifdef __ZEPHYR__

right/src/wormhole.h

@@ -15,7 +15,8 @@
 
     typedef struct {
         bool devMode;
-        bool UsbLogEnabled;
+        bool LogUsbSinkEnabled;
+        bool LogOledSinkEnabled;
     } worm_config_t;
 
     typedef struct {