Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/drv/serial/usb/UsbSerial.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Michael J. Spencer 1:f5ac63519541 1
Michael J. Spencer 1:f5ac63519541 2 /*
Michael J. Spencer 1:f5ac63519541 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
Michael J. Spencer 1:f5ac63519541 4
Michael J. Spencer 1:f5ac63519541 5 Permission is hereby granted, free of charge, to any person obtaining a copy
Michael J. Spencer 1:f5ac63519541 6 of this software and associated documentation files (the "Software"), to deal
Michael J. Spencer 1:f5ac63519541 7 in the Software without restriction, including without limitation the rights
Michael J. Spencer 1:f5ac63519541 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
Michael J. Spencer 1:f5ac63519541 9 copies of the Software, and to permit persons to whom the Software is
Michael J. Spencer 1:f5ac63519541 10 furnished to do so, subject to the following conditions:
Michael J. Spencer 1:f5ac63519541 11
Michael J. Spencer 1:f5ac63519541 12 The above copyright notice and this permission notice shall be included in
Michael J. Spencer 1:f5ac63519541 13 all copies or substantial portions of the Software.
Michael J. Spencer 1:f5ac63519541 14
Michael J. Spencer 1:f5ac63519541 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Michael J. Spencer 1:f5ac63519541 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Michael J. Spencer 1:f5ac63519541 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Michael J. Spencer 1:f5ac63519541 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Michael J. Spencer 1:f5ac63519541 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Michael J. Spencer 1:f5ac63519541 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
Michael J. Spencer 1:f5ac63519541 21 THE SOFTWARE.
Michael J. Spencer 1:f5ac63519541 22 */
Michael J. Spencer 1:f5ac63519541 23
Michael J. Spencer 1:f5ac63519541 24 #ifndef USB_SERIAL_H
Michael J. Spencer 1:f5ac63519541 25 #define USB_SERIAL_H
Michael J. Spencer 1:f5ac63519541 26
Michael J. Spencer 1:f5ac63519541 27 //DG 2010
Michael J. Spencer 1:f5ac63519541 28 //Essentially a clone of Serial if
Michael J. Spencer 1:f5ac63519541 29 #include "Stream.h"
Michael J. Spencer 1:f5ac63519541 30 #include "mbed.h"
Michael J. Spencer 1:f5ac63519541 31
Michael J. Spencer 1:f5ac63519541 32 #include "drv/usb/UsbDevice.h"
Michael J. Spencer 1:f5ac63519541 33 #include "drv/usb/UsbEndpoint.h"
Michael J. Spencer 1:f5ac63519541 34
Michael J. Spencer 1:f5ac63519541 35 namespace mbed {
Michael J. Spencer 1:f5ac63519541 36
Michael J. Spencer 1:f5ac63519541 37 class UsbSerial : public Stream {
Michael J. Spencer 1:f5ac63519541 38
Michael J. Spencer 1:f5ac63519541 39 public:
Michael J. Spencer 1:f5ac63519541 40
Michael J. Spencer 1:f5ac63519541 41 UsbSerial(UsbDevice* pDevice, int epIn, int epOut, const char* name = NULL);
Michael J. Spencer 1:f5ac63519541 42 virtual ~UsbSerial();
Michael J. Spencer 1:f5ac63519541 43 //Apart from the ctor/dtor, exactly the same protos as Serial
Michael J. Spencer 1:f5ac63519541 44
Michael J. Spencer 1:f5ac63519541 45 void baud(int baudrate);
Michael J. Spencer 1:f5ac63519541 46
Michael J. Spencer 1:f5ac63519541 47 enum Parity {
Michael J. Spencer 1:f5ac63519541 48 None = 0,
Michael J. Spencer 1:f5ac63519541 49 Odd = 1,
Michael J. Spencer 1:f5ac63519541 50 Even = 2,
Michael J. Spencer 1:f5ac63519541 51 Forced1 = 3,
Michael J. Spencer 1:f5ac63519541 52 Forced0 = 4
Michael J. Spencer 1:f5ac63519541 53 };
Michael J. Spencer 1:f5ac63519541 54
Michael J. Spencer 1:f5ac63519541 55 enum IrqType {
Michael J. Spencer 1:f5ac63519541 56 RxIrq = 0
Michael J. Spencer 1:f5ac63519541 57 , TxIrq
Michael J. Spencer 1:f5ac63519541 58 };
Michael J. Spencer 1:f5ac63519541 59
Michael J. Spencer 1:f5ac63519541 60 void format(int bits, int parity, int stop);
Michael J. Spencer 1:f5ac63519541 61
Michael J. Spencer 1:f5ac63519541 62 class CDummy;
Michael J. Spencer 1:f5ac63519541 63 template <class T>
Michael J. Spencer 1:f5ac63519541 64 void attach(T* pCbItem, void (T::*pCbMeth)(), IrqType type = RxIrq)
Michael J. Spencer 1:f5ac63519541 65 {
Michael J. Spencer 1:f5ac63519541 66 if(type == RxIrq)
Michael J. Spencer 1:f5ac63519541 67 {
Michael J. Spencer 1:f5ac63519541 68 m_pInCbItem = (CDummy*) pCbItem;
Michael J. Spencer 1:f5ac63519541 69 m_pInCbMeth = (void (CDummy::*)()) pCbMeth;
Michael J. Spencer 1:f5ac63519541 70 }
Michael J. Spencer 1:f5ac63519541 71 else
Michael J. Spencer 1:f5ac63519541 72 {
Michael J. Spencer 1:f5ac63519541 73 m_pOutCbItem = (CDummy*) pCbItem;
Michael J. Spencer 1:f5ac63519541 74 m_pOutCbMeth = (void (CDummy::*)()) pCbMeth;
Michael J. Spencer 1:f5ac63519541 75 }
Michael J. Spencer 1:f5ac63519541 76 }
Michael J. Spencer 1:f5ac63519541 77
Michael J. Spencer 1:f5ac63519541 78 #if 0 // Inhereted from Stream, for documentation only
Michael J. Spencer 1:f5ac63519541 79
Michael J. Spencer 1:f5ac63519541 80 /* Function: putc
Michael J. Spencer 1:f5ac63519541 81 * Write a character
Michael J. Spencer 1:f5ac63519541 82 *
Michael J. Spencer 1:f5ac63519541 83 * Variables:
Michael J. Spencer 1:f5ac63519541 84 * c - The character to write to the serial port
Michael J. Spencer 1:f5ac63519541 85 */
Michael J. Spencer 1:f5ac63519541 86 int putc(int c);
Michael J. Spencer 1:f5ac63519541 87
Michael J. Spencer 1:f5ac63519541 88 /* Function: getc
Michael J. Spencer 1:f5ac63519541 89 * Read a character
Michael J. Spencer 1:f5ac63519541 90 *
Michael J. Spencer 1:f5ac63519541 91 * Variables:
Michael J. Spencer 1:f5ac63519541 92 * returns - The character read from the serial port
Michael J. Spencer 1:f5ac63519541 93 */
Michael J. Spencer 1:f5ac63519541 94 int getc();
Michael J. Spencer 1:f5ac63519541 95
Michael J. Spencer 1:f5ac63519541 96 /* Function: printf
Michael J. Spencer 1:f5ac63519541 97 * Write a formated string
Michael J. Spencer 1:f5ac63519541 98 *
Michael J. Spencer 1:f5ac63519541 99 * Variables:
Michael J. Spencer 1:f5ac63519541 100 * format - A printf-style format string, followed by the
Michael J. Spencer 1:f5ac63519541 101 * variables to use in formating the string.
Michael J. Spencer 1:f5ac63519541 102 */
Michael J. Spencer 1:f5ac63519541 103 int printf(const char* format, ...);
Michael J. Spencer 1:f5ac63519541 104
Michael J. Spencer 1:f5ac63519541 105 /* Function: scanf
Michael J. Spencer 1:f5ac63519541 106 * Read a formated string
Michael J. Spencer 1:f5ac63519541 107 *
Michael J. Spencer 1:f5ac63519541 108 * Variables:
Michael J. Spencer 1:f5ac63519541 109 * format - A scanf-style format string,
Michael J. Spencer 1:f5ac63519541 110 * followed by the pointers to variables to store the results.
Michael J. Spencer 1:f5ac63519541 111 */
Michael J. Spencer 1:f5ac63519541 112 int scanf(const char* format, ...);
Michael J. Spencer 1:f5ac63519541 113
Michael J. Spencer 1:f5ac63519541 114 #endif
Michael J. Spencer 1:f5ac63519541 115
Michael J. Spencer 1:f5ac63519541 116 /* Function: readable
Michael J. Spencer 1:f5ac63519541 117 * Determine if there is a character available to read
Michael J. Spencer 1:f5ac63519541 118 *
Michael J. Spencer 1:f5ac63519541 119 * Variables:
Michael J. Spencer 1:f5ac63519541 120 * returns - 1 if there is a character available to read, else 0
Michael J. Spencer 1:f5ac63519541 121 */
Michael J. Spencer 1:f5ac63519541 122 int readable();
Michael J. Spencer 1:f5ac63519541 123
Michael J. Spencer 1:f5ac63519541 124 /* Function: writeable
Michael J. Spencer 1:f5ac63519541 125 * Determine if there is space available to write a character
Michael J. Spencer 1:f5ac63519541 126 *
Michael J. Spencer 1:f5ac63519541 127 * Variables:
Michael J. Spencer 1:f5ac63519541 128 * returns - 1 if there is space to write a character, else 0
Michael J. Spencer 1:f5ac63519541 129 */
Michael J. Spencer 1:f5ac63519541 130 int writeable();
Michael J. Spencer 1:f5ac63519541 131
Michael J. Spencer 1:f5ac63519541 132 #ifdef MBED_RPC
Michael J. Spencer 1:f5ac63519541 133 virtual const struct rpc_method *get_rpc_methods();
Michael J. Spencer 1:f5ac63519541 134 static struct rpc_class *get_rpc_class();
Michael J. Spencer 1:f5ac63519541 135 #endif
Michael J. Spencer 1:f5ac63519541 136
Michael J. Spencer 1:f5ac63519541 137 protected:
Michael J. Spencer 1:f5ac63519541 138
Michael J. Spencer 1:f5ac63519541 139 virtual int _getc();
Michael J. Spencer 1:f5ac63519541 140 virtual int _putc(int c);
Michael J. Spencer 1:f5ac63519541 141
Michael J. Spencer 1:f5ac63519541 142 void onReadable();
Michael J. Spencer 1:f5ac63519541 143 void onWriteable();
Michael J. Spencer 1:f5ac63519541 144
Michael J. Spencer 1:f5ac63519541 145 void onEpInTransfer();
Michael J. Spencer 1:f5ac63519541 146 void onEpOutTransfer();
Michael J. Spencer 1:f5ac63519541 147
Michael J. Spencer 1:f5ac63519541 148 private:
Michael J. Spencer 1:f5ac63519541 149
Michael J. Spencer 1:f5ac63519541 150 UsbEndpoint m_epIn;
Michael J. Spencer 1:f5ac63519541 151 UsbEndpoint m_epOut;
Michael J. Spencer 1:f5ac63519541 152
Michael J. Spencer 1:f5ac63519541 153 CDummy* m_pInCbItem;
Michael J. Spencer 1:f5ac63519541 154 void (CDummy::*m_pInCbMeth)();
Michael J. Spencer 1:f5ac63519541 155
Michael J. Spencer 1:f5ac63519541 156 CDummy* m_pOutCbItem;
Michael J. Spencer 1:f5ac63519541 157 void (CDummy::*m_pOutCbMeth)();
Michael J. Spencer 1:f5ac63519541 158
Michael J. Spencer 1:f5ac63519541 159 void startTx();
Michael J. Spencer 1:f5ac63519541 160 void startRx();
Michael J. Spencer 1:f5ac63519541 161
Michael J. Spencer 1:f5ac63519541 162 Timeout m_txTimeout;
Michael J. Spencer 1:f5ac63519541 163 volatile bool m_timeout;
Michael J. Spencer 1:f5ac63519541 164
Michael J. Spencer 1:f5ac63519541 165 volatile char* m_inBufEven;
Michael J. Spencer 1:f5ac63519541 166 volatile char* m_inBufOdd;
Michael J. Spencer 1:f5ac63519541 167 volatile char* m_inBufUsr;
Michael J. Spencer 1:f5ac63519541 168 volatile char* m_inBufTrmt;
Michael J. Spencer 1:f5ac63519541 169
Michael J. Spencer 1:f5ac63519541 170 volatile char* m_outBufEven;
Michael J. Spencer 1:f5ac63519541 171 volatile char* m_outBufOdd;
Michael J. Spencer 1:f5ac63519541 172 volatile char* m_outBufUsr;
Michael J. Spencer 1:f5ac63519541 173 volatile char* m_outBufTrmt;
Michael J. Spencer 1:f5ac63519541 174
Michael J. Spencer 1:f5ac63519541 175 volatile int m_inBufLen;
Michael J. Spencer 1:f5ac63519541 176 volatile int m_outBufLen;
Michael J. Spencer 1:f5ac63519541 177
Michael J. Spencer 1:f5ac63519541 178 volatile char* m_pInBufPos;
Michael J. Spencer 1:f5ac63519541 179 volatile char* m_pOutBufPos;
Michael J. Spencer 1:f5ac63519541 180
Michael J. Spencer 1:f5ac63519541 181
Michael J. Spencer 1:f5ac63519541 182
Michael J. Spencer 1:f5ac63519541 183 };
Michael J. Spencer 1:f5ac63519541 184
Michael J. Spencer 1:f5ac63519541 185 }
Michael J. Spencer 1:f5ac63519541 186
Michael J. Spencer 1:f5ac63519541 187
Michael J. Spencer 1:f5ac63519541 188
Michael J. Spencer 1:f5ac63519541 189 #endif