8d1e2cb9ea5414848cfbe574a7679b5bf5e588a3
[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 CUSBCECAdapterProcessor: public PLATFORM::CThread
50 {
51 public:
52 CUSBCECAdapterProcessor(IAdapterCommunicationCallback *cb) :
53 m_callback(cb) {};
54 virtual ~CUSBCECAdapterProcessor(void)
55 {
56 StopThread();
57 }
58
59 void *Process(void);
60 void AddCommand(cec_command command);
61 private:
62 IAdapterCommunicationCallback * m_callback;
63 PLATFORM::SyncedBuffer<cec_command> m_inBuffer;
64 };
65
66 class CUSBCECAdapterCommunication : public IAdapterCommunication, private PLATFORM::CThread
67 {
68 public:
69 CUSBCECAdapterCommunication(CCECProcessor *processor, const char *strPort, uint16_t iBaudRate = 38400);
70 virtual ~CUSBCECAdapterCommunication();
71
72 virtual bool Open(IAdapterCommunicationCallback *cb, uint32_t iTimeoutMs = 10000, bool bSkipChecks = false);
73 virtual void Close(void);
74 virtual bool IsOpen(void);
75 virtual CStdString GetError(void) const;
76
77 bool Read(cec_command &command, uint32_t iTimeout);
78 cec_adapter_message_state Write(const cec_command &data, uint8_t iMaxTries, uint8_t iLineTimeout = 3, uint8_t iRetryLineTimeout = 3);
79
80 virtual bool SetLineTimeout(uint8_t iTimeout);
81 virtual bool StartBootloader(void);
82 virtual bool SetAckMask(uint16_t iMask);
83 virtual bool PingAdapter(void);
84 virtual uint16_t GetFirmwareVersion(void);
85 virtual bool SetControlledMode(bool controlled);
86 virtual bool PersistConfiguration(libcec_configuration *configuration);
87 virtual CStdString GetPortName(void);
88 virtual uint16_t GetPhysicalAddress(void) { return 0; }
89
90 void *Process(void);
91 private:
92 bool SetAutoEnabled(bool enabled);
93 bool SetDeviceType(cec_device_type type);
94 bool SetDefaultLogicalAddress(cec_logical_address address);
95 bool SetLogicalAddressMask(uint16_t iMask);
96 bool SetPhysicalAddress(uint16_t iPhysicalAddress);
97 bool SetCECVersion(cec_version version);
98 bool SetOSDName(const char *strOSDName);
99 bool WriteEEPROM(void);
100
101 bool SetAckMaskInternal(uint16_t iMask, bool bWriteDirectly = false);
102
103 bool CheckAdapter(uint32_t iTimeoutMs = 10000);
104 bool Write(CCECAdapterMessage *data);
105 bool Read(CCECAdapterMessage &msg, uint32_t iTimeout = 1000);
106 bool ParseMessage(const CCECAdapterMessage &msg);
107 void SendMessageToAdapter(CCECAdapterMessage *msg);
108 void WriteNextCommand(void);
109 void AddData(uint8_t *data, size_t iLen);
110 bool ReadFromDevice(uint32_t iTimeout, size_t iSize = 256);
111 bool WaitForAck(CCECAdapterMessage &message);
112
113 PLATFORM::ISocket * m_port;
114 CCECProcessor * m_processor;
115 PLATFORM::SyncedBuffer<CCECAdapterMessage *> m_inBuffer;
116 PLATFORM::SyncedBuffer<CCECAdapterMessage *> m_outBuffer;
117 PLATFORM::CMutex m_mutex;
118 PLATFORM::CCondition<volatile bool> m_rcvCondition;
119 volatile bool m_bHasData;
120 uint8_t m_iLineTimeout;
121 uint16_t m_iFirmwareVersion;
122 cec_command m_currentframe;
123 cec_logical_address m_lastInitiator;
124 CCECAdapterMessage m_currentAdapterMessage;
125 bool m_bNextIsEscaped;
126 bool m_bGotStart;
127 IAdapterCommunicationCallback * m_callback;
128 CUSBCECAdapterProcessor * m_messageProcessor;
129 bool m_bInitialised;
130 };
131 };