Embedded Artists / DM_USBHost

Adaptation of the official mbed USBHost repository to work with the LPC4088 Display Module

Dependents:   DMSupport DMSupport DMSupport DMSupport

Fork of DM_USBHost by EmbeddedArtists AB

USBHostHID/USBHostMouse.h@33:819bbf04163b, 2019-11-04 (annotated)

Committer:
embeddedartists
Date:
Mon Nov 04 14:30:07 2019 +0000
Revision:
33:819bbf04163b
Parent:
28:a55c5a98d5e9 
More updates related to mbed OS 5

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
mbed_official 24:868cbfe611a7 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();
embeddedartists 28:a55c5a98d5e9 36 virtual ~USBHostMouse();
mbed_official 0:a554658735bf 37
mbed_official 0:a554658735bf 38 /**
mbed_official 0:a554658735bf 39 * Try to connect a mouse device
mbed_official 0:a554658735bf 40 *
samux 3:0f5c32575eb8 41 * @return true if connection was successful
mbed_official 0:a554658735bf 42 */
mbed_official 0:a554658735bf 43 bool connect();
mbed_official 0:a554658735bf 44
mbed_official 0:a554658735bf 45 /**
mbed_official 0:a554658735bf 46 * Check if a mouse is connected
mbed_official 0:a554658735bf 47 *
mbed_official 0:a554658735bf 48 * @returns true if a mouse is connected
mbed_official 0:a554658735bf 49 */
mbed_official 0:a554658735bf 50 bool connected();
mbed_official 0:a554658735bf 51
mbed_official 0:a554658735bf 52 /**
mbed_official 0:a554658735bf 53 * Attach a callback called when a mouse event is received
mbed_official 0:a554658735bf 54 *
samux 2:5e8fdc541b98 55 * @param ptr function pointer
mbed_official 0:a554658735bf 56 */
samux 5:e48791a1ef18 57 inline void attachEvent(void (*ptr)(uint8_t buttons, int8_t x, int8_t y, int8_t z)) {
mbed_official 0:a554658735bf 58 if (ptr != NULL) {
mbed_official 0:a554658735bf 59 onUpdate = ptr;
mbed_official 0:a554658735bf 60 }
mbed_official 0:a554658735bf 61 }
mbed_official 24:868cbfe611a7 62
samux 5:e48791a1ef18 63 /**
samux 5:e48791a1ef18 64 * Attach a callback called when the button state changes
samux 5:e48791a1ef18 65 *
samux 5:e48791a1ef18 66 * @param ptr function pointer
samux 5:e48791a1ef18 67 */
samux 5:e48791a1ef18 68 inline void attachButtonEvent(void (*ptr)(uint8_t buttons)) {
samux 5:e48791a1ef18 69 if (ptr != NULL) {
samux 5:e48791a1ef18 70 onButtonUpdate = ptr;
samux 5:e48791a1ef18 71 }
samux 5:e48791a1ef18 72 }
mbed_official 24:868cbfe611a7 73
samux 5:e48791a1ef18 74 /**
samux 5:e48791a1ef18 75 * Attach a callback called when the X axis value changes
samux 5:e48791a1ef18 76 *
samux 5:e48791a1ef18 77 * @param ptr function pointer
samux 5:e48791a1ef18 78 */
samux 5:e48791a1ef18 79 inline void attachXEvent(void (*ptr)(int8_t x)) {
samux 5:e48791a1ef18 80 if (ptr != NULL) {
samux 5:e48791a1ef18 81 onXUpdate = ptr;
samux 5:e48791a1ef18 82 }
samux 5:e48791a1ef18 83 }
mbed_official 24:868cbfe611a7 84
samux 5:e48791a1ef18 85 /**
samux 5:e48791a1ef18 86 * Attach a callback called when the Y axis value changes
samux 5:e48791a1ef18 87 *
samux 5:e48791a1ef18 88 * @param ptr function pointer
samux 5:e48791a1ef18 89 */
samux 5:e48791a1ef18 90 inline void attachYEvent(void (*ptr)(int8_t y)) {
samux 5:e48791a1ef18 91 if (ptr != NULL) {
samux 5:e48791a1ef18 92 onYUpdate = ptr;
samux 5:e48791a1ef18 93 }
samux 5:e48791a1ef18 94 }
mbed_official 24:868cbfe611a7 95
samux 5:e48791a1ef18 96 /**
samux 5:e48791a1ef18 97 * Attach a callback called when the Z axis value changes (scrolling)
samux 5:e48791a1ef18 98 *
samux 5:e48791a1ef18 99 * @param ptr function pointer
samux 5:e48791a1ef18 100 */
samux 5:e48791a1ef18 101 inline void attachZEvent(void (*ptr)(int8_t z)) {
samux 5:e48791a1ef18 102 if (ptr != NULL) {
samux 5:e48791a1ef18 103 onZUpdate = ptr;
samux 5:e48791a1ef18 104 }
samux 5:e48791a1ef18 105 }
mbed_official 0:a554658735bf 106
mbed_official 0:a554658735bf 107 protected:
mbed_official 0:a554658735bf 108 //From IUSBEnumerator
mbed_official 0:a554658735bf 109 virtual void setVidPid(uint16_t vid, uint16_t pid);
mbed_official 0:a554658735bf 110 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 111 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 112
mbed_official 0:a554658735bf 113 private:
mbed_official 0:a554658735bf 114 USBHost * host;
mbed_official 0:a554658735bf 115 USBDeviceConnected * dev;
mbed_official 0:a554658735bf 116 USBEndpoint * int_in;
embeddedartists 28:a55c5a98d5e9 117 uint8_t* report;
mbed_official 24:868cbfe611a7 118
mbed_official 0:a554658735bf 119 bool dev_connected;
mbed_official 0:a554658735bf 120 bool mouse_device_found;
mbed_official 0:a554658735bf 121 int mouse_intf;
mbed_official 0:a554658735bf 122
samux 5:e48791a1ef18 123 uint8_t buttons;
samux 5:e48791a1ef18 124 int8_t x;
samux 5:e48791a1ef18 125 int8_t y;
samux 5:e48791a1ef18 126 int8_t z;
samux 5:e48791a1ef18 127
mbed_official 0:a554658735bf 128 void rxHandler();
mbed_official 0:a554658735bf 129 void (*onUpdate)(uint8_t buttons, int8_t x, int8_t y, int8_t z);
samux 5:e48791a1ef18 130 void (*onButtonUpdate)(uint8_t buttons);
samux 5:e48791a1ef18 131 void (*onXUpdate)(int8_t x);
samux 5:e48791a1ef18 132 void (*onYUpdate)(int8_t y);
samux 5:e48791a1ef18 133 void (*onZUpdate)(int8_t z);
mbed_official 0:a554658735bf 134 int report_id;
mbed_official 0:a554658735bf 135 void init();
mbed_official 0:a554658735bf 136 };
mbed_official 0:a554658735bf 137
mbed_official 0:a554658735bf 138 #endif
mbed_official 0:a554658735bf 139
mbed_official 0:a554658735bf 140 #endif