Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
drv/serial/buf/SerialBuf.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 SERIALBUF_H |
| donatien | 0:632c9925f013 | 25 | #define SERIALBUF_H |
| donatien | 0:632c9925f013 | 26 | |
| donatien | 0:632c9925f013 | 27 | #include "mbed.h" |
| donatien | 0:632c9925f013 | 28 | #include "netCfg.h" |
| donatien | 0:632c9925f013 | 29 | #if NET_USB_SERIAL |
| donatien | 0:632c9925f013 | 30 | #include "drv/serial/usb/UsbSerial.h" |
| donatien | 0:632c9925f013 | 31 | #endif |
| donatien | 0:632c9925f013 | 32 | |
| donatien | 0:632c9925f013 | 33 | class SerialBuf |
| donatien | 0:632c9925f013 | 34 | { |
| donatien | 0:632c9925f013 | 35 | public: |
| donatien | 0:632c9925f013 | 36 | SerialBuf(int len); //Buffer length |
| donatien | 0:632c9925f013 | 37 | ~SerialBuf(); |
| donatien | 0:632c9925f013 | 38 | |
| donatien | 0:632c9925f013 | 39 | void attach(Serial* pSerial); |
| donatien | 0:632c9925f013 | 40 | void detach(); |
| donatien | 0:632c9925f013 | 41 | |
| donatien | 0:632c9925f013 | 42 | #if NET_USB_SERIAL |
| donatien | 0:632c9925f013 | 43 | void attach(UsbSerial* pUsbSerial); |
| donatien | 0:632c9925f013 | 44 | #endif |
| donatien | 0:632c9925f013 | 45 | |
| donatien | 0:632c9925f013 | 46 | //Really useful for debugging |
| donatien | 0:632c9925f013 | 47 | char getc(); |
| donatien | 0:632c9925f013 | 48 | void putc(char c); |
| donatien | 0:632c9925f013 | 49 | bool readable(); |
| donatien | 0:632c9925f013 | 50 | bool writeable(); |
| donatien | 0:632c9925f013 | 51 | /*protected:*/ |
| donatien | 0:632c9925f013 | 52 | void setReadMode(bool readMode); //If true, keeps chars in buf when read, false by default |
| donatien | 0:632c9925f013 | 53 | void flushRead(); //Delete chars that have been read & return chars len (only useful with readMode = true) |
| donatien | 0:632c9925f013 | 54 | void resetRead(); //Go back to initial read position & return chars len (only useful with readMode = true) |
| donatien | 0:632c9925f013 | 55 | protected: |
| donatien | 0:632c9925f013 | 56 | virtual bool onRead();// = 0; //Called when new bytes are received : WARN: executed in an interrupt context >> only fast & non-blocking code (eg no printf;)) |
| donatien | 0:632c9925f013 | 57 | //return true if handled, false otherwise |
| donatien | 0:632c9925f013 | 58 | private: |
| donatien | 0:632c9925f013 | 59 | void onSerialInterrupt(); //Callback from m_pSerial |
| donatien | 0:632c9925f013 | 60 | |
| donatien | 0:632c9925f013 | 61 | volatile bool m_trmt; //For debugging (Was transmitting?) |
| donatien | 0:632c9925f013 | 62 | |
| donatien | 0:632c9925f013 | 63 | Serial* m_pSerial; //Not owned |
| donatien | 0:632c9925f013 | 64 | |
| donatien | 0:632c9925f013 | 65 | char get(); //Get a char from buf |
| donatien | 0:632c9925f013 | 66 | void put(char c); //Put a char in buf |
| donatien | 0:632c9925f013 | 67 | int room(); //Return room available in buf |
| donatien | 0:632c9925f013 | 68 | int len(); //Return chars len in buf |
| donatien | 0:632c9925f013 | 69 | |
| donatien | 0:632c9925f013 | 70 | char* m_buf; |
| donatien | 0:632c9925f013 | 71 | int m_bufLen; |
| donatien | 0:632c9925f013 | 72 | volatile char* m_pReadStart; |
| donatien | 0:632c9925f013 | 73 | volatile char* m_pRead; |
| donatien | 0:632c9925f013 | 74 | |
| donatien | 0:632c9925f013 | 75 | volatile char* m_pReadByInt; //Chars read during interrupt |
| donatien | 0:632c9925f013 | 76 | volatile bool m_intCanReadData; |
| donatien | 0:632c9925f013 | 77 | |
| donatien | 0:632c9925f013 | 78 | volatile char* m_pWrite; |
| donatien | 0:632c9925f013 | 79 | volatile bool m_readMode; |
| donatien | 0:632c9925f013 | 80 | |
| donatien | 0:632c9925f013 | 81 | #if NET_USB_SERIAL |
| donatien | 0:632c9925f013 | 82 | //USB Serial Impl |
| donatien | 0:632c9925f013 | 83 | UsbSerial* m_pUsbSerial; //Not owned |
| donatien | 0:632c9925f013 | 84 | Ticker m_usbTick; |
| donatien | 0:632c9925f013 | 85 | #endif |
| donatien | 0:632c9925f013 | 86 | }; |
| donatien | 0:632c9925f013 | 87 | |
| donatien | 0:632c9925f013 | 88 | |
| donatien | 0:632c9925f013 | 89 | #endif |