USB device stack (USBDevice::connect non-blocking)
Fork of USBDevice by
USBSerial.h
00001 /* Copyright (c) 2010-2011 mbed.org, MIT License 00002 * 00003 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software 00004 * and associated documentation files (the "Software"), to deal in the Software without 00005 * restriction, including without limitation the rights to use, copy, modify, merge, publish, 00006 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the 00007 * Software is furnished to do so, subject to the following conditions: 00008 * 00009 * The above copyright notice and this permission notice shall be included in all copies or 00010 * substantial portions of the Software. 00011 * 00012 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING 00013 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 00014 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 00015 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 00016 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 00017 */ 00018 00019 #ifndef USBSERIAL_H 00020 #define USBSERIAL_H 00021 00022 #include "USBCDC.h" 00023 #include "Stream.h" 00024 #include "CircBuffer.h" 00025 00026 00027 /** 00028 * USBSerial example 00029 * 00030 * @code 00031 * #include "mbed.h" 00032 * #include "USBSerial.h" 00033 * 00034 * //Virtual serial port over USB 00035 * USBSerial serial; 00036 * 00037 * int main(void) { 00038 * 00039 * while(1) 00040 * { 00041 * serial.printf("I am a virtual serial port\n"); 00042 * wait(1); 00043 * } 00044 * } 00045 * @endcode 00046 */ 00047 class USBSerial: public USBCDC, public Stream { 00048 public: 00049 00050 /** 00051 * Constructor 00052 * 00053 * @param vendor_id Your vendor_id (default: 0x1f00) 00054 * @param product_id Your product_id (default: 0x2012) 00055 * @param product_release Your preoduct_release (default: 0x0001) 00056 * 00057 */ 00058 USBSerial(uint16_t vendor_id = 0x1f00, uint16_t product_id = 0x2012, uint16_t product_release = 0x0001): USBCDC(vendor_id, product_id, product_release), buf(128){ 00059 settingsChangedCallback = 0; 00060 }; 00061 00062 00063 /** 00064 * Send a character. You can use puts, printf. 00065 * 00066 * @param c character to be sent 00067 * @returns true if there is no error, false otherwise 00068 */ 00069 virtual int _putc(int c); 00070 00071 /** 00072 * Read a character: blocking 00073 * 00074 * @returns character read 00075 */ 00076 virtual int _getc(); 00077 00078 /** 00079 * Check the number of bytes available. 00080 * 00081 * @returns the number of bytes available 00082 */ 00083 uint8_t available(); 00084 00085 /** Determine if there is a character available to read 00086 * 00087 * @returns 00088 * 1 if there is a character available to read, 00089 * 0 otherwise 00090 */ 00091 int readable() { return available() ? 1 : 0; } 00092 00093 /** Determine if there is space available to write a character 00094 * 00095 * @returns 00096 * 1 if there is space to write a character, 00097 * 0 otherwise 00098 */ 00099 int writeable() { return 1; } // always return 1, for write operation is blocking 00100 00101 /** 00102 * Write a block of data. 00103 * 00104 * For more efficiency, a block of size 64 (maximum size of a bulk endpoint) has to be written. 00105 * 00106 * @param buf pointer on data which will be written 00107 * @param size size of the buffer. The maximum size of a block is limited by the size of the endpoint (64 bytes) 00108 * 00109 * @returns true if successfull 00110 */ 00111 bool writeBlock(uint8_t * buf, uint16_t size); 00112 00113 /** 00114 * Attach a member function to call when a packet is received. 00115 * 00116 * @param tptr pointer to the object to call the member function on 00117 * @param mptr pointer to the member function to be called 00118 */ 00119 template<typename T> 00120 void attach(T* tptr, void (T::*mptr)(void)) { 00121 if((mptr != NULL) && (tptr != NULL)) { 00122 rx.attach(tptr, mptr); 00123 } 00124 } 00125 00126 /** 00127 * Attach a callback called when a packet is received 00128 * 00129 * @param fptr function pointer 00130 */ 00131 void attach(void (*fptr)(void)) { 00132 if(fptr != NULL) { 00133 rx.attach(fptr); 00134 } 00135 } 00136 00137 /** 00138 * Attach a callback to call when serial's settings are changed. 00139 * 00140 * @param fptr function pointer 00141 */ 00142 void attach(void (*fptr)(int baud, int bits, int parity, int stop)) { 00143 settingsChangedCallback = fptr; 00144 } 00145 00146 protected: 00147 virtual bool EP2_OUT_callback(); 00148 virtual void lineCodingChanged(int baud, int bits, int parity, int stop){ 00149 if (settingsChangedCallback) { 00150 settingsChangedCallback(baud, bits, parity, stop); 00151 } 00152 } 00153 00154 private: 00155 FunctionPointer rx; 00156 CircBuffer<uint8_t> buf; 00157 void (*settingsChangedCallback)(int baud, int bits, int parity, int stop); 00158 }; 00159 00160 #endif
Generated on Wed Jul 13 2022 19:47:50 by 1.7.2