Point Labs / USBDevice

adds a USB serial port to your design

Dependents:   Example_WatchDog_Timer

USBSerial/USBSerial.h@77:3e96144c2bf2, 2018-11-26 (annotated)

Committer:
rlanders73
Date:
Mon Nov 26 20:46:02 2018 +0000
Revision:
77:3e96144c2bf2
Parent:
70:2c525a50f1b6
Child:
78:772335cfca9a
added _write, and _read functions to make more compatible with the UARTserial lib

Who changed what in which revision?

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