Merge pull request adafruit#6808 from maximkulkin/7.3.x-usb-hid-get-last-report-fix

dhalbert · web-flow · commit d13578fb4e30 · 2022-08-25T08:00:56.000-04:00
shared-module/usb_hid: Fix behavior of Device.get_last_received_report()
diff --git a/shared-module/usb_hid/Device.c b/shared-module/usb_hid/Device.c
@@ -24,6 +24,7 @@
  * THE SOFTWARE.
  */
 
+#include <stdbool.h>
 #include <string.h>
 
 #include "py/gc.h"
@@ -246,6 +247,10 @@ void common_hal_usb_hid_device_send_report(usb_hid_device_obj_t *self, uint8_t *
 mp_obj_t common_hal_usb_hid_device_get_last_received_report(usb_hid_device_obj_t *self, uint8_t report_id) {
     // report_id has already been validated for this device.
     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]);
 }
 
@@ -263,6 +268,7 @@ void usb_hid_device_create_report_buffers(usb_hid_device_obj_t *self) {
             ? gc_alloc(self->out_report_lengths[i], false, true /*long-lived*/)
             : NULL;
     }
+    memset(self->out_report_buffers_updated, 0, sizeof(self->out_report_buffers_updated));
 }
 
 
@@ -309,6 +315,7 @@ void tud_hid_set_report_cb(uint8_t itf, uint8_t report_id, hid_report_type_t rep
             hid_device->out_report_buffers[id_idx] &&
             hid_device->out_report_lengths[id_idx] >= bufsize) {
             memcpy(hid_device->out_report_buffers[id_idx], buffer, bufsize);
+            hid_device->out_report_buffers_updated[id_idx] = true;
         }
     }
 }
diff --git a/shared-module/usb_hid/Device.h b/shared-module/usb_hid/Device.h
@@ -38,6 +38,7 @@ typedef struct  {
     const uint8_t *report_descriptor;
     uint8_t *in_report_buffers[CIRCUITPY_USB_HID_MAX_REPORT_IDS_PER_DESCRIPTOR];
     uint8_t *out_report_buffers[CIRCUITPY_USB_HID_MAX_REPORT_IDS_PER_DESCRIPTOR];
+    uint8_t out_report_buffers_updated[CIRCUITPY_USB_HID_MAX_REPORT_IDS_PER_DESCRIPTOR];
     uint16_t report_descriptor_length;
     uint8_t report_ids[CIRCUITPY_USB_HID_MAX_REPORT_IDS_PER_DESCRIPTOR];
     uint8_t in_report_lengths[CIRCUITPY_USB_HID_MAX_REPORT_IDS_PER_DESCRIPTOR];

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`* THE SOFTWARE.`
`25`	`25`	`*/`
`26`	`26`
	`27`	`+#include <stdbool.h>`
`27`	`28`	`#include <string.h>`
`28`	`29`
`29`	`30`	`#include "py/gc.h"`
`@@ -246,6 +247,10 @@ void common_hal_usb_hid_device_send_report(usb_hid_device_obj_t self, uint8_t `
`246`	`247`	`mp_obj_t common_hal_usb_hid_device_get_last_received_report(usb_hid_device_obj_t *self, uint8_t report_id) {`
`247`	`248`	`// report_id has already been validated for this device.`
`248`	`249`	`size_t id_idx = get_report_id_idx(self, report_id);`
	`250`	`+ if (!self->out_report_buffers_updated[id_idx]) {`
	`251`	`+ return mp_const_none;`
	`252`	`+ }`
	`253`	`+ self->out_report_buffers_updated[id_idx] = false;`
`249`	`254`	`return mp_obj_new_bytes(self->out_report_buffers[id_idx], self->out_report_lengths[id_idx]);`
`250`	`255`	`}`
`251`	`256`
`@@ -263,6 +268,7 @@ void usb_hid_device_create_report_buffers(usb_hid_device_obj_t *self) {`
`263`	`268`	`? gc_alloc(self->out_report_lengths[i], false, true /long-lived/)`
`264`	`269`	`: NULL;`
`265`	`270`	`}`
	`271`	`+ memset(self->out_report_buffers_updated, 0, sizeof(self->out_report_buffers_updated));`
`266`	`272`	`}`
`267`	`273`
`268`	`274`
`@@ -309,6 +315,7 @@ void tud_hid_set_report_cb(uint8_t itf, uint8_t report_id, hid_report_type_t rep`
`309`	`315`	`hid_device->out_report_buffers[id_idx] &&`
`310`	`316`	`hid_device->out_report_lengths[id_idx] >= bufsize) {`
`311`	`317`	`memcpy(hid_device->out_report_buffers[id_idx], buffer, bufsize);`
	`318`	`+ hid_device->out_report_buffers_updated[id_idx] = true;`
`312`	`319`	`}`
`313`	`320`	`}`
`314`	`321`	`}`