Marco Zecchini / Mbed OS Example_RTOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/features/unsupported/USBDevice/USBSerial/USBSerial.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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