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/buf/SerialBuf.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 SERIALBUF_H
Michael J. Spencer 1:f5ac63519541 25 #define SERIALBUF_H
Michael J. Spencer 1:f5ac63519541 26
Michael J. Spencer 1:f5ac63519541 27 #include "mbed.h"
Michael J. Spencer 1:f5ac63519541 28 #include "netCfg.h"
Michael J. Spencer 1:f5ac63519541 29 #if NET_USB_SERIAL
Michael J. Spencer 1:f5ac63519541 30 #include "drv/serial/usb/UsbSerial.h"
Michael J. Spencer 1:f5ac63519541 31 #endif
Michael J. Spencer 1:f5ac63519541 32
Michael J. Spencer 1:f5ac63519541 33 class SerialCircularBuf
Michael J. Spencer 1:f5ac63519541 34 {
Michael J. Spencer 1:f5ac63519541 35 public:
Michael J. Spencer 1:f5ac63519541 36 SerialCircularBuf(int len);
Michael J. Spencer 1:f5ac63519541 37 ~SerialCircularBuf();
Michael J. Spencer 1:f5ac63519541 38
Michael J. Spencer 1:f5ac63519541 39 int room();
Michael J. Spencer 1:f5ac63519541 40 int len();
Michael J. Spencer 1:f5ac63519541 41
Michael J. Spencer 1:f5ac63519541 42 void write(char c);
Michael J. Spencer 1:f5ac63519541 43 char read();
Michael J. Spencer 1:f5ac63519541 44
Michael J. Spencer 1:f5ac63519541 45 void setReadMode(bool readMode); //If true, keeps chars in buf when read, false by default
Michael J. Spencer 1:f5ac63519541 46 void flushRead(); //Delete chars that have been read & return chars len (only useful with readMode = true)
Michael J. Spencer 1:f5ac63519541 47 void resetRead(); //Go back to initial read position & return chars len (only useful with readMode = true)
Michael J. Spencer 1:f5ac63519541 48
Michael J. Spencer 1:f5ac63519541 49 private:
Michael J. Spencer 1:f5ac63519541 50 char* m_buf;
Michael J. Spencer 1:f5ac63519541 51 int m_len;
Michael J. Spencer 1:f5ac63519541 52
Michael J. Spencer 1:f5ac63519541 53 volatile char* m_pReadStart;
Michael J. Spencer 1:f5ac63519541 54 volatile char* m_pRead;
Michael J. Spencer 1:f5ac63519541 55 volatile char* m_pWrite;
Michael J. Spencer 1:f5ac63519541 56 volatile bool m_readMode;
Michael J. Spencer 1:f5ac63519541 57 };
Michael J. Spencer 1:f5ac63519541 58
Michael J. Spencer 1:f5ac63519541 59 class SerialBuf
Michael J. Spencer 1:f5ac63519541 60 {
Michael J. Spencer 1:f5ac63519541 61 public:
Michael J. Spencer 1:f5ac63519541 62 SerialBuf(int len); //Buffer length
Michael J. Spencer 1:f5ac63519541 63 virtual ~SerialBuf();
Michael J. Spencer 1:f5ac63519541 64
Michael J. Spencer 1:f5ac63519541 65 void attach(Serial* pSerial);
Michael J. Spencer 1:f5ac63519541 66 void detach();
Michael J. Spencer 1:f5ac63519541 67
Michael J. Spencer 1:f5ac63519541 68 #if NET_USB_SERIAL
Michael J. Spencer 1:f5ac63519541 69 void attach(UsbSerial* pUsbSerial);
Michael J. Spencer 1:f5ac63519541 70 #endif
Michael J. Spencer 1:f5ac63519541 71
Michael J. Spencer 1:f5ac63519541 72 //Really useful for debugging
Michael J. Spencer 1:f5ac63519541 73 char getc();
Michael J. Spencer 1:f5ac63519541 74 void putc(char c);
Michael J. Spencer 1:f5ac63519541 75 bool readable();
Michael J. Spencer 1:f5ac63519541 76 bool writeable();
Michael J. Spencer 1:f5ac63519541 77 /*protected:*/
Michael J. Spencer 1:f5ac63519541 78 void setReadMode(bool readMode); //If true, keeps chars in buf when read, false by default
Michael J. Spencer 1:f5ac63519541 79 void flushRead(); //Delete chars that have been read & return chars len (only useful with readMode = true)
Michael J. Spencer 1:f5ac63519541 80 void resetRead(); //Go back to initial read position & return chars len (only useful with readMode = true)
Michael J. Spencer 1:f5ac63519541 81
Michael J. Spencer 1:f5ac63519541 82 private:
Michael J. Spencer 1:f5ac63519541 83 void onRxInterrupt(); //Callback from m_pSerial
Michael J. Spencer 1:f5ac63519541 84 void onTxInterrupt(); //Callback from m_pSerial
Michael J. Spencer 1:f5ac63519541 85
Michael J. Spencer 1:f5ac63519541 86 SerialCircularBuf m_rxBuf;
Michael J. Spencer 1:f5ac63519541 87 SerialCircularBuf m_txBuf;
Michael J. Spencer 1:f5ac63519541 88
Michael J. Spencer 1:f5ac63519541 89 Serial* m_pSerial; //Not owned
Michael J. Spencer 1:f5ac63519541 90
Michael J. Spencer 1:f5ac63519541 91 #if NET_USB_SERIAL
Michael J. Spencer 1:f5ac63519541 92 //USB Serial Impl
Michael J. Spencer 1:f5ac63519541 93 UsbSerial* m_pUsbSerial; //Not owned
Michael J. Spencer 1:f5ac63519541 94 //Ticker m_usbTick;
Michael J. Spencer 1:f5ac63519541 95 #endif
Michael J. Spencer 1:f5ac63519541 96 };
Michael J. Spencer 1:f5ac63519541 97
Michael J. Spencer 1:f5ac63519541 98
Michael J. Spencer 1:f5ac63519541 99 #endif