mbed official / USBHostWANDongleSprint

USB Host Library for Sprint Dongles

Fork of USBHostWANDongleSprint_bleedingedge by Donatien Garnier

Legacy Warning

This is an mbed 2 libary. To learn more about mbed OS 5, visit the docs.

USBHost/USBDeviceConnected.h@9:2a7b7333245f, 2012-12-10 (annotated)

Committer:
donatien
Date:
Mon Dec 10 18:18:35 2012 +0000
Revision:
9:2a7b7333245f
Parent:
3:9ec92dd8a8cb 
Merge

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:bfed5767d0a5 1 /* Copyright (c) 2010-2012 mbed.org, MIT License
donatien 0:bfed5767d0a5 2 *
donatien 0:bfed5767d0a5 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 0:bfed5767d0a5 4 * and associated documentation files (the "Software"), to deal in the Software without
donatien 0:bfed5767d0a5 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
donatien 0:bfed5767d0a5 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
donatien 0:bfed5767d0a5 7 * Software is furnished to do so, subject to the following conditions:
donatien 0:bfed5767d0a5 8 *
donatien 0:bfed5767d0a5 9 * The above copyright notice and this permission notice shall be included in all copies or
donatien 0:bfed5767d0a5 10 * substantial portions of the Software.
donatien 0:bfed5767d0a5 11 *
donatien 0:bfed5767d0a5 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 0:bfed5767d0a5 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 0:bfed5767d0a5 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 0:bfed5767d0a5 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:bfed5767d0a5 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 0:bfed5767d0a5 17 */
donatien 0:bfed5767d0a5 18
donatien 0:bfed5767d0a5 19 #ifndef USBDEVICECONNECTED_H
donatien 0:bfed5767d0a5 20 #define USBDEVICECONNECTED_H
donatien 0:bfed5767d0a5 21
donatien 0:bfed5767d0a5 22 #include "stdint.h"
donatien 0:bfed5767d0a5 23 #include "USBEndpoint.h"
donatien 0:bfed5767d0a5 24
donatien 3:9ec92dd8a8cb 25 #define MAX_ENDPOINT_PER_INTERFACE 4
donatien 3:9ec92dd8a8cb 26 #define MAX_INTF 1
donatien 0:bfed5767d0a5 27
donatien 0:bfed5767d0a5 28 typedef struct {
donatien 0:bfed5767d0a5 29 bool in_use;
donatien 0:bfed5767d0a5 30 uint8_t nb_endpoint;
donatien 0:bfed5767d0a5 31 uint8_t intf_class;
donatien 0:bfed5767d0a5 32 uint8_t intf_subclass;
donatien 0:bfed5767d0a5 33 uint8_t intf_protocol;
donatien 0:bfed5767d0a5 34 USBEndpoint * ep[MAX_ENDPOINT_PER_INTERFACE];
donatien 0:bfed5767d0a5 35 FunctionPointer detach;
donatien 0:bfed5767d0a5 36 }INTERFACE;
donatien 0:bfed5767d0a5 37
donatien 0:bfed5767d0a5 38
donatien 0:bfed5767d0a5 39 class USBDeviceConnected {
donatien 0:bfed5767d0a5 40 public:
donatien 0:bfed5767d0a5 41
donatien 0:bfed5767d0a5 42 /*
donatien 0:bfed5767d0a5 43 * Constructor
donatien 0:bfed5767d0a5 44 */
donatien 0:bfed5767d0a5 45 USBDeviceConnected();
donatien 0:bfed5767d0a5 46
donatien 0:bfed5767d0a5 47 /*
donatien 0:bfed5767d0a5 48 * Attach an USBEndpoint to this device
donatien 0:bfed5767d0a5 49 *
donatien 0:bfed5767d0a5 50 * @param ep pointeur on the USBEndpoint which will be attached
donatien 0:bfed5767d0a5 51 * @returns true if successful, false otherwise
donatien 0:bfed5767d0a5 52 */
donatien 0:bfed5767d0a5 53 bool addEndpoint(uint8_t intf_nb, USBEndpoint * ep);
donatien 0:bfed5767d0a5 54
donatien 0:bfed5767d0a5 55 /*
donatien 0:bfed5767d0a5 56 * Retrieve an USBEndpoint by its TYPE and DIRECTION
donatien 0:bfed5767d0a5 57 *
donatien 0:bfed5767d0a5 58 * @param intf_nb the interface on which to lookup the USBEndpoint
donatien 0:bfed5767d0a5 59 * @param type type of the USBEndpoint looked for
donatien 0:bfed5767d0a5 60 * @param direction of the USBEndpoint looked for
donatien 0:bfed5767d0a5 61 * @param index the index of the USBEndpoint whitin the interface
donatien 0:bfed5767d0a5 62 * @returns pointer on the USBEndpoint if found, NULL otherwise
donatien 0:bfed5767d0a5 63 */
donatien 0:bfed5767d0a5 64 USBEndpoint * getEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir, uint8_t index = 0);
donatien 0:bfed5767d0a5 65
donatien 0:bfed5767d0a5 66 /*
donatien 0:bfed5767d0a5 67 * Retrieve an USBEndpoint by its index
donatien 0:bfed5767d0a5 68 *
donatien 0:bfed5767d0a5 69 * @param index index of the USBEndpoint
donatien 0:bfed5767d0a5 70 * @returns pointer on the USBEndpoint if found, NULL otherwise
donatien 0:bfed5767d0a5 71 */
donatien 0:bfed5767d0a5 72 USBEndpoint * getEndpoint(uint8_t intf_nb, uint8_t index);
donatien 0:bfed5767d0a5 73
donatien 0:bfed5767d0a5 74 bool addInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol);
donatien 0:bfed5767d0a5 75
donatien 0:bfed5767d0a5 76 uint8_t getNbInterface() {return nb_interf;};
donatien 0:bfed5767d0a5 77
donatien 0:bfed5767d0a5 78 INTERFACE * getInterface(uint8_t index);
donatien 0:bfed5767d0a5 79
donatien 0:bfed5767d0a5 80 /**
donatien 0:bfed5767d0a5 81 * Attach a member function to call when a the device has been disconnected
donatien 0:bfed5767d0a5 82 *
donatien 0:bfed5767d0a5 83 * @param tptr pointer to the object to call the member function on
donatien 0:bfed5767d0a5 84 * @param mptr pointer to the member function to be called
donatien 0:bfed5767d0a5 85 */
donatien 0:bfed5767d0a5 86 template<typename T>
donatien 0:bfed5767d0a5 87 void onDisconnect(uint8_t intf_nb, T* tptr, void (T::*mptr)(void)) {
donatien 0:bfed5767d0a5 88 if ((mptr != NULL) && (tptr != NULL)) {
donatien 0:bfed5767d0a5 89 intf[intf_nb].detach.attach(tptr, mptr);
donatien 0:bfed5767d0a5 90 }
donatien 0:bfed5767d0a5 91 }
donatien 0:bfed5767d0a5 92
donatien 0:bfed5767d0a5 93 /**
donatien 0:bfed5767d0a5 94 * Attach a callback called when the device has been disconnected
donatien 0:bfed5767d0a5 95 *
donatien 0:bfed5767d0a5 96 * @param fptr function pointer
donatien 0:bfed5767d0a5 97 */
donatien 0:bfed5767d0a5 98 void onDisconnect(uint8_t intf_nb, void (*fn)(void)) {
donatien 0:bfed5767d0a5 99 if (fn != NULL) {
donatien 0:bfed5767d0a5 100 intf[intf_nb].detach.attach(fn);
donatien 0:bfed5767d0a5 101 }
donatien 0:bfed5767d0a5 102 }
donatien 0:bfed5767d0a5 103
donatien 0:bfed5767d0a5 104 /*
donatien 0:bfed5767d0a5 105 * Disconnect the device by calling a callback function registered by a driver
donatien 0:bfed5767d0a5 106 */
donatien 0:bfed5767d0a5 107 void disconnect();
donatien 0:bfed5767d0a5 108
donatien 0:bfed5767d0a5 109 /*
donatien 0:bfed5767d0a5 110 * Setters
donatien 0:bfed5767d0a5 111 */
donatien 0:bfed5767d0a5 112 void init(uint8_t hub, uint8_t port, bool lowSpeed);
donatien 0:bfed5767d0a5 113 void setAddress(uint8_t addr) {
donatien 0:bfed5767d0a5 114 this->addr = addr;
donatien 0:bfed5767d0a5 115 };
donatien 0:bfed5767d0a5 116 void setVid(uint16_t vid) {
donatien 0:bfed5767d0a5 117 this->vid = vid;
donatien 0:bfed5767d0a5 118 };
donatien 0:bfed5767d0a5 119 void setPid(uint16_t pid) {
donatien 0:bfed5767d0a5 120 this->pid = pid;
donatien 0:bfed5767d0a5 121 };
donatien 0:bfed5767d0a5 122 void setClass(uint8_t device_class) {
donatien 0:bfed5767d0a5 123 this->device_class = device_class;
donatien 0:bfed5767d0a5 124 };
donatien 0:bfed5767d0a5 125 void setSubClass(uint8_t device_subclass) {
donatien 0:bfed5767d0a5 126 this->device_subclass = device_subclass;
donatien 0:bfed5767d0a5 127 };
donatien 0:bfed5767d0a5 128 void setProtocol(uint8_t pr) {
donatien 0:bfed5767d0a5 129 proto = pr;
donatien 0:bfed5767d0a5 130 };
donatien 0:bfed5767d0a5 131 void setSizeControlEndpoint(uint32_t size) {
donatien 0:bfed5767d0a5 132 sizeControlEndpoint = size;
donatien 0:bfed5767d0a5 133 };
donatien 0:bfed5767d0a5 134 void activeAddress() {
donatien 0:bfed5767d0a5 135 activeAddr = true;
donatien 0:bfed5767d0a5 136 };
donatien 0:bfed5767d0a5 137 void setEnumerated() {
donatien 0:bfed5767d0a5 138 enumerated = true;
donatien 0:bfed5767d0a5 139 };
donatien 0:bfed5767d0a5 140
donatien 0:bfed5767d0a5 141 /*
donatien 0:bfed5767d0a5 142 * Getters
donatien 0:bfed5767d0a5 143 */
donatien 0:bfed5767d0a5 144 uint8_t getPort() {
donatien 0:bfed5767d0a5 145 return port;
donatien 0:bfed5767d0a5 146 };
donatien 0:bfed5767d0a5 147 uint8_t getHub() {
donatien 0:bfed5767d0a5 148 return hub;
donatien 0:bfed5767d0a5 149 };
donatien 0:bfed5767d0a5 150 uint8_t getAddress() {
donatien 0:bfed5767d0a5 151 return addr;
donatien 0:bfed5767d0a5 152 };
donatien 0:bfed5767d0a5 153 uint16_t getVid() {
donatien 0:bfed5767d0a5 154 return vid;
donatien 0:bfed5767d0a5 155 };
donatien 0:bfed5767d0a5 156 uint16_t getPid() {
donatien 0:bfed5767d0a5 157 return pid;
donatien 0:bfed5767d0a5 158 };
donatien 0:bfed5767d0a5 159 uint8_t getClass() {
donatien 0:bfed5767d0a5 160 return device_class;
donatien 0:bfed5767d0a5 161 };
donatien 0:bfed5767d0a5 162 uint8_t getSubClass() {
donatien 0:bfed5767d0a5 163 return device_subclass;
donatien 0:bfed5767d0a5 164 };
donatien 0:bfed5767d0a5 165 uint8_t getProtocol() {
donatien 0:bfed5767d0a5 166 return proto;
donatien 0:bfed5767d0a5 167 };
donatien 0:bfed5767d0a5 168 bool getSpeed() {
donatien 0:bfed5767d0a5 169 return speed;
donatien 0:bfed5767d0a5 170 };
donatien 0:bfed5767d0a5 171 uint32_t getSizeControlEndpoint() {
donatien 0:bfed5767d0a5 172 return sizeControlEndpoint;
donatien 0:bfed5767d0a5 173 };
donatien 0:bfed5767d0a5 174 bool isActiveAddress() {
donatien 0:bfed5767d0a5 175 return activeAddr;
donatien 0:bfed5767d0a5 176 };
donatien 0:bfed5767d0a5 177 bool isEnumerated() {
donatien 0:bfed5767d0a5 178 return enumerated;
donatien 0:bfed5767d0a5 179 };
donatien 0:bfed5767d0a5 180
donatien 0:bfed5767d0a5 181
donatien 0:bfed5767d0a5 182 private:
donatien 0:bfed5767d0a5 183 INTERFACE intf[MAX_INTF];
donatien 0:bfed5767d0a5 184 //USBEndpoint * ep[MAX_ENDPOINT_PER_DEVICE];
donatien 0:bfed5767d0a5 185 uint32_t sizeControlEndpoint;
donatien 0:bfed5767d0a5 186 uint8_t hub;
donatien 0:bfed5767d0a5 187 uint8_t port;
donatien 0:bfed5767d0a5 188 uint16_t vid;
donatien 0:bfed5767d0a5 189 uint16_t pid;
donatien 0:bfed5767d0a5 190 uint8_t addr;
donatien 0:bfed5767d0a5 191 uint8_t device_class;
donatien 0:bfed5767d0a5 192 uint8_t device_subclass;
donatien 0:bfed5767d0a5 193 uint8_t proto;
donatien 0:bfed5767d0a5 194 bool speed;
donatien 0:bfed5767d0a5 195 bool activeAddr;
donatien 0:bfed5767d0a5 196 bool enumerated;
donatien 0:bfed5767d0a5 197
donatien 0:bfed5767d0a5 198 uint8_t nb_interf;
donatien 0:bfed5767d0a5 199
donatien 0:bfed5767d0a5 200
donatien 0:bfed5767d0a5 201 void init();
donatien 0:bfed5767d0a5 202
donatien 0:bfed5767d0a5 203 };
donatien 0:bfed5767d0a5 204
donatien 0:bfed5767d0a5 205 #endif