mbed official / USBDevice Featured

USB device stack

Dependents:   mbed-mX-USB-TEST1 USBMSD_SD_HID_HelloWorld HidTest MIDI_usb_bridge ... more

Legacy Warning

This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.

Pull requests against this repository are no longer supported. Please raise against mbed OS 5 as documented above.

USBSerial/USBSerial.h@71:53949e6131f6, 2017-07-27 (annotated)

Committer:
Kojto
Date:
Thu Jul 27 12:14:04 2017 +0100
Revision:
71:53949e6131f6
Parent:
70:2c525a50f1b6 
Update libraries



Fixes the previous commmit, as some devices were not copied. USBDevice contains

now targets directory with all targets implementations

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();
mbed_official 25:7c72828865f3 78
samux 1:80ab0d068708 79 /**
samux 1:80ab0d068708 80 * Check the number of bytes available.
samux 1:80ab0d068708 81 *
samux 1:80ab0d068708 82 * @returns the number of bytes available
samux 1:80ab0d068708 83 */
mbed_official 25:7c72828865f3 84 uint8_t available();
mbed_official 15:849c0c0f2769 85
Kojto 70:2c525a50f1b6 86 /**
Kojto 70:2c525a50f1b6 87 * Check if the terminal is connected.
Kojto 70:2c525a50f1b6 88 *
Kojto 70:2c525a50f1b6 89 * @returns connection status
Kojto 70:2c525a50f1b6 90 */
Kojto 70:2c525a50f1b6 91 bool connected();
Kojto 70:2c525a50f1b6 92
mbed_official 15:849c0c0f2769 93 /** Determine if there is a character available to read
mbed_official 15:849c0c0f2769 94 *
mbed_official 15:849c0c0f2769 95 * @returns
mbed_official 15:849c0c0f2769 96 * 1 if there is a character available to read,
mbed_official 15:849c0c0f2769 97 * 0 otherwise
mbed_official 15:849c0c0f2769 98 */
mbed_official 15:849c0c0f2769 99 int readable() { return available() ? 1 : 0; }
mbed_official 25:7c72828865f3 100
mbed_official 15:849c0c0f2769 101 /** Determine if there is space available to write a character
mbed_official 15:849c0c0f2769 102 *
mbed_official 15:849c0c0f2769 103 * @returns
mbed_official 15:849c0c0f2769 104 * 1 if there is space to write a character,
mbed_official 15:849c0c0f2769 105 * 0 otherwise
mbed_official 15:849c0c0f2769 106 */
mbed_official 15:849c0c0f2769 107 int writeable() { return 1; } // always return 1, for write operation is blocking
mbed_official 25:7c72828865f3 108
samux 1:80ab0d068708 109 /**
mbed_official 25:7c72828865f3 110 * Write a block of data.
samux 1:80ab0d068708 111 *
samux 1:80ab0d068708 112 * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written.
samux 1:80ab0d068708 113 *
samux 1:80ab0d068708 114 * @param buf pointer on data which will be written
samux 1:80ab0d068708 115 * @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 116 *
samux 1:80ab0d068708 117 * @returns true if successfull
samux 1:80ab0d068708 118 */
samux 1:80ab0d068708 119 bool writeBlock(uint8_t * buf, uint16_t size);
samux 1:80ab0d068708 120
samux 1:80ab0d068708 121 /**
mbed_official 25:7c72828865f3 122 * Attach a member function to call when a packet is received.
samux 1:80ab0d068708 123 *
samux 1:80ab0d068708 124 * @param tptr pointer to the object to call the member function on
samux 1:80ab0d068708 125 * @param mptr pointer to the member function to be called
samux 1:80ab0d068708 126 */
samux 1:80ab0d068708 127 template<typename T>
samux 1:80ab0d068708 128 void attach(T* tptr, void (T::*mptr)(void)) {
samux 1:80ab0d068708 129 if((mptr != NULL) && (tptr != NULL)) {
samux 1:80ab0d068708 130 rx.attach(tptr, mptr);
samux 1:80ab0d068708 131 }
samux 1:80ab0d068708 132 }
samux 1:80ab0d068708 133
samux 1:80ab0d068708 134 /**
samux 1:80ab0d068708 135 * Attach a callback called when a packet is received
samux 1:80ab0d068708 136 *
samux 1:80ab0d068708 137 * @param fptr function pointer
samux 1:80ab0d068708 138 */
mbed_official 15:849c0c0f2769 139 void attach(void (*fptr)(void)) {
mbed_official 15:849c0c0f2769 140 if(fptr != NULL) {
mbed_official 15:849c0c0f2769 141 rx.attach(fptr);
samux 1:80ab0d068708 142 }
samux 1:80ab0d068708 143 }
samux 1:80ab0d068708 144
mbed_official 15:849c0c0f2769 145 /**
mbed_official 15:849c0c0f2769 146 * Attach a callback to call when serial's settings are changed.
mbed_official 15:849c0c0f2769 147 *
mbed_official 15:849c0c0f2769 148 * @param fptr function pointer
mbed_official 15:849c0c0f2769 149 */
mbed_official 15:849c0c0f2769 150 void attach(void (*fptr)(int baud, int bits, int parity, int stop)) {
mbed_official 15:849c0c0f2769 151 settingsChangedCallback = fptr;
mbed_official 15:849c0c0f2769 152 }
samux 1:80ab0d068708 153
samux 1:80ab0d068708 154 protected:
mbed_official 47:a0cd9646ecd1 155 virtual bool EPBULK_OUT_callback();
mbed_official 15:849c0c0f2769 156 virtual void lineCodingChanged(int baud, int bits, int parity, int stop){
mbed_official 15:849c0c0f2769 157 if (settingsChangedCallback) {
mbed_official 15:849c0c0f2769 158 settingsChangedCallback(baud, bits, parity, stop);
mbed_official 15:849c0c0f2769 159 }
mbed_official 15:849c0c0f2769 160 }
samux 1:80ab0d068708 161
samux 1:80ab0d068708 162 private:
Kojto 70:2c525a50f1b6 163 Callback<void()> rx;
mbed_official 51:deafa44182d9 164 CircBuffer<uint8_t,128> buf;
mbed_official 15:849c0c0f2769 165 void (*settingsChangedCallback)(int baud, int bits, int parity, int stop);
samux 1:80ab0d068708 166 };
samux 1:80ab0d068708 167
samux 1:80ab0d068708 168 #endif