Mike R / Mbed 2 deprecated Pinscape_Controller_v1

Pinscape Controller version 1 fork. This is a fork to allow for ongoing bug fixes to the original controller version, from before the major changes for the expansion board project.

Dependencies:   FastIO FastPWM SimpleDMA mbed

Fork of Pinscape_Controller by Mike R

USBJoystick/USBJoystick.cpp@21:5048e16cc9ef, 2015-03-28 (annotated)

Committer:
mjr
Date:
Sat Mar 28 07:59:47 2015 +0000
Revision:
21:5048e16cc9ef
Parent:
11:bd9da7088e6e
Child:
25:e22b88bd783a
New No-Joystick configuration option (for secondary devices that only act as output controllers)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mjr 3:3514575d4f86 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
mjr 3:3514575d4f86 2 * Modified Mouse code for Joystick - WH 2012
mjr 3:3514575d4f86 3 *
mjr 3:3514575d4f86 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
mjr 3:3514575d4f86 5 * and associated documentation files (the "Software"), to deal in the Software without
mjr 3:3514575d4f86 6 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
mjr 3:3514575d4f86 7 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
mjr 3:3514575d4f86 8 * Software is furnished to do so, subject to the following conditions:
mjr 3:3514575d4f86 9 *
mjr 3:3514575d4f86 10 * The above copyright notice and this permission notice shall be included in all copies or
mjr 3:3514575d4f86 11 * substantial portions of the Software.
mjr 3:3514575d4f86 12 *
mjr 3:3514575d4f86 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
mjr 3:3514575d4f86 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
mjr 3:3514575d4f86 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
mjr 3:3514575d4f86 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mjr 3:3514575d4f86 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
mjr 3:3514575d4f86 18 */
mjr 3:3514575d4f86 19
mjr 3:3514575d4f86 20 #include "stdint.h"
mjr 3:3514575d4f86 21 #include "USBJoystick.h"
mjr 21:5048e16cc9ef 22
mjr 21:5048e16cc9ef 23 #include "config.h" // Pinscape configuration
mjr 21:5048e16cc9ef 24
mjr 21:5048e16cc9ef 25 // Length of our joystick reports. Important: This must be kept in sync
mjr 21:5048e16cc9ef 26 // with the actual joystick report format sent in update().
mjr 21:5048e16cc9ef 27 const int reportLen = 14;
mjr 21:5048e16cc9ef 28
mjr 21:5048e16cc9ef 29 #ifdef ENABLE_JOYSTICK
mjr 11:bd9da7088e6e 30 bool USBJoystick::update(int16_t x, int16_t y, int16_t z, uint32_t buttons, uint16_t status)
mjr 3:3514575d4f86 31 {
mjr 3:3514575d4f86 32 _x = x;
mjr 3:3514575d4f86 33 _y = y;
mjr 3:3514575d4f86 34 _z = z;
mjr 11:bd9da7088e6e 35 _buttonsLo = (uint16_t)(buttons & 0xffff);
mjr 11:bd9da7088e6e 36 _buttonsHi = (uint16_t)((buttons >> 16) & 0xffff);
mjr 10:976666ffa4ef 37 _status = status;
mjr 3:3514575d4f86 38
mjr 3:3514575d4f86 39 // send the report
mjr 3:3514575d4f86 40 return update();
mjr 3:3514575d4f86 41 }
mjr 3:3514575d4f86 42
mjr 11:bd9da7088e6e 43 bool USBJoystick::update()
mjr 11:bd9da7088e6e 44 {
mjr 3:3514575d4f86 45 HID_REPORT report;
mjr 11:bd9da7088e6e 46
mjr 3:3514575d4f86 47 // Fill the report according to the Joystick Descriptor
mjr 6:cc35eb643e8f 48 #define put(idx, val) (report.data[idx] = (val) & 0xff, report.data[(idx)+1] = ((val) >> 8) & 0xff)
mjr 10:976666ffa4ef 49 put(0, _status);
mjr 10:976666ffa4ef 50 put(2, 0); // second byte of status isn't used in normal reports
mjr 11:bd9da7088e6e 51 put(4, _buttonsLo);
mjr 11:bd9da7088e6e 52 put(6, _buttonsHi);
mjr 11:bd9da7088e6e 53 put(8, _x);
mjr 11:bd9da7088e6e 54 put(10, _y);
mjr 11:bd9da7088e6e 55 put(12, _z);
mjr 21:5048e16cc9ef 56
mjr 21:5048e16cc9ef 57 // important: keep reportLen in sync with the actual byte length of
mjr 21:5048e16cc9ef 58 // the reports we build here
mjr 11:bd9da7088e6e 59 report.length = reportLen;
mjr 3:3514575d4f86 60
mjr 5:a70c0bce770d 61 // send the report
mjr 10:976666ffa4ef 62 return sendTO(&report, 100);
mjr 10:976666ffa4ef 63 }
mjr 10:976666ffa4ef 64
mjr 10:976666ffa4ef 65 bool USBJoystick::updateExposure(int &idx, int npix, const uint16_t *pix)
mjr 10:976666ffa4ef 66 {
mjr 10:976666ffa4ef 67 HID_REPORT report;
mjr 10:976666ffa4ef 68
mjr 10:976666ffa4ef 69 // Set the special status bits to indicate it's an exposure report.
mjr 10:976666ffa4ef 70 // The high 5 bits of the status word are set to 10000, and the
mjr 10:976666ffa4ef 71 // low 11 bits are the current pixel index.
mjr 10:976666ffa4ef 72 uint16_t s = idx | 0x8000;
mjr 10:976666ffa4ef 73 put(0, s);
mjr 10:976666ffa4ef 74
mjr 10:976666ffa4ef 75 // now fill out the remaining words with exposure values
mjr 11:bd9da7088e6e 76 report.length = reportLen;
mjr 10:976666ffa4ef 77 for (int ofs = 2 ; ofs + 1 < report.length ; ofs += 2)
mjr 10:976666ffa4ef 78 {
mjr 10:976666ffa4ef 79 uint16_t p = (idx < npix ? pix[idx++] : 0);
mjr 10:976666ffa4ef 80 put(ofs, p);
mjr 10:976666ffa4ef 81 }
mjr 10:976666ffa4ef 82
mjr 10:976666ffa4ef 83 // send the report
mjr 10:976666ffa4ef 84 return send(&report);
mjr 3:3514575d4f86 85 }
mjr 9:fd65b0a94720 86
mjr 3:3514575d4f86 87 bool USBJoystick::move(int16_t x, int16_t y) {
mjr 3:3514575d4f86 88 _x = x;
mjr 3:3514575d4f86 89 _y = y;
mjr 3:3514575d4f86 90 return update();
mjr 3:3514575d4f86 91 }
mjr 3:3514575d4f86 92
mjr 3:3514575d4f86 93 bool USBJoystick::setZ(int16_t z) {
mjr 3:3514575d4f86 94 _z = z;
mjr 3:3514575d4f86 95 return update();
mjr 3:3514575d4f86 96 }
mjr 3:3514575d4f86 97
mjr 11:bd9da7088e6e 98 bool USBJoystick::buttons(uint32_t buttons) {
mjr 11:bd9da7088e6e 99 _buttonsLo = (uint16_t)(buttons & 0xffff);
mjr 11:bd9da7088e6e 100 _buttonsHi = (uint16_t)((buttons >> 16) & 0xffff);
mjr 3:3514575d4f86 101 return update();
mjr 3:3514575d4f86 102 }
mjr 21:5048e16cc9ef 103
mjr 21:5048e16cc9ef 104 #else /* ENABLE_JOYSTICK */
mjr 21:5048e16cc9ef 105
mjr 21:5048e16cc9ef 106 bool USBJoystick::updateStatus(uint32_t status)
mjr 21:5048e16cc9ef 107 {
mjr 21:5048e16cc9ef 108 HID_REPORT report;
mjr 21:5048e16cc9ef 109
mjr 21:5048e16cc9ef 110 // Fill the report according to the Joystick Descriptor
mjr 21:5048e16cc9ef 111 #define put(idx, val) (report.data[idx] = (val) & 0xff, report.data[(idx)+1] = ((val) >> 8) & 0xff)
mjr 21:5048e16cc9ef 112 memset(report.data, 0, reportLen);
mjr 21:5048e16cc9ef 113 put(0, status);
mjr 21:5048e16cc9ef 114 report.length = reportLen;
mjr 21:5048e16cc9ef 115
mjr 21:5048e16cc9ef 116 // send the report
mjr 21:5048e16cc9ef 117 return sendTO(&report, 100);
mjr 21:5048e16cc9ef 118 }
mjr 21:5048e16cc9ef 119
mjr 21:5048e16cc9ef 120 #endif /* ENABLE_JOYSTICK */
mjr 3:3514575d4f86 121
mjr 3:3514575d4f86 122
mjr 3:3514575d4f86 123 void USBJoystick::_init() {
mjr 3:3514575d4f86 124
mjr 3:3514575d4f86 125 _x = 0;
mjr 3:3514575d4f86 126 _y = 0;
mjr 3:3514575d4f86 127 _z = 0;
mjr 11:bd9da7088e6e 128 _buttonsLo = 0x0000;
mjr 11:bd9da7088e6e 129 _buttonsHi = 0x0000;
mjr 9:fd65b0a94720 130 _status = 0;
mjr 3:3514575d4f86 131 }
mjr 3:3514575d4f86 132
mjr 3:3514575d4f86 133
mjr 3:3514575d4f86 134 uint8_t * USBJoystick::reportDesc()
mjr 3:3514575d4f86 135 {
mjr 21:5048e16cc9ef 136 #ifdef ENABLE_JOYSTICK
mjr 21:5048e16cc9ef 137 // Joystick reports are enabled. Use the full joystick report
mjr 21:5048e16cc9ef 138 // format.
mjr 3:3514575d4f86 139 static uint8_t reportDescriptor[] =
mjr 3:3514575d4f86 140 {
mjr 3:3514575d4f86 141 USAGE_PAGE(1), 0x01, // Generic desktop
mjr 3:3514575d4f86 142 USAGE(1), 0x04, // Joystick
mjr 3:3514575d4f86 143
mjr 3:3514575d4f86 144 COLLECTION(1), 0x01, // Application
mjr 9:fd65b0a94720 145
mjr 9:fd65b0a94720 146 // NB - the canonical joystick has a nested collection at this
mjr 9:fd65b0a94720 147 // point. We remove the inner collection to enable the LedWiz
mjr 9:fd65b0a94720 148 // emulation. The LedWiz API implementation on the PC side
mjr 9:fd65b0a94720 149 // appears to use the collection structure as part of the
mjr 9:fd65b0a94720 150 // device signature, and the real LedWiz descriptor has just
mjr 9:fd65b0a94720 151 // one top-level collection. The built-in Windows HID drivers
mjr 9:fd65b0a94720 152 // don't appear to care whether this collection is present or
mjr 9:fd65b0a94720 153 // not for the purposes of recognizing a joystick, so it seems
mjr 9:fd65b0a94720 154 // to make everyone happy to leave it out.
mjr 9:fd65b0a94720 155 //
mjr 9:fd65b0a94720 156 // All of the reference material for USB joystick device builders
mjr 9:fd65b0a94720 157 // does use the inner collection, so it's possible that omitting
mjr 9:fd65b0a94720 158 // it will create an incompatibility with some non-Windows hosts.
mjr 9:fd65b0a94720 159 // But that seems largely moot in that VP only runs on Windows.
mjr 9:fd65b0a94720 160 // If you're you're trying to adapt this code for a different
mjr 9:fd65b0a94720 161 // device and run into problems connecting to a non-Windows host,
mjr 9:fd65b0a94720 162 // try restoring the inner collection. You probably won't
mjr 9:fd65b0a94720 163 // care about LedWiz compatibility in such a situation so there
mjr 9:fd65b0a94720 164 // should be no reason not to return to the standard structure.
mjr 6:cc35eb643e8f 165 // COLLECTION(1), 0x00, // Physical
mjr 3:3514575d4f86 166
mjr 9:fd65b0a94720 167 // input report (device to host)
mjr 10:976666ffa4ef 168
mjr 10:976666ffa4ef 169 USAGE_PAGE(1), 0x06, // generic device controls - for config status
mjr 10:976666ffa4ef 170 USAGE(1), 0x00, // undefined device control
mjr 10:976666ffa4ef 171 LOGICAL_MINIMUM(1), 0x00, // 8-bit values
mjr 10:976666ffa4ef 172 LOGICAL_MAXIMUM(1), 0xFF,
mjr 10:976666ffa4ef 173 REPORT_SIZE(1), 0x08, // 8 bits per report
mjr 10:976666ffa4ef 174 REPORT_COUNT(1), 0x04, // 4 reports (4 bytes)
mjr 10:976666ffa4ef 175 INPUT(1), 0x02, // Data, Variable, Absolute
mjr 10:976666ffa4ef 176
mjr 3:3514575d4f86 177 USAGE_PAGE(1), 0x09, // Buttons
mjr 3:3514575d4f86 178 USAGE_MINIMUM(1), 0x01, // { buttons }
mjr 11:bd9da7088e6e 179 USAGE_MAXIMUM(1), 0x20, // { 1-32 }
mjr 3:3514575d4f86 180 LOGICAL_MINIMUM(1), 0x00, // 1-bit buttons - 0...
mjr 3:3514575d4f86 181 LOGICAL_MAXIMUM(1), 0x01, // ...to 1
mjr 3:3514575d4f86 182 REPORT_SIZE(1), 0x01, // 1 bit per report
mjr 11:bd9da7088e6e 183 REPORT_COUNT(1), 0x20, // 32 reports
mjr 3:3514575d4f86 184 UNIT_EXPONENT(1), 0x00, // Unit_Exponent (0)
mjr 3:3514575d4f86 185 UNIT(1), 0x00, // Unit (None)
mjr 3:3514575d4f86 186 INPUT(1), 0x02, // Data, Variable, Absolute
mjr 3:3514575d4f86 187
mjr 3:3514575d4f86 188 USAGE_PAGE(1), 0x01, // Generic desktop
mjr 9:fd65b0a94720 189 USAGE(1), 0x30, // X axis
mjr 9:fd65b0a94720 190 USAGE(1), 0x31, // Y axis
mjr 9:fd65b0a94720 191 USAGE(1), 0x32, // Z axis
mjr 6:cc35eb643e8f 192 LOGICAL_MINIMUM(2), 0x00,0xF0, // each value ranges -4096
mjr 6:cc35eb643e8f 193 LOGICAL_MAXIMUM(2), 0x00,0x10, // ...to +4096
mjr 6:cc35eb643e8f 194 REPORT_SIZE(1), 0x10, // 16 bits per report
mjr 9:fd65b0a94720 195 REPORT_COUNT(1), 0x03, // 3 reports (X, Y, Z)
mjr 9:fd65b0a94720 196 INPUT(1), 0x02, // Data, Variable, Absolute
mjr 9:fd65b0a94720 197
mjr 9:fd65b0a94720 198 // output report (host to device)
mjr 9:fd65b0a94720 199 REPORT_SIZE(1), 0x08, // 8 bits per report
mjr 9:fd65b0a94720 200 REPORT_COUNT(1), 0x08, // output report count (LEDWiz messages)
mjr 3:3514575d4f86 201 0x09, 0x01, // usage
mjr 3:3514575d4f86 202 0x91, 0x01, // Output (array)
mjr 3:3514575d4f86 203
mjr 6:cc35eb643e8f 204 // END_COLLECTION(0),
mjr 3:3514575d4f86 205 END_COLLECTION(0)
mjr 3:3514575d4f86 206 };
mjr 21:5048e16cc9ef 207 #else /* defined(ENABLE_JOYSTICK) */
mjr 21:5048e16cc9ef 208
mjr 21:5048e16cc9ef 209 // Joystick reports are disabled. We still want to appear
mjr 21:5048e16cc9ef 210 // as a USB device for the LedWiz output emulation, but we
mjr 21:5048e16cc9ef 211 // don't want to appear as a joystick.
mjr 21:5048e16cc9ef 212
mjr 21:5048e16cc9ef 213 static uint8_t reportDescriptor[] =
mjr 21:5048e16cc9ef 214 {
mjr 21:5048e16cc9ef 215 USAGE_PAGE(1), 0x01, // Generic desktop
mjr 21:5048e16cc9ef 216 USAGE(1), 0x00, // Undefined
mjr 21:5048e16cc9ef 217
mjr 21:5048e16cc9ef 218 COLLECTION(1), 0x01, // Application
mjr 21:5048e16cc9ef 219
mjr 21:5048e16cc9ef 220 // input report (device to host)
mjr 21:5048e16cc9ef 221 USAGE_PAGE(1), 0x06, // generic device controls - for config status
mjr 21:5048e16cc9ef 222 USAGE(1), 0x00, // undefined device control
mjr 21:5048e16cc9ef 223 LOGICAL_MINIMUM(1), 0x00, // 8-bit values
mjr 21:5048e16cc9ef 224 LOGICAL_MAXIMUM(1), 0xFF,
mjr 21:5048e16cc9ef 225 REPORT_SIZE(1), 0x08, // 8 bits per report
mjr 21:5048e16cc9ef 226 REPORT_COUNT(1), reportLen, // standard report length (same as if we were in joystick mode)
mjr 21:5048e16cc9ef 227 INPUT(1), 0x02, // Data, Variable, Absolute
mjr 21:5048e16cc9ef 228
mjr 21:5048e16cc9ef 229 // output report (host to device)
mjr 21:5048e16cc9ef 230 REPORT_SIZE(1), 0x08, // 8 bits per report
mjr 21:5048e16cc9ef 231 REPORT_COUNT(1), 0x08, // output report count (LEDWiz messages)
mjr 21:5048e16cc9ef 232 0x09, 0x01, // usage
mjr 21:5048e16cc9ef 233 0x91, 0x01, // Output (array)
mjr 21:5048e16cc9ef 234
mjr 21:5048e16cc9ef 235 END_COLLECTION(0)
mjr 21:5048e16cc9ef 236 };
mjr 3:3514575d4f86 237
mjr 21:5048e16cc9ef 238 #endif /* defined(ENABLE_JOYSTICK) */
mjr 21:5048e16cc9ef 239
mjr 3:3514575d4f86 240 reportLength = sizeof(reportDescriptor);
mjr 3:3514575d4f86 241 return reportDescriptor;
mjr 3:3514575d4f86 242 }
mjr 3:3514575d4f86 243
mjr 3:3514575d4f86 244 uint8_t * USBJoystick::stringImanufacturerDesc() {
mjr 3:3514575d4f86 245 static uint8_t stringImanufacturerDescriptor[] = {
mjr 3:3514575d4f86 246 0x10, /*bLength*/
mjr 3:3514575d4f86 247 STRING_DESCRIPTOR, /*bDescriptorType 0x03*/
mjr 3:3514575d4f86 248 'm',0,'j',0,'r',0,'c',0,'o',0,'r',0,'p',0 /*bString iManufacturer - mjrcorp*/
mjr 3:3514575d4f86 249 };
mjr 3:3514575d4f86 250 return stringImanufacturerDescriptor;
mjr 3:3514575d4f86 251 }
mjr 3:3514575d4f86 252
mjr 3:3514575d4f86 253 uint8_t * USBJoystick::stringIserialDesc() {
mjr 3:3514575d4f86 254 static uint8_t stringIserialDescriptor[] = {
mjr 3:3514575d4f86 255 0x16, /*bLength*/
mjr 3:3514575d4f86 256 STRING_DESCRIPTOR, /*bDescriptorType 0x03*/
mjr 3:3514575d4f86 257 '0',0,'1',0,'2',0,'3',0,'4',0,'5',0,'6',0,'7',0,'8',0,'9',0, /*bString iSerial - 0123456789*/
mjr 3:3514575d4f86 258 };
mjr 3:3514575d4f86 259 return stringIserialDescriptor;
mjr 3:3514575d4f86 260 }
mjr 3:3514575d4f86 261
mjr 3:3514575d4f86 262 uint8_t * USBJoystick::stringIproductDesc() {
mjr 3:3514575d4f86 263 static uint8_t stringIproductDescriptor[] = {
mjr 9:fd65b0a94720 264 0x28, /*bLength*/
mjr 3:3514575d4f86 265 STRING_DESCRIPTOR, /*bDescriptorType 0x03*/
mjr 3:3514575d4f86 266 'P',0,'i',0,'n',0,'s',0,'c',0,'a',0,'p',0,'e',0,
mjr 3:3514575d4f86 267 ' ',0,'C',0,'o',0,'n',0,'t',0,'r',0,'o',0,'l',0,
mjr 3:3514575d4f86 268 'l',0,'e',0,'r',0 /*String iProduct */
mjr 3:3514575d4f86 269 };
mjr 3:3514575d4f86 270 return stringIproductDescriptor;
mjr 3:3514575d4f86 271 }