Donatien Garnier / VodafoneUSBModem

Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket

This library is deprecated. Please use the newest production branch of the library from https://mbed.org/users/mbed_official/code/VodafoneUSBModem/

USBHostWANDongleLib/USBHost/USBEndpoint.h@2:50930edb6eb3, 2012-11-01 (annotated)

Committer:
donatien
Date:
Thu Nov 01 09:57:11 2012 +0000
Revision:
2:50930edb6eb3
Parent:
0:bd5343539e38 
Deprecated library, pointing out to new one

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:bd5343539e38 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
donatien 0:bd5343539e38 2 *
donatien 0:bd5343539e38 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 0:bd5343539e38 4 * and associated documentation files (the "Software"), to deal in the Software without
donatien 0:bd5343539e38 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
donatien 0:bd5343539e38 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
donatien 0:bd5343539e38 7 * Software is furnished to do so, subject to the following conditions:
donatien 0:bd5343539e38 8 *
donatien 0:bd5343539e38 9 * The above copyright notice and this permission notice shall be included in all copies or
donatien 0:bd5343539e38 10 * substantial portions of the Software.
donatien 0:bd5343539e38 11 *
donatien 0:bd5343539e38 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 0:bd5343539e38 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 0:bd5343539e38 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 0:bd5343539e38 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:bd5343539e38 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 0:bd5343539e38 17 */
donatien 0:bd5343539e38 18
donatien 0:bd5343539e38 19 #ifndef USBENDPOINT_H
donatien 0:bd5343539e38 20 #define USBENDPOINT_H
donatien 0:bd5343539e38 21
donatien 0:bd5343539e38 22 #include "stdint.h"
donatien 0:bd5343539e38 23 #include "FunctionPointer.h"
donatien 0:bd5343539e38 24 #include "USBHostTypes.h"
donatien 0:bd5343539e38 25
donatien 0:bd5343539e38 26
donatien 0:bd5343539e38 27 enum ENDPOINT_TYPE {
donatien 0:bd5343539e38 28 CONTROL_ENDPOINT = 0,
donatien 0:bd5343539e38 29 ISOCHRONOUS_ENDPOINT,
donatien 0:bd5343539e38 30 BULK_ENDPOINT,
donatien 0:bd5343539e38 31 INTERRUPT_ENDPOINT
donatien 0:bd5343539e38 32 };
donatien 0:bd5343539e38 33
donatien 0:bd5343539e38 34 enum ENDPOINT_DIRECTION {
donatien 0:bd5343539e38 35 OUT = 1,
donatien 0:bd5343539e38 36 IN
donatien 0:bd5343539e38 37 };
donatien 0:bd5343539e38 38
donatien 0:bd5343539e38 39 class USBEndpoint {
donatien 0:bd5343539e38 40 public:
donatien 0:bd5343539e38 41 /*
donatien 0:bd5343539e38 42 * Constructor
donatien 0:bd5343539e38 43 */
donatien 0:bd5343539e38 44 USBEndpoint() {state = USB_TYPE_FREE; nextEp = NULL;};
donatien 0:bd5343539e38 45
donatien 0:bd5343539e38 46 /*
donatien 0:bd5343539e38 47 * Initialize an endpoint
donatien 0:bd5343539e38 48 *
donatien 0:bd5343539e38 49 * @param hced hced associated to the endpoint
donatien 0:bd5343539e38 50 * @param type endpoint type
donatien 0:bd5343539e38 51 * @param dir endpoint direction
donatien 0:bd5343539e38 52 * @param size endpoint size
donatien 0:bd5343539e38 53 * @param ep_number endpoint number
donatien 0:bd5343539e38 54 */
donatien 0:bd5343539e38 55 void init(HCED * hced, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir, uint32_t size, uint8_t ep_number, HCTD* td_list[2]);
donatien 0:bd5343539e38 56
donatien 0:bd5343539e38 57 /*
donatien 0:bd5343539e38 58 * Set next token. Warining: only useful for the control endpoint
donatien 0:bd5343539e38 59 *
donatien 0:bd5343539e38 60 * @param token IN, OUT or SETUP token
donatien 0:bd5343539e38 61 */
donatien 0:bd5343539e38 62 void setNextToken(uint32_t token);
donatien 0:bd5343539e38 63
donatien 0:bd5343539e38 64 /*
donatien 0:bd5343539e38 65 * Queue an endpoint
donatien 0:bd5343539e38 66 *
donatien 0:bd5343539e38 67 * endpoint endpoint which will be queued in the linked list
donatien 0:bd5343539e38 68 */
donatien 0:bd5343539e38 69 void queueEndpoint(USBEndpoint * endpoint);
donatien 0:bd5343539e38 70
donatien 0:bd5343539e38 71 /*
donatien 0:bd5343539e38 72 * Get a td to be queued
donatien 0:bd5343539e38 73 *
donatien 0:bd5343539e38 74 * @returns td hctd which will be queued
donatien 0:bd5343539e38 75 */
donatien 0:bd5343539e38 76 volatile HCTD* getNextTD();
donatien 0:bd5343539e38 77
donatien 0:bd5343539e38 78 /*
donatien 0:bd5343539e38 79 * Queue a transfer on the endpoint
donatien 0:bd5343539e38 80 *
donatien 0:bd5343539e38 81 */
donatien 0:bd5343539e38 82 void queueTransfer();
donatien 0:bd5343539e38 83
donatien 0:bd5343539e38 84 /*
donatien 0:bd5343539e38 85 * Get the currently processed td
donatien 0:bd5343539e38 86 *
donatien 0:bd5343539e38 87 * @returns td hctd that was queued
donatien 0:bd5343539e38 88 */
donatien 0:bd5343539e38 89 volatile HCTD * getProcessedTD();
donatien 0:bd5343539e38 90
donatien 0:bd5343539e38 91 /*
donatien 0:bd5343539e38 92 * Unqueue a transfer from the endpoint
donatien 0:bd5343539e38 93 *
donatien 0:bd5343539e38 94 * @param td hctd which will be unqueued
donatien 0:bd5343539e38 95 */
donatien 0:bd5343539e38 96 void unqueueTransfer(volatile HCTD * td);
donatien 0:bd5343539e38 97
donatien 0:bd5343539e38 98 /*
donatien 0:bd5343539e38 99 * Return the next endpoint in the linked list
donatien 0:bd5343539e38 100 *
donatien 0:bd5343539e38 101 * @returns next endpoint
donatien 0:bd5343539e38 102 */
donatien 0:bd5343539e38 103 USBEndpoint * nextEndpoint();
donatien 0:bd5343539e38 104
donatien 0:bd5343539e38 105 /**
donatien 0:bd5343539e38 106 * Attach a member function to call when a transfer is finished
donatien 0:bd5343539e38 107 *
donatien 0:bd5343539e38 108 * @param tptr pointer to the object to call the member function on
donatien 0:bd5343539e38 109 * @param mptr pointer to the member function to be called
donatien 0:bd5343539e38 110 */
donatien 0:bd5343539e38 111 template<typename T>
donatien 0:bd5343539e38 112 void attach(T* tptr, void (T::*mptr)(void)) {
donatien 0:bd5343539e38 113 if((mptr != NULL) && (tptr != NULL)) {
donatien 0:bd5343539e38 114 rx.attach(tptr, mptr);
donatien 0:bd5343539e38 115 }
donatien 0:bd5343539e38 116 }
donatien 0:bd5343539e38 117
donatien 0:bd5343539e38 118 /**
donatien 0:bd5343539e38 119 * Attach a callback called when a transfer is finished
donatien 0:bd5343539e38 120 *
donatien 0:bd5343539e38 121 * @param fptr function pointer
donatien 0:bd5343539e38 122 */
donatien 0:bd5343539e38 123 void attach(void (*fn)(void)) {
donatien 0:bd5343539e38 124 if(fn != NULL) {
donatien 0:bd5343539e38 125 rx.attach(fn);
donatien 0:bd5343539e38 126 }
donatien 0:bd5343539e38 127 }
donatien 0:bd5343539e38 128
donatien 0:bd5343539e38 129 /*
donatien 0:bd5343539e38 130 * Call the handler associted to the end of a transfer
donatien 0:bd5343539e38 131 */
donatien 0:bd5343539e38 132 void call() {
donatien 0:bd5343539e38 133 rx.call();
donatien 0:bd5343539e38 134 };
donatien 0:bd5343539e38 135
donatien 0:bd5343539e38 136
donatien 0:bd5343539e38 137 /*
donatien 0:bd5343539e38 138 * Setters
donatien 0:bd5343539e38 139 */
donatien 0:bd5343539e38 140 void setState(USB_TYPE st) {state = st;}
donatien 0:bd5343539e38 141 void setDeviceAddress(uint8_t addr);
donatien 0:bd5343539e38 142 void setLengthTransferred(int len);
donatien 0:bd5343539e38 143 void setSpeed(uint8_t speed);
donatien 0:bd5343539e38 144 void setSize(uint32_t size);
donatien 0:bd5343539e38 145 void setDir(ENDPOINT_DIRECTION d) {dir = d;}
donatien 0:bd5343539e38 146
donatien 0:bd5343539e38 147 /*
donatien 0:bd5343539e38 148 * Getters
donatien 0:bd5343539e38 149 */
donatien 0:bd5343539e38 150 USB_TYPE getState() {return state;}
donatien 0:bd5343539e38 151 ENDPOINT_TYPE getType();
donatien 0:bd5343539e38 152 uint8_t getDeviceAddress();
donatien 0:bd5343539e38 153 int getLengthTransferred() {return transferred;}
donatien 0:bd5343539e38 154 uint32_t getBufStart();
donatien 0:bd5343539e38 155 uint32_t getSize();
donatien 0:bd5343539e38 156 volatile HCTD * getHeadTD();
donatien 0:bd5343539e38 157 volatile HCTD** getTDList();
donatien 0:bd5343539e38 158 volatile HCED * getHCED();
donatien 0:bd5343539e38 159 ENDPOINT_DIRECTION getDir() {return dir;}
donatien 0:bd5343539e38 160 bool isSetup() {return setup;}
donatien 0:bd5343539e38 161
donatien 0:bd5343539e38 162
donatien 0:bd5343539e38 163 private:
donatien 0:bd5343539e38 164 ENDPOINT_TYPE type;
donatien 0:bd5343539e38 165 volatile USB_TYPE state;
donatien 0:bd5343539e38 166 ENDPOINT_DIRECTION dir;
donatien 0:bd5343539e38 167 bool setup;
donatien 0:bd5343539e38 168
donatien 0:bd5343539e38 169 int transfer_len;
donatien 0:bd5343539e38 170 int transferred;
donatien 0:bd5343539e38 171 uint32_t buf_start;
donatien 0:bd5343539e38 172
donatien 0:bd5343539e38 173 FunctionPointer rx;
donatien 0:bd5343539e38 174
donatien 0:bd5343539e38 175 USBEndpoint* nextEp;
donatien 0:bd5343539e38 176
donatien 0:bd5343539e38 177 // USBEndpoint descriptor
donatien 0:bd5343539e38 178 volatile HCED * hced;
donatien 0:bd5343539e38 179
donatien 0:bd5343539e38 180 volatile HCTD * td_list[2];
donatien 0:bd5343539e38 181 volatile HCTD * td_current;
donatien 0:bd5343539e38 182 volatile HCTD * td_next;
donatien 0:bd5343539e38 183 /*bool carry;*/
donatien 0:bd5343539e38 184
donatien 0:bd5343539e38 185 int count;
donatien 0:bd5343539e38 186
donatien 0:bd5343539e38 187 };
donatien 0:bd5343539e38 188
donatien 0:bd5343539e38 189 #endif