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/MIDIMessage.h@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 #ifndef MIDIMESSAGE_H
samux 1:80ab0d068708 20 #define MIDIMESSAGE_H
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 #include "mbed.h"
samux 1:80ab0d068708 23
samux 1:80ab0d068708 24 // MIDI Message Format
samux 1:80ab0d068708 25 //
samux 1:80ab0d068708 26 // [ msg(4) | channel(4) ] [ 0 | n(7) ] [ 0 | m(7) ]
samux 1:80ab0d068708 27 //
samux 1:80ab0d068708 28 // MIDI Data Messages (Channel Specific)
samux 1:80ab0d068708 29 //
samux 1:80ab0d068708 30 // Message msg n m
samux 1:80ab0d068708 31 // ---------------------------------------------
samux 1:80ab0d068708 32 // Note Off 0x8 Key Velocity
samux 1:80ab0d068708 33 // Note On 0x9 Key Velocity
samux 1:80ab0d068708 34 // Polyphonic Aftertouch 0xA Key Pressure
samux 1:80ab0d068708 35 // Control Change 0xB Controller Value
samux 1:80ab0d068708 36 // Program Change 0xC Program -
samux 1:80ab0d068708 37 // Channel Aftertouch 0xD Pressure -
samux 1:80ab0d068708 38 // Pitch Wheel 0xE LSB MSB
samux 1:80ab0d068708 39
samux 1:80ab0d068708 40 #define CABLE_NUM (0<<4)
samux 1:80ab0d068708 41
samux 1:80ab0d068708 42 /** A MIDI message container */
samux 1:80ab0d068708 43 class MIDIMessage {
samux 1:80ab0d068708 44 public:
samux 1:80ab0d068708 45 MIDIMessage() {}
samux 1:80ab0d068708 46
samux 1:80ab0d068708 47 MIDIMessage(uint8_t *buf) {
samux 1:80ab0d068708 48 *((uint32_t *)data) = *((uint32_t *)buf);
samux 1:80ab0d068708 49 }
samux 1:80ab0d068708 50
samux 1:80ab0d068708 51 // create messages
samux 1:80ab0d068708 52
samux 1:80ab0d068708 53 /** Create a NoteOff message
samux 1:80ab0d068708 54 * @param key Key ID
samux 1:80ab0d068708 55 * @param velocity Key velocity (0-127, default = 127)
samux 1:80ab0d068708 56 * @param channel Key channel (0-15, default 0)
samux 1:80ab0d068708 57 * @returns A MIDIMessage
samux 1:80ab0d068708 58 */
samux 1:80ab0d068708 59 static MIDIMessage NoteOff(int key, int velocity = 127, int channel = 0) {
samux 1:80ab0d068708 60 MIDIMessage msg;
samux 1:80ab0d068708 61 msg.data[0] = CABLE_NUM | 0x08;
samux 1:80ab0d068708 62 msg.data[1] = 0x80 | (channel & 0x0F);
samux 1:80ab0d068708 63 msg.data[2] = key & 0x7F;
samux 1:80ab0d068708 64 msg.data[3] = velocity & 0x7F;
samux 1:80ab0d068708 65 return msg;
samux 1:80ab0d068708 66 }
samux 1:80ab0d068708 67
samux 1:80ab0d068708 68 /** Create a NoteOn message
samux 1:80ab0d068708 69 * @param key Key ID
samux 1:80ab0d068708 70 * @param velocity Key velocity (0-127, default = 127)
samux 1:80ab0d068708 71 * @param channel Key channel (0-15, default 0)
samux 1:80ab0d068708 72 * @returns A MIDIMessage
samux 1:80ab0d068708 73 */
samux 1:80ab0d068708 74 static MIDIMessage NoteOn(int key, int velocity = 127, int channel = 0) {
samux 1:80ab0d068708 75 MIDIMessage msg;
samux 1:80ab0d068708 76 msg.data[0] = CABLE_NUM | 0x09;
samux 1:80ab0d068708 77 msg.data[1] = 0x90 | (channel & 0x0F);
samux 1:80ab0d068708 78 msg.data[2] = key & 0x7F;
samux 1:80ab0d068708 79 msg.data[3] = velocity & 0x7F;
samux 1:80ab0d068708 80 return msg;
samux 1:80ab0d068708 81 }
samux 1:80ab0d068708 82
samux 1:80ab0d068708 83 /** Create a PolyPhonic Aftertouch message
samux 1:80ab0d068708 84 * @param key Key ID
samux 1:80ab0d068708 85 * @param pressure Aftertouch pressure (0-127)
samux 1:80ab0d068708 86 * @param channel Key channel (0-15, default 0)
samux 1:80ab0d068708 87 * @returns A MIDIMessage
samux 1:80ab0d068708 88 */
samux 1:80ab0d068708 89 static MIDIMessage PolyphonicAftertouch(int key, int pressure, int channel = 0) {
samux 1:80ab0d068708 90 MIDIMessage msg;
samux 1:80ab0d068708 91 msg.data[0] = CABLE_NUM | 0x0A;
samux 1:80ab0d068708 92 msg.data[1] = 0xA0 | (channel & 0x0F);
samux 1:80ab0d068708 93 msg.data[2] = key & 0x7F;
samux 1:80ab0d068708 94 msg.data[3] = pressure & 0x7F;
samux 1:80ab0d068708 95 return msg;
samux 1:80ab0d068708 96 }
samux 1:80ab0d068708 97
samux 1:80ab0d068708 98 /** Create a Control Change message
samux 1:80ab0d068708 99 * @param control Controller ID
samux 1:80ab0d068708 100 * @param value Controller value (0-127)
samux 1:80ab0d068708 101 * @param channel Controller channel (0-15, default 0)
samux 1:80ab0d068708 102 * @returns A MIDIMessage
samux 1:80ab0d068708 103 */
samux 1:80ab0d068708 104 static MIDIMessage ControlChange(int control, int value, int channel = 0) {
samux 1:80ab0d068708 105 MIDIMessage msg;
samux 1:80ab0d068708 106 msg.data[0] = CABLE_NUM | 0x0B;
samux 1:80ab0d068708 107 msg.data[1] = 0xB0 | (channel & 0x0F);
samux 1:80ab0d068708 108 msg.data[2] = control & 0x7F;
samux 1:80ab0d068708 109 msg.data[3] = value & 0x7F;
samux 1:80ab0d068708 110 return msg;
samux 1:80ab0d068708 111 }
samux 1:80ab0d068708 112
samux 1:80ab0d068708 113 /** Create a Program Change message
samux 1:80ab0d068708 114 * @param program Program ID
samux 1:80ab0d068708 115 * @param channel Channel (0-15, default 0)
samux 1:80ab0d068708 116 * @returns A MIDIMessage
samux 1:80ab0d068708 117 */
samux 1:80ab0d068708 118 static MIDIMessage ProgramChange(int program, int channel = 0) {
samux 1:80ab0d068708 119 MIDIMessage msg;
samux 1:80ab0d068708 120 msg.data[0] = CABLE_NUM | 0x0C;
samux 1:80ab0d068708 121 msg.data[1] = 0xC0 | (channel & 0x0F);
samux 1:80ab0d068708 122 msg.data[2] = program & 0x7F;
samux 1:80ab0d068708 123 msg.data[3] = 0x00;
samux 1:80ab0d068708 124 return msg;
samux 1:80ab0d068708 125 }
samux 1:80ab0d068708 126
samux 1:80ab0d068708 127 /** Create a Channel Aftertouch message
samux 1:80ab0d068708 128 * @param pressure Pressure
samux 1:80ab0d068708 129 * @param channel Key channel (0-15, default 0)
samux 1:80ab0d068708 130 * @returns A MIDIMessage
samux 1:80ab0d068708 131 */
samux 1:80ab0d068708 132 static MIDIMessage ChannelAftertouch(int pressure, int channel = 0) {
samux 1:80ab0d068708 133 MIDIMessage msg;
samux 1:80ab0d068708 134 msg.data[0] = CABLE_NUM | 0x0D;
samux 1:80ab0d068708 135 msg.data[1] = 0xD0 | (channel & 0x0F);
samux 1:80ab0d068708 136 msg.data[2] = pressure & 0x7F;
samux 1:80ab0d068708 137 msg.data[3] = 0x00;
samux 1:80ab0d068708 138 return msg;
samux 1:80ab0d068708 139 }
samux 1:80ab0d068708 140
samux 1:80ab0d068708 141 /** Create a Pitch Wheel message
samux 1:80ab0d068708 142 * @param pitch Pitch (-8192 - 8191, default = 0)
samux 1:80ab0d068708 143 * @param channel Channel (0-15, default 0)
samux 1:80ab0d068708 144 * @returns A MIDIMessage
samux 1:80ab0d068708 145 */
samux 1:80ab0d068708 146 static MIDIMessage PitchWheel(int pitch = 0, int channel = 0) {
samux 1:80ab0d068708 147 MIDIMessage msg;
samux 1:80ab0d068708 148 int p = pitch + 8192; // 0 - 16383, 8192 is center
samux 1:80ab0d068708 149 msg.data[0] = CABLE_NUM | 0x0E;
samux 1:80ab0d068708 150 msg.data[1] = 0xE0 | (channel & 0x0F);
samux 1:80ab0d068708 151 msg.data[2] = p & 0x7F;
samux 1:80ab0d068708 152 msg.data[3] = (p >> 7) & 0x7F;
samux 1:80ab0d068708 153 return msg;
samux 1:80ab0d068708 154 }
samux 1:80ab0d068708 155
samux 1:80ab0d068708 156 /** Create an All Notes Off message
samux 1:80ab0d068708 157 * @param channel Channel (0-15, default 0)
samux 1:80ab0d068708 158 * @returns A MIDIMessage
samux 1:80ab0d068708 159 */
samux 1:80ab0d068708 160 static MIDIMessage AllNotesOff(int channel = 0) {
samux 1:80ab0d068708 161 return ControlChange(123, 0, channel);
samux 1:80ab0d068708 162 }
samux 1:80ab0d068708 163
samux 1:80ab0d068708 164 // decode messages
samux 1:80ab0d068708 165
samux 1:80ab0d068708 166 /** MIDI Message Types */
samux 1:80ab0d068708 167 enum MIDIMessageType {
samux 1:80ab0d068708 168 ErrorType,
samux 1:80ab0d068708 169 NoteOffType,
samux 1:80ab0d068708 170 NoteOnType,
samux 1:80ab0d068708 171 PolyphonicAftertouchType,
samux 1:80ab0d068708 172 ControlChangeType,
samux 1:80ab0d068708 173 ProgramChangeType,
samux 1:80ab0d068708 174 ChannelAftertouchType,
samux 1:80ab0d068708 175 PitchWheelType,
samux 1:80ab0d068708 176 AllNotesOffType
samux 1:80ab0d068708 177 };
samux 1:80ab0d068708 178
samux 1:80ab0d068708 179 /** Read the message type
samux 1:80ab0d068708 180 * @returns MIDIMessageType
samux 1:80ab0d068708 181 */
samux 1:80ab0d068708 182 MIDIMessageType type() {
samux 1:80ab0d068708 183 switch((data[1] >> 4) & 0xF) {
samux 1:80ab0d068708 184 case 0x8: return NoteOffType;
samux 1:80ab0d068708 185 case 0x9: return NoteOnType;
samux 1:80ab0d068708 186 case 0xA: return PolyphonicAftertouchType;
samux 1:80ab0d068708 187 case 0xB:
samux 1:80ab0d068708 188 if(controller() < 120) { // standard controllers
samux 1:80ab0d068708 189 return ControlChangeType;
samux 1:80ab0d068708 190 } else if(controller() == 123) {
samux 1:80ab0d068708 191 return AllNotesOffType;
samux 1:80ab0d068708 192 } else {
samux 1:80ab0d068708 193 return ErrorType; // unsupported atm
samux 1:80ab0d068708 194 }
samux 1:80ab0d068708 195 case 0xC: return ProgramChangeType;
samux 1:80ab0d068708 196 case 0xD: return ChannelAftertouchType;
samux 1:80ab0d068708 197 case 0xE: return PitchWheelType;
samux 1:80ab0d068708 198 default: return ErrorType;
samux 1:80ab0d068708 199 }
samux 1:80ab0d068708 200 }
samux 1:80ab0d068708 201
samux 1:80ab0d068708 202 /** Read the channel number */
samux 1:80ab0d068708 203 int channel() {
samux 1:80ab0d068708 204 return (data[1] & 0x0F);
samux 1:80ab0d068708 205 }
samux 1:80ab0d068708 206
samux 1:80ab0d068708 207 /** Read the key ID */
samux 1:80ab0d068708 208 int key() {
samux 1:80ab0d068708 209 return (data[2] & 0x7F);
samux 1:80ab0d068708 210 }
samux 1:80ab0d068708 211
samux 1:80ab0d068708 212 /** Read the velocity */
samux 1:80ab0d068708 213 int velocity() {
samux 1:80ab0d068708 214 return (data[3] & 0x7F);
samux 1:80ab0d068708 215 }
samux 1:80ab0d068708 216
samux 1:80ab0d068708 217 /** Read the controller value */
samux 1:80ab0d068708 218 int value() {
samux 1:80ab0d068708 219 return (data[3] & 0x7F);
samux 1:80ab0d068708 220 }
samux 1:80ab0d068708 221
samux 1:80ab0d068708 222 /** Read the aftertouch pressure */
samux 1:80ab0d068708 223 int pressure() {
samux 1:80ab0d068708 224 if(type() == PolyphonicAftertouchType) {
samux 1:80ab0d068708 225 return (data[3] & 0x7F);
samux 1:80ab0d068708 226 } else {
samux 1:80ab0d068708 227 return (data[2] & 0x7F);
samux 1:80ab0d068708 228 }
samux 1:80ab0d068708 229 }
samux 1:80ab0d068708 230
samux 1:80ab0d068708 231 /** Read the controller number */
samux 1:80ab0d068708 232 int controller() {
samux 1:80ab0d068708 233 return (data[2] & 0x7F);
samux 1:80ab0d068708 234 }
samux 1:80ab0d068708 235
samux 1:80ab0d068708 236 /** Read the program number */
samux 1:80ab0d068708 237 int program() {
samux 1:80ab0d068708 238 return (data[2] & 0x7F);
samux 1:80ab0d068708 239 }
samux 1:80ab0d068708 240
samux 1:80ab0d068708 241 /** Read the pitch value */
samux 1:80ab0d068708 242 int pitch() {
samux 1:80ab0d068708 243 int p = ((data[3] & 0x7F) << 7) | (data[2] & 0x7F);
samux 1:80ab0d068708 244 return p - 8192; // 0 - 16383, 8192 is center
samux 1:80ab0d068708 245 }
samux 1:80ab0d068708 246
samux 1:80ab0d068708 247 uint8_t data[4];
samux 1:80ab0d068708 248 };
samux 1:80ab0d068708 249
samux 1:80ab0d068708 250 #endif