Suga koubou / Mbed 2 deprecated XTouch-djay-bridge

X-TOUCH to djay bridge

Dependencies:   mbed mbed-rtos FATFileSystem

USBHost/USBHost/USBDeviceConnected.h@1:0dac72ab5910, 2019-06-05 (annotated)

Committer:
okini3939
Date:
Wed Jun 05 04:54:37 2019 +0000
Revision:
1:0dac72ab5910
sample

Who changed what in which revision?

UserRevisionLine numberNew contents of line
okini3939 1:0dac72ab5910 1 /* mbed USBHost Library
okini3939 1:0dac72ab5910 2 * Copyright (c) 2006-2013 ARM Limited
okini3939 1:0dac72ab5910 3 *
okini3939 1:0dac72ab5910 4 * Licensed under the Apache License, Version 2.0 (the "License");
okini3939 1:0dac72ab5910 5 * you may not use this file except in compliance with the License.
okini3939 1:0dac72ab5910 6 * You may obtain a copy of the License at
okini3939 1:0dac72ab5910 7 *
okini3939 1:0dac72ab5910 8 * http://www.apache.org/licenses/LICENSE-2.0
okini3939 1:0dac72ab5910 9 *
okini3939 1:0dac72ab5910 10 * Unless required by applicable law or agreed to in writing, software
okini3939 1:0dac72ab5910 11 * distributed under the License is distributed on an "AS IS" BASIS,
okini3939 1:0dac72ab5910 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
okini3939 1:0dac72ab5910 13 * See the License for the specific language governing permissions and
okini3939 1:0dac72ab5910 14 * limitations under the License.
okini3939 1:0dac72ab5910 15 */
okini3939 1:0dac72ab5910 16
okini3939 1:0dac72ab5910 17 #ifndef USBDEVICECONNECTED_H
okini3939 1:0dac72ab5910 18 #define USBDEVICECONNECTED_H
okini3939 1:0dac72ab5910 19
okini3939 1:0dac72ab5910 20 #include "stdint.h"
okini3939 1:0dac72ab5910 21 #include "USBEndpoint.h"
okini3939 1:0dac72ab5910 22 #include "USBHostConf.h"
okini3939 1:0dac72ab5910 23 #include "rtos.h"
okini3939 1:0dac72ab5910 24 #include "Callback.h"
okini3939 1:0dac72ab5910 25
okini3939 1:0dac72ab5910 26 class USBHostHub;
okini3939 1:0dac72ab5910 27
okini3939 1:0dac72ab5910 28 typedef struct {
okini3939 1:0dac72ab5910 29 bool in_use;
okini3939 1:0dac72ab5910 30 uint8_t nb_endpoint;
okini3939 1:0dac72ab5910 31 uint8_t intf_class;
okini3939 1:0dac72ab5910 32 uint8_t intf_subclass;
okini3939 1:0dac72ab5910 33 uint8_t intf_protocol;
okini3939 1:0dac72ab5910 34 USBEndpoint * ep[MAX_ENDPOINT_PER_INTERFACE];
okini3939 1:0dac72ab5910 35 Callback<void()> detach;
okini3939 1:0dac72ab5910 36 char name[10];
okini3939 1:0dac72ab5910 37 } INTERFACE;
okini3939 1:0dac72ab5910 38
okini3939 1:0dac72ab5910 39 /**
okini3939 1:0dac72ab5910 40 * USBDeviceConnected class
okini3939 1:0dac72ab5910 41 */
okini3939 1:0dac72ab5910 42 class USBDeviceConnected
okini3939 1:0dac72ab5910 43 {
okini3939 1:0dac72ab5910 44 public:
okini3939 1:0dac72ab5910 45
okini3939 1:0dac72ab5910 46 /**
okini3939 1:0dac72ab5910 47 * Constructor
okini3939 1:0dac72ab5910 48 */
okini3939 1:0dac72ab5910 49 USBDeviceConnected();
okini3939 1:0dac72ab5910 50
okini3939 1:0dac72ab5910 51 /**
okini3939 1:0dac72ab5910 52 * Attach an USBEndpoint to this device
okini3939 1:0dac72ab5910 53 *
okini3939 1:0dac72ab5910 54 * @param intf_nb interface number
okini3939 1:0dac72ab5910 55 * @param ep pointeur on the USBEndpoint which will be attached
okini3939 1:0dac72ab5910 56 * @returns true if successful, false otherwise
okini3939 1:0dac72ab5910 57 */
okini3939 1:0dac72ab5910 58 bool addEndpoint(uint8_t intf_nb, USBEndpoint * ep);
okini3939 1:0dac72ab5910 59
okini3939 1:0dac72ab5910 60 /**
okini3939 1:0dac72ab5910 61 * Retrieve an USBEndpoint by its TYPE and DIRECTION
okini3939 1:0dac72ab5910 62 *
okini3939 1:0dac72ab5910 63 * @param intf_nb the interface on which to lookup the USBEndpoint
okini3939 1:0dac72ab5910 64 * @param type type of the USBEndpoint looked for
okini3939 1:0dac72ab5910 65 * @param dir direction of the USBEndpoint looked for
okini3939 1:0dac72ab5910 66 * @param index the index of the USBEndpoint whitin the interface
okini3939 1:0dac72ab5910 67 * @returns pointer on the USBEndpoint if found, NULL otherwise
okini3939 1:0dac72ab5910 68 */
okini3939 1:0dac72ab5910 69 USBEndpoint * getEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir, uint8_t index = 0);
okini3939 1:0dac72ab5910 70
okini3939 1:0dac72ab5910 71 /**
okini3939 1:0dac72ab5910 72 * Retrieve an USBEndpoint by its index
okini3939 1:0dac72ab5910 73 *
okini3939 1:0dac72ab5910 74 * @param intf_nb interface number
okini3939 1:0dac72ab5910 75 * @param index index of the USBEndpoint
okini3939 1:0dac72ab5910 76 * @returns pointer on the USBEndpoint if found, NULL otherwise
okini3939 1:0dac72ab5910 77 */
okini3939 1:0dac72ab5910 78 USBEndpoint * getEndpoint(uint8_t intf_nb, uint8_t index);
okini3939 1:0dac72ab5910 79
okini3939 1:0dac72ab5910 80 /**
okini3939 1:0dac72ab5910 81 * Add a new interface to this device
okini3939 1:0dac72ab5910 82 *
okini3939 1:0dac72ab5910 83 * @param intf_nb interface number
okini3939 1:0dac72ab5910 84 * @param intf_class interface class
okini3939 1:0dac72ab5910 85 * @param intf_subclass interface subclass
okini3939 1:0dac72ab5910 86 * @param intf_protocol interface protocol
okini3939 1:0dac72ab5910 87 * @returns true if successful, false otherwise
okini3939 1:0dac72ab5910 88 */
okini3939 1:0dac72ab5910 89 bool addInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol);
okini3939 1:0dac72ab5910 90
okini3939 1:0dac72ab5910 91 /**
okini3939 1:0dac72ab5910 92 * Get a specific interface
okini3939 1:0dac72ab5910 93 *
okini3939 1:0dac72ab5910 94 * @param index index of the interface to be fetched
okini3939 1:0dac72ab5910 95 * @returns interface
okini3939 1:0dac72ab5910 96 */
okini3939 1:0dac72ab5910 97 INTERFACE * getInterface(uint8_t index);
okini3939 1:0dac72ab5910 98
okini3939 1:0dac72ab5910 99 /**
okini3939 1:0dac72ab5910 100 * Attach a member function to call when a the device has been disconnected
okini3939 1:0dac72ab5910 101 *
okini3939 1:0dac72ab5910 102 * @param intf_nb interface number
okini3939 1:0dac72ab5910 103 * @param tptr pointer to the object to call the member function on
okini3939 1:0dac72ab5910 104 * @param mptr pointer to the member function to be called
okini3939 1:0dac72ab5910 105 */
okini3939 1:0dac72ab5910 106 template<typename T>
okini3939 1:0dac72ab5910 107 inline void onDisconnect(uint8_t intf_nb, T* tptr, void (T::*mptr)(void)) {
okini3939 1:0dac72ab5910 108 if ((mptr != NULL) && (tptr != NULL)) {
okini3939 1:0dac72ab5910 109 intf[intf_nb].detach.attach(tptr, mptr);
okini3939 1:0dac72ab5910 110 }
okini3939 1:0dac72ab5910 111 }
okini3939 1:0dac72ab5910 112
okini3939 1:0dac72ab5910 113 /**
okini3939 1:0dac72ab5910 114 * Attach a callback called when the device has been disconnected
okini3939 1:0dac72ab5910 115 *
okini3939 1:0dac72ab5910 116 * @param intf_nb interface number
okini3939 1:0dac72ab5910 117 * @param fn function pointer
okini3939 1:0dac72ab5910 118 */
okini3939 1:0dac72ab5910 119 inline void onDisconnect(uint8_t intf_nb, void (*fn)(void)) {
okini3939 1:0dac72ab5910 120 if (fn != NULL) {
okini3939 1:0dac72ab5910 121 intf[intf_nb].detach.attach(fn);
okini3939 1:0dac72ab5910 122 }
okini3939 1:0dac72ab5910 123 }
okini3939 1:0dac72ab5910 124
okini3939 1:0dac72ab5910 125 /**
okini3939 1:0dac72ab5910 126 * Disconnect the device by calling a callback function registered by a driver
okini3939 1:0dac72ab5910 127 */
okini3939 1:0dac72ab5910 128 void disconnect();
okini3939 1:0dac72ab5910 129
okini3939 1:0dac72ab5910 130 // setters
okini3939 1:0dac72ab5910 131 void init(uint8_t hub, uint8_t port, bool lowSpeed);
okini3939 1:0dac72ab5910 132 inline void setAddress(uint8_t addr_) { addr = addr_; };
okini3939 1:0dac72ab5910 133 inline void setVid(uint16_t vid_) { vid = vid_; };
okini3939 1:0dac72ab5910 134 inline void setPid(uint16_t pid_) { pid = pid_; };
okini3939 1:0dac72ab5910 135 inline void setClass(uint8_t device_class_) { device_class = device_class_; };
okini3939 1:0dac72ab5910 136 inline void setSubClass(uint8_t device_subclass_) { device_subclass = device_subclass_; };
okini3939 1:0dac72ab5910 137 inline void setProtocol(uint8_t pr) { proto = pr; };
okini3939 1:0dac72ab5910 138 inline void setSizeControlEndpoint(uint32_t size) { sizeControlEndpoint = size; };
okini3939 1:0dac72ab5910 139 inline void activeAddress(bool active) { activeAddr = active; };
okini3939 1:0dac72ab5910 140 inline void setEnumerated() { enumerated = true; };
okini3939 1:0dac72ab5910 141 inline void setNbIntf(uint8_t nb_intf) {nb_interf = nb_intf; };
okini3939 1:0dac72ab5910 142 inline void setHubParent(USBHostHub * hub) { hub_parent = hub; };
okini3939 1:0dac72ab5910 143 inline void setName(const char * name_, uint8_t intf_nb) { strcpy(intf[intf_nb].name, name_); };
okini3939 1:0dac72ab5910 144
okini3939 1:0dac72ab5910 145 //getters
okini3939 1:0dac72ab5910 146 inline uint8_t getPort() { return port; };
okini3939 1:0dac72ab5910 147 inline uint8_t getHub() { return hub_nb; };
okini3939 1:0dac72ab5910 148 inline uint8_t getAddress() { return addr; };
okini3939 1:0dac72ab5910 149 inline uint16_t getVid() { return vid; };
okini3939 1:0dac72ab5910 150 inline uint16_t getPid() { return pid; };
okini3939 1:0dac72ab5910 151 inline uint8_t getClass() { return device_class; };
okini3939 1:0dac72ab5910 152 inline uint8_t getSubClass() { return device_subclass; };
okini3939 1:0dac72ab5910 153 inline uint8_t getProtocol() { return proto; };
okini3939 1:0dac72ab5910 154 inline bool getSpeed() { return speed; };
okini3939 1:0dac72ab5910 155 inline uint32_t getSizeControlEndpoint() { return sizeControlEndpoint; };
okini3939 1:0dac72ab5910 156 inline bool isActiveAddress() { return activeAddr; };
okini3939 1:0dac72ab5910 157 inline bool isEnumerated() { return enumerated; };
okini3939 1:0dac72ab5910 158 inline USBHostHub * getHubParent() { return hub_parent; };
okini3939 1:0dac72ab5910 159 inline uint8_t getNbIntf() { return nb_interf; };
okini3939 1:0dac72ab5910 160 inline const char * getName(uint8_t intf_nb) { return intf[intf_nb].name; };
okini3939 1:0dac72ab5910 161
okini3939 1:0dac72ab5910 162 // in case this device is a hub
okini3939 1:0dac72ab5910 163 USBHostHub * hub;
okini3939 1:0dac72ab5910 164
okini3939 1:0dac72ab5910 165 private:
okini3939 1:0dac72ab5910 166 USBHostHub * hub_parent;
okini3939 1:0dac72ab5910 167
okini3939 1:0dac72ab5910 168 INTERFACE intf[MAX_INTF];
okini3939 1:0dac72ab5910 169 uint32_t sizeControlEndpoint;
okini3939 1:0dac72ab5910 170 uint8_t hub_nb;
okini3939 1:0dac72ab5910 171 uint8_t port;
okini3939 1:0dac72ab5910 172 uint16_t vid;
okini3939 1:0dac72ab5910 173 uint16_t pid;
okini3939 1:0dac72ab5910 174 uint8_t addr;
okini3939 1:0dac72ab5910 175 uint8_t device_class;
okini3939 1:0dac72ab5910 176 uint8_t device_subclass;
okini3939 1:0dac72ab5910 177 uint8_t proto;
okini3939 1:0dac72ab5910 178 bool speed;
okini3939 1:0dac72ab5910 179 volatile bool activeAddr;
okini3939 1:0dac72ab5910 180 volatile bool enumerated;
okini3939 1:0dac72ab5910 181 uint8_t nb_interf;
okini3939 1:0dac72ab5910 182
okini3939 1:0dac72ab5910 183 void init();
okini3939 1:0dac72ab5910 184 };
okini3939 1:0dac72ab5910 185
okini3939 1:0dac72ab5910 186 #endif