Jörg Weber / Mbed 2 deprecated USBJoystick_HelloWorld2_wip

WIP PID

Dependencies:   USBDEVICE USBJoystick mbed

Fork of USBJoystick_HelloWorld2 by Wim Huiskamp

USBPID/USBPID.h@1:caf8a4134cbf, 2018-07-07 (annotated)

Committer:
Cirrus01
Date:
Sat Jul 07 10:48:38 2018 +0000
Revision:
1:caf8a4134cbf
First

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Cirrus01 1:caf8a4134cbf 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
Cirrus01 1:caf8a4134cbf 2 *
Cirrus01 1:caf8a4134cbf 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Cirrus01 1:caf8a4134cbf 4 * and associated documentation files (the "Software"), to deal in the Software without
Cirrus01 1:caf8a4134cbf 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
Cirrus01 1:caf8a4134cbf 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Cirrus01 1:caf8a4134cbf 7 * Software is furnished to do so, subject to the following conditions:
Cirrus01 1:caf8a4134cbf 8 *
Cirrus01 1:caf8a4134cbf 9 * The above copyright notice and this permission notice shall be included in all copies or
Cirrus01 1:caf8a4134cbf 10 * substantial portions of the Software.
Cirrus01 1:caf8a4134cbf 11 *
Cirrus01 1:caf8a4134cbf 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Cirrus01 1:caf8a4134cbf 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Cirrus01 1:caf8a4134cbf 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Cirrus01 1:caf8a4134cbf 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Cirrus01 1:caf8a4134cbf 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Cirrus01 1:caf8a4134cbf 17 */
Cirrus01 1:caf8a4134cbf 18
Cirrus01 1:caf8a4134cbf 19 #ifndef USB_PID_H
Cirrus01 1:caf8a4134cbf 20 #define USB_PID_H
Cirrus01 1:caf8a4134cbf 21
Cirrus01 1:caf8a4134cbf 22 /* These headers are included for child class. */
Cirrus01 1:caf8a4134cbf 23 #include "USBEndpoints.h"
Cirrus01 1:caf8a4134cbf 24 #include "USBDescriptor.h"
Cirrus01 1:caf8a4134cbf 25 #include "USBDevice_Types.h"
Cirrus01 1:caf8a4134cbf 26
Cirrus01 1:caf8a4134cbf 27 #include "USBPID_Types.h"
Cirrus01 1:caf8a4134cbf 28 #include "USBDevice.h"
Cirrus01 1:caf8a4134cbf 29
Cirrus01 1:caf8a4134cbf 30
Cirrus01 1:caf8a4134cbf 31 /**
Cirrus01 1:caf8a4134cbf 32 * USBPID example
Cirrus01 1:caf8a4134cbf 33 * @code
Cirrus01 1:caf8a4134cbf 34 * #include "mbed.h"
Cirrus01 1:caf8a4134cbf 35 * #include "USBPID.h"
Cirrus01 1:caf8a4134cbf 36 *
Cirrus01 1:caf8a4134cbf 37 * USBPID pid;
Cirrus01 1:caf8a4134cbf 38 * PID_REPORT recv;
Cirrus01 1:caf8a4134cbf 39 * BusOut leds(LED1,LED2,LED3,LED4);
Cirrus01 1:caf8a4134cbf 40 *
Cirrus01 1:caf8a4134cbf 41 * int main(void) {
Cirrus01 1:caf8a4134cbf 42 * while (1) {
Cirrus01 1:caf8a4134cbf 43 * pid.read(&recv);
Cirrus01 1:caf8a4134cbf 44 * leds = recv.data[0];
Cirrus01 1:caf8a4134cbf 45 * }
Cirrus01 1:caf8a4134cbf 46 * }
Cirrus01 1:caf8a4134cbf 47 * @endcode
Cirrus01 1:caf8a4134cbf 48 */
Cirrus01 1:caf8a4134cbf 49
Cirrus01 1:caf8a4134cbf 50 class USBPID: public USBDevice {
Cirrus01 1:caf8a4134cbf 51 public:
Cirrus01 1:caf8a4134cbf 52
Cirrus01 1:caf8a4134cbf 53 /**
Cirrus01 1:caf8a4134cbf 54 * Constructor
Cirrus01 1:caf8a4134cbf 55 *
Cirrus01 1:caf8a4134cbf 56 * @param output_report_length Maximum length of a sent report (up to 64 bytes) (default: 64 bytes)
Cirrus01 1:caf8a4134cbf 57 * @param input_report_length Maximum length of a received report (up to 64 bytes) (default: 64 bytes)
Cirrus01 1:caf8a4134cbf 58 * @param vendor_id Your vendor_id
Cirrus01 1:caf8a4134cbf 59 * @param product_id Your product_id
Cirrus01 1:caf8a4134cbf 60 * @param product_release Your preoduct_release
Cirrus01 1:caf8a4134cbf 61 * @param connect Connect the device
Cirrus01 1:caf8a4134cbf 62 */
Cirrus01 1:caf8a4134cbf 63 USBPID(uint8_t output_report_length = 64, uint8_t input_report_length = 64, uint16_t vendor_id = 0x1209, uint16_t product_id = 0x0001, uint16_t product_release = 0x0001, bool connect = true);
Cirrus01 1:caf8a4134cbf 64
Cirrus01 1:caf8a4134cbf 65
Cirrus01 1:caf8a4134cbf 66 /**
Cirrus01 1:caf8a4134cbf 67 * Send a Report. warning: blocking
Cirrus01 1:caf8a4134cbf 68 *
Cirrus01 1:caf8a4134cbf 69 * @param report Report which will be sent (a report is defined by all data and the length)
Cirrus01 1:caf8a4134cbf 70 * @returns true if successful
Cirrus01 1:caf8a4134cbf 71 */
Cirrus01 1:caf8a4134cbf 72 bool send(PID_REPORT *report);
Cirrus01 1:caf8a4134cbf 73
Cirrus01 1:caf8a4134cbf 74
Cirrus01 1:caf8a4134cbf 75 /**
Cirrus01 1:caf8a4134cbf 76 * Send a Report. warning: non blocking
Cirrus01 1:caf8a4134cbf 77 *
Cirrus01 1:caf8a4134cbf 78 * @param report Report which will be sent (a report is defined by all data and the length)
Cirrus01 1:caf8a4134cbf 79 * @returns true if successful
Cirrus01 1:caf8a4134cbf 80 */
Cirrus01 1:caf8a4134cbf 81 bool sendNB(PID_REPORT *report);
Cirrus01 1:caf8a4134cbf 82
Cirrus01 1:caf8a4134cbf 83 /**
Cirrus01 1:caf8a4134cbf 84 * Read a report: blocking
Cirrus01 1:caf8a4134cbf 85 *
Cirrus01 1:caf8a4134cbf 86 * @param report pointer to the report to fill
Cirrus01 1:caf8a4134cbf 87 * @returns true if successful
Cirrus01 1:caf8a4134cbf 88 */
Cirrus01 1:caf8a4134cbf 89 bool read(PID_REPORT * report);
Cirrus01 1:caf8a4134cbf 90
Cirrus01 1:caf8a4134cbf 91 /**
Cirrus01 1:caf8a4134cbf 92 * Read a report: non blocking
Cirrus01 1:caf8a4134cbf 93 *
Cirrus01 1:caf8a4134cbf 94 * @param report pointer to the report to fill
Cirrus01 1:caf8a4134cbf 95 * @returns true if successful
Cirrus01 1:caf8a4134cbf 96 */
Cirrus01 1:caf8a4134cbf 97 bool readNB(PID_REPORT * report);
Cirrus01 1:caf8a4134cbf 98
Cirrus01 1:caf8a4134cbf 99 protected:
Cirrus01 1:caf8a4134cbf 100 uint16_t reportLength;
Cirrus01 1:caf8a4134cbf 101
Cirrus01 1:caf8a4134cbf 102 /*
Cirrus01 1:caf8a4134cbf 103 * Get the Report descriptor
Cirrus01 1:caf8a4134cbf 104 *
Cirrus01 1:caf8a4134cbf 105 * @returns pointer to the report descriptor
Cirrus01 1:caf8a4134cbf 106 */
Cirrus01 1:caf8a4134cbf 107 virtual uint8_t * reportDesc();
Cirrus01 1:caf8a4134cbf 108
Cirrus01 1:caf8a4134cbf 109 /*
Cirrus01 1:caf8a4134cbf 110 * Get the length of the report descriptor
Cirrus01 1:caf8a4134cbf 111 *
Cirrus01 1:caf8a4134cbf 112 * @returns the length of the report descriptor
Cirrus01 1:caf8a4134cbf 113 */
Cirrus01 1:caf8a4134cbf 114 virtual uint16_t reportDescLength();
Cirrus01 1:caf8a4134cbf 115
Cirrus01 1:caf8a4134cbf 116 /*
Cirrus01 1:caf8a4134cbf 117 * Get string product descriptor
Cirrus01 1:caf8a4134cbf 118 *
Cirrus01 1:caf8a4134cbf 119 * @returns pointer to the string product descriptor
Cirrus01 1:caf8a4134cbf 120 */
Cirrus01 1:caf8a4134cbf 121 virtual uint8_t * stringIproductDesc();
Cirrus01 1:caf8a4134cbf 122
Cirrus01 1:caf8a4134cbf 123 /*
Cirrus01 1:caf8a4134cbf 124 * Get string interface descriptor
Cirrus01 1:caf8a4134cbf 125 *
Cirrus01 1:caf8a4134cbf 126 * @returns pointer to the string interface descriptor
Cirrus01 1:caf8a4134cbf 127 */
Cirrus01 1:caf8a4134cbf 128 virtual uint8_t * stringIinterfaceDesc();
Cirrus01 1:caf8a4134cbf 129
Cirrus01 1:caf8a4134cbf 130 /*
Cirrus01 1:caf8a4134cbf 131 * Get configuration descriptor
Cirrus01 1:caf8a4134cbf 132 *
Cirrus01 1:caf8a4134cbf 133 * @returns pointer to the configuration descriptor
Cirrus01 1:caf8a4134cbf 134 */
Cirrus01 1:caf8a4134cbf 135 virtual uint8_t * configurationDesc();
Cirrus01 1:caf8a4134cbf 136
Cirrus01 1:caf8a4134cbf 137
Cirrus01 1:caf8a4134cbf 138 /*
Cirrus01 1:caf8a4134cbf 139 * PID Report received by SET_REPORT request. Warning: Called in ISR context
Cirrus01 1:caf8a4134cbf 140 * First byte of data will be the report ID
Cirrus01 1:caf8a4134cbf 141 *
Cirrus01 1:caf8a4134cbf 142 * @param report Data and length received
Cirrus01 1:caf8a4134cbf 143 */
Cirrus01 1:caf8a4134cbf 144 virtual void PID_callbackSetReport(PID_REPORT *report){};
Cirrus01 1:caf8a4134cbf 145
Cirrus01 1:caf8a4134cbf 146
Cirrus01 1:caf8a4134cbf 147 /*
Cirrus01 1:caf8a4134cbf 148 * Called by USBDevice on Endpoint0 request. Warning: Called in ISR context
Cirrus01 1:caf8a4134cbf 149 * This is used to handle extensions to standard requests
Cirrus01 1:caf8a4134cbf 150 * and class specific requests
Cirrus01 1:caf8a4134cbf 151 *
Cirrus01 1:caf8a4134cbf 152 * @returns true if class handles this request
Cirrus01 1:caf8a4134cbf 153 */
Cirrus01 1:caf8a4134cbf 154 virtual bool USBCallback_request();
Cirrus01 1:caf8a4134cbf 155
Cirrus01 1:caf8a4134cbf 156
Cirrus01 1:caf8a4134cbf 157 /*
Cirrus01 1:caf8a4134cbf 158 * Called by USBDevice layer. Set configuration of the device.
Cirrus01 1:caf8a4134cbf 159 * For instance, you can add all endpoints that you need on this function.
Cirrus01 1:caf8a4134cbf 160 *
Cirrus01 1:caf8a4134cbf 161 * @param configuration Number of the configuration
Cirrus01 1:caf8a4134cbf 162 * @returns true if class handles this request
Cirrus01 1:caf8a4134cbf 163 */
Cirrus01 1:caf8a4134cbf 164 virtual bool USBCallback_setConfiguration(uint8_t configuration);
Cirrus01 1:caf8a4134cbf 165
Cirrus01 1:caf8a4134cbf 166 private:
Cirrus01 1:caf8a4134cbf 167 PID_REPORT outputReport;
Cirrus01 1:caf8a4134cbf 168 uint8_t output_length;
Cirrus01 1:caf8a4134cbf 169 uint8_t input_length;
Cirrus01 1:caf8a4134cbf 170 };
Cirrus01 1:caf8a4134cbf 171
Cirrus01 1:caf8a4134cbf 172 #endif