diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2009-10-26 11:44:36 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-10-26 11:44:36 +0000 |
commit | de8c9445d478dc31dab7e042c9c2943d0758bbb3 (patch) | |
tree | bd6d4e98ce3a3d2995a7cbc86f0fcd84abdef5ad /LUFA/Drivers/USB/Class/Device/HID.h | |
parent | 9ea891ea201a3ef897b108c7a9431d36cadfafae (diff) | |
download | lufa-de8c9445d478dc31dab7e042c9c2943d0758bbb3.tar.gz lufa-de8c9445d478dc31dab7e042c9c2943d0758bbb3.tar.bz2 lufa-de8c9445d478dc31dab7e042c9c2943d0758bbb3.zip |
Make HID device class driver ignore the previous HID report comparison buffer when the user sets it to NULL, disabling automatic report comparisons. Update HID device class driver documentation giving previous report buffer limitations.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Device/HID.h')
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/HID.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index dee892d06..4865a1243 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -77,7 +77,14 @@ void* PrevReportINBuffer; /** Pointer to a buffer where the previously created HID input report can be
* stored by the driver, for comparison purposes to detect report changes that
* must be sent immediately to the host. This should point to a buffer big enough
- * to hold the largest HID input report sent from the HID interface.
+ * to hold the largest HID input report sent from the HID interface. If this is set
+ * to NULL, it is up to the user to force transfers when needed in the
+ * \ref CALLBACK_HID_Device_CreateHIDReport() callback function.
+ *
+ * \note Due to the single buffer, the internal driver can only correctly compare
+ * subsequent reports with identical report IDs. In multiple report devices,
+ * this buffer should be set to NULL and the decision to send reports made
+ * by the user application instead.
*/
uint8_t PrevReportINBufferSize; /** Size in bytes of the given input report buffer. This is used to create a
* second buffer of the same size within the driver so that subsequent reports
|