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