src/lib/AdapterCommunication.h

   1 #pragma once
   2 /*
   3  * This file is part of the libCEC(R) library.
   4  *
   5  * libCEC(R) is Copyright (C) 2011 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 <cectypes.h>
  35 #include "platform/threads.h"
  36 #include "util/buffer.h"
  37 #include <string>
  38 #include <boost/enable_shared_from_this.hpp>
  39 #include <boost/shared_ptr.hpp>
  40
  41 namespace CEC
  42 {
  43   typedef enum cec_adapter_message_state
  44   {
  45     ADAPTER_MESSAGE_STATE_UNKNOWN = 0,
  46     ADAPTER_MESSAGE_STATE_WAITING,
  47     ADAPTER_MESSAGE_STATE_SENT,
  48     ADAPTER_MESSAGE_STATE_RECEIVED,
  49     ADAPTER_MESSAGE_STATE_ERROR
  50   } cec_adapter_message_state;
  51
  52
  53   class CCECAdapterMessage : public boost::enable_shared_from_this<CCECAdapterMessage>
  54   {
  55   public:
  56     CCECAdapterMessage(void) { clear(); }
  57     CCECAdapterMessage(const cec_command &command);
  58     CCECAdapterMessage &operator =(const CCECAdapterMessage &msg);
  59
  60     bool                    empty(void) const             { return packet.empty(); }
  61     uint8_t                 operator[](uint8_t pos) const { return packet[pos]; }
  62     uint8_t                 at(uint8_t pos) const         { return packet[pos]; }
  63     uint8_t                 size(void) const              { return packet.size; }
  64     void                    clear(void)                   { state = ADAPTER_MESSAGE_STATE_UNKNOWN; packet.clear(); }
  65     void                    shift(uint8_t iShiftBy)       { packet.shift(iShiftBy); }
  66     void                    push_back(uint8_t add)        { packet.push_back(add); }
  67     cec_adapter_messagecode message(void) const           { return packet.size >= 1 ? (cec_adapter_messagecode) (packet.at(0) & ~(MSGCODE_FRAME_EOM | MSGCODE_FRAME_ACK))  : MSGCODE_NOTHING; }
  68     bool                    eom(void) const               { return packet.size >= 1 ? (packet.at(0) & MSGCODE_FRAME_EOM) != 0 : false; }
  69     bool                    ack(void) const               { return packet.size >= 1 ? (packet.at(0) & MSGCODE_FRAME_ACK) != 0 : false; }
  70     cec_logical_address     initiator(void) const         { return packet.size >= 2 ? (cec_logical_address) (packet.at(1) >> 4)  : CECDEVICE_UNKNOWN; };
  71     cec_logical_address     destination(void) const       { return packet.size >= 2 ? (cec_logical_address) (packet.at(1) & 0xF) : CECDEVICE_UNKNOWN; };
  72     void                    push_escaped(int16_t byte);
  73
  74     cec_datapacket            packet;
  75     cec_adapter_message_state state;
  76     CMutex                    mutex;
  77     CCondition                condition;
  78   };
  79   typedef boost::shared_ptr<CCECAdapterMessage> CCECAdapterMessagePtr;
  80
  81   class CSerialPort;
  82   class CLibCEC;
  83
  84   class CAdapterCommunication : private CThread
  85   {
  86   public:
  87     CAdapterCommunication(CLibCEC *controller);
  88     virtual ~CAdapterCommunication();
  89
  90     bool Open(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
  91     bool Read(CCECAdapterMessage &msg, uint32_t iTimeout = 1000);
  92     bool Write(CCECAdapterMessagePtr data);
  93     bool PingAdapter(void);
  94     void Close(void);
  95     bool IsOpen(void) const;
  96     std::string GetError(void) const;
  97
  98     void *Process(void);
  99
 100     bool StartBootloader(void);
 101     bool SetAckMask(uint16_t iMask);
 102
 103   private:
 104     void WriteNextCommand(void);
 105     void AddData(uint8_t *data, uint8_t iLen);
 106     bool ReadFromDevice(uint32_t iTimeout);
 107
 108     CSerialPort *                    m_port;
 109     CLibCEC *                        m_controller;
 110     CecBuffer<uint8_t>               m_inBuffer;
 111     CecBuffer<CCECAdapterMessagePtr> m_outBuffer;
 112     CMutex                           m_mutex;
 113     CCondition                       m_rcvCondition;
 114     CCondition                       m_startCondition;
 115   };
 116 };