EL4121 Embedded System / mbed-os

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.

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/unsupported/USBDevice/USBSerial/USBSerial.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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