re-enabling serial

[clinton/Smoothieware.git] / gcc4mbed / samples / MSTest / USBDevice / USBSERIAL / USBSerial.h

/* Copyright (c) 2010-2011 mbed.org, MIT License\r
*\r
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software\r
* and associated documentation files (the "Software"), to deal in the Software without\r
* restriction, including without limitation the rights to use, copy, modify, merge, publish,\r
* distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the\r
* Software is furnished to do so, subject to the following conditions:\r
*\r
* The above copyright notice and this permission notice shall be included in all copies or\r
* substantial portions of the Software.\r
*\r
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING\r
* BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\r
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,\r
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
*/\r
\r
#ifndef USBSERIAL_H\r
#define USBSERIAL_H\r
\r
#include "USBCDC.h"\r
#include "Stream.h"\r
#include "CircBuffer.h"\r
\r
\r
/**\r
* USBSerial example\r
*\r
* @code\r
* #include "mbed.h"\r
* #include "USBSerial.h"\r
*\r
* //Virtual serial port over USB\r
* USBSerial serial;\r
*\r
* int main(void) {\r
*\r
*    while(1)\r
*    {\r
*        serial.printf("I am a virtual serial port\n");\r
*        wait(1);\r
*    }\r
* }\r
* @endcode\r
*/\r
class USBSerial: public USBCDC, public Stream {\r
public:\r
\r
    /**\r
    *   Constructor\r
    *\r
    * @param vendor_id Your vendor_id (default: 0x1f00)\r
    * @param product_id Your product_id (default: 0x2012)\r
    * @param product_release Your preoduct_release (default: 0x0001)\r
    *\r
    */\r
    USBSerial(uint16_t vendor_id = 0x1f00, uint16_t product_id = 0x2012, uint16_t product_release = 0x0001): USBCDC(vendor_id, product_id, product_release), buf(128){ };\r
\r
\r
    /**\r
    * Send a character. You can use puts, printf.\r
    *\r
    * @param c character to be sent\r
    * @returns true if there is no error, false otherwise\r
    */\r
    virtual int _putc(int c);\r
    \r
    /**\r
    * Read a character: blocking\r
    *\r
    * @returns character read\r
    */\r
    virtual int _getc();\r
    \r
    /**\r
    * Check the number of bytes available.\r
    *\r
    * @returns the number of bytes available\r
    */\r
    uint8_t available(); \r
    \r
    /**\r
    * Write a block of data. \r
    *\r
    * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.\r
    *\r
    * @param buf pointer on data which will be written\r
    * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes)\r
    *\r
    * @returns true if successfull\r
    */\r
    bool writeBlock(uint8_t * buf, uint16_t size);\r
\r
    /**\r
     *  Attach a member function to call when a packet is received. \r
     *\r
     *  @param tptr pointer to the object to call the member function on\r
     *  @param mptr pointer to the member function to be called\r
     */\r
    template<typename T>\r
    void attach(T* tptr, void (T::*mptr)(void)) {\r
        if((mptr != NULL) && (tptr != NULL)) {\r
            rx.attach(tptr, mptr);\r
        }\r
    }\r
\r
    /**\r
     * Attach a callback called when a packet is received\r
     *\r
     * @param fptr function pointer\r
     */\r
    void attach(void (*fn)(void)) {\r
        if(fn != NULL) {\r
            rx.attach(fn);\r
        }\r
    }\r
\r
\r
protected:\r
    virtual bool EP2_OUT_callback();\r
\r
private:\r
    FunctionPointer rx;\r
    CircBuffer<uint8_t> buf;\r
};\r
\r
#endif\r