USBHost custom library.
Dependents: GR-PEACH_HVC-P2_sample_client mbed-os-storage-access GR-PEACH_Digital_Signage GR-PEACH_Audio_Playback_Sample ... more
Fork of USBHost by
USBHost/USBEndpoint.h
- Committer:
- mbed_official
- Date:
- 2013-03-06
- Revision:
- 0:a554658735bf
- Child:
- 4:b320d68e98e7
File content as of revision 0:a554658735bf:
/* Copyright (c) 2010-2012 mbed.org, MIT License * * Permission is hereby granted, free of charge, to any person obtaining a copy of this software * and associated documentation files (the "Software"), to deal in the Software without * restriction, including without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all copies or * substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef USBENDPOINT_H #define USBENDPOINT_H #include "FunctionPointer.h" #include "USBHostTypes.h" class USBDeviceConnected; class USBEndpoint { public: /** * Constructor */ USBEndpoint() { state = USB_TYPE_FREE; nextEp = NULL; }; /** * Initialize an endpoint * * @param hced hced associated to the endpoint * @param type endpoint type * @param dir endpoint direction * @param size endpoint size * @param ep_number endpoint number * @param td_list array of two allocated transfer descriptors */ void init(HCED * hced, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir, uint32_t size, uint8_t ep_number, HCTD* td_list[2]); /** * Set next token. Warining: only useful for the control endpoint * * @param token IN, OUT or SETUP token */ void setNextToken(uint32_t token); /** * Queue an endpoint * * endpoint endpoint which will be queued in the linked list */ void queueEndpoint(USBEndpoint * endpoint); /** * Queue a transfer on the endpoint */ void queueTransfer(); /** * Unqueue a transfer from the endpoint * * @param td hctd which will be unqueued */ void unqueueTransfer(volatile HCTD * td); /** * Attach a member function to call when a transfer is finished * * @param tptr pointer to the object to call the member function on * @param mptr pointer to the member function to be called */ template<typename T> inline void attach(T* tptr, void (T::*mptr)(void)) { if((mptr != NULL) && (tptr != NULL)) { rx.attach(tptr, mptr); } } /** * Attach a callback called when a transfer is finished * * @param fptr function pointer */ inline void attach(void (*fn)(void)) { if(fn != NULL) { rx.attach(fn); } } /** * Call the handler associted to the end of a transfer */ inline void call() { rx.call(); }; // setters inline void setState(USB_TYPE st) { state = st; } void setState(uint8_t st); void setDeviceAddress(uint8_t addr); inline void setLengthTransferred(int len) { transferred = len; }; void setSpeed(uint8_t speed); void setSize(uint32_t size); inline void setDir(ENDPOINT_DIRECTION d) { dir = d; } // getters const char * getStateString(); inline USB_TYPE getState() { return state; } inline ENDPOINT_TYPE getType() { return type; }; inline uint8_t getDeviceAddress() { return hced->control & 0x7f; }; inline int getLengthTransferred() { return transferred; } inline uint8_t * getBufStart() { return buf_start; } inline uint8_t getAddress(){ return address; }; inline uint32_t getSize() { return (hced->control >> 16) & 0x3ff; }; inline volatile HCTD * getHeadTD() { return (volatile HCTD*) ((uint32_t)hced->headTD & ~0xF); }; inline volatile HCTD** getTDList() { return td_list; }; inline volatile HCED * getHCED() { return hced; }; inline ENDPOINT_DIRECTION getDir() { return dir; } inline volatile HCTD * getProcessedTD() { return td_current; }; inline volatile HCTD* getNextTD() { return td_current; }; inline bool isSetup() { return setup; } inline USBEndpoint * nextEndpoint() { return (USBEndpoint*)nextEp; }; USBDeviceConnected * dev; private: ENDPOINT_TYPE type; volatile USB_TYPE state; ENDPOINT_DIRECTION dir; bool setup; uint8_t address; int transfer_len; int transferred; uint8_t * buf_start; FunctionPointer rx; USBEndpoint* nextEp; // USBEndpoint descriptor volatile HCED * hced; volatile HCTD * td_list[2]; volatile HCTD * td_current; volatile HCTD * td_next; }; #endif