cec: sync C and .NET interfaces with C++
[deb_libcec.git] / src / lib / adapter / USBCECAdapterCommunication.h
1 #pragma once
2 /*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011-2012 Pulse-Eight Limited. All rights reserved.
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
13 * (at your option) any later version.
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/
32 */
33
34 #include "../../../include/cectypes.h"
35 #include "../platform/threads/threads.h"
36 #include "../platform/util/buffer.h"
37 #include "AdapterCommunication.h"
38 #include "USBCECAdapterMessage.h"
39
40 namespace PLATFORM
41 {
42 class ISocket;
43 }
44
45 namespace CEC
46 {
47 class CCECProcessor;
48
49 class CUSBCECAdapterCommunication : public IAdapterCommunication, private PLATFORM::CThread
50 {
51 public:
52 CUSBCECAdapterCommunication(CCECProcessor *processor, const char *strPort, uint16_t iBaudRate = 38400);
53 virtual ~CUSBCECAdapterCommunication() {};
54
55 virtual bool Open(IAdapterCommunicationCallback *cb, uint32_t iTimeoutMs = 10000, bool bSkipChecks = false, bool bStartListening = true);
56 virtual void Close(void);
57 virtual bool IsOpen(void);
58 virtual CStdString GetError(void) const;
59
60 bool Read(cec_command &command, uint32_t iTimeout);
61 cec_adapter_message_state Write(const cec_command &data, uint8_t iMaxTries, uint8_t iLineTimeout = 3, uint8_t iRetryLineTimeout = 3);
62
63 virtual bool SetLineTimeout(uint8_t iTimeout);
64 virtual bool StartBootloader(void);
65 virtual bool SetAckMask(uint16_t iMask);
66 virtual bool PingAdapter(void);
67 virtual uint16_t GetFirmwareVersion(void);
68 virtual bool SetControlledMode(bool controlled);
69 virtual bool PersistConfiguration(libcec_configuration *configuration);
70 virtual bool GetConfiguration(libcec_configuration *configuration);
71 virtual CStdString GetPortName(void);
72 virtual uint16_t GetPhysicalAddress(void) { return 0; }
73
74 void *Process(void);
75 private:
76 bool SendCommand(cec_adapter_messagecode msgCode, CCECAdapterMessage &params, bool bExpectAck = true, bool bIsTransmission = false, bool bSendDirectly = true, bool bIsRetry = false);
77 cec_datapacket GetSetting(cec_adapter_messagecode msgCode, uint8_t iResponseLength);
78
79 bool SetSettingAutoEnabled(bool enabled);
80 bool GetSettingAutoEnabled(bool &enabled);
81
82 bool SetSettingDeviceType(cec_device_type type);
83 bool GetSettingDeviceType(cec_device_type &type);
84
85 bool SetSettingDefaultLogicalAddress(cec_logical_address address);
86 bool GetSettingDefaultLogicalAddress(cec_logical_address &address);
87
88 bool SetSettingLogicalAddressMask(uint16_t iMask);
89 bool GetSettingLogicalAddressMask(uint16_t &iMask);
90
91 bool SetSettingPhysicalAddress(uint16_t iPhysicalAddress);
92 bool GetSettingPhysicalAddress(uint16_t &iPhysicalAddress);
93
94 bool SetSettingCECVersion(cec_version version);
95 bool GetSettingCECVersion(cec_version &version);
96
97 bool SetSettingOSDName(const char *strOSDName);
98 bool GetSettingOSDName(CStdString &strOSDName);
99
100 bool WriteEEPROM(void);
101
102 bool SetAckMaskInternal(uint16_t iMask, bool bWriteDirectly = false);
103
104 bool CheckAdapter(uint32_t iTimeoutMs = 10000);
105 bool Write(CCECAdapterMessage *data);
106 bool Read(CCECAdapterMessage &msg, uint32_t iTimeout = 1000);
107 bool ParseMessage(const CCECAdapterMessage &msg);
108 void SendMessageToAdapter(CCECAdapterMessage *msg);
109 void WriteNextCommand(void);
110 void AddData(uint8_t *data, size_t iLen);
111 bool ReadFromDevice(uint32_t iTimeout, size_t iSize = 256);
112 bool WaitForAck(CCECAdapterMessage &message);
113
114 PLATFORM::ISocket * m_port;
115 CCECProcessor * m_processor;
116 PLATFORM::SyncedBuffer<CCECAdapterMessage *> m_inBuffer;
117 PLATFORM::SyncedBuffer<CCECAdapterMessage *> m_outBuffer;
118 PLATFORM::CMutex m_mutex;
119 PLATFORM::CCondition<volatile bool> m_rcvCondition;
120 volatile bool m_bHasData;
121 uint8_t m_iLineTimeout;
122 uint16_t m_iFirmwareVersion;
123 cec_command m_currentframe;
124 cec_logical_address m_lastDestination;
125 CCECAdapterMessage m_currentAdapterMessage;
126 bool m_bNextIsEscaped;
127 bool m_bGotStart;
128 IAdapterCommunicationCallback * m_callback;
129 bool m_bInitialised;
130 bool m_bWaitingForAck[15];
131 };
132 };