Kentaro Sekimoto / USBHost

To support GR-PEACH

Fork of USBHost by mbed official

USBHostHID/USBHostMouse.h@8:93da8ea2708b, 2013-03-14 (annotated)

Committer:
samux
Date:
Thu Mar 14 11:49:53 2013 +0000
Revision:
8:93da8ea2708b
Parent:
5:e48791a1ef18
Child:
24:868cbfe611a7
update doc + license

Who changed what in which revision?

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