1 /* Copyright (c) 2010-2011 mbed.org, MIT License
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:
9 * The above copyright notice and this permission notice shall be included in all copies or
10 * substantial portions of the Software.
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.
24 #include "CircBuffer.h"
32 * #include "USBSerial.h"
34 * //Virtual serial port over USB
41 * serial.printf("I am a virtual serial port\n");
47 class USBSerial: public USBCDC, public Stream {
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
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;
65 * Send a character. You can use puts, printf.
67 * @param c character to be sent
68 * @returns true if there is no error, false otherwise
70 virtual int _putc(int c);
73 * Read a character: blocking
75 * @returns character read
80 * Check the number of bytes available.
82 * @returns the number of bytes available
86 /** Determine if there is a character available to read
89 * 1 if there is a character available to read,
92 int readable() { return available() ? 1 : 0; }
94 /** Determine if there is space available to write a character
97 * 1 if there is space to write a character,
100 int writeable() { return 1; } // always return 1, for write operation is blocking
103 * Write a block of data.
105 * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
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)
110 * @returns true if successfull
112 bool writeBlock(uint8_t * buf, uint16_t size);
115 * Attach a member function to call when a packet is received.
117 * @param tptr pointer to the object to call the member function on
118 * @param mptr pointer to the member function to be called
121 void attach(T* tptr, void (T::*mptr)(void)) {
122 if((mptr != NULL) && (tptr != NULL)) {
123 rx.attach(tptr, mptr);
128 * Attach a callback called when a packet is received
130 * @param fptr function pointer
132 void attach(void (*fptr)(void)) {
139 * Attach a callback to call when serial's settings are changed.
141 * @param fptr function pointer
143 void attach(void (*fptr)(int baud, int bits, int parity, int stop)) {
144 settingsChangedCallback = fptr;
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);
157 CircBuffer<uint8_t,128> buf;
158 void (*settingsChangedCallback)(int baud, int bits, int parity, int stop);