TEAMUSB / Mbed 2 deprecated SPI_Master_arch

SPI_Master_arch

Dependencies:   USBDevice mbed

Fork of SPI_HelloWorld_Mbed by mbed official

USBSerial.h@4:fb6fa24b502c, 2015-03-16 (annotated)

Committer:
armdran
Date:
Mon Mar 16 14:33:35 2015 +0000
Revision:
4:fb6fa24b502c
Parent:
3:849c7a28b185 
1

Who changed what in which revision?

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