tool/mbed/mbed-sdk/libraries/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     * @param connect_blocking define if the connection must be blocked if USB not plugged in
  57     *
  58     */
  59     USBSerial(uint16_t vendor_id = 0x1f00, uint16_t product_id = 0x2012, uint16_t product_release = 0x0001, bool connect_blocking = true): USBCDC(vendor_id, product_id, product_release, connect_blocking){
  60         settingsChangedCallback = 0;
  61     };
  62
  63
  64     /**
  65     * Send a character. You can use puts, printf.
  66     *
  67     * @param c character to be sent
  68     * @returns true if there is no error, false otherwise
  69     */
  70     virtual int _putc(int c);
  71
  72     /**
  73     * Read a character: blocking
  74     *
  75     * @returns character read
  76     */
  77     virtual int _getc();
  78
  79     /**
  80     * Check the number of bytes available.
  81     *
  82     * @returns the number of bytes available
  83     */
  84     uint8_t available();
  85
  86     /** Determine if there is a character available to read
  87      *
  88      *  @returns
  89      *    1 if there is a character available to read,
  90      *    0 otherwise
  91      */
  92     int readable() { return available() ? 1 : 0; }
  93
  94     /** Determine if there is space available to write a character
  95      *
  96      *  @returns
  97      *    1 if there is space to write a character,
  98      *    0 otherwise
  99      */
 100     int writeable() { return 1; } // always return 1, for write operation is blocking
 101
 102     /**
 103     * Write a block of data.
 104     *
 105     * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
 106     *
 107     * @param buf pointer on data which will be written
 108     * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes)
 109     *
 110     * @returns true if successfull
 111     */
 112     bool writeBlock(uint8_t * buf, uint16_t size);
 113
 114     /**
 115      *  Attach a member function to call when a packet is received.
 116      *
 117      *  @param tptr pointer to the object to call the member function on
 118      *  @param mptr pointer to the member function to be called
 119      */
 120     template<typename T>
 121     void attach(T* tptr, void (T::*mptr)(void)) {
 122         if((mptr != NULL) && (tptr != NULL)) {
 123             rx.attach(tptr, mptr);
 124         }
 125     }
 126
 127     /**
 128      * Attach a callback called when a packet is received
 129      *
 130      * @param fptr function pointer
 131      */
 132     void attach(void (*fptr)(void)) {
 133         if(fptr != NULL) {
 134             rx.attach(fptr);
 135         }
 136     }
 137
 138     /**
 139      * Attach a callback to call when serial's settings are changed.
 140      *
 141      * @param fptr function pointer
 142      */
 143     void attach(void (*fptr)(int baud, int bits, int parity, int stop)) {
 144         settingsChangedCallback = fptr;
 145     }
 146
 147 protected:
 148     virtual bool EPBULK_OUT_callback();
 149     virtual void lineCodingChanged(int baud, int bits, int parity, int stop){
 150         if (settingsChangedCallback) {
 151             settingsChangedCallback(baud, bits, parity, stop);
 152         }
 153     }
 154
 155 private:
 156     FunctionPointer rx;
 157     CircBuffer<uint8_t,128> buf;
 158     void (*settingsChangedCallback)(int baud, int bits, int parity, int stop);
 159 };
 160
 161 #endif