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

USBDevice/USBHAL.h@18:cb3afa532fcd, 2013-08-08 (annotated)

Committer:
jakowisp
Date:
Thu Aug 08 08:02:46 2013 +0000
Revision:
18:cb3afa532fcd
Parent:
10:1e3d126a322b 
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 USBBUSINTERFACE_H
samux 1:80ab0d068708 20 #define USBBUSINTERFACE_H
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 #include "mbed.h"
samux 1:80ab0d068708 23 #include "USBEndpoints.h"
samux 1:80ab0d068708 24
emilmont 10:1e3d126a322b 25 #ifdef __GNUC__
emilmont 10:1e3d126a322b 26 #define __packed __attribute__ ((__packed__))
emilmont 10:1e3d126a322b 27 #endif
emilmont 10:1e3d126a322b 28
samux 1:80ab0d068708 29 class USBHAL {
samux 1:80ab0d068708 30 public:
samux 1:80ab0d068708 31 /* Configuration */
samux 1:80ab0d068708 32 USBHAL();
samux 1:80ab0d068708 33 ~USBHAL();
samux 1:80ab0d068708 34 void connect(void);
samux 1:80ab0d068708 35 void disconnect(void);
samux 1:80ab0d068708 36 void configureDevice(void);
samux 1:80ab0d068708 37 void unconfigureDevice(void);
samux 1:80ab0d068708 38 void setAddress(uint8_t address);
samux 1:80ab0d068708 39 void remoteWakeup(void);
samux 1:80ab0d068708 40
samux 1:80ab0d068708 41 /* Endpoint 0 */
samux 1:80ab0d068708 42 void EP0setup(uint8_t *buffer);
samux 1:80ab0d068708 43 void EP0read(void);
samux 8:335f2506f422 44 void EP0readStage(void);
samux 1:80ab0d068708 45 uint32_t EP0getReadResult(uint8_t *buffer);
samux 1:80ab0d068708 46 void EP0write(uint8_t *buffer, uint32_t size);
samux 1:80ab0d068708 47 void EP0getWriteResult(void);
samux 1:80ab0d068708 48 void EP0stall(void);
samux 1:80ab0d068708 49
samux 1:80ab0d068708 50 /* Other endpoints */
samux 1:80ab0d068708 51 EP_STATUS endpointRead(uint8_t endpoint, uint32_t maximumSize);
samux 1:80ab0d068708 52 EP_STATUS endpointReadResult(uint8_t endpoint, uint8_t *data, uint32_t *bytesRead);
samux 1:80ab0d068708 53 EP_STATUS endpointWrite(uint8_t endpoint, uint8_t *data, uint32_t size);
samux 1:80ab0d068708 54 EP_STATUS endpointWriteResult(uint8_t endpoint);
samux 1:80ab0d068708 55 void stallEndpoint(uint8_t endpoint);
samux 1:80ab0d068708 56 void unstallEndpoint(uint8_t endpoint);
samux 1:80ab0d068708 57 bool realiseEndpoint(uint8_t endpoint, uint32_t maxPacket, uint32_t options);
samux 1:80ab0d068708 58 bool getEndpointStallState(unsigned char endpoint);
samux 1:80ab0d068708 59 uint32_t endpointReadcore(uint8_t endpoint, uint8_t *buffer);
samux 1:80ab0d068708 60
samux 1:80ab0d068708 61 protected:
samux 1:80ab0d068708 62 virtual void busReset(void){};
samux 1:80ab0d068708 63 virtual void EP0setupCallback(void){};
samux 1:80ab0d068708 64 virtual void EP0out(void){};
samux 1:80ab0d068708 65 virtual void EP0in(void){};
samux 1:80ab0d068708 66 virtual void connectStateChanged(unsigned int connected){};
samux 1:80ab0d068708 67 virtual void suspendStateChanged(unsigned int suspended){};
samux 1:80ab0d068708 68 virtual void SOF(int frameNumber){};
samux 8:335f2506f422 69
samux 1:80ab0d068708 70 virtual bool EP1_OUT_callback(){return false;};
samux 1:80ab0d068708 71 virtual bool EP1_IN_callback(){return false;};
samux 1:80ab0d068708 72 virtual bool EP2_OUT_callback(){return false;};
samux 1:80ab0d068708 73 virtual bool EP2_IN_callback(){return false;};
samux 1:80ab0d068708 74 virtual bool EP3_OUT_callback(){return false;};
samux 1:80ab0d068708 75 virtual bool EP3_IN_callback(){return false;};
samux 8:335f2506f422 76 virtual bool EP4_OUT_callback(){return false;};
samux 8:335f2506f422 77 virtual bool EP4_IN_callback(){return false;};
samux 8:335f2506f422 78
samux 8:335f2506f422 79 #if !defined(TARGET_LPC11U24)
samux 8:335f2506f422 80 virtual bool EP5_OUT_callback(){return false;};
samux 8:335f2506f422 81 virtual bool EP5_IN_callback(){return false;};
samux 8:335f2506f422 82 virtual bool EP6_OUT_callback(){return false;};
samux 8:335f2506f422 83 virtual bool EP6_IN_callback(){return false;};
samux 8:335f2506f422 84 virtual bool EP7_OUT_callback(){return false;};
samux 8:335f2506f422 85 virtual bool EP7_IN_callback(){return false;};
samux 8:335f2506f422 86 virtual bool EP8_OUT_callback(){return false;};
samux 8:335f2506f422 87 virtual bool EP8_IN_callback(){return false;};
samux 8:335f2506f422 88 virtual bool EP9_OUT_callback(){return false;};
samux 8:335f2506f422 89 virtual bool EP9_IN_callback(){return false;};
samux 8:335f2506f422 90 virtual bool EP10_OUT_callback(){return false;};
samux 8:335f2506f422 91 virtual bool EP10_IN_callback(){return false;};
samux 8:335f2506f422 92 virtual bool EP11_OUT_callback(){return false;};
samux 8:335f2506f422 93 virtual bool EP11_IN_callback(){return false;};
samux 8:335f2506f422 94 virtual bool EP12_OUT_callback(){return false;};
samux 8:335f2506f422 95 virtual bool EP12_IN_callback(){return false;};
samux 8:335f2506f422 96 virtual bool EP13_OUT_callback(){return false;};
samux 8:335f2506f422 97 virtual bool EP13_IN_callback(){return false;};
samux 8:335f2506f422 98 virtual bool EP14_OUT_callback(){return false;};
samux 8:335f2506f422 99 virtual bool EP14_IN_callback(){return false;};
samux 8:335f2506f422 100 virtual bool EP15_OUT_callback(){return false;};
samux 8:335f2506f422 101 virtual bool EP15_IN_callback(){return false;};
samux 8:335f2506f422 102 #endif
samux 1:80ab0d068708 103
samux 1:80ab0d068708 104 private:
samux 1:80ab0d068708 105 void usbisr(void);
samux 1:80ab0d068708 106 static void _usbisr(void);
samux 1:80ab0d068708 107 static USBHAL * instance;
samux 8:335f2506f422 108
samux 8:335f2506f422 109 #if defined(TARGET_LPC11U24)
samux 8:335f2506f422 110 bool (USBHAL::*epCallback[10 - 2])(void);
samux 8:335f2506f422 111 #else
samux 8:335f2506f422 112 bool (USBHAL::*epCallback[32 - 2])(void);
samux 8:335f2506f422 113 #endif
samux 8:335f2506f422 114
samux 8:335f2506f422 115
samux 1:80ab0d068708 116 };
samux 1:80ab0d068708 117 #endif