Hexley Ball
NetTribute library with debug turned on in FShandler Donatien Garner -> Segundo Equipo -> this version
drv/serial/buf/SerialBuf.h@0:281d6ff68967, 2010-11-19 (annotated)
- Committer:
- hexley
- Date:
- Fri Nov 19 01:54:45 2010 +0000
- Revision:
- 0:281d6ff68967
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| hexley | 0:281d6ff68967 | 1 | |
| hexley | 0:281d6ff68967 | 2 | /* |
| hexley | 0:281d6ff68967 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| hexley | 0:281d6ff68967 | 4 | |
| hexley | 0:281d6ff68967 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| hexley | 0:281d6ff68967 | 6 | of this software and associated documentation files (the "Software"), to deal |
| hexley | 0:281d6ff68967 | 7 | in the Software without restriction, including without limitation the rights |
| hexley | 0:281d6ff68967 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| hexley | 0:281d6ff68967 | 9 | copies of the Software, and to permit persons to whom the Software is |
| hexley | 0:281d6ff68967 | 10 | furnished to do so, subject to the following conditions: |
| hexley | 0:281d6ff68967 | 11 | |
| hexley | 0:281d6ff68967 | 12 | The above copyright notice and this permission notice shall be included in |
| hexley | 0:281d6ff68967 | 13 | all copies or substantial portions of the Software. |
| hexley | 0:281d6ff68967 | 14 | |
| hexley | 0:281d6ff68967 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| hexley | 0:281d6ff68967 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| hexley | 0:281d6ff68967 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| hexley | 0:281d6ff68967 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| hexley | 0:281d6ff68967 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| hexley | 0:281d6ff68967 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| hexley | 0:281d6ff68967 | 21 | THE SOFTWARE. |
| hexley | 0:281d6ff68967 | 22 | */ |
| hexley | 0:281d6ff68967 | 23 | |
| hexley | 0:281d6ff68967 | 24 | #ifndef SERIALBUF_H |
| hexley | 0:281d6ff68967 | 25 | #define SERIALBUF_H |
| hexley | 0:281d6ff68967 | 26 | |
| hexley | 0:281d6ff68967 | 27 | #include "mbed.h" |
| hexley | 0:281d6ff68967 | 28 | #include "netCfg.h" |
| hexley | 0:281d6ff68967 | 29 | #if NET_USB_SERIAL |
| hexley | 0:281d6ff68967 | 30 | #include "drv/serial/usb/UsbSerial.h" |
| hexley | 0:281d6ff68967 | 31 | #endif |
| hexley | 0:281d6ff68967 | 32 | |
| hexley | 0:281d6ff68967 | 33 | class SerialCircularBuf |
| hexley | 0:281d6ff68967 | 34 | { |
| hexley | 0:281d6ff68967 | 35 | public: |
| hexley | 0:281d6ff68967 | 36 | SerialCircularBuf(int len); |
| hexley | 0:281d6ff68967 | 37 | ~SerialCircularBuf(); |
| hexley | 0:281d6ff68967 | 38 | |
| hexley | 0:281d6ff68967 | 39 | int room(); |
| hexley | 0:281d6ff68967 | 40 | int len(); |
| hexley | 0:281d6ff68967 | 41 | |
| hexley | 0:281d6ff68967 | 42 | void write(char c); |
| hexley | 0:281d6ff68967 | 43 | char read(); |
| hexley | 0:281d6ff68967 | 44 | |
| hexley | 0:281d6ff68967 | 45 | void setReadMode(bool readMode); //If true, keeps chars in buf when read, false by default |
| hexley | 0:281d6ff68967 | 46 | void flushRead(); //Delete chars that have been read & return chars len (only useful with readMode = true) |
| hexley | 0:281d6ff68967 | 47 | void resetRead(); //Go back to initial read position & return chars len (only useful with readMode = true) |
| hexley | 0:281d6ff68967 | 48 | |
| hexley | 0:281d6ff68967 | 49 | private: |
| hexley | 0:281d6ff68967 | 50 | char* m_buf; |
| hexley | 0:281d6ff68967 | 51 | int m_len; |
| hexley | 0:281d6ff68967 | 52 | |
| hexley | 0:281d6ff68967 | 53 | volatile char* m_pReadStart; |
| hexley | 0:281d6ff68967 | 54 | volatile char* m_pRead; |
| hexley | 0:281d6ff68967 | 55 | volatile char* m_pWrite; |
| hexley | 0:281d6ff68967 | 56 | volatile bool m_readMode; |
| hexley | 0:281d6ff68967 | 57 | }; |
| hexley | 0:281d6ff68967 | 58 | |
| hexley | 0:281d6ff68967 | 59 | class SerialBuf |
| hexley | 0:281d6ff68967 | 60 | { |
| hexley | 0:281d6ff68967 | 61 | public: |
| hexley | 0:281d6ff68967 | 62 | SerialBuf(int len); //Buffer length |
| hexley | 0:281d6ff68967 | 63 | virtual ~SerialBuf(); |
| hexley | 0:281d6ff68967 | 64 | |
| hexley | 0:281d6ff68967 | 65 | void attach(Serial* pSerial); |
| hexley | 0:281d6ff68967 | 66 | void detach(); |
| hexley | 0:281d6ff68967 | 67 | |
| hexley | 0:281d6ff68967 | 68 | #if NET_USB_SERIAL |
| hexley | 0:281d6ff68967 | 69 | void attach(UsbSerial* pUsbSerial); |
| hexley | 0:281d6ff68967 | 70 | #endif |
| hexley | 0:281d6ff68967 | 71 | |
| hexley | 0:281d6ff68967 | 72 | //Really useful for debugging |
| hexley | 0:281d6ff68967 | 73 | char getc(); |
| hexley | 0:281d6ff68967 | 74 | void putc(char c); |
| hexley | 0:281d6ff68967 | 75 | bool readable(); |
| hexley | 0:281d6ff68967 | 76 | bool writeable(); |
| hexley | 0:281d6ff68967 | 77 | /*protected:*/ |
| hexley | 0:281d6ff68967 | 78 | void setReadMode(bool readMode); //If true, keeps chars in buf when read, false by default |
| hexley | 0:281d6ff68967 | 79 | void flushRead(); //Delete chars that have been read & return chars len (only useful with readMode = true) |
| hexley | 0:281d6ff68967 | 80 | void resetRead(); //Go back to initial read position & return chars len (only useful with readMode = true) |
| hexley | 0:281d6ff68967 | 81 | |
| hexley | 0:281d6ff68967 | 82 | private: |
| hexley | 0:281d6ff68967 | 83 | void onRxInterrupt(); //Callback from m_pSerial |
| hexley | 0:281d6ff68967 | 84 | void onTxInterrupt(); //Callback from m_pSerial |
| hexley | 0:281d6ff68967 | 85 | |
| hexley | 0:281d6ff68967 | 86 | SerialCircularBuf m_rxBuf; |
| hexley | 0:281d6ff68967 | 87 | SerialCircularBuf m_txBuf; |
| hexley | 0:281d6ff68967 | 88 | |
| hexley | 0:281d6ff68967 | 89 | Serial* m_pSerial; //Not owned |
| hexley | 0:281d6ff68967 | 90 | |
| hexley | 0:281d6ff68967 | 91 | #if NET_USB_SERIAL |
| hexley | 0:281d6ff68967 | 92 | //USB Serial Impl |
| hexley | 0:281d6ff68967 | 93 | UsbSerial* m_pUsbSerial; //Not owned |
| hexley | 0:281d6ff68967 | 94 | //Ticker m_usbTick; |
| hexley | 0:281d6ff68967 | 95 | #endif |
| hexley | 0:281d6ff68967 | 96 | }; |
| hexley | 0:281d6ff68967 | 97 | |
| hexley | 0:281d6ff68967 | 98 | |
| hexley | 0:281d6ff68967 | 99 | #endif |