GambitDev / F401RE-USBHost

USB Host Driver with Socket Modem support. Works with revision 323 of mbed-src but broken with any later version.

Dependencies:   FATFileSystem

Fork of F401RE-USBHost by Norimasa Okamoto

USBHostHID/USBHostMouse.h@9:7f9f64cf5ded, 2014-02-03 (annotated)

Committer:
va009039
Date:
Mon Feb 03 13:00:16 2014 +0000
Revision:
9:7f9f64cf5ded
Parent:
8:6463cd1964c0 
add interrupt write transfer.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
va009039 9:7f9f64cf5ded 1 /* mbed USBHost Library
va009039 9:7f9f64cf5ded 2 * Copyright (c) 2006-2013 ARM Limited
va009039 9:7f9f64cf5ded 3 *
va009039 9:7f9f64cf5ded 4 * Licensed under the Apache License, Version 2.0 (the "License");
va009039 9:7f9f64cf5ded 5 * you may not use this file except in compliance with the License.
va009039 9:7f9f64cf5ded 6 * You may obtain a copy of the License at
va009039 9:7f9f64cf5ded 7 *
va009039 9:7f9f64cf5ded 8 * http://www.apache.org/licenses/LICENSE-2.0
va009039 9:7f9f64cf5ded 9 *
va009039 9:7f9f64cf5ded 10 * Unless required by applicable law or agreed to in writing, software
va009039 9:7f9f64cf5ded 11 * distributed under the License is distributed on an "AS IS" BASIS,
va009039 9:7f9f64cf5ded 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
va009039 9:7f9f64cf5ded 13 * See the License for the specific language governing permissions and
va009039 9:7f9f64cf5ded 14 * limitations under the License.
va009039 9:7f9f64cf5ded 15 */
va009039 9:7f9f64cf5ded 16
va009039 9:7f9f64cf5ded 17 #ifndef USBHOSTMOUSE_H
va009039 9:7f9f64cf5ded 18 #define USBHOSTMOUSE_H
va009039 9:7f9f64cf5ded 19
va009039 9:7f9f64cf5ded 20 #include "USBHostConf.h"
va009039 9:7f9f64cf5ded 21
va009039 9:7f9f64cf5ded 22 #if USBHOST_MOUSE
va009039 9:7f9f64cf5ded 23
va009039 9:7f9f64cf5ded 24 #include "USBHost.h"
va009039 9:7f9f64cf5ded 25
va009039 9:7f9f64cf5ded 26 /**
va009039 9:7f9f64cf5ded 27 * A class to communicate a USB mouse
va009039 9:7f9f64cf5ded 28 */
va009039 9:7f9f64cf5ded 29 class USBHostMouse : public IUSBEnumerator {
va009039 9:7f9f64cf5ded 30 public:
va009039 9:7f9f64cf5ded 31
va009039 9:7f9f64cf5ded 32 /**
va009039 9:7f9f64cf5ded 33 * Constructor
va009039 9:7f9f64cf5ded 34 */
va009039 9:7f9f64cf5ded 35 USBHostMouse();
va009039 9:7f9f64cf5ded 36
va009039 9:7f9f64cf5ded 37 /**
va009039 9:7f9f64cf5ded 38 * Try to connect a mouse device
va009039 9:7f9f64cf5ded 39 *
va009039 9:7f9f64cf5ded 40 * @return true if connection was successful
va009039 9:7f9f64cf5ded 41 */
va009039 9:7f9f64cf5ded 42 bool connect();
va009039 9:7f9f64cf5ded 43
va009039 9:7f9f64cf5ded 44 /**
va009039 9:7f9f64cf5ded 45 * Check if a mouse is connected
va009039 9:7f9f64cf5ded 46 *
va009039 9:7f9f64cf5ded 47 * @returns true if a mouse is connected
va009039 9:7f9f64cf5ded 48 */
va009039 9:7f9f64cf5ded 49 bool connected();
va009039 9:7f9f64cf5ded 50
va009039 9:7f9f64cf5ded 51 /**
va009039 9:7f9f64cf5ded 52 * Attach a callback called when a mouse event is received
va009039 9:7f9f64cf5ded 53 *
va009039 9:7f9f64cf5ded 54 * @param ptr function pointer
va009039 9:7f9f64cf5ded 55 */
va009039 9:7f9f64cf5ded 56 inline void attachEvent(void (*ptr)(uint8_t buttons, int8_t x, int8_t y, int8_t z)) {
va009039 9:7f9f64cf5ded 57 if (ptr != NULL) {
va009039 9:7f9f64cf5ded 58 onUpdate = ptr;
va009039 9:7f9f64cf5ded 59 }
va009039 9:7f9f64cf5ded 60 }
va009039 9:7f9f64cf5ded 61
va009039 9:7f9f64cf5ded 62 /**
va009039 9:7f9f64cf5ded 63 * Attach a callback called when the button state changes
va009039 9:7f9f64cf5ded 64 *
va009039 9:7f9f64cf5ded 65 * @param ptr function pointer
va009039 9:7f9f64cf5ded 66 */
va009039 9:7f9f64cf5ded 67 inline void attachButtonEvent(void (*ptr)(uint8_t buttons)) {
va009039 9:7f9f64cf5ded 68 if (ptr != NULL) {
va009039 9:7f9f64cf5ded 69 onButtonUpdate = ptr;
va009039 9:7f9f64cf5ded 70 }
va009039 9:7f9f64cf5ded 71 }
va009039 9:7f9f64cf5ded 72
va009039 9:7f9f64cf5ded 73 /**
va009039 9:7f9f64cf5ded 74 * Attach a callback called when the X axis value changes
va009039 9:7f9f64cf5ded 75 *
va009039 9:7f9f64cf5ded 76 * @param ptr function pointer
va009039 9:7f9f64cf5ded 77 */
va009039 9:7f9f64cf5ded 78 inline void attachXEvent(void (*ptr)(int8_t x)) {
va009039 9:7f9f64cf5ded 79 if (ptr != NULL) {
va009039 9:7f9f64cf5ded 80 onXUpdate = ptr;
va009039 9:7f9f64cf5ded 81 }
va009039 9:7f9f64cf5ded 82 }
va009039 9:7f9f64cf5ded 83
va009039 9:7f9f64cf5ded 84 /**
va009039 9:7f9f64cf5ded 85 * Attach a callback called when the Y axis value changes
va009039 9:7f9f64cf5ded 86 *
va009039 9:7f9f64cf5ded 87 * @param ptr function pointer
va009039 9:7f9f64cf5ded 88 */
va009039 9:7f9f64cf5ded 89 inline void attachYEvent(void (*ptr)(int8_t y)) {
va009039 9:7f9f64cf5ded 90 if (ptr != NULL) {
va009039 9:7f9f64cf5ded 91 onYUpdate = ptr;
va009039 9:7f9f64cf5ded 92 }
va009039 9:7f9f64cf5ded 93 }
va009039 9:7f9f64cf5ded 94
va009039 9:7f9f64cf5ded 95 /**
va009039 9:7f9f64cf5ded 96 * Attach a callback called when the Z axis value changes (scrolling)
va009039 9:7f9f64cf5ded 97 *
va009039 9:7f9f64cf5ded 98 * @param ptr function pointer
va009039 9:7f9f64cf5ded 99 */
va009039 9:7f9f64cf5ded 100 inline void attachZEvent(void (*ptr)(int8_t z)) {
va009039 9:7f9f64cf5ded 101 if (ptr != NULL) {
va009039 9:7f9f64cf5ded 102 onZUpdate = ptr;
va009039 9:7f9f64cf5ded 103 }
va009039 9:7f9f64cf5ded 104 }
va009039 9:7f9f64cf5ded 105
va009039 9:7f9f64cf5ded 106 protected:
va009039 9:7f9f64cf5ded 107 //From IUSBEnumerator
va009039 9:7f9f64cf5ded 108 virtual void setVidPid(uint16_t vid, uint16_t pid);
va009039 9:7f9f64cf5ded 109 virtual bool parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol); //Must return true if the interface should be parsed
va009039 9:7f9f64cf5ded 110 virtual bool useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir); //Must return true if the endpoint will be used
va009039 9:7f9f64cf5ded 111
va009039 9:7f9f64cf5ded 112 private:
va009039 9:7f9f64cf5ded 113 USBHost * host;
va009039 9:7f9f64cf5ded 114 USBDeviceConnected * dev;
va009039 9:7f9f64cf5ded 115 USBEndpoint * int_in;
va009039 9:7f9f64cf5ded 116 uint8_t report[4];
va009039 9:7f9f64cf5ded 117
va009039 9:7f9f64cf5ded 118 bool dev_connected;
va009039 9:7f9f64cf5ded 119 bool mouse_device_found;
va009039 9:7f9f64cf5ded 120 int mouse_intf;
va009039 9:7f9f64cf5ded 121
va009039 9:7f9f64cf5ded 122 uint8_t buttons;
va009039 9:7f9f64cf5ded 123 int8_t x;
va009039 9:7f9f64cf5ded 124 int8_t y;
va009039 9:7f9f64cf5ded 125 int8_t z;
va009039 9:7f9f64cf5ded 126
va009039 9:7f9f64cf5ded 127 void rxHandler();
va009039 9:7f9f64cf5ded 128 void (*onUpdate)(uint8_t buttons, int8_t x, int8_t y, int8_t z);
va009039 9:7f9f64cf5ded 129 void (*onButtonUpdate)(uint8_t buttons);
va009039 9:7f9f64cf5ded 130 void (*onXUpdate)(int8_t x);
va009039 9:7f9f64cf5ded 131 void (*onYUpdate)(int8_t y);
va009039 9:7f9f64cf5ded 132 void (*onZUpdate)(int8_t z);
va009039 9:7f9f64cf5ded 133 int report_id;
va009039 9:7f9f64cf5ded 134 void init();
va009039 9:7f9f64cf5ded 135 };
va009039 9:7f9f64cf5ded 136
va009039 9:7f9f64cf5ded 137 #endif
va009039 9:7f9f64cf5ded 138
va009039 9:7f9f64cf5ded 139 #endif