USBSerial.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 USBSERIAL_H
00020 #define USBSERIAL_H
00021 
00022 #include "USBCDC.h"
00023 #include "Stream.h"
00024 #include "CircBuffer.h"
00025 
00026 
00027 /**
00028 * USBSerial example
00029 *
00030 * @code
00031 * #include "mbed.h"
00032 * #include "USBSerial.h"
00033 *
00034 * //Virtual serial port over USB
00035 * USBSerial serial;
00036 *
00037 * int main(void) {
00038 *
00039 *    while(1)
00040 *    {
00041 *        serial.printf("I am a virtual serial port\n");
00042 *        wait(1);
00043 *    }
00044 * }
00045 * @endcode
00046 */
00047 class USBSerial: public USBCDC//, public Stream
00048 {
00049 public:
00050 
00051     /**
00052     *   Constructor
00053     *
00054     * @param vendor_id Your vendor_id (default: 0x1f00)
00055     * @param product_id Your product_id (default: 0x2012)
00056     * @param product_release Your preoduct_release (default: 0x0001)
00057     *
00058     */
00059     USBSerial( uint16_t vendor_id = 0x1f00, uint16_t product_id = 0x2012, uint16_t product_release = 0x0001 );
00060 
00061 
00062     /**
00063     * Send a character. You can use puts, printf.
00064     *
00065     * @param c character to be sent
00066     * @returns true if there is no error, false otherwise
00067     */
00068     virtual int _putc( int c );
00069 
00070     /**
00071     * Read a character: blocking
00072     *
00073     * @returns character read
00074     */
00075     virtual int _getc();
00076 
00077     /**
00078     * Check the number of bytes available.
00079     *
00080     * @returns the number of bytes available
00081     */
00082     uint8_t available();
00083 
00084 
00085     /**
00086      * Check the number of bytes available.
00087      */
00088     void flush( void );
00089 
00090     /**
00091     * Write a block of data.
00092     *
00093     * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
00094     *
00095     * @param buf pointer on data which will be written
00096     * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes)
00097     *
00098     * @returns true if successfull
00099     */
00100     bool writeBlock( uint8_t *buf, uint16_t size );
00101     bool writeBlock( const char *buf );
00102     void printf( const char *format, ... );
00103 
00104 #ifdef USB_ERRATA_WORKAROUND
00105     void connect( void );
00106     void disconnect( void );
00107     bool vbusDetected( void );
00108 #endif
00109 
00110     /**
00111      *  Attach a member function to call when a packet is received.
00112      *
00113      *  @param tptr pointer to the object to call the member function on
00114      *  @param mptr pointer to the member function to be called
00115      */
00116     template<typename T>
00117     void attach( T *tptr, void ( T::*mptr )( void ) )
00118     {
00119         if( ( mptr != NULL ) && ( tptr != NULL ) )
00120         {
00121             rx.attach( tptr, mptr );
00122         }
00123     }
00124 
00125     /**
00126      * Attach a callback called when a packet is received
00127      *
00128      * @param fptr function pointer
00129      */
00130     void attach( void ( *fn )( void ) )
00131     {
00132         if( fn != NULL )
00133         {
00134             rx.attach( fn );
00135         }
00136     }
00137 
00138 
00139 protected:
00140     virtual bool EP2_OUT_callback();
00141 
00142 private:
00143     FunctionPointer rx;
00144     CircBuffer<uint8_t> buf;
00145 
00146 #ifdef USB_ERRATA_WORKAROUND
00147     DigitalOut _connect;
00148     DigitalIn _vbus;
00149 #endif
00150 
00151 };
00152 
00153 #endif
00154