Maxim Integrated / Mbed OS Host_Software_MAX32664GWEB_HR_EXTENDED

ME11B Sample Code in Maxim Integrated Team

Dependencies:   BMI160 max32630hsp3 MemoryLCD USBDevice

Fork of Host_Software_MAX32664GWEB_HR_EXTENDED by Seyhmus Cacina

Drivers/USBDevice/USBHID/USBHID.h@0:ac4dea3e2894, 2019-03-18 (annotated)

Committer:
seyhmus.cacina
Date:
Mon Mar 18 10:21:53 2019 +0300
Revision:
0:ac4dea3e2894
ME11B Sample Code First Commit

Who changed what in which revision?

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