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

USBSerial/USBSerial.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 USBSERIAL_H
samux 1:80ab0d068708 20 #define USBSERIAL_H
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 #include "USBCDC.h"
samux 1:80ab0d068708 23 #include "Stream.h"
samux 1:80ab0d068708 24 #include "CircBuffer.h"
samux 1:80ab0d068708 25
samux 1:80ab0d068708 26
samux 1:80ab0d068708 27 /**
samux 1:80ab0d068708 28 * USBSerial example
samux 1:80ab0d068708 29 *
samux 1:80ab0d068708 30 * @code
samux 1:80ab0d068708 31 * #include "mbed.h"
samux 1:80ab0d068708 32 * #include "USBSerial.h"
samux 1:80ab0d068708 33 *
samux 1:80ab0d068708 34 * //Virtual serial port over USB
samux 1:80ab0d068708 35 * USBSerial serial;
samux 1:80ab0d068708 36 *
samux 1:80ab0d068708 37 * int main(void) {
samux 1:80ab0d068708 38 *
samux 1:80ab0d068708 39 * while(1)
samux 1:80ab0d068708 40 * {
samux 1:80ab0d068708 41 * serial.printf("I am a virtual serial port\n");
samux 1:80ab0d068708 42 * wait(1);
samux 1:80ab0d068708 43 * }
samux 1:80ab0d068708 44 * }
samux 1:80ab0d068708 45 * @endcode
samux 1:80ab0d068708 46 */
samux 1:80ab0d068708 47 class USBSerial: public USBCDC, public Stream {
samux 1:80ab0d068708 48 public:
samux 1:80ab0d068708 49
samux 1:80ab0d068708 50 /**
samux 1:80ab0d068708 51 * Constructor
samux 1:80ab0d068708 52 *
samux 1:80ab0d068708 53 * @param vendor_id Your vendor_id (default: 0x1f00)
samux 1:80ab0d068708 54 * @param product_id Your product_id (default: 0x2012)
samux 1:80ab0d068708 55 * @param product_release Your preoduct_release (default: 0x0001)
samux 1:80ab0d068708 56 *
samux 1:80ab0d068708 57 */
samux 1:80ab0d068708 58 USBSerial(uint16_t vendor_id = 0x1f00, uint16_t product_id = 0x2012, uint16_t product_release = 0x0001): USBCDC(vendor_id, product_id, product_release), buf(128){ };
samux 1:80ab0d068708 59
samux 1:80ab0d068708 60
samux 1:80ab0d068708 61 /**
samux 1:80ab0d068708 62 * Send a character. You can use puts, printf.
samux 1:80ab0d068708 63 *
samux 1:80ab0d068708 64 * @param c character to be sent
samux 1:80ab0d068708 65 * @returns true if there is no error, false otherwise
samux 1:80ab0d068708 66 */
samux 1:80ab0d068708 67 virtual int _putc(int c);
samux 1:80ab0d068708 68
samux 1:80ab0d068708 69 /**
samux 1:80ab0d068708 70 * Read a character: blocking
samux 1:80ab0d068708 71 *
samux 1:80ab0d068708 72 * @returns character read
samux 1:80ab0d068708 73 */
samux 1:80ab0d068708 74 virtual int _getc();
samux 1:80ab0d068708 75
samux 1:80ab0d068708 76 /**
samux 1:80ab0d068708 77 * Check the number of bytes available.
samux 1:80ab0d068708 78 *
samux 1:80ab0d068708 79 * @returns the number of bytes available
samux 1:80ab0d068708 80 */
samux 1:80ab0d068708 81 uint8_t available();
samux 1:80ab0d068708 82
samux 1:80ab0d068708 83 /**
samux 1:80ab0d068708 84 * Write a block of data.
samux 1:80ab0d068708 85 *
samux 1:80ab0d068708 86 * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
samux 1:80ab0d068708 87 *
samux 1:80ab0d068708 88 * @param buf pointer on data which will be written
samux 1:80ab0d068708 89 * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes)
samux 1:80ab0d068708 90 *
samux 1:80ab0d068708 91 * @returns true if successfull
samux 1:80ab0d068708 92 */
samux 1:80ab0d068708 93 bool writeBlock(uint8_t * buf, uint16_t size);
samux 1:80ab0d068708 94
samux 1:80ab0d068708 95 /**
samux 1:80ab0d068708 96 * Attach a member function to call when a packet is received.
samux 1:80ab0d068708 97 *
samux 1:80ab0d068708 98 * @param tptr pointer to the object to call the member function on
samux 1:80ab0d068708 99 * @param mptr pointer to the member function to be called
samux 1:80ab0d068708 100 */
samux 1:80ab0d068708 101 template<typename T>
samux 1:80ab0d068708 102 void attach(T* tptr, void (T::*mptr)(void)) {
samux 1:80ab0d068708 103 if((mptr != NULL) && (tptr != NULL)) {
samux 1:80ab0d068708 104 rx.attach(tptr, mptr);
samux 1:80ab0d068708 105 }
samux 1:80ab0d068708 106 }
samux 1:80ab0d068708 107
samux 1:80ab0d068708 108 /**
samux 1:80ab0d068708 109 * Attach a callback called when a packet is received
samux 1:80ab0d068708 110 *
samux 1:80ab0d068708 111 * @param fptr function pointer
samux 1:80ab0d068708 112 */
samux 1:80ab0d068708 113 void attach(void (*fn)(void)) {
samux 1:80ab0d068708 114 if(fn != NULL) {
samux 1:80ab0d068708 115 rx.attach(fn);
samux 1:80ab0d068708 116 }
samux 1:80ab0d068708 117 }
samux 1:80ab0d068708 118
samux 1:80ab0d068708 119
samux 1:80ab0d068708 120 protected:
samux 1:80ab0d068708 121 virtual bool EP2_OUT_callback();
samux 1:80ab0d068708 122
samux 1:80ab0d068708 123 private:
samux 1:80ab0d068708 124 FunctionPointer rx;
samux 1:80ab0d068708 125 CircBuffer<uint8_t> buf;
samux 1:80ab0d068708 126 };
samux 1:80ab0d068708 127
samux 1:80ab0d068708 128 #endif