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

USBMIDI/USBMIDI.cpp@18:cb3afa532fcd, 2013-08-08 (annotated)

Committer:
jakowisp
Date:
Thu Aug 08 08:02:46 2013 +0000
Revision:
18:cb3afa532fcd
Parent:
1:80ab0d068708 
Default ProtocolState was incorrectly being set to 0:Boot when the HID specification states that the default should be 1:Report

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:80ab0d068708 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 1:80ab0d068708 2 *
samux 1:80ab0d068708 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:80ab0d068708 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 1:80ab0d068708 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 1:80ab0d068708 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 1:80ab0d068708 7 * Software is furnished to do so, subject to the following conditions:
samux 1:80ab0d068708 8 *
samux 1:80ab0d068708 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:80ab0d068708 10 * substantial portions of the Software.
samux 1:80ab0d068708 11 *
samux 1:80ab0d068708 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:80ab0d068708 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:80ab0d068708 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:80ab0d068708 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:80ab0d068708 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:80ab0d068708 17 */
samux 1:80ab0d068708 18
samux 1:80ab0d068708 19 #include "stdint.h"
samux 1:80ab0d068708 20 #include "USBMIDI.h"
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22
samux 1:80ab0d068708 23 USBMIDI::USBMIDI(uint16_t vendor_id, uint16_t product_id, uint16_t product_release): USBDevice(vendor_id, product_id, product_release) {
samux 1:80ab0d068708 24 midi_evt = NULL;
samux 1:80ab0d068708 25 USBDevice::connect();
samux 1:80ab0d068708 26 }
samux 1:80ab0d068708 27
samux 1:80ab0d068708 28 void USBMIDI::write(MIDIMessage m) {
samux 1:80ab0d068708 29 USBDevice::write(EPBULK_IN, m.data, 4, MAX_PACKET_SIZE_EPBULK);
samux 1:80ab0d068708 30 }
samux 1:80ab0d068708 31
samux 1:80ab0d068708 32
samux 1:80ab0d068708 33 void USBMIDI::attach(void (*fptr)(MIDIMessage)) {
samux 1:80ab0d068708 34 midi_evt = fptr;
samux 1:80ab0d068708 35 }
samux 1:80ab0d068708 36
samux 1:80ab0d068708 37
samux 1:80ab0d068708 38 bool USBMIDI::EP2_OUT_callback() {
samux 1:80ab0d068708 39 uint8_t buf[64];
samux 1:80ab0d068708 40 uint32_t len;
samux 1:80ab0d068708 41 readEP(EPBULK_OUT, buf, &len, 64);
samux 1:80ab0d068708 42
samux 1:80ab0d068708 43 if (midi_evt != NULL) {
samux 1:80ab0d068708 44 for (int i=0; i<len; i+=4) {
samux 1:80ab0d068708 45 midi_evt(MIDIMessage(buf+i));
samux 1:80ab0d068708 46 }
samux 1:80ab0d068708 47 }
samux 1:80ab0d068708 48
samux 1:80ab0d068708 49 // We reactivate the endpoint to receive next characters
samux 1:80ab0d068708 50 readStart(EPBULK_OUT, MAX_PACKET_SIZE_EPBULK);
samux 1:80ab0d068708 51 return true;
samux 1:80ab0d068708 52 }
samux 1:80ab0d068708 53
samux 1:80ab0d068708 54
samux 1:80ab0d068708 55
samux 1:80ab0d068708 56 // Called in ISR context
samux 1:80ab0d068708 57 // Set configuration. Return false if the
samux 1:80ab0d068708 58 // configuration is not supported.
samux 1:80ab0d068708 59 bool USBMIDI::USBCallback_setConfiguration(uint8_t configuration) {
samux 1:80ab0d068708 60 if (configuration != DEFAULT_CONFIGURATION) {
samux 1:80ab0d068708 61 return false;
samux 1:80ab0d068708 62 }
samux 1:80ab0d068708 63
samux 1:80ab0d068708 64 // Configure endpoints > 0
samux 1:80ab0d068708 65 addEndpoint(EPBULK_IN, MAX_PACKET_SIZE_EPBULK);
samux 1:80ab0d068708 66 addEndpoint(EPBULK_OUT, MAX_PACKET_SIZE_EPBULK);
samux 1:80ab0d068708 67
samux 1:80ab0d068708 68 // We activate the endpoint to be able to receive data
samux 1:80ab0d068708 69 readStart(EPBULK_OUT, MAX_PACKET_SIZE_EPBULK);
samux 1:80ab0d068708 70 return true;
samux 1:80ab0d068708 71 }
samux 1:80ab0d068708 72
samux 1:80ab0d068708 73
samux 1:80ab0d068708 74 uint8_t * USBMIDI::stringIinterfaceDesc() {
samux 1:80ab0d068708 75 static uint8_t stringIinterfaceDescriptor[] = {
samux 1:80ab0d068708 76 0x0c, //bLength
samux 1:80ab0d068708 77 STRING_DESCRIPTOR, //bDescriptorType 0x03
samux 1:80ab0d068708 78 'A',0,'u',0,'d',0,'i',0,'o',0 //bString iInterface - Audio
samux 1:80ab0d068708 79 };
samux 1:80ab0d068708 80 return stringIinterfaceDescriptor;
samux 1:80ab0d068708 81 }
samux 1:80ab0d068708 82
samux 1:80ab0d068708 83 uint8_t * USBMIDI::stringIproductDesc() {
samux 1:80ab0d068708 84 static uint8_t stringIproductDescriptor[] = {
samux 1:80ab0d068708 85 0x16, //bLength
samux 1:80ab0d068708 86 STRING_DESCRIPTOR, //bDescriptorType 0x03
samux 1:80ab0d068708 87 'M',0,'b',0,'e',0,'d',0,' ',0,'A',0,'u',0,'d',0,'i',0,'o',0 //bString iProduct - Mbed Audio
samux 1:80ab0d068708 88 };
samux 1:80ab0d068708 89 return stringIproductDescriptor;
samux 1:80ab0d068708 90 }
samux 1:80ab0d068708 91
samux 1:80ab0d068708 92
samux 1:80ab0d068708 93 uint8_t * USBMIDI::configurationDesc() {
samux 1:80ab0d068708 94 static uint8_t configDescriptor[] = {
samux 1:80ab0d068708 95 // configuration descriptor
samux 1:80ab0d068708 96 0x09, 0x02, 0x65, 0x00, 0x02, 0x01, 0x00, 0xc0, 0x50,
samux 1:80ab0d068708 97
samux 1:80ab0d068708 98 // The Audio Interface Collection
samux 1:80ab0d068708 99 0x09, 0x04, 0x00, 0x00, 0x00, 0x01, 0x01, 0x00, 0x00, // Standard AC Interface Descriptor
samux 1:80ab0d068708 100 0x09, 0x24, 0x01, 0x00, 0x01, 0x09, 0x00, 0x01, 0x01, // Class-specific AC Interface Descriptor
samux 1:80ab0d068708 101 0x09, 0x04, 0x01, 0x00, 0x02, 0x01, 0x03, 0x00, 0x00, // MIDIStreaming Interface Descriptors
samux 1:80ab0d068708 102 0x07, 0x24, 0x01, 0x00, 0x01, 0x41, 0x00, // Class-Specific MS Interface Header Descriptor
samux 1:80ab0d068708 103
samux 1:80ab0d068708 104 // MIDI IN JACKS
samux 1:80ab0d068708 105 0x06, 0x24, 0x02, 0x01, 0x01, 0x00,
samux 1:80ab0d068708 106 0x06, 0x24, 0x02, 0x02, 0x02, 0x00,
samux 1:80ab0d068708 107
samux 1:80ab0d068708 108 // MIDI OUT JACKS
samux 1:80ab0d068708 109 0x09, 0x24, 0x03, 0x01, 0x03, 0x01, 0x02, 0x01, 0x00,
samux 1:80ab0d068708 110 0x09, 0x24, 0x03, 0x02, 0x06, 0x01, 0x01, 0x01, 0x00,
samux 1:80ab0d068708 111
samux 1:80ab0d068708 112 // OUT endpoint descriptor
samux 1:80ab0d068708 113 0x09, 0x05, 0x02, 0x02, 0x40, 0x00, 0x00, 0x00, 0x00,
samux 1:80ab0d068708 114 0x05, 0x25, 0x01, 0x01, 0x01,
samux 1:80ab0d068708 115
samux 1:80ab0d068708 116 // IN endpoint descriptor
samux 1:80ab0d068708 117 0x09, 0x05, 0x82, 0x02, 0x40, 0x00, 0x00, 0x00, 0x00,
samux 1:80ab0d068708 118 0x05, 0x25, 0x01, 0x01, 0x03,
samux 1:80ab0d068708 119 };
samux 1:80ab0d068708 120 return configDescriptor;
samux 1:80ab0d068708 121 }