4c4cb43fd3ec5bc1e394c198c4d07ee6d48ccb71
[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 class CAdapterPingThread;
49 class CUSBCECAdapterCommands;
50 class CCECAdapterMessageQueue;
51
52 class CUSBCECAdapterCommunication : public IAdapterCommunication, public PLATFORM::CThread
53 {
54 friend class CUSBCECAdapterCommands;
55 friend class CCECAdapterMessageQueue;
56
57 public:
58 /*!
59 * @brief Create a new USB-CEC communication handler.
60 * @param callback The callback to use for incoming CEC commands.
61 * @param strPort The name of the com port to use.
62 * @param iBaudRate The baudrate to use on the com port connection.
63 */
64 CUSBCECAdapterCommunication(IAdapterCommunicationCallback *callback, const char *strPort, uint16_t iBaudRate = 38400);
65 virtual ~CUSBCECAdapterCommunication(void);
66
67 /** @name IAdapterCommunication implementation */
68 ///{
69 bool Open(uint32_t iTimeoutMs = 10000, bool bSkipChecks = false, bool bStartListening = true);
70 void Close(void);
71 bool IsOpen(void);
72 CStdString GetError(void) const;
73 cec_adapter_message_state Write(const cec_command &data, bool &bRetry, uint8_t iLineTimeout = 3);
74
75 bool StartBootloader(void);
76 bool SetAckMask(uint16_t iMask);
77 bool PingAdapter(void);
78 uint16_t GetFirmwareVersion(void);
79 bool PersistConfiguration(libcec_configuration *configuration);
80 bool GetConfiguration(libcec_configuration *configuration);
81 CStdString GetPortName(void);
82 uint16_t GetPhysicalAddress(void) { return 0; }
83 bool SetControlledMode(bool controlled);
84 ///}
85
86 void *Process(void);
87
88 private:
89 /*!
90 * @brief Clear all input bytes.
91 * @param iTimeout Timeout when anything was received.
92 */
93 void ClearInputBytes(uint32_t iTimeout = 1000);
94
95 /*!
96 * @brief Change the current CEC line timeout.
97 * @param iTimeout The new timeout.
98 * @return True when acked by the controller, false otherwise.
99 */
100 bool SetLineTimeout(uint8_t iTimeout);
101
102 /*!
103 * @brief Send a command to the controller and wait for an ack.
104 * @param msgCode The command to send.
105 * @param params The parameters to the command.
106 * @param bIsRetry True when this command is being retried, false otherwise.
107 * @return The message. Delete when done with it.
108 */
109 CCECAdapterMessage *SendCommand(cec_adapter_messagecode msgCode, CCECAdapterMessage &params, bool bIsRetry = false);
110
111 /*!
112 * @brief Change the "initialised" status.
113 * @param bSetTo The new value.
114 */
115 void SetInitialised(bool bSetTo = true);
116
117 /*!
118 * @return True when initialised, false otherwise.
119 */
120 bool IsInitialised(void);
121
122 /*!
123 * @brief Pings the adapter, checks the firmware version and sets controlled mode.
124 * @param iTimeoutMs The timeout after which this fails if no proper data was received.
125 * @return True when the checks passed, false otherwise.
126 */
127 bool CheckAdapter(uint32_t iTimeoutMs = 10000);
128
129 /*!
130 * @brief Handle a poll message inside the adapter message (checks if one is present).
131 * @param msg The adapter message to parse.
132 * @return True when the message resulted in a CEC error, false otherwise.
133 */
134 bool HandlePoll(const CCECAdapterMessage &msg);
135
136 /*!
137 * @brief Read data from the device.
138 * @param iTimeout The read timeout to use.
139 * @param iSize The maximum read size.
140 * @return True when something was read, false otherwise.
141 */
142 bool ReadFromDevice(uint32_t iTimeout, size_t iSize = 256);
143
144 /*!
145 * @brief Writes a message to the serial port.
146 * @param message The message to write.
147 * @return True when written, false otherwise.
148 */
149 bool WriteToDevice(CCECAdapterMessage *message);
150
151 /*!
152 * @brief Called before sending a CEC command over the line, so we know we're expecting an ack.
153 * @param dest The destination of the CEC command.
154 */
155 void MarkAsWaiting(const cec_logical_address dest);
156
157 PLATFORM::ISocket * m_port; /**< the com port connection */
158 PLATFORM::CMutex m_mutex; /**< mutex for changes in this class */
159 uint8_t m_iLineTimeout; /**< the current line timeout on the CEC line */
160 cec_logical_address m_lastPollDestination; /**< the destination of the last poll message that was received */
161 bool m_bInitialised; /**< true when the connection is initialised, false otherwise */
162 bool m_bWaitingForAck[15]; /**< array in which we store from which devices we're expecting acks */
163 CAdapterPingThread * m_pingThread; /**< ping thread, that pings the adapter every 15 seconds */
164 CUSBCECAdapterCommands * m_commands; /**< commands that can be sent to the adapter */
165 CCECAdapterMessageQueue * m_adapterMessageQueue; /**< the incoming and outgoing message queue */
166 };
167
168 class CAdapterPingThread : public PLATFORM::CThread
169 {
170 public:
171 CAdapterPingThread(CUSBCECAdapterCommunication *com, uint32_t iTimeout) :
172 m_com(com),
173 m_timeout(iTimeout){}
174 virtual ~CAdapterPingThread(void) {}
175
176 virtual void* Process(void);
177 private:
178 CUSBCECAdapterCommunication *m_com;
179 PLATFORM::CTimeout m_timeout;
180 };
181 };