bump version numbers to 1.7.0 and updated changelog
[deb_libcec.git] / src / lib / platform / sockets / serialport.h
CommitLineData
b9187cc6 1#pragma once
b9187cc6 2/*
f7febb0e
LOK
3 * This file is part of the libCEC(R) library.
4 *
b492c10e 5 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
f7febb0e
LOK
6 * libCEC(R) is an original work, containing original code.
7 *
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 *
10 * This program is dual-licensed; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
b9187cc6 13 * (at your option) any later version.
f7febb0e
LOK
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 *
24 *
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
27 *
28 * For more information contact:
29 * Pulse-Eight Licensing <license@pulse-eight.com>
30 * http://www.pulse-eight.com/
31 * http://www.pulse-eight.net/
b9187cc6
LOK
32 */
33
f00ff009 34#include "../os.h"
ba65909d
LOK
35#include "../util/buffer.h"
36
b9187cc6 37#include <string>
b9187cc6
LOK
38#include <stdint.h>
39
ba65909d 40#if !defined(__WINDOWS__)
b9187cc6 41#include <termios.h>
b9187cc6
LOK
42#endif
43
24048d57
LOK
44#include "socket.h"
45
f00ff009 46namespace PLATFORM
b9187cc6 47{
99666519
LOK
48 enum SerialParity
49 {
50 SERIAL_PARITY_NONE = 0,
51 SERIAL_PARITY_EVEN,
52 SERIAL_PARITY_ODD
53 };
54
55 enum SerialStopBits
56 {
57 SERIAL_STOP_BITS_ONE = 1,
58 SERIAL_STOP_BITS_TWO = 2
59 };
60
61 enum SerialDataBits
62 {
63 SERIAL_DATA_BITS_FIVE = 5,
64 SERIAL_DATA_BITS_SIX = 6,
65 SERIAL_DATA_BITS_SEVEN = 7,
66 SERIAL_DATA_BITS_EIGHT = 8
67 };
b9187cc6 68
99666519 69 class CSerialSocket : public CCommonSocket<serial_socket_t>
b9187cc6
LOK
70 {
71 public:
99666519
LOK
72 CSerialSocket(const CStdString &strName, uint32_t iBaudrate, SerialDataBits iDatabits = SERIAL_DATA_BITS_EIGHT, SerialStopBits iStopbits = SERIAL_STOP_BITS_ONE, SerialParity iParity = SERIAL_PARITY_NONE) :
73 CCommonSocket<serial_socket_t>(INVALID_SERIAL_SOCKET_VALUE, strName),
251eb3e8
LOK
74 #ifdef __WINDOWS__
75 m_iCurrentReadTimeout(MAXDWORD),
76 #endif
99666519
LOK
77 m_bIsOpen(false),
78 m_iBaudrate(iBaudrate),
79 m_iDatabits(iDatabits),
80 m_iStopbits(iStopbits),
81 m_iParity(iParity) {}
b9187cc6 82
48c4128d 83 virtual ~CSerialSocket(void) { Close(); }
b9187cc6 84
99666519
LOK
85 virtual bool Open(uint64_t iTimeoutMs = 0);
86 virtual void Close(void);
87 virtual void Shutdown(void);
88 virtual ssize_t Write(void* data, size_t len);
89 virtual ssize_t Read(void* data, size_t len, uint64_t iTimeoutMs = 0);
90
91 virtual bool IsOpen(void)
ba65909d 92 {
99666519
LOK
93 return m_socket != INVALID_SERIAL_SOCKET_VALUE &&
94 m_bIsOpen;
ba65909d 95 }
b9187cc6 96
99666519 97 virtual bool SetBaudRate(uint32_t baudrate);
24048d57 98
99666519
LOK
99 protected:
100 #ifndef __WINDOWS__
101 struct termios m_options;
251eb3e8
LOK
102 #else
103 bool SetTimeouts(serial_socket_t socket, int* iError, DWORD iTimeoutMs);
104 DWORD m_iCurrentReadTimeout;
99666519 105 #endif
b1f50952 106
99666519
LOK
107 bool m_bIsOpen;
108 uint32_t m_iBaudrate;
109 SerialDataBits m_iDatabits;
110 SerialStopBits m_iStopbits;
111 SerialParity m_iParity;
112 };
b9187cc6 113
99666519
LOK
114 class CSerialPort : public CProtectedSocket<CSerialSocket>
115 {
116 public:
117 CSerialPort(const CStdString &strName, uint32_t iBaudrate, SerialDataBits iDatabits = SERIAL_DATA_BITS_EIGHT, SerialStopBits iStopbits = SERIAL_STOP_BITS_ONE, SerialParity iParity = SERIAL_PARITY_NONE) :
118 CProtectedSocket<CSerialSocket> (new CSerialSocket(strName, iBaudrate, iDatabits, iStopbits, iParity)) {}
119 virtual ~CSerialPort(void) {}
b9187cc6
LOK
120 };
121};