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