src/lib/adapter/AdapterCommunication.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 <string>
  35
  36 namespace CEC
  37 {
  38   class CLibCEC;
  39
  40   typedef enum cec_adapter_message_state
  41   {
  42     ADAPTER_MESSAGE_STATE_UNKNOWN = 0,        /**< the initial state */
  43     ADAPTER_MESSAGE_STATE_WAITING_TO_BE_SENT, /**< waiting in the send queue of the adapter, or timed out */
  44     ADAPTER_MESSAGE_STATE_SENT,               /**< sent and waiting on an ACK */
  45     ADAPTER_MESSAGE_STATE_SENT_NOT_ACKED,     /**< sent, but failed to ACK */
  46     ADAPTER_MESSAGE_STATE_SENT_ACKED,         /**< sent, and ACK received */
  47     ADAPTER_MESSAGE_STATE_INCOMING,           /**< received from another device */
  48     ADAPTER_MESSAGE_STATE_ERROR               /**< an error occured */
  49   } cec_adapter_message_state;
  50
  51   class IAdapterCommunicationCallback
  52   {
  53   public:
  54     IAdapterCommunicationCallback(void) {}
  55     virtual ~IAdapterCommunicationCallback(void) {}
  56
  57     /*!
  58      * @brief Callback method for IAdapterCommunication, called when a new cec_command is received
  59      * @param command The command that has been received
  60      * @return True when it was handled by this listener, false otherwise.
  61      */
  62     virtual bool OnCommandReceived(const cec_command &command) = 0;
  63
  64     /*!
  65      * @brief Callback method for IAdapterCommunication, called when a poll was received.
  66      * @param initiator The initiator that sent the poll.
  67      * @param destination The destination of the poll message.
  68      */
  69     virtual void HandlePoll(cec_logical_address initiator, cec_logical_address destination) = 0;
  70
  71     /*!
  72      * @brief Callback method for IAdapterCommunication, called when a receive failed message was received.
  73      * @param initiator The initiator that sent the receive failed message.
  74      * @return True when this is an error, false otherwise.
  75      */
  76     virtual bool HandleReceiveFailed(cec_logical_address initiator) = 0;
  77
  78     /*!
  79      * @brief Callback method for IAdapterCommunication, called when a logical address that libCEC uses was taken by another device.
  80      * @param oldAddress The logical address that was taken by another device.
  81      * @param newAddress The new logical address, or CECDEVICE_UNKNOWN if no new LA could be allocated.
  82      */
  83     virtual void HandleLogicalAddressLost(cec_logical_address oldAddress, cec_logical_address newAddress) = 0;
  84
  85     virtual CLibCEC *GetLib(void) const = 0;
  86   };
  87
  88   class IAdapterCommunication
  89   {
  90   public:
  91     /*!
  92      * @param callback The callback struct. if set to NULL, the Read() method has to be used to read commands. if set, OnCommandReceived() will be called for each command that was received
  93      */
  94     IAdapterCommunication(IAdapterCommunicationCallback *callback) :
  95       m_callback(callback) {}
  96     virtual ~IAdapterCommunication(void) {}
  97
  98     /*!
  99      * @brief Open a connection to the CEC adapter
 100      * @param iTimeoutMs Connection timeout in ms
 101      * @param bSkipChecks Skips all initial checks of the adapter, and starts the reader/writer threads directly after connecting.
 102      * @param bStartListening Start a listener thread when true. False to just open a connection, read the device info, and close the connection.
 103      * @return True when connected, false otherwise
 104      */
 105     virtual bool Open(uint32_t iTimeoutMs = CEC_DEFAULT_CONNECT_TIMEOUT, bool bSkipChecks = false, bool bStartListening = true) = 0;
 106
 107     /*!
 108      * @brief Close an open connection
 109      */
 110     virtual void Close(void) = 0;
 111
 112     /*!
 113      * @return True when the connection is open, false otherwise
 114      */
 115     virtual bool IsOpen(void) = 0;
 116
 117     /*!
 118      * @return The last error message, or an empty string if there was none
 119      */
 120     virtual std::string GetError(void) const = 0;
 121
 122     /*!
 123      * @brief Write a cec_command to the adapter
 124      * @param data The command to write
 125      * @param bRetry The command can be retried
 126      * @param iLineTimeout The line timeout to be used
 127      * @param bIsReply True when this message is a reply, false otherwise
 128      * @return The last state of the transmitted command
 129      */
 130     virtual cec_adapter_message_state Write(const cec_command &data, bool &bRetry, uint8_t iLineTimeout, bool bIsReply) = 0;
 131
 132     /*!
 133      * @brief Change the current line timeout on the CEC bus
 134      * @param iTimeout The new timeout
 135      * @return True when set, false otherwise
 136      */
 137     virtual bool SetLineTimeout(uint8_t iTimeout) = 0;
 138
 139     /*!
 140      * @brief Put the device in bootloader mode (which will disrupt CEC communication when it succeeds)
 141      * @return True when the bootloader command has been sent, false otherwise.
 142      */
 143     virtual bool StartBootloader(void) = 0;
 144
 145     virtual bool SetLogicalAddresses(const cec_logical_addresses &addresses) = 0;
 146     virtual cec_logical_addresses GetLogicalAddresses(void) = 0;
 147
 148     /*!
 149      * @brief Check whether the CEC adapter responds
 150      * @return True when the ping was sent and acked, false otherwise.
 151      */
 152     virtual bool PingAdapter(void) = 0;
 153
 154     /*!
 155      * @return The firmware version of this CEC adapter, or 0 if it's unknown.
 156      */
 157     virtual uint16_t GetFirmwareVersion(void) = 0;
 158
 159     /*!
 160      * @return The build date in seconds since epoch, or 0 when no (valid) reply was received.
 161      */
 162     virtual uint32_t GetFirmwareBuildDate(void) = 0;
 163
 164     /*!
 165      * @return True when this adapter is using the latest firmware build, or when the latest firmware build for this adapter type is unknown. False otherwise.
 166      */
 167     virtual bool IsRunningLatestFirmware(void) = 0;
 168
 169     /*!
 170      * @return True when the control mode has been set, false otherwise.
 171      */
 172     virtual bool SetControlledMode(bool controlled) = 0;
 173
 174     /*!
 175      * @brief Persist the given configuration in adapter (if supported)
 176      * @brief The configuration to store.
 177      * @return True when the configuration was persisted, false otherwise.
 178      */
 179     virtual bool PersistConfiguration(const libcec_configuration &configuration) = 0;
 180
 181     /*!
 182      * @brief Get the persisted configuration from the adapter (if supported)
 183      * @param configuration The updated configuration.
 184      * @return True when the configuration was updated, false otherwise.
 185      */
 186     virtual bool GetConfiguration(libcec_configuration &configuration) = 0;
 187
 188     /*!
 189      * @return The name of the port
 190      */
 191     virtual std::string GetPortName(void) = 0;
 192
 193     /*!
 194      * @return The physical address, if the adapter supports this. 0 otherwise.
 195      */
 196     virtual uint16_t GetPhysicalAddress(void) = 0;
 197
 198     /*!
 199      * @return The vendor id for this device
 200      */
 201     virtual cec_vendor_id GetVendorId(void) = 0;
 202
 203     /*!
 204      * @brief Checks whether a logical address is supported by the adapter.
 205      * @param address The address to check.
 206      * @return True when supported, false otherwise.
 207      */
 208     virtual bool SupportsSourceLogicalAddress(const cec_logical_address address) = 0;
 209
 210     /*!
 211      * @return The type of adapter that this instance is connected to.
 212      */
 213     virtual cec_adapter_type GetAdapterType(void) = 0;
 214
 215     IAdapterCommunicationCallback *m_callback;
 216   };
 217 };