Paul Jeon / Mbed 2 deprecated GSMTest2PICO-ece493

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.

Dependencies:   mbed

USBSerialLib/USBSerial/USBSerial.h@1:6e512faaa17c, 2020-02-21 (annotated)

Committer:
mjoun
Date:
Fri Feb 21 20:40:56 2020 +0000
Revision:
1:6e512faaa17c
works

Who changed what in which revision?

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