Merge 9de57c1918 into 0f972f1cc3

app/Kconfig

@@ -650,6 +650,15 @@ config ZMK_SETTINGS_SAVE_DEBOUNCE
 #SETTINGS
 endif
 
+config ZMK_WORKAROUND_COPY_USB_TX_DATA_BUFFER
+    bool "Enable workaround for USB driver not copying data before transmit"
+    help
+      Work around some hardware USB drivers not copying the passed USB TX buffer
+      contents before beginning a transaction, causing corruption of the USB
+      message, by copying the TX data into a temporary buffer first. For
+      example, the NRFx family of Zephyr drivers suffer this issue.
+    default y if SOC_SERIES_NRF52X
+
 config ZMK_BATTERY_REPORT_INTERVAL
     depends on ZMK_BATTERY_REPORTING
     int "Battery level report interval in seconds"

app/include/zmk/hid.h

@@ -270,6 +270,30 @@ struct zmk_hid_mouse_report {
 
 #endif // IS_ENABLED(CONFIG_ZMK_MOUSE)
 
+struct zmk_hid_report_body {
+    union {
+#if IS_ENABLED(CONFIG_ZMK_MOUSE)
+        struct zmk_hid_mouse_report_body mouse;
+#endif
+
+        struct zmk_hid_keyboard_report_body keyboard;
+        struct zmk_hid_consumer_report_body consumer;
+    } __packed;
+} __packed;
+
+struct zmk_hid_report {
+    union {
+#if IS_ENABLED(CONFIG_ZMK_USB_BOOT)
+        zmk_hid_boot_report_t boot;
+#endif
+
+        struct {
+            uint8_t report_id;
+            struct zmk_hid_report_body body;
+        } __packed;
+    } __packed;
+} __packed;
+
 zmk_mod_flags_t zmk_hid_get_explicit_mods(void);
 int zmk_hid_register_mod(zmk_mod_t modifier);
 int zmk_hid_unregister_mod(zmk_mod_t modifier);

app/src/hog.c

@@ -224,22 +224,41 @@ K_THREAD_STACK_DEFINE(hog_q_stack, CONFIG_ZMK_BLE_THREAD_STACK_SIZE);
 
 struct k_work_q hog_work_q;
 
-K_MSGQ_DEFINE(zmk_hog_keyboard_msgq, sizeof(struct zmk_hid_keyboard_report_body),
+static int hog_send_report(struct k_msgq *msgq, struct k_work *work, void *body) {
-              CONFIG_ZMK_BLE_KEYBOARD_REPORT_QUEUE_SIZE, 4);
+    int err = k_msgq_put(msgq, body, K_MSEC(100));
+    if (err) {
+        switch (err) {
+        case -EAGAIN: {
+            LOG_WRN("Message queue full, popping first message and queueing again");
+            struct zmk_hid_keyboard_report_body discard;
+            k_msgq_get(msgq, &discard, K_NO_WAIT);
+            return hog_send_report(msgq, work, body);
+        }
+        default:
+            LOG_WRN("Failed to queue report to send (%d)", err);
+            return err;
+        }
+    }
 
-void send_keyboard_report_callback(struct k_work *work) {
+    k_work_submit_to_queue(&hog_work_q, work);
-    struct zmk_hid_keyboard_report_body report;
 
-    while (k_msgq_get(&zmk_hog_keyboard_msgq, &report, K_NO_WAIT) == 0) {
+    return 0;
+};
+
+static void send_report_callback(struct k_msgq *msgq, const struct bt_gatt_attr *attr,
+                                 uint8_t len) {
+    uint8_t body[sizeof(struct zmk_hid_report_body)];
+
+    while (k_msgq_get(msgq, &body, K_NO_WAIT) == 0) {
         struct bt_conn *conn = zmk_ble_active_profile_conn();
         if (conn == NULL) {
             return;
         }
 
         struct bt_gatt_notify_params notify_params = {
-            .attr = &hog_svc.attrs[5],
+            .attr = attr,
-            .data = &report,
+            .len = len,
-            .len = sizeof(report),
+            .data = &body,
         };
 
         int err = bt_gatt_notify_cb(conn, &notify_params);
@@ -253,135 +272,53 @@ void send_keyboard_report_callback(struct k_work *work) {
     }
 }
 
+K_MSGQ_DEFINE(hog_keyboard_msgq, sizeof(struct zmk_hid_keyboard_report_body),
+              CONFIG_ZMK_BLE_KEYBOARD_REPORT_QUEUE_SIZE, 4);
+
+K_MSGQ_DEFINE(hog_consumer_msgq, sizeof(struct zmk_hid_consumer_report_body),
+              CONFIG_ZMK_BLE_CONSUMER_REPORT_QUEUE_SIZE, 4);
+
+#if IS_ENABLED(CONFIG_ZMK_MOUSE)
+K_MSGQ_DEFINE(hog_mouse_msgq, sizeof(struct zmk_hid_mouse_report_body),
+              CONFIG_ZMK_BLE_MOUSE_REPORT_QUEUE_SIZE, 4);
+#endif
+
+static void send_keyboard_report_callback(struct k_work *work) {
+    send_report_callback(&hog_keyboard_msgq, &hog_svc.attrs[5],
+                         sizeof(struct zmk_hid_keyboard_report_body));
+}
+
 K_WORK_DEFINE(hog_keyboard_work, send_keyboard_report_callback);
 
-int zmk_hog_send_keyboard_report(struct zmk_hid_keyboard_report_body *report) {
+static void send_consumer_report_callback(struct k_work *work) {
-    int err = k_msgq_put(&zmk_hog_keyboard_msgq, report, K_MSEC(100));
+    send_report_callback(&hog_consumer_msgq, &hog_svc.attrs[9],
-    if (err) {
+                         sizeof(struct zmk_hid_consumer_report_body));
-        switch (err) {
-        case -EAGAIN: {
-            LOG_WRN("Keyboard message queue full, popping first message and queueing again");
-            struct zmk_hid_keyboard_report_body discarded_report;
-            k_msgq_get(&zmk_hog_keyboard_msgq, &discarded_report, K_NO_WAIT);
-            return zmk_hog_send_keyboard_report(report);
-        }
-        default:
-            LOG_WRN("Failed to queue keyboard report to send (%d)", err);
-            return err;
-        }
-    }
-
-    k_work_submit_to_queue(&hog_work_q, &hog_keyboard_work);
-
-    return 0;
-};
-
-K_MSGQ_DEFINE(zmk_hog_consumer_msgq, sizeof(struct zmk_hid_consumer_report_body),
-              CONFIG_ZMK_BLE_CONSUMER_REPORT_QUEUE_SIZE, 4);
-
-void send_consumer_report_callback(struct k_work *work) {
-    struct zmk_hid_consumer_report_body report;
-
-    while (k_msgq_get(&zmk_hog_consumer_msgq, &report, K_NO_WAIT) == 0) {
-        struct bt_conn *conn = zmk_ble_active_profile_conn();
-        if (conn == NULL) {
-            return;
-        }
-
-        struct bt_gatt_notify_params notify_params = {
-            .attr = &hog_svc.attrs[9],
-            .data = &report,
-            .len = sizeof(report),
-        };
-
-        int err = bt_gatt_notify_cb(conn, &notify_params);
-        if (err == -EPERM) {
-            bt_conn_set_security(conn, BT_SECURITY_L2);
-        } else if (err) {
-            LOG_DBG("Error notifying %d", err);
-        }
-
-        bt_conn_unref(conn);
-    }
 };
 
 K_WORK_DEFINE(hog_consumer_work, send_consumer_report_callback);
 
-int zmk_hog_send_consumer_report(struct zmk_hid_consumer_report_body *report) {
-    int err = k_msgq_put(&zmk_hog_consumer_msgq, report, K_MSEC(100));
-    if (err) {
-        switch (err) {
-        case -EAGAIN: {
-            LOG_WRN("Consumer message queue full, popping first message and queueing again");
-            struct zmk_hid_consumer_report_body discarded_report;
-            k_msgq_get(&zmk_hog_consumer_msgq, &discarded_report, K_NO_WAIT);
-            return zmk_hog_send_consumer_report(report);
-        }
-        default:
-            LOG_WRN("Failed to queue consumer report to send (%d)", err);
-            return err;
-        }
-    }
-
-    k_work_submit_to_queue(&hog_work_q, &hog_consumer_work);
-
-    return 0;
-};
-
 #if IS_ENABLED(CONFIG_ZMK_MOUSE)
-
+static void send_mouse_report_callback(struct k_work *work) {
-K_MSGQ_DEFINE(zmk_hog_mouse_msgq, sizeof(struct zmk_hid_mouse_report_body),
+    send_report_callback(&hog_mouse_msgq, &hog_svc.attrs[13],
-              CONFIG_ZMK_BLE_MOUSE_REPORT_QUEUE_SIZE, 4);
+                         sizeof(struct zmk_hid_mouse_report_body));
-
-void send_mouse_report_callback(struct k_work *work) {
-    struct zmk_hid_mouse_report_body report;
-    while (k_msgq_get(&zmk_hog_mouse_msgq, &report, K_NO_WAIT) == 0) {
-        struct bt_conn *conn = zmk_ble_active_profile_conn();
-        if (conn == NULL) {
-            return;
-        }
-
-        struct bt_gatt_notify_params notify_params = {
-            .attr = &hog_svc.attrs[13],
-            .data = &report,
-            .len = sizeof(report),
-        };
-
-        int err = bt_gatt_notify_cb(conn, &notify_params);
-        if (err == -EPERM) {
-            bt_conn_set_security(conn, BT_SECURITY_L2);
-        } else if (err) {
-            LOG_DBG("Error notifying %d", err);
-        }
-
-        bt_conn_unref(conn);
-    }
 };
 
 K_WORK_DEFINE(hog_mouse_work, send_mouse_report_callback);
+#endif
 
-int zmk_hog_send_mouse_report(struct zmk_hid_mouse_report_body *report) {
+int zmk_hog_send_keyboard_report(struct zmk_hid_keyboard_report_body *body) {
-    int err = k_msgq_put(&zmk_hog_mouse_msgq, report, K_MSEC(100));
+    return hog_send_report(&hog_keyboard_msgq, &hog_keyboard_work, body);
-    if (err) {
-        switch (err) {
-        case -EAGAIN: {
-            LOG_WRN("Consumer message queue full, popping first message and queueing again");
-            struct zmk_hid_mouse_report_body discarded_report;
-            k_msgq_get(&zmk_hog_mouse_msgq, &discarded_report, K_NO_WAIT);
-            return zmk_hog_send_mouse_report(report);
-        }
-        default:
-            LOG_WRN("Failed to queue mouse report to send (%d)", err);
-            return err;
-        }
-    }
-
-    k_work_submit_to_queue(&hog_work_q, &hog_mouse_work);
-
-    return 0;
 };
 
-#endif // IS_ENABLED(CONFIG_ZMK_MOUSE)
+int zmk_hog_send_consumer_report(struct zmk_hid_consumer_report_body *body) {
+    return hog_send_report(&hog_consumer_msgq, &hog_consumer_work, body);
+};
+
+#if IS_ENABLED(CONFIG_ZMK_MOUSE)
+int zmk_hog_send_mouse_report(struct zmk_hid_mouse_report_body *body) {
+    return hog_send_report(&hog_mouse_msgq, &hog_mouse_work, body);
+};
+#endif
 
 static int zmk_hog_init(void) {
     static const struct k_work_queue_config queue_config = {.name = "HID Over GATT Send Work"};

app/src/usb_hid.c

@@ -4,6 +4,8 @@
  * SPDX-License-Identifier: MIT
  */
 
+#include <zephyr/sys/util.h>
+
 #include <zephyr/device.h>
 #include <zephyr/init.h>
 
@@ -24,6 +26,17 @@ static const struct device *hid_dev;
 
 static K_SEM_DEFINE(hid_sem, 1, 1);
 
+#if IS_ENABLED(CONFIG_ZMK_WORKAROUND_COPY_USB_TX_DATA_BUFFER)
+static uint8_t hid_ep_write_buf[sizeof(struct zmk_hid_report)];
+
+static const uint8_t *prepare_report_buf(const uint8_t *report, size_t len) {
+    memcpy(hid_ep_write_buf, report, len);
+    return hid_ep_write_buf;
+}
+#else
+static const uint8_t *prepare_report_buf(const uint8_t *report, size_t len) { return report; }
+#endif
+
 static void in_ready_cb(const struct device *dev) { k_sem_give(&hid_sem); }
 
 #define HID_GET_REPORT_TYPE_MASK 0xff00
@@ -137,7 +150,8 @@ static int zmk_usb_hid_send_report(const uint8_t *report, size_t len) {
         return -ENODEV;
     default:
         k_sem_take(&hid_sem, K_MSEC(30));
-        int err = hid_int_ep_write(hid_dev, report, len, NULL);
+        const uint8_t *buf = prepare_report_buf(report, len);
+        int err = hid_int_ep_write(hid_dev, buf, len, NULL);
 
         if (err) {
             k_sem_give(&hid_sem);