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 #define USB_ERRATA_WORKAROUND
00026 
00027 class USBHAL
00028 {
00029 public:
00030     /* Configuration */
00031     USBHAL();
00032     ~USBHAL();
00033     void connect( void );
00034     void disconnect( void );
00035 #ifndef USB_ERRATA_WORKAROUND
00036     bool vbusDetected( void );
00037 #endif
00038     void configureDevice( void );
00039     void unconfigureDevice( void );
00040     void setAddress( uint8_t address );
00041     void remoteWakeup( void );
00042 
00043     /* Endpoint 0 */
00044     void EP0setup( uint8_t *buffer );
00045     void EP0read( void );
00046     uint32_t EP0getReadResult( uint8_t *buffer );
00047     void EP0write( uint8_t *buffer, uint32_t size );
00048     void EP0getWriteResult( void );
00049     void EP0stall( void );
00050 
00051     /* Other endpoints */
00052     EP_STATUS endpointRead( uint8_t endpoint, uint32_t maximumSize );
00053     EP_STATUS endpointReadResult( uint8_t endpoint, uint8_t *data, uint32_t *bytesRead );
00054     EP_STATUS endpointWrite( uint8_t endpoint, uint8_t *data, uint32_t size );
00055     EP_STATUS endpointWriteResult( uint8_t endpoint );
00056     void stallEndpoint( uint8_t endpoint );
00057     void unstallEndpoint( uint8_t endpoint );
00058     bool realiseEndpoint( uint8_t endpoint, uint32_t maxPacket, uint32_t options );
00059     bool getEndpointStallState( unsigned char endpoint );
00060     uint32_t endpointReadcore( uint8_t endpoint, uint8_t *buffer );
00061 
00062 protected:
00063     virtual void busReset( void ) {};
00064     virtual void EP0setupCallback( void ) {};
00065     virtual void EP0out( void ) {};
00066     virtual void EP0in( void ) {};
00067     virtual void connectStateChanged( unsigned int connected ) {};
00068     virtual void suspendStateChanged( unsigned int suspended ) {};
00069     virtual void SOF( int frameNumber ) {};
00070     virtual bool EP1_OUT_callback()
00071     {
00072         return false;
00073     };
00074     virtual bool EP1_IN_callback()
00075     {
00076         return false;
00077     };
00078     virtual bool EP2_OUT_callback()
00079     {
00080         return false;
00081     };
00082     virtual bool EP2_IN_callback()
00083     {
00084         return false;
00085     };
00086     virtual bool EP3_OUT_callback()
00087     {
00088         return false;
00089     };
00090     virtual bool EP3_IN_callback()
00091     {
00092         return false;
00093     };
00094 
00095 private:
00096     void usbisr( void );
00097     static void _usbisr( void );
00098     static USBHAL *instance;
00099 };
00100 #endif
00101 
00102