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 public:
00049 
00050     /**
00051     *   Constructor
00052     *
00053     * @param vendor_id Your vendor_id (default: 0x1f00)
00054     * @param product_id Your product_id (default: 0x2012)
00055     * @param product_release Your preoduct_release (default: 0x0001)
00056     * @param connect_blocking define if the connection must be blocked if USB not plugged in
00057     *
00058     */
00059 
00060     USBSerial(USBDevice *usb = new USBDevice(), bool connect_blocking = true, uint8_t ep_int_in = EPINT_IN, uint8_t ep_bulk_in = EPBULK_IN, uint8_t ep_bulk_out = EPBULK_OUT):
00061         USBCDC(usb, ep_int_in, ep_bulk_in, ep_bulk_out, connect_blocking) {
00062         settingsChangedCallback = 0;
00063         usb->set_ep_callback(ep_bulk_out, this, &USBSerial::EP_OUT_callback);
00064     };
00065 
00066 
00067     /**
00068     * Send a character. You can use puts, printf.
00069     *
00070     * @param c character to be sent
00071     * @returns true if there is no error, false otherwise
00072     */
00073     virtual int _putc(int c);
00074 
00075     /**
00076     * Read a character: blocking
00077     *
00078     * @returns character read
00079     */
00080     virtual int _getc();
00081 
00082     /**
00083     * Check the number of bytes available.
00084     *
00085     * @returns the number of bytes available
00086     */
00087     uint8_t available();
00088 
00089     /** Determine if there is a character available to read
00090      *
00091      *  @returns
00092      *    1 if there is a character available to read,
00093      *    0 otherwise
00094      */
00095     int readable() { return available() ? 1 : 0; }
00096 
00097     /** Determine if there is space available to write a character
00098      *
00099      *  @returns
00100      *    1 if there is space to write a character,
00101      *    0 otherwise
00102      */
00103     int writeable() { return 1; } // always return 1, for write operation is blocking
00104 
00105     /**
00106     * Write a block of data.
00107     *
00108     * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
00109     *
00110     * @param buf pointer on data which will be written
00111     * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes)
00112     *
00113     * @returns true if successfull
00114     */
00115     bool writeBlock(uint8_t * buf, uint16_t size);
00116 
00117     /**
00118      *  Attach a member function to call when a packet is received.
00119      *
00120      *  @param tptr pointer to the object to call the member function on
00121      *  @param mptr pointer to the member function to be called
00122      */
00123     template<typename T>
00124     void attach(T* tptr, void (T::*mptr)(void)) {
00125         if((mptr != NULL) && (tptr != NULL)) {
00126             rx.attach(tptr, mptr);
00127         }
00128     }
00129 
00130     /**
00131      * Attach a callback called when a packet is received
00132      *
00133      * @param fptr function pointer
00134      */
00135     void attach(void (*fptr)(void)) {
00136         if(fptr != NULL) {
00137             rx.attach(fptr);
00138         }
00139     }
00140 
00141     /**
00142      * Attach a callback to call when serial's settings are changed.
00143      *
00144      * @param fptr function pointer
00145      */
00146     void attach(void (*fptr)(int baud, int bits, int parity, int stop)) {
00147         settingsChangedCallback = fptr;
00148     }
00149 
00150 protected:
00151     static bool EP_OUT_callback(void *self);
00152 
00153     virtual void lineCodingChanged(int baud, int bits, int parity, int stop){
00154         if (settingsChangedCallback) {
00155             settingsChangedCallback(baud, bits, parity, stop);
00156         }
00157     }
00158 
00159 
00160 private:
00161     FunctionPointer rx;
00162     CircBuffer<uint8_t,128> buf;
00163     void (*settingsChangedCallback)(int baud, int bits, int parity, int stop);
00164 };
00165 
00166 #endif