YOSHIHISA TABUCHI / Mbed OS Host_Software_MAX32664GWEB_HR_EXTENDEDtest

test

Dependencies:   BMI160 max32630hsp3 MemoryLCD USBDevice

Drivers/USBDevice/USBSerial/USBSerial.h@0:ac4dea3e2894, 2019-03-18 (annotated)

Committer:
seyhmus.cacina
Date:
Mon Mar 18 10:21:53 2019 +0300
Revision:
0:ac4dea3e2894
ME11B Sample Code First Commit

Who changed what in which revision?

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