USBHost library. NOTE: This library is only officially supported on the LPC1768 platform. For more information, please see the handbook page.
Dependencies: FATFileSystem mbed-rtos
Dependents: BTstack WallbotWii SD to Flash Data Transfer USBHost-MSD_HelloWorld ... more
Legacy Warning
This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.
Pull requests against this repository are no longer supported. Please raise against mbed OS 5 as documented above.
USBHost/USBDeviceConnected.h@37:f1e388e7b752, 2017-07-20 (annotated)
- Committer:
- Kojto
- Date:
- Thu Jul 20 10:13:56 2017 +0100
- Revision:
- 37:f1e388e7b752
- Parent:
- 24:868cbfe611a7
Update libraries (ed9d1da)
Who changed what in which revision?
User | Revision | Line number | New 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 USBDEVICECONNECTED_H |
mbed_official | 0:a554658735bf | 18 | #define USBDEVICECONNECTED_H |
mbed_official | 0:a554658735bf | 19 | |
mbed_official | 0:a554658735bf | 20 | #include "stdint.h" |
mbed_official | 0:a554658735bf | 21 | #include "USBEndpoint.h" |
mbed_official | 0:a554658735bf | 22 | #include "USBHostConf.h" |
samux | 4:b320d68e98e7 | 23 | #include "rtos.h" |
Kojto | 37:f1e388e7b752 | 24 | #include "Callback.h" |
mbed_official | 0:a554658735bf | 25 | |
mbed_official | 0:a554658735bf | 26 | class USBHostHub; |
mbed_official | 0:a554658735bf | 27 | |
mbed_official | 0:a554658735bf | 28 | typedef struct { |
mbed_official | 0:a554658735bf | 29 | bool in_use; |
mbed_official | 0:a554658735bf | 30 | uint8_t nb_endpoint; |
mbed_official | 0:a554658735bf | 31 | uint8_t intf_class; |
mbed_official | 0:a554658735bf | 32 | uint8_t intf_subclass; |
mbed_official | 0:a554658735bf | 33 | uint8_t intf_protocol; |
mbed_official | 0:a554658735bf | 34 | USBEndpoint * ep[MAX_ENDPOINT_PER_INTERFACE]; |
Kojto | 37:f1e388e7b752 | 35 | Callback<void()> detach; |
samux | 4:b320d68e98e7 | 36 | char name[10]; |
mbed_official | 24:868cbfe611a7 | 37 | } INTERFACE; |
mbed_official | 0:a554658735bf | 38 | |
samux | 8:93da8ea2708b | 39 | /** |
samux | 8:93da8ea2708b | 40 | * USBDeviceConnected class |
samux | 8:93da8ea2708b | 41 | */ |
mbed_official | 0:a554658735bf | 42 | class USBDeviceConnected |
mbed_official | 0:a554658735bf | 43 | { |
mbed_official | 0:a554658735bf | 44 | public: |
mbed_official | 0:a554658735bf | 45 | |
mbed_official | 0:a554658735bf | 46 | /** |
mbed_official | 0:a554658735bf | 47 | * Constructor |
mbed_official | 0:a554658735bf | 48 | */ |
mbed_official | 0:a554658735bf | 49 | USBDeviceConnected(); |
mbed_official | 0:a554658735bf | 50 | |
mbed_official | 0:a554658735bf | 51 | /** |
mbed_official | 0:a554658735bf | 52 | * Attach an USBEndpoint to this device |
mbed_official | 0:a554658735bf | 53 | * |
samux | 8:93da8ea2708b | 54 | * @param intf_nb interface number |
mbed_official | 0:a554658735bf | 55 | * @param ep pointeur on the USBEndpoint which will be attached |
mbed_official | 0:a554658735bf | 56 | * @returns true if successful, false otherwise |
mbed_official | 0:a554658735bf | 57 | */ |
mbed_official | 0:a554658735bf | 58 | bool addEndpoint(uint8_t intf_nb, USBEndpoint * ep); |
mbed_official | 0:a554658735bf | 59 | |
mbed_official | 0:a554658735bf | 60 | /** |
mbed_official | 0:a554658735bf | 61 | * Retrieve an USBEndpoint by its TYPE and DIRECTION |
mbed_official | 0:a554658735bf | 62 | * |
mbed_official | 0:a554658735bf | 63 | * @param intf_nb the interface on which to lookup the USBEndpoint |
mbed_official | 0:a554658735bf | 64 | * @param type type of the USBEndpoint looked for |
samux | 2:5e8fdc541b98 | 65 | * @param dir direction of the USBEndpoint looked for |
mbed_official | 0:a554658735bf | 66 | * @param index the index of the USBEndpoint whitin the interface |
mbed_official | 0:a554658735bf | 67 | * @returns pointer on the USBEndpoint if found, NULL otherwise |
mbed_official | 0:a554658735bf | 68 | */ |
mbed_official | 0:a554658735bf | 69 | USBEndpoint * getEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir, uint8_t index = 0); |
mbed_official | 0:a554658735bf | 70 | |
mbed_official | 0:a554658735bf | 71 | /** |
mbed_official | 0:a554658735bf | 72 | * Retrieve an USBEndpoint by its index |
mbed_official | 0:a554658735bf | 73 | * |
samux | 8:93da8ea2708b | 74 | * @param intf_nb interface number |
mbed_official | 0:a554658735bf | 75 | * @param index index of the USBEndpoint |
mbed_official | 0:a554658735bf | 76 | * @returns pointer on the USBEndpoint if found, NULL otherwise |
mbed_official | 0:a554658735bf | 77 | */ |
mbed_official | 0:a554658735bf | 78 | USBEndpoint * getEndpoint(uint8_t intf_nb, uint8_t index); |
mbed_official | 0:a554658735bf | 79 | |
mbed_official | 0:a554658735bf | 80 | /** |
mbed_official | 0:a554658735bf | 81 | * Add a new interface to this device |
mbed_official | 0:a554658735bf | 82 | * |
mbed_official | 0:a554658735bf | 83 | * @param intf_nb interface number |
mbed_official | 0:a554658735bf | 84 | * @param intf_class interface class |
mbed_official | 0:a554658735bf | 85 | * @param intf_subclass interface subclass |
samux | 2:5e8fdc541b98 | 86 | * @param intf_protocol interface protocol |
mbed_official | 0:a554658735bf | 87 | * @returns true if successful, false otherwise |
mbed_official | 0:a554658735bf | 88 | */ |
mbed_official | 0:a554658735bf | 89 | bool addInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol); |
mbed_official | 0:a554658735bf | 90 | |
mbed_official | 0:a554658735bf | 91 | /** |
mbed_official | 0:a554658735bf | 92 | * Get a specific interface |
mbed_official | 0:a554658735bf | 93 | * |
mbed_official | 0:a554658735bf | 94 | * @param index index of the interface to be fetched |
mbed_official | 0:a554658735bf | 95 | * @returns interface |
mbed_official | 0:a554658735bf | 96 | */ |
mbed_official | 0:a554658735bf | 97 | INTERFACE * getInterface(uint8_t index); |
mbed_official | 0:a554658735bf | 98 | |
mbed_official | 0:a554658735bf | 99 | /** |
mbed_official | 0:a554658735bf | 100 | * Attach a member function to call when a the device has been disconnected |
mbed_official | 0:a554658735bf | 101 | * |
samux | 2:5e8fdc541b98 | 102 | * @param intf_nb interface number |
mbed_official | 0:a554658735bf | 103 | * @param tptr pointer to the object to call the member function on |
mbed_official | 0:a554658735bf | 104 | * @param mptr pointer to the member function to be called |
mbed_official | 0:a554658735bf | 105 | */ |
mbed_official | 0:a554658735bf | 106 | template<typename T> |
mbed_official | 0:a554658735bf | 107 | inline void onDisconnect(uint8_t intf_nb, T* tptr, void (T::*mptr)(void)) { |
mbed_official | 0:a554658735bf | 108 | if ((mptr != NULL) && (tptr != NULL)) { |
mbed_official | 0:a554658735bf | 109 | intf[intf_nb].detach.attach(tptr, mptr); |
mbed_official | 0:a554658735bf | 110 | } |
mbed_official | 0:a554658735bf | 111 | } |
mbed_official | 0:a554658735bf | 112 | |
mbed_official | 0:a554658735bf | 113 | /** |
mbed_official | 0:a554658735bf | 114 | * Attach a callback called when the device has been disconnected |
mbed_official | 0:a554658735bf | 115 | * |
samux | 2:5e8fdc541b98 | 116 | * @param intf_nb interface number |
samux | 2:5e8fdc541b98 | 117 | * @param fn function pointer |
mbed_official | 0:a554658735bf | 118 | */ |
mbed_official | 0:a554658735bf | 119 | inline void onDisconnect(uint8_t intf_nb, void (*fn)(void)) { |
mbed_official | 0:a554658735bf | 120 | if (fn != NULL) { |
mbed_official | 0:a554658735bf | 121 | intf[intf_nb].detach.attach(fn); |
mbed_official | 0:a554658735bf | 122 | } |
mbed_official | 0:a554658735bf | 123 | } |
mbed_official | 0:a554658735bf | 124 | |
mbed_official | 0:a554658735bf | 125 | /** |
mbed_official | 0:a554658735bf | 126 | * Disconnect the device by calling a callback function registered by a driver |
mbed_official | 0:a554658735bf | 127 | */ |
mbed_official | 0:a554658735bf | 128 | void disconnect(); |
mbed_official | 0:a554658735bf | 129 | |
mbed_official | 0:a554658735bf | 130 | // setters |
mbed_official | 0:a554658735bf | 131 | void init(uint8_t hub, uint8_t port, bool lowSpeed); |
mbed_official | 0:a554658735bf | 132 | inline void setAddress(uint8_t addr_) { addr = addr_; }; |
mbed_official | 0:a554658735bf | 133 | inline void setVid(uint16_t vid_) { vid = vid_; }; |
mbed_official | 0:a554658735bf | 134 | inline void setPid(uint16_t pid_) { pid = pid_; }; |
mbed_official | 0:a554658735bf | 135 | inline void setClass(uint8_t device_class_) { device_class = device_class_; }; |
mbed_official | 0:a554658735bf | 136 | inline void setSubClass(uint8_t device_subclass_) { device_subclass = device_subclass_; }; |
mbed_official | 0:a554658735bf | 137 | inline void setProtocol(uint8_t pr) { proto = pr; }; |
mbed_official | 0:a554658735bf | 138 | inline void setSizeControlEndpoint(uint32_t size) { sizeControlEndpoint = size; }; |
mbed_official | 0:a554658735bf | 139 | inline void activeAddress(bool active) { activeAddr = active; }; |
mbed_official | 0:a554658735bf | 140 | inline void setEnumerated() { enumerated = true; }; |
samux | 4:b320d68e98e7 | 141 | inline void setNbIntf(uint8_t nb_intf) {nb_interf = nb_intf; }; |
mbed_official | 0:a554658735bf | 142 | inline void setHubParent(USBHostHub * hub) { hub_parent = hub; }; |
samux | 4:b320d68e98e7 | 143 | inline void setName(const char * name_, uint8_t intf_nb) { strcpy(intf[intf_nb].name, name_); }; |
mbed_official | 0:a554658735bf | 144 | |
mbed_official | 0:a554658735bf | 145 | //getters |
mbed_official | 0:a554658735bf | 146 | inline uint8_t getPort() { return port; }; |
mbed_official | 0:a554658735bf | 147 | inline uint8_t getHub() { return hub_nb; }; |
mbed_official | 0:a554658735bf | 148 | inline uint8_t getAddress() { return addr; }; |
mbed_official | 0:a554658735bf | 149 | inline uint16_t getVid() { return vid; }; |
mbed_official | 0:a554658735bf | 150 | inline uint16_t getPid() { return pid; }; |
mbed_official | 0:a554658735bf | 151 | inline uint8_t getClass() { return device_class; }; |
mbed_official | 0:a554658735bf | 152 | inline uint8_t getSubClass() { return device_subclass; }; |
mbed_official | 0:a554658735bf | 153 | inline uint8_t getProtocol() { return proto; }; |
mbed_official | 0:a554658735bf | 154 | inline bool getSpeed() { return speed; }; |
mbed_official | 0:a554658735bf | 155 | inline uint32_t getSizeControlEndpoint() { return sizeControlEndpoint; }; |
mbed_official | 0:a554658735bf | 156 | inline bool isActiveAddress() { return activeAddr; }; |
mbed_official | 0:a554658735bf | 157 | inline bool isEnumerated() { return enumerated; }; |
mbed_official | 0:a554658735bf | 158 | inline USBHostHub * getHubParent() { return hub_parent; }; |
samux | 4:b320d68e98e7 | 159 | inline uint8_t getNbIntf() { return nb_interf; }; |
samux | 4:b320d68e98e7 | 160 | inline const char * getName(uint8_t intf_nb) { return intf[intf_nb].name; }; |
mbed_official | 24:868cbfe611a7 | 161 | |
mbed_official | 0:a554658735bf | 162 | // in case this device is a hub |
mbed_official | 0:a554658735bf | 163 | USBHostHub * hub; |
mbed_official | 0:a554658735bf | 164 | |
mbed_official | 0:a554658735bf | 165 | private: |
mbed_official | 0:a554658735bf | 166 | USBHostHub * hub_parent; |
mbed_official | 0:a554658735bf | 167 | |
mbed_official | 0:a554658735bf | 168 | INTERFACE intf[MAX_INTF]; |
mbed_official | 0:a554658735bf | 169 | uint32_t sizeControlEndpoint; |
mbed_official | 0:a554658735bf | 170 | uint8_t hub_nb; |
mbed_official | 0:a554658735bf | 171 | uint8_t port; |
mbed_official | 0:a554658735bf | 172 | uint16_t vid; |
mbed_official | 0:a554658735bf | 173 | uint16_t pid; |
mbed_official | 0:a554658735bf | 174 | uint8_t addr; |
mbed_official | 0:a554658735bf | 175 | uint8_t device_class; |
mbed_official | 0:a554658735bf | 176 | uint8_t device_subclass; |
mbed_official | 0:a554658735bf | 177 | uint8_t proto; |
mbed_official | 0:a554658735bf | 178 | bool speed; |
mbed_official | 0:a554658735bf | 179 | volatile bool activeAddr; |
mbed_official | 0:a554658735bf | 180 | volatile bool enumerated; |
mbed_official | 0:a554658735bf | 181 | uint8_t nb_interf; |
mbed_official | 0:a554658735bf | 182 | |
mbed_official | 0:a554658735bf | 183 | void init(); |
mbed_official | 0:a554658735bf | 184 | }; |
mbed_official | 0:a554658735bf | 185 | |
mbed_official | 0:a554658735bf | 186 | #endif |