Dwayne Dilbeck / USBDevice

Forked to make modifications to bring the USBHID into USB compliance and add additional features.

Dependents:   HW4_AudioControl

Fork of USBDevice by mbed official

As of Revision 18 everything in the USBHID specification is now implemented, except Multi-reports.

Revision comments for changelist 18

USBHID.cpp

  • Added SET_PROTOCOL support
  • Added GET_PROTOCOL support
  • protocolSate is set to 1 by default to match USB HID specification. This variable should be checked to determine which format theinput report should have. 1 - Use the user specified report format. 0 - Use the BOOT protocol report format.

Revision comments for changelist 16

  • HID_REPORT transformed from structure to class. This was done for several reasons.
  1. When multiple reports are used the 64 byte size for every report becomes a problem.
  2. The length value should always remain the same for a report, Make the constructor set the vale at the same time it allocates memory for the DATA area.
  • By default the data will be an array of MAX_HID_REPORT_SIZE like the structure,
  • When given a length argument, the hid_report.length will be set, and hid_report.data will be an array of the size given.
  • Length zero causes data to be NULL
  • Mostly backwards compatible. The definition of a destructor caused a compiler error in USBMouse::update and USBMousekeyboard::update. This error was caused by instatiation of HID_REPORT in the middle of an IF logic statement. These files have been modified. The error complained that the logic skipped object initialization. The HID_REPORT has been moved to the class definition. Since both ABSOLUTE and RELATIVE modes used the HID_REPORT, this seems to make more sense. Previously the hid_report would be instatiated in <class>::mousesend and <class>::update.

Revision comments for changelist 14

USBdevice.cpp

  • Modified USB device state to change from Configure when disconnect is called.
  • Modified the call back function for when the suspend state changes. This should be used to turn off peripherals to conserve power.

Revision comments for changelist 13

USBdevice.cpp

  • ) Changed DEBUG messages to be more descriptive for string descriptor
  • ) Bug fix: Control Transfers did not actually transfer the data from Buffer to transfer->ptr

USBHIDTypes.h

  • ) Added ALL CLASS request to KEYWORD list
  • ) Added KEYWORDS for report type

USBHID.h

  • ) Added a new constructor to specify size of feature report
  • ) Added HID_REPORT inputReport and featureReport
  • ) Added data structures to support IDLE rate
  • ) Added data structures to support callback functions

USBHID.cpp

  • ) Changed constructor to initialize new feature data structures
  • ) Implemented Set_IDLE/GET_IDLE and the periodic resend of non-changed data
  • ) Implemented HID specification required control transfer GET_REPORT
  • ) Fixed issue where Intreput transfers and control transfers did not access the same data structures.
  • ) Implemented Feature reports
  • ) Implemented Callback Hooks for get_report/set_report actions.
  • ) Added callback hooks for interupt actions in the new functions.
  • ) interupt transfer can now write to outputReport
  • ) Modified SET_REPORT code to function for multiple types.
  • ) Refactored some code in preperation to add multi report support
Test NumberTest DescriptionTest ResultNotes
1Use USBmouse to verify backward compatibility of constructor and methodsPass
2Test SET_REPORT can set a feature reportPass
3Test GET_REPORT can retrieve a feature reportPass
4Test SET_IDLE sets up a reoccuring triggerPassIOCTL_SET_POLL_FREQUENCY_MSEC does not function for the windows HID driver. A Special test program is used to rearm the IDLE rate after windows sets it to zero
5Test SET_IDLE disables a triggerPassWindows automatically sends this command to a HID device when it is inserted.
6Enabled DEBUG in USBDevice.cpp and generated str descriptor requests.Pass
7Test SET_REPORT can set an output reportPass
8Test GET_REPORT can retrieve an output reportPass
9ReadFile, accesses the input_reportPass
10WriteFile accesses the output_report, via interupt transfer when ep1_out is used.Pass
11WriteFile accesses the output_report, via control transfer when ep1_out is NOT used.Not Tested
12Callback hooks trigger independently for each type of set_report/get_reportPass
13New constructor sets feature_report sizePass
14Control transfer SET_REPORT and writeFile access the same data structureBUGThe same data structure is accessed, but the data transfer size is different. The writeFile strips the leading byte which is the report ID, The Control transfer keeps the byte.
15Control transfer GET_REPORT and readFile access the same data structureBUGThe same dtat structure is accessed, but the data transfer size is different. The readFile strips the leading byte which is the report ID, The Control transfer keeps the byte.
16Test GET_IDLE retrieves the IDLE rateUnknownWindows HID driver does not implement IOCTL_HID_GET_POLL_FREQUENCY_MSEC

Files at this revision

API Documentation at this revision

Revision 13:9f652add7891, committed 2013-07-25

Comitter:
jakowisp
Date:
Thu Jul 25 01:06:37 2013 +0000
Parent:
12:590d5be7b7f4
Child:
14:00cd29199e0e
Commit message:
Changed the Comments to display better information on the wiki page.

Changed in this revision

USBHID/USBHID.h Show annotated file Show diff for this revision Revisions of this file 
--- a/USBHID/USBHID.h	Thu Jul 25 00:38:09 2013 +0000
+++ b/USBHID/USBHID.h	Thu Jul 25 01:06:37 2013 +0000
@@ -30,19 +30,38 @@
 /**
  * USBHID example
  * @code
- * #include "mbed.h"
- * #include "USBHID.h"
- *
- * USBHID hid;
- * HID_REPORT recv;
- * BusOut leds(LED1,LED2,LED3,LED4);
- *
+ * 
+ * //We declare a USBHID device. Input, Output, and Feature reports have a length of 8 bytes
+ * USBHID hid(8, 8, 8,0x1234,0x0006, 0x0001,true);
+ * HID_REPORT tempReport;
+ 
+ * void MycallbackSetReport(HID_REPORT *report){
+ *     printf("Report: ");
+ *             for(int i = 0; i < report->length; i++) {
+ *                 printf("%x ", report->data[i]);
+ *             }
+ *     printf("\r\n");
+ * };
+ * 
+ * bool SetTempReport(HID_REPORT *report){
+ *         for (int i = 0; i < report->length; i++) {
+ *             report->data[i] = rand() & 0xff;
+ *         }
+ *     return true;
+ * };
+ *  
  * int main(void) {
- *    while (1) {
- *        hid.read(&recv);
- *        leds = recv.data[0];
- *    }
+ *     printf("Starting==>\r\n");
+ *     hid.callbackSetOutputReport=&MycallbackSetReport;    
+ *     tempReport.length=8;
+
+ *     while (1) {
+ *        SetTempReport(&tempReport);
+ *        hid.FillInputReport(&tempReport);        
+ *        wait(2.2);
+ *     }
  * }
+ * 
  * @endcode
  */
 
@@ -50,7 +69,7 @@
 public:
 
     /**
-    * Constructors
+    * Constructor
     *
     * @param output_report_length Maximum length of a sent report (up to 64 bytes) (default: 64 bytes)
     * @param input_report_length Maximum length of a received report (up to 64 bytes) (default: 64 bytes)
@@ -61,12 +80,24 @@
     * @param connect Connect the device
     */
     USBHID(uint8_t output_report_length , uint8_t input_report_length , uint8_t feature_report_length , uint16_t vendor_id , uint16_t product_id , uint16_t product_release , bool connect );
-    /* default constructor to maintain backwards compatibility. */
+    /**
+    * Constructor
+    * default constructor to maintain backwards compatibility. 
+    *
+    * @param output_report_length Maximum length of a sent report (up to 64 bytes) (default: 64 bytes)
+    * @param input_report_length Maximum length of a received report (up to 64 bytes) (default: 64 bytes)
+    * @param report_report_length Maximum length of a received report (up to 64 bytes) (default: 64 bytes)
+    * @param vendor_id Your vendor_id
+    * @param product_id Your product_id
+    * @param product_release Your preoduct_release
+    * @param connect Connect the device
+    */
     USBHID(uint8_t output_report_length = 64, uint8_t input_report_length = 64, uint16_t vendor_id = 0x1234, uint16_t product_id = 0x0006, uint16_t product_release = 0x0001, bool connect = true);
 
 
     /**
     * Send a Report. warning: blocking
+    * legacy method retained for backward compatability
     *
     * @param report Report which will be sent (a report is defined by all data and the length)
     * @returns true if successful
@@ -76,6 +107,7 @@
     
     /**
     * Send a Report. warning: non blocking
+    * legacy method retained for backward compatability
     *
     * @param report Report which will be sent (a report is defined by all data and the length)
     * @returns true if successful
@@ -84,6 +116,7 @@
     
     /**
     * Read a report: blocking
+    * legacy method retained for backward compatability
     *
     * @param report pointer to the report to fill
     * @returns true if successful
@@ -92,6 +125,7 @@
     
     /**
     * Read a report: non blocking
+    * legacy method retained for backward compatability
     *
     * @param report pointer to the report to fill
     * @returns true if successful
@@ -99,31 +133,69 @@
     bool readNB(HID_REPORT * report);
     
     /**
-    * Provide function to trigger default report transfer
+    * Provide the ability to Fill the inputReport. Report transfer is automatic if the data changes
     *
     * @param HID_REPORT
     * @returns true if succsful
     * The devloper should always use FillReport, The IDLE logic will send a report if the value has changed, or if the idle period expires.
     */
     bool FillInputReport(HID_REPORT *report);
+    
+    /**
+    * Provide the ability to Fill the featureReport. 
+    *
+    * @param HID_REPORT
+    * @returns true if succsful
+    */
     bool FillFeatureReport(HID_REPORT *report);
     
     
     /**
-    * Callback poiters to functions.
+    * Callback pointers to functions
     *
     * @param report pointer to the report to fill
-    * These allow a user program to hook on get/set report control setup stages.
+    * These allow a user program to hook on get_report/set_report actions for each type.
     */
     void (*callbackSetInputReport)(HID_REPORT *report);
+    /**
+    * Callback pointers to functions
+    *
+    * @param report pointer to the report to fill
+    * These allow a user program to hook on get_report/set_report actions for each type.
+    */
     bool (*callbackGetInputReport)(HID_REPORT *report);
+    /**
+    * Callback pointers to functions
+    *
+    * @param report pointer to the report to fill
+    * These allow a user program to hook on get_report/set_report actions for each type.
+    */
     void (*callbackSetOutputReport)(HID_REPORT *report);
+    /**
+    * Callback pointers to functions
+    *
+    * @param report pointer to the report to fill
+    * These allow a user program to hook on get_report/set_report actions for each type.
+    */
     bool (*callbackGetOutputReport)(HID_REPORT *report);
+    /**
+    * Callback pointers to functions
+    *
+    * @param report pointer to the report to fill
+    * These allow a user program to hook on get_report/set_report actions for each type.
+    */
     void (*callbackSetFeatureReport)(HID_REPORT *report);
+    /**
+    * Callback pointers to functions
+    *
+    * @param report pointer to the report to fill
+    * These allow a user program to hook on get_report/set_report actions for each type.
+    */
     bool (*callbackGetFeatureReport)(HID_REPORT *report);
     
-    /* This function should be private, but is exposed to allow a developer to reenable IDLE values > zero after windows sets the value to zero. 
-        This is due to microsoft windows HID driver not implementing IOCTL_HID_SET_POLL_FREQUENCY_MSEC/IOCTL_HID_GET_POLL_FREQUENCY_MSEC
+    /**
+    * This function should be private, but is exposed to allow a developer to reenable IDLE values > zero after windows sets the value to zero. 
+    *    This is due to microsoft windows HID driver not implementing IOCTL_HID_SET_POLL_FREQUENCY_MSEC/IOCTL_HID_GET_POLL_FREQUENCY_MSEC
     */
     virtual void SetReportIdle(uint16_t wValue);