Anh Tran / Mbed OS GR-Boards_WebCamera

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   HttpServer_snapshot_mbed-os

mbed-gr-libs/USBHost_custom/USBHost/USBDeviceConnected.h@0:e9fd5575b10e, 2019-10-18 (annotated)

Committer:
anhtran
Date:
Fri Oct 18 03:09:43 2019 +0000
Revision:
0:e9fd5575b10e
abc

Who changed what in which revision?

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