z ysaito / USBHost2

2018.07.26

Dependencies:   FATFileSystem2 mbed-rtos

Fork of USBHost by mbed official

USBHostHID/USBHostMouse.h@44:e437b1c7c61e, 2018-07-26 (annotated)

Committer:
sayzyas
Date:
Thu Jul 26 00:29:30 2018 +0000
Revision:
44:e437b1c7c61e
Parent:
43:78f328f311dc 
2018.07.26

Who changed what in which revision?

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