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@10:976666ffa4ef, 2014-08-23 (annotated)

Committer:
mjr
Date:
Sat Aug 23 01:24:36 2014 +0000
Revision:
10:976666ffa4ef
Parent:
9:fd65b0a94720
Child:
11:bd9da7088e6e
Add raw pixel dump support for use by the Windows config tool

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 3:3514575d4f86 22
mjr 9:fd65b0a94720 23 bool USBJoystick::update(int16_t x, int16_t y, int16_t z, uint16_t buttons, uint16_t status)
mjr 3:3514575d4f86 24 {
mjr 3:3514575d4f86 25 _x = x;
mjr 3:3514575d4f86 26 _y = y;
mjr 3:3514575d4f86 27 _z = z;
mjr 3:3514575d4f86 28 _buttons = buttons;
mjr 10:976666ffa4ef 29 _status = status;
mjr 3:3514575d4f86 30
mjr 3:3514575d4f86 31 // send the report
mjr 3:3514575d4f86 32 return update();
mjr 3:3514575d4f86 33 }
mjr 3:3514575d4f86 34
mjr 3:3514575d4f86 35 bool USBJoystick::update() {
mjr 3:3514575d4f86 36 HID_REPORT report;
mjr 3:3514575d4f86 37
mjr 3:3514575d4f86 38 // Fill the report according to the Joystick Descriptor
mjr 6:cc35eb643e8f 39 #define put(idx, val) (report.data[idx] = (val) & 0xff, report.data[(idx)+1] = ((val) >> 8) & 0xff)
mjr 10:976666ffa4ef 40 put(0, _status);
mjr 10:976666ffa4ef 41 put(2, 0); // second byte of status isn't used in normal reports
mjr 10:976666ffa4ef 42 put(4, _buttons);
mjr 10:976666ffa4ef 43 put(6, _x);
mjr 10:976666ffa4ef 44 put(8, _y);
mjr 10:976666ffa4ef 45 put(10, _z);
mjr 10:976666ffa4ef 46 report.length = 12;
mjr 3:3514575d4f86 47
mjr 5:a70c0bce770d 48 // send the report
mjr 10:976666ffa4ef 49 return sendTO(&report, 100);
mjr 10:976666ffa4ef 50 }
mjr 10:976666ffa4ef 51
mjr 10:976666ffa4ef 52 bool USBJoystick::updateExposure(int &idx, int npix, const uint16_t *pix)
mjr 10:976666ffa4ef 53 {
mjr 10:976666ffa4ef 54 HID_REPORT report;
mjr 10:976666ffa4ef 55
mjr 10:976666ffa4ef 56 // Set the special status bits to indicate it's an exposure report.
mjr 10:976666ffa4ef 57 // The high 5 bits of the status word are set to 10000, and the
mjr 10:976666ffa4ef 58 // low 11 bits are the current pixel index.
mjr 10:976666ffa4ef 59 uint16_t s = idx | 0x8000;
mjr 10:976666ffa4ef 60 put(0, s);
mjr 10:976666ffa4ef 61
mjr 10:976666ffa4ef 62 // now fill out the remaining words with exposure values
mjr 10:976666ffa4ef 63 report.length = 12;
mjr 10:976666ffa4ef 64 for (int ofs = 2 ; ofs + 1 < report.length ; ofs += 2)
mjr 10:976666ffa4ef 65 {
mjr 10:976666ffa4ef 66 uint16_t p = (idx < npix ? pix[idx++] : 0);
mjr 10:976666ffa4ef 67 put(ofs, p);
mjr 10:976666ffa4ef 68 }
mjr 10:976666ffa4ef 69
mjr 10:976666ffa4ef 70 // send the report
mjr 10:976666ffa4ef 71 return send(&report);
mjr 3:3514575d4f86 72 }
mjr 9:fd65b0a94720 73
mjr 3:3514575d4f86 74 bool USBJoystick::move(int16_t x, int16_t y) {
mjr 3:3514575d4f86 75 _x = x;
mjr 3:3514575d4f86 76 _y = y;
mjr 3:3514575d4f86 77 return update();
mjr 3:3514575d4f86 78 }
mjr 3:3514575d4f86 79
mjr 3:3514575d4f86 80 bool USBJoystick::setZ(int16_t z) {
mjr 3:3514575d4f86 81 _z = z;
mjr 3:3514575d4f86 82 return update();
mjr 3:3514575d4f86 83 }
mjr 3:3514575d4f86 84
mjr 3:3514575d4f86 85 bool USBJoystick::buttons(uint16_t buttons) {
mjr 3:3514575d4f86 86 _buttons = buttons;
mjr 3:3514575d4f86 87 return update();
mjr 3:3514575d4f86 88 }
mjr 3:3514575d4f86 89
mjr 3:3514575d4f86 90
mjr 3:3514575d4f86 91 void USBJoystick::_init() {
mjr 3:3514575d4f86 92
mjr 3:3514575d4f86 93 _x = 0;
mjr 3:3514575d4f86 94 _y = 0;
mjr 3:3514575d4f86 95 _z = 0;
mjr 3:3514575d4f86 96 _buttons = 0x0000;
mjr 9:fd65b0a94720 97 _status = 0;
mjr 3:3514575d4f86 98 }
mjr 3:3514575d4f86 99
mjr 3:3514575d4f86 100
mjr 3:3514575d4f86 101 uint8_t * USBJoystick::reportDesc()
mjr 3:3514575d4f86 102 {
mjr 3:3514575d4f86 103 static uint8_t reportDescriptor[] =
mjr 3:3514575d4f86 104 {
mjr 3:3514575d4f86 105 USAGE_PAGE(1), 0x01, // Generic desktop
mjr 3:3514575d4f86 106 USAGE(1), 0x04, // Joystick
mjr 3:3514575d4f86 107
mjr 3:3514575d4f86 108 COLLECTION(1), 0x01, // Application
mjr 9:fd65b0a94720 109
mjr 9:fd65b0a94720 110 // NB - the canonical joystick has a nested collection at this
mjr 9:fd65b0a94720 111 // point. We remove the inner collection to enable the LedWiz
mjr 9:fd65b0a94720 112 // emulation. The LedWiz API implementation on the PC side
mjr 9:fd65b0a94720 113 // appears to use the collection structure as part of the
mjr 9:fd65b0a94720 114 // device signature, and the real LedWiz descriptor has just
mjr 9:fd65b0a94720 115 // one top-level collection. The built-in Windows HID drivers
mjr 9:fd65b0a94720 116 // don't appear to care whether this collection is present or
mjr 9:fd65b0a94720 117 // not for the purposes of recognizing a joystick, so it seems
mjr 9:fd65b0a94720 118 // to make everyone happy to leave it out.
mjr 9:fd65b0a94720 119 //
mjr 9:fd65b0a94720 120 // All of the reference material for USB joystick device builders
mjr 9:fd65b0a94720 121 // does use the inner collection, so it's possible that omitting
mjr 9:fd65b0a94720 122 // it will create an incompatibility with some non-Windows hosts.
mjr 9:fd65b0a94720 123 // But that seems largely moot in that VP only runs on Windows.
mjr 9:fd65b0a94720 124 // If you're you're trying to adapt this code for a different
mjr 9:fd65b0a94720 125 // device and run into problems connecting to a non-Windows host,
mjr 9:fd65b0a94720 126 // try restoring the inner collection. You probably won't
mjr 9:fd65b0a94720 127 // care about LedWiz compatibility in such a situation so there
mjr 9:fd65b0a94720 128 // should be no reason not to return to the standard structure.
mjr 6:cc35eb643e8f 129 // COLLECTION(1), 0x00, // Physical
mjr 3:3514575d4f86 130
mjr 9:fd65b0a94720 131 // input report (device to host)
mjr 10:976666ffa4ef 132
mjr 10:976666ffa4ef 133 USAGE_PAGE(1), 0x06, // generic device controls - for config status
mjr 10:976666ffa4ef 134 USAGE(1), 0x00, // undefined device control
mjr 10:976666ffa4ef 135 LOGICAL_MINIMUM(1), 0x00, // 8-bit values
mjr 10:976666ffa4ef 136 LOGICAL_MAXIMUM(1), 0xFF,
mjr 10:976666ffa4ef 137 REPORT_SIZE(1), 0x08, // 8 bits per report
mjr 10:976666ffa4ef 138 REPORT_COUNT(1), 0x04, // 4 reports (4 bytes)
mjr 10:976666ffa4ef 139 INPUT(1), 0x02, // Data, Variable, Absolute
mjr 10:976666ffa4ef 140
mjr 3:3514575d4f86 141 USAGE_PAGE(1), 0x09, // Buttons
mjr 3:3514575d4f86 142 USAGE_MINIMUM(1), 0x01, // { buttons }
mjr 3:3514575d4f86 143 USAGE_MAXIMUM(1), 0x10, // { 1-16 }
mjr 3:3514575d4f86 144 LOGICAL_MINIMUM(1), 0x00, // 1-bit buttons - 0...
mjr 3:3514575d4f86 145 LOGICAL_MAXIMUM(1), 0x01, // ...to 1
mjr 3:3514575d4f86 146 REPORT_SIZE(1), 0x01, // 1 bit per report
mjr 3:3514575d4f86 147 REPORT_COUNT(1), 0x10, // 16 reports
mjr 3:3514575d4f86 148 UNIT_EXPONENT(1), 0x00, // Unit_Exponent (0)
mjr 3:3514575d4f86 149 UNIT(1), 0x00, // Unit (None)
mjr 3:3514575d4f86 150 INPUT(1), 0x02, // Data, Variable, Absolute
mjr 3:3514575d4f86 151
mjr 3:3514575d4f86 152 USAGE_PAGE(1), 0x01, // Generic desktop
mjr 9:fd65b0a94720 153 USAGE(1), 0x30, // X axis
mjr 9:fd65b0a94720 154 USAGE(1), 0x31, // Y axis
mjr 9:fd65b0a94720 155 USAGE(1), 0x32, // Z axis
mjr 6:cc35eb643e8f 156 LOGICAL_MINIMUM(2), 0x00,0xF0, // each value ranges -4096
mjr 6:cc35eb643e8f 157 LOGICAL_MAXIMUM(2), 0x00,0x10, // ...to +4096
mjr 6:cc35eb643e8f 158 REPORT_SIZE(1), 0x10, // 16 bits per report
mjr 9:fd65b0a94720 159 REPORT_COUNT(1), 0x03, // 3 reports (X, Y, Z)
mjr 9:fd65b0a94720 160 INPUT(1), 0x02, // Data, Variable, Absolute
mjr 9:fd65b0a94720 161
mjr 9:fd65b0a94720 162 // output report (host to device)
mjr 9:fd65b0a94720 163 REPORT_SIZE(1), 0x08, // 8 bits per report
mjr 9:fd65b0a94720 164 REPORT_COUNT(1), 0x08, // output report count (LEDWiz messages)
mjr 3:3514575d4f86 165 0x09, 0x01, // usage
mjr 3:3514575d4f86 166 0x91, 0x01, // Output (array)
mjr 3:3514575d4f86 167
mjr 6:cc35eb643e8f 168 // END_COLLECTION(0),
mjr 3:3514575d4f86 169 END_COLLECTION(0)
mjr 3:3514575d4f86 170 };
mjr 3:3514575d4f86 171
mjr 3:3514575d4f86 172 reportLength = sizeof(reportDescriptor);
mjr 3:3514575d4f86 173 return reportDescriptor;
mjr 3:3514575d4f86 174 }
mjr 3:3514575d4f86 175
mjr 3:3514575d4f86 176 uint8_t * USBJoystick::stringImanufacturerDesc() {
mjr 3:3514575d4f86 177 static uint8_t stringImanufacturerDescriptor[] = {
mjr 3:3514575d4f86 178 0x10, /*bLength*/
mjr 3:3514575d4f86 179 STRING_DESCRIPTOR, /*bDescriptorType 0x03*/
mjr 3:3514575d4f86 180 'm',0,'j',0,'r',0,'c',0,'o',0,'r',0,'p',0 /*bString iManufacturer - mjrcorp*/
mjr 3:3514575d4f86 181 };
mjr 3:3514575d4f86 182 return stringImanufacturerDescriptor;
mjr 3:3514575d4f86 183 }
mjr 3:3514575d4f86 184
mjr 3:3514575d4f86 185 uint8_t * USBJoystick::stringIserialDesc() {
mjr 3:3514575d4f86 186 static uint8_t stringIserialDescriptor[] = {
mjr 3:3514575d4f86 187 0x16, /*bLength*/
mjr 3:3514575d4f86 188 STRING_DESCRIPTOR, /*bDescriptorType 0x03*/
mjr 3:3514575d4f86 189 '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 190 };
mjr 3:3514575d4f86 191 return stringIserialDescriptor;
mjr 3:3514575d4f86 192 }
mjr 3:3514575d4f86 193
mjr 3:3514575d4f86 194 uint8_t * USBJoystick::stringIproductDesc() {
mjr 3:3514575d4f86 195 static uint8_t stringIproductDescriptor[] = {
mjr 9:fd65b0a94720 196 0x28, /*bLength*/
mjr 3:3514575d4f86 197 STRING_DESCRIPTOR, /*bDescriptorType 0x03*/
mjr 3:3514575d4f86 198 'P',0,'i',0,'n',0,'s',0,'c',0,'a',0,'p',0,'e',0,
mjr 3:3514575d4f86 199 ' ',0,'C',0,'o',0,'n',0,'t',0,'r',0,'o',0,'l',0,
mjr 3:3514575d4f86 200 'l',0,'e',0,'r',0 /*String iProduct */
mjr 3:3514575d4f86 201 };
mjr 3:3514575d4f86 202 return stringIproductDescriptor;
mjr 3:3514575d4f86 203 }