gcc4mbed/samples/MSTest/USBDevice/USBSERIAL/USBSerial.h

   1 /* Copyright (c) 2010-2011 mbed.org, MIT License
   2 *
   3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
   4 * and associated documentation files (the "Software"), to deal in the Software without
   5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
   6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
   7 * Software is furnished to do so, subject to the following conditions:
   8 *
   9 * The above copyright notice and this permission notice shall be included in all copies or
  10 * substantial portions of the Software.
  11 *
  12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  17 */
  18
  19 #ifndef USBSERIAL_H
  20 #define USBSERIAL_H
  21
  22 #include "USBCDC.h"
  23 #include "Stream.h"
  24 #include "CircBuffer.h"
  25
  26
  27 /**
  28 * USBSerial example
  29 *
  30 * @code
  31 * #include "mbed.h"
  32 * #include "USBSerial.h"
  33 *
  34 * //Virtual serial port over USB
  35 * USBSerial serial;
  36 *
  37 * int main(void) {
  38 *
  39 *    while(1)
  40 *    {
  41 *        serial.printf("I am a virtual serial port\n");
  42 *        wait(1);
  43 *    }
  44 * }
  45 * @endcode
  46 */
  47 class USBSerial: public USBCDC, public Stream {
  48 public:
  49
  50     /**
  51     *   Constructor
  52     *
  53     * @param vendor_id Your vendor_id (default: 0x1f00)
  54     * @param product_id Your product_id (default: 0x2012)
  55     * @param product_release Your preoduct_release (default: 0x0001)
  56     *
  57     */
  58     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){ };
  59
  60
  61     /**
  62     * Send a character. You can use puts, printf.
  63     *
  64     * @param c character to be sent
  65     * @returns true if there is no error, false otherwise
  66     */
  67     virtual int _putc(int c);
  68
  69     /**
  70     * Read a character: blocking
  71     *
  72     * @returns character read
  73     */
  74     virtual int _getc();
  75
  76     /**
  77     * Check the number of bytes available.
  78     *
  79     * @returns the number of bytes available
  80     */
  81     uint8_t available();
  82
  83     /**
  84     * Write a block of data.
  85     *
  86     * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
  87     *
  88     * @param buf pointer on data which will be written
  89     * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes)
  90     *
  91     * @returns true if successfull
  92     */
  93     bool writeBlock(uint8_t * buf, uint16_t size);
  94
  95     /**
  96      *  Attach a member function to call when a packet is received.
  97      *
  98      *  @param tptr pointer to the object to call the member function on
  99      *  @param mptr pointer to the member function to be called
 100      */
 101     template<typename T>
 102     void attach(T* tptr, void (T::*mptr)(void)) {
 103         if((mptr != NULL) && (tptr != NULL)) {
 104             rx.attach(tptr, mptr);
 105         }
 106     }
 107
 108     /**
 109      * Attach a callback called when a packet is received
 110      *
 111      * @param fptr function pointer
 112      */
 113     void attach(void (*fn)(void)) {
 114         if(fn != NULL) {
 115             rx.attach(fn);
 116         }
 117     }
 118
 119
 120 protected:
 121     virtual bool EP2_OUT_callback();
 122
 123 private:
 124     FunctionPointer rx;
 125     CircBuffer<uint8_t> buf;
 126 };
 127
 128 #endif