Implement and enable usb_hid on Zephyr

locale/circuitpython.pot

@@ -2244,6 +2244,10 @@ msgstr ""
 msgid "SocketPool can only be used with wifi.radio or hostnetwork.HostNetwork"
 msgstr ""
 
+#: ports/zephyr-cp/common-hal/usb_hid/Device.c shared-module/usb_hid/Device.c
+msgid "USB error"
+msgstr ""
+
 #: ports/zephyr-cp/common-hal/wifi/Radio.c
 msgid "Failed to set hostname"
 msgstr ""
@@ -3749,10 +3753,6 @@ msgstr ""
 msgid "bits_per_sample must be 16"
 msgstr ""
 
-#: shared-bindings/audioi2sin/I2SIn.c
-msgid "%q requires %q"
-msgstr ""
-
 #: shared-bindings/audioi2sin/I2SIn.c
 #, c-format
 msgid "invalid destination buffer, must be an array of type: %c"
@@ -4514,10 +4514,6 @@ msgstr ""
 msgid "USB busy"
 msgstr ""
 
-#: shared-module/usb_hid/Device.c
-msgid "USB error"
-msgstr ""
-
 #: shared-module/vectorio/Circle.c shared-module/vectorio/Polygon.c
 #: shared-module/vectorio/Rectangle.c
 msgid "can only have one parent"

ports/zephyr-cp/app.overlay

@@ -8,3 +8,15 @@
 		label = "CircuitPython Data";
 	};
 };
+
+/ {
+	hid_dev_0: hid_dev_0 {
+		compatible = "zephyr,hid-device";
+		label = "HID0";
+		protocol-code = "none";
+		in-polling-period-us = <1000>;
+		in-report-size = <64>;
+		out-polling-period-us = <1000>;
+		out-report-size = <64>;
+	};
+};

ports/zephyr-cp/boards/adafruit/feather_nrf52840_sense_zephyr/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/adafruit/feather_nrf52840_zephyr/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/adafruit/feather_rp2040_zephyr/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/nordic/nrf5340dk/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/nordic/nrf54h20dk/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/nordic/nrf54lm20dk/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/nordic/nrf7002dk/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/nxp/frdm_mcxn947/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/nxp/frdm_rw612/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/nxp/mimxrt1170_evk/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/raspberrypi/rpi_pico2_w_zephyr/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/raspberrypi/rpi_pico2_zephyr/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/raspberrypi/rpi_pico_w_zephyr/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/raspberrypi/rpi_pico_zephyr/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/renesas/da14695_dk_usb/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/renesas/ek_ra6m5/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/renesas/ek_ra8d1/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/st/nucleo_n657x0_q/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/st/nucleo_u575zi_q/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/st/stm32h7b3i_dk/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/boards/st/stm32wba65i_dk1/autogen_board_info.toml

@@ -109,7 +109,7 @@ uheap = false
 usb = false
 usb_audio = false
 usb_cdc = true
-usb_hid = false
+usb_hid = true
 usb_host = false
 usb_midi = false
 usb_video = false

ports/zephyr-cp/common-hal/usb_hid/Device.c

@@ -0,0 +1,150 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2018 hathach for Adafruit Industries
+// SPDX-FileCopyrightText: Copyright (c) 2025 Scott Shawcroft for Adafruit Industries
+//
+// SPDX-License-Identifier: MIT
+
+#include <stdbool.h>
+#include <string.h>
+
+#include "py/gc.h"
+#include "py/runtime.h"
+#include "shared-bindings/usb_hid/Device.h"
+#include "shared-module/usb_hid/__init__.h"
+#include "shared-module/usb_hid/Device.h"
+#include "shared-module/usb_hid/report_descriptors.h"
+#include "common-hal/usb_hid/__init__.h"
+#include "supervisor/shared/tick.h"
+
+const usb_hid_device_obj_t usb_hid_device_keyboard_obj = {
+    .base = {
+        .type = &usb_hid_device_type,
+    },
+    .report_descriptor = keyboard_report_descriptor,
+    .report_descriptor_length = sizeof(keyboard_report_descriptor),
+    .usage_page = 0x01,
+    .usage = 0x06,
+    .num_report_ids = 1,
+    .report_ids = { 0x01, },
+    .in_report_lengths = { 8, },
+    .out_report_lengths = { 1, },
+};
+
+const usb_hid_device_obj_t usb_hid_device_mouse_obj = {
+    .base = {
+        .type = &usb_hid_device_type,
+    },
+    .report_descriptor = mouse_report_descriptor,
+    .report_descriptor_length = sizeof(mouse_report_descriptor),
+    .usage_page = 0x01,
+    .usage = 0x02,
+    .num_report_ids = 1,
+    .report_ids = { 0x02, },
+    .in_report_lengths = { 4, },
+    .out_report_lengths = { 0, },
+};
+
+const usb_hid_device_obj_t usb_hid_device_consumer_control_obj = {
+    .base = {
+        .type = &usb_hid_device_type,
+    },
+    .report_descriptor = consumer_control_report_descriptor,
+    .report_descriptor_length = sizeof(consumer_control_report_descriptor),
+    .usage_page = 0x0C,
+    .usage = 0x01,
+    .num_report_ids = 1,
+    .report_ids = { 0x03 },
+    .in_report_lengths = { 2, },
+    .out_report_lengths = { 0, },
+};
+
+char *custom_usb_hid_interface_name;
+
+static size_t get_report_id_idx(usb_hid_device_obj_t *self, size_t report_id) {
+    for (size_t i = 0; i < self->num_report_ids; i++) {
+        if (report_id == self->report_ids[i]) {
+            return i;
+        }
+    }
+    return CIRCUITPY_USB_HID_MAX_REPORT_IDS_PER_DESCRIPTOR;
+}
+
+uint8_t common_hal_usb_hid_device_validate_report_id(usb_hid_device_obj_t *self, mp_int_t report_id_arg) {
+    if (report_id_arg == -1 && self->num_report_ids == 1) {
+        return self->report_ids[0];
+    }
+    if (!(report_id_arg >= 0 &&
+          get_report_id_idx(self, (size_t)report_id_arg) < CIRCUITPY_USB_HID_MAX_REPORT_IDS_PER_DESCRIPTOR)) {
+        mp_arg_error_invalid(MP_QSTR_report_id);
+    }
+    return (uint8_t)report_id_arg;
+}
+
+void common_hal_usb_hid_device_construct(usb_hid_device_obj_t *self, mp_obj_t report_descriptor, uint16_t usage_page, uint16_t usage, size_t num_report_ids, uint8_t *report_ids, uint8_t *in_report_lengths, uint8_t *out_report_lengths) {
+    mp_arg_validate_length_max(
+        num_report_ids, CIRCUITPY_USB_HID_MAX_REPORT_IDS_PER_DESCRIPTOR, MP_QSTR_report_ids);
+
+    mp_buffer_info_t bufinfo;
+    mp_get_buffer_raise(report_descriptor, &bufinfo, MP_BUFFER_READ);
+    self->report_descriptor_length = bufinfo.len;
+
+    uint8_t *descriptor_bytes = gc_alloc(bufinfo.len, false);
+    memcpy(descriptor_bytes, bufinfo.buf, bufinfo.len);
+    self->report_descriptor = descriptor_bytes;
+
+    self->usage_page = usage_page;
+    self->usage = usage;
+    self->num_report_ids = num_report_ids;
+    memcpy(self->report_ids, report_ids, num_report_ids);
+    memcpy(self->in_report_lengths, in_report_lengths, num_report_ids);
+    memcpy(self->out_report_lengths, out_report_lengths, num_report_ids);
+}
+
+uint16_t common_hal_usb_hid_device_get_usage_page(usb_hid_device_obj_t *self) {
+    return self->usage_page;
+}
+
+uint16_t common_hal_usb_hid_device_get_usage(usb_hid_device_obj_t *self) {
+    return self->usage;
+}
+
+void common_hal_usb_hid_device_send_report(usb_hid_device_obj_t *self, uint8_t *report, uint8_t len, uint8_t report_id) {
+    size_t id_idx = get_report_id_idx(self, report_id);
+
+    mp_arg_validate_length(len, self->in_report_lengths[id_idx], MP_QSTR_report);
+
+    // Wait until interface is ready, timeout = 2 seconds
+    uint64_t end_ticks = supervisor_ticks_ms64() + 2000;
+    while ((supervisor_ticks_ms64() < end_ticks) && !usb_hid_ready()) {
+        RUN_BACKGROUND_TASKS;
+    }
+
+    if (!usb_hid_submit_report(report_id, report, len)) {
+        mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("USB error"));
+    }
+}
+
+mp_obj_t common_hal_usb_hid_device_get_last_received_report(usb_hid_device_obj_t *self, uint8_t report_id) {
+    size_t id_idx = get_report_id_idx(self, report_id);
+    if (!self->out_report_buffers_updated[id_idx]) {
+        return mp_const_none;
+    }
+    self->out_report_buffers_updated[id_idx] = false;
+    return mp_obj_new_bytes(self->out_report_buffers[id_idx], self->out_report_lengths[id_idx]);
+}
+
+void usb_hid_device_create_report_buffers(usb_hid_device_obj_t *self) {
+    for (size_t i = 0; i < self->num_report_ids; i++) {
+        self->in_report_buffers[i] =
+            self->in_report_lengths[i] > 0
+            ? gc_alloc(self->in_report_lengths[i], false)
+            : NULL;
+
+        self->out_report_buffers[i] =
+            self->out_report_lengths[i] > 0
+            ? gc_alloc(self->out_report_lengths[i], false)
+            : NULL;
+    }
+    memset(self->out_report_buffers_updated, 0, sizeof(self->out_report_buffers_updated));
+}