USBHAL.h

00001 /* Copyright (c) 2010-2011 mbed.org, MIT License
00002 *
00003 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004 * and associated documentation files (the "Software"), to deal in the Software without
00005 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
00006 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
00007 * Software is furnished to do so, subject to the following conditions:
00008 *
00009 * The above copyright notice and this permission notice shall be included in all copies or
00010 * substantial portions of the Software.
00011 *
00012 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017 */
00018 
00019 #ifndef USBBUSINTERFACE_H
00020 #define USBBUSINTERFACE_H
00021 
00022 #include "mbed.h"
00023 #include "USBEndpoints.h"
00024 
00025 class USBHAL {
00026 public:
00027     /* Configuration */
00028     USBHAL();
00029     ~USBHAL();
00030     void connect(void);
00031     void disconnect(void);
00032     void configureDevice(void);
00033     void unconfigureDevice(void);
00034     void setAddress(uint8_t address);
00035     void remoteWakeup(void);
00036 
00037     /* Endpoint 0 */
00038     void EP0setup(uint8_t *buffer);
00039     void EP0read(void);
00040     uint32_t EP0getReadResult(uint8_t *buffer);
00041     void EP0write(uint8_t *buffer, uint32_t size);
00042     void EP0getWriteResult(void);
00043     void EP0stall(void);
00044 
00045     /* Other endpoints */
00046     EP_STATUS endpointRead(uint8_t endpoint, uint32_t maximumSize);
00047     EP_STATUS endpointReadResult(uint8_t endpoint, uint8_t *data, uint32_t *bytesRead);
00048     EP_STATUS endpointWrite(uint8_t endpoint, uint8_t *data, uint32_t size);
00049     EP_STATUS endpointWriteResult(uint8_t endpoint);
00050     void stallEndpoint(uint8_t endpoint);
00051     void unstallEndpoint(uint8_t endpoint);
00052     bool realiseEndpoint(uint8_t endpoint, uint32_t maxPacket, uint32_t options);
00053     bool getEndpointStallState(unsigned char endpoint);
00054     uint32_t endpointReadcore(uint8_t endpoint, uint8_t *buffer);
00055     
00056 protected:
00057     virtual void busReset(void){};
00058     virtual void EP0setupCallback(void){};
00059     virtual void EP0out(void){};
00060     virtual void EP0in(void){};
00061     virtual void connectStateChanged(unsigned int connected){};
00062     virtual void suspendStateChanged(unsigned int suspended){};
00063     virtual void SOF(int frameNumber){};
00064     virtual bool EP1_OUT_callback(){return false;};
00065     virtual bool EP1_IN_callback(){return false;};
00066     virtual bool EP2_OUT_callback(){return false;};
00067     virtual bool EP2_IN_callback(){return false;};
00068     virtual bool EP3_OUT_callback(){return false;};
00069     virtual bool EP3_IN_callback(){return false;};
00070     
00071 private:
00072     void usbisr(void);
00073     static void _usbisr(void);
00074     static USBHAL * instance;
00075 };
00076 #endif
00077