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/USBHALHost.h@9:2a7b7333245f, 2012-12-10 (annotated)

Committer:
donatien
Date:
Mon Dec 10 18:18:35 2012 +0000
Revision:
9:2a7b7333245f
Parent:
0:bfed5767d0a5 
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 USBHALHOST_H
donatien 0:bfed5767d0a5 20 #define USBHALHOST_H
donatien 0:bfed5767d0a5 21
donatien 0:bfed5767d0a5 22 #include "rtos.h"
donatien 0:bfed5767d0a5 23
donatien 0:bfed5767d0a5 24 #include "USBHostTypes.h"
donatien 0:bfed5767d0a5 25
donatien 0:bfed5767d0a5 26 #define MAX_ENDPOINT 5
donatien 0:bfed5767d0a5 27 #define MAX_TD (MAX_ENDPOINT*2)
donatien 0:bfed5767d0a5 28
donatien 0:bfed5767d0a5 29 #define USBHALHOST_SIG_INIT 0x01
donatien 0:bfed5767d0a5 30 #define USBHALHOST_SIG_IRQ 0x02
donatien 0:bfed5767d0a5 31
donatien 0:bfed5767d0a5 32 class USBHALHost {
donatien 0:bfed5767d0a5 33 public:
donatien 0:bfed5767d0a5 34
donatien 0:bfed5767d0a5 35 /*
donatien 0:bfed5767d0a5 36 * Constructor
donatien 0:bfed5767d0a5 37 * init variables and memory where will be stored HCCA, ED and TD
donatien 0:bfed5767d0a5 38 */
donatien 0:bfed5767d0a5 39 USBHALHost();
donatien 0:bfed5767d0a5 40
donatien 0:bfed5767d0a5 41 /*
donatien 0:bfed5767d0a5 42 * Initialize host controller. Enable USB interrupts. This part is not in the constructor because,
donatien 0:bfed5767d0a5 43 * this function calls a virtual method if a device is already connected
donatien 0:bfed5767d0a5 44 */
donatien 0:bfed5767d0a5 45 void init();
donatien 0:bfed5767d0a5 46
donatien 0:bfed5767d0a5 47 /*
donatien 0:bfed5767d0a5 48 * reset a port of a specific hub
donatien 0:bfed5767d0a5 49 * TODO: support hub
donatien 0:bfed5767d0a5 50 */
donatien 0:bfed5767d0a5 51 void resetPort(int hub, int port);
donatien 0:bfed5767d0a5 52
donatien 0:bfed5767d0a5 53 /*
donatien 0:bfed5767d0a5 54 * return the value contained in the control HEAD ED register
donatien 0:bfed5767d0a5 55 *
donatien 0:bfed5767d0a5 56 * @returns address of the control Head ED
donatien 0:bfed5767d0a5 57 */
donatien 0:bfed5767d0a5 58 uint32_t controlHeadED();
donatien 0:bfed5767d0a5 59
donatien 0:bfed5767d0a5 60 /*
donatien 0:bfed5767d0a5 61 * return the value contained in the bulk HEAD ED register
donatien 0:bfed5767d0a5 62 *
donatien 0:bfed5767d0a5 63 * @returns address of the bulk head ED
donatien 0:bfed5767d0a5 64 */
donatien 0:bfed5767d0a5 65 uint32_t bulkHeadED();
donatien 0:bfed5767d0a5 66
donatien 0:bfed5767d0a5 67 /*
donatien 0:bfed5767d0a5 68 * return the value of the head interrupt ED contained in the HCCA
donatien 0:bfed5767d0a5 69 *
donatien 0:bfed5767d0a5 70 * @returns address of the head interrupt ED contained in the HCCA
donatien 0:bfed5767d0a5 71 */
donatien 0:bfed5767d0a5 72 uint32_t interruptHeadED();
donatien 0:bfed5767d0a5 73
donatien 0:bfed5767d0a5 74
donatien 0:bfed5767d0a5 75 /*
donatien 0:bfed5767d0a5 76 * Update the head ED for control transfers
donatien 0:bfed5767d0a5 77 */
donatien 0:bfed5767d0a5 78 void updateControlHeadED(uint32_t addr);
donatien 0:bfed5767d0a5 79
donatien 0:bfed5767d0a5 80 /*
donatien 0:bfed5767d0a5 81 * Update the head ED for bulk transfers
donatien 0:bfed5767d0a5 82 */
donatien 0:bfed5767d0a5 83 void updateBulkHeadED(uint32_t addr);
donatien 0:bfed5767d0a5 84
donatien 0:bfed5767d0a5 85 /*
donatien 0:bfed5767d0a5 86 * Update the head ED for interrupt transfers
donatien 0:bfed5767d0a5 87 */
donatien 0:bfed5767d0a5 88 void updateInterruptHeadED(uint32_t addr);
donatien 0:bfed5767d0a5 89
donatien 0:bfed5767d0a5 90 /*
donatien 0:bfed5767d0a5 91 * Enable control list ED
donatien 0:bfed5767d0a5 92 */
donatien 0:bfed5767d0a5 93 void enableControlList();
donatien 0:bfed5767d0a5 94
donatien 0:bfed5767d0a5 95 /*
donatien 0:bfed5767d0a5 96 * Enable bulk list ED
donatien 0:bfed5767d0a5 97 */
donatien 0:bfed5767d0a5 98 void enableBulkList();
donatien 0:bfed5767d0a5 99
donatien 0:bfed5767d0a5 100 /*
donatien 0:bfed5767d0a5 101 * Enable Interrupt list ED
donatien 0:bfed5767d0a5 102 */
donatien 0:bfed5767d0a5 103 void enableInterruptList();
donatien 0:bfed5767d0a5 104
donatien 0:bfed5767d0a5 105 /*
donatien 0:bfed5767d0a5 106 * Disable control list ED
donatien 0:bfed5767d0a5 107 */
donatien 0:bfed5767d0a5 108 bool disableControlList();
donatien 0:bfed5767d0a5 109
donatien 0:bfed5767d0a5 110 /*
donatien 0:bfed5767d0a5 111 * Disable bulk list ED
donatien 0:bfed5767d0a5 112 */
donatien 0:bfed5767d0a5 113 bool disableBulkList();
donatien 0:bfed5767d0a5 114
donatien 0:bfed5767d0a5 115 /*
donatien 0:bfed5767d0a5 116 * Disable Interrupt list ED
donatien 0:bfed5767d0a5 117 */
donatien 0:bfed5767d0a5 118 bool disableInterruptList();
donatien 0:bfed5767d0a5 119
donatien 0:bfed5767d0a5 120 //Lock processing
donatien 0:bfed5767d0a5 121 void lock();
donatien 0:bfed5767d0a5 122
donatien 0:bfed5767d0a5 123 void unlock();
donatien 0:bfed5767d0a5 124
donatien 0:bfed5767d0a5 125
donatien 0:bfed5767d0a5 126 protected:
donatien 0:bfed5767d0a5 127 /*
donatien 0:bfed5767d0a5 128 * Virtual method called when a device has been connected
donatien 0:bfed5767d0a5 129 *
donatien 0:bfed5767d0a5 130 * @param hub hub number of the device
donatien 0:bfed5767d0a5 131 * @param port port number of the device
donatien 0:bfed5767d0a5 132 * @param lowSpeed 1 if low speed, 0 otherwise
donatien 0:bfed5767d0a5 133 */
donatien 0:bfed5767d0a5 134 virtual void deviceConnected(int hub, int port, bool lowSpeed) {};
donatien 0:bfed5767d0a5 135
donatien 0:bfed5767d0a5 136 /*
donatien 0:bfed5767d0a5 137 * Virtuel method called when a device has been disconnected
donatien 0:bfed5767d0a5 138 *
donatien 0:bfed5767d0a5 139 * @param hub hub number of the device
donatien 0:bfed5767d0a5 140 * @param port port number of the device
donatien 0:bfed5767d0a5 141 * @param addr list of the TDs which have been completed to dequeue freed TDs
donatien 0:bfed5767d0a5 142 */
donatien 0:bfed5767d0a5 143 virtual void deviceDisconnected(int hub, int port, volatile uint32_t addr) {};
donatien 0:bfed5767d0a5 144
donatien 0:bfed5767d0a5 145 /*
donatien 0:bfed5767d0a5 146 * Virtual method called when a transfer has been completed
donatien 0:bfed5767d0a5 147 *
donatien 0:bfed5767d0a5 148 * @param addr list of the TDs which have been completed
donatien 0:bfed5767d0a5 149 */
donatien 0:bfed5767d0a5 150 virtual void transferCompleted(volatile uint32_t addr){};
donatien 0:bfed5767d0a5 151
donatien 0:bfed5767d0a5 152 /*
donatien 0:bfed5767d0a5 153 * Find a memory section for a new ED
donatien 0:bfed5767d0a5 154 *
donatien 0:bfed5767d0a5 155 * @returns the address of this section
donatien 0:bfed5767d0a5 156 */
donatien 0:bfed5767d0a5 157 volatile uint8_t * getED();
donatien 0:bfed5767d0a5 158
donatien 0:bfed5767d0a5 159 /*
donatien 0:bfed5767d0a5 160 * Find a memory section for a new TD
donatien 0:bfed5767d0a5 161 *
donatien 0:bfed5767d0a5 162 * @returns the address of this section
donatien 0:bfed5767d0a5 163 */
donatien 0:bfed5767d0a5 164 volatile uint8_t * getTD();
donatien 0:bfed5767d0a5 165
donatien 0:bfed5767d0a5 166 /*
donatien 0:bfed5767d0a5 167 * Release a previous memory section reserved for an ED
donatien 0:bfed5767d0a5 168 *
donatien 0:bfed5767d0a5 169 * @param ed address of the ED
donatien 0:bfed5767d0a5 170 */
donatien 0:bfed5767d0a5 171 void freeED(volatile uint8_t * ed);
donatien 0:bfed5767d0a5 172
donatien 0:bfed5767d0a5 173 /*
donatien 0:bfed5767d0a5 174 * Release a previous memory section reserved for an TD
donatien 0:bfed5767d0a5 175 *
donatien 0:bfed5767d0a5 176 * @param ed address of the TD
donatien 0:bfed5767d0a5 177 */
donatien 0:bfed5767d0a5 178 void freeTD(volatile uint8_t * td);
donatien 0:bfed5767d0a5 179
donatien 0:bfed5767d0a5 180
donatien 0:bfed5767d0a5 181 private:
donatien 0:bfed5767d0a5 182 static void _usbisr(void);
donatien 0:bfed5767d0a5 183 void UsbIrqhandler();
donatien 0:bfed5767d0a5 184
donatien 0:bfed5767d0a5 185 void memInit();
donatien 0:bfed5767d0a5 186
donatien 0:bfed5767d0a5 187 void process();
donatien 0:bfed5767d0a5 188
donatien 0:bfed5767d0a5 189 static void staticCb(void const* p);
donatien 0:bfed5767d0a5 190
donatien 0:bfed5767d0a5 191 HCCA volatile * usb_hcca; //256 bytes aligned!
donatien 0:bfed5767d0a5 192 uint8_t volatile * usb_edBuf; //4 bytes aligned!
donatien 0:bfed5767d0a5 193 uint8_t volatile * usb_tdBuf; //4 bytes aligned!
donatien 0:bfed5767d0a5 194
donatien 0:bfed5767d0a5 195 static USBHALHost * instHost;
donatien 0:bfed5767d0a5 196
donatien 0:bfed5767d0a5 197 bool volatile edBufAlloc[MAX_ENDPOINT];
donatien 0:bfed5767d0a5 198 bool volatile tdBufAlloc[MAX_TD];
donatien 0:bfed5767d0a5 199
donatien 0:bfed5767d0a5 200 //RTOS impl
donatien 0:bfed5767d0a5 201 Thread thread;
donatien 0:bfed5767d0a5 202 Mutex mtx;
donatien 0:bfed5767d0a5 203
donatien 0:bfed5767d0a5 204 };
donatien 0:bfed5767d0a5 205
donatien 0:bfed5767d0a5 206 #endif