Fred Parker / Mbed 2 deprecated Official_mBot

The preloaded firmware shipped on the mBot.

Dependencies:   mbed

Please use the version of this project/repo found at: http://developer.mbed.org/teams/Outrageous-Circuits/code/Official_mBot/

USBDevice/USBSerial/USBSerial.h@1:ffd9a51e7d35, 2014-11-25 (annotated)

Committer:
jeffknaggs
Date:
Tue Nov 25 14:49:40 2014 +0000
Revision:
1:ffd9a51e7d35
Parent:
0:865d42c46692 
Initial commit.

Who changed what in which revision?

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