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 "util/StdString.h"
  38 #include <string>
  39
  40 namespace CEC
  41 {
  42   typedef enum cec_adapter_message_state
  43   {
  44     ADAPTER_MESSAGE_STATE_UNKNOWN = 0,
  45     ADAPTER_MESSAGE_STATE_WAITING,
  46     ADAPTER_MESSAGE_STATE_SENT,
  47     ADAPTER_MESSAGE_STATE_RECEIVED,
  48     ADAPTER_MESSAGE_STATE_ERROR
  49   } cec_adapter_message_state;
  50
  51
  52   class CCECAdapterMessage
  53   {
  54   public:
  55     CCECAdapterMessage(void) { clear(); }
  56     CCECAdapterMessage(const cec_command &command);
  57     CCECAdapterMessage &operator =(const CCECAdapterMessage &msg);
  58     CStdString ToString(void) const;
  59     CStdString MessageCodeAsString(void) const;
  60
  61     bool                    empty(void) const             { return packet.IsEmpty(); }
  62     uint8_t                 operator[](uint8_t pos) const { return packet[pos]; }
  63     uint8_t                 at(uint8_t pos) const         { return packet[pos]; }
  64     uint8_t                 size(void) const              { return packet.size; }
  65     void                    clear(void)                   { state = ADAPTER_MESSAGE_STATE_UNKNOWN; transmit_timeout = 0; packet.Clear(); maxTries = 5; tries = 0; reply = MSGCODE_NOTHING; }
  66     void                    shift(uint8_t iShiftBy)       { packet.Shift(iShiftBy); }
  67     void                    push_back(uint8_t add)        { packet.PushBack(add); }
  68     cec_adapter_messagecode message(void) const           { return packet.size >= 1 ? (cec_adapter_messagecode) (packet.At(0) & ~(MSGCODE_FRAME_EOM | MSGCODE_FRAME_ACK))  : MSGCODE_NOTHING; }
  69     bool                    eom(void) const               { return packet.size >= 1 ? (packet.At(0) & MSGCODE_FRAME_EOM) != 0 : false; }
  70     bool                    ack(void) const               { return packet.size >= 1 ? (packet.At(0) & MSGCODE_FRAME_ACK) != 0 : false; }
  71     cec_logical_address     initiator(void) const         { return packet.size >= 2 ? (cec_logical_address) (packet.At(1) >> 4)  : CECDEVICE_UNKNOWN; };
  72     cec_logical_address     destination(void) const       { return packet.size >= 2 ? (cec_logical_address) (packet.At(1) & 0xF) : CECDEVICE_UNKNOWN; };
  73     bool                    is_error(void) const;
  74     void                    push_escaped(uint8_t byte);
  75     bool                    needs_retry(void) const       { return reply == MSGCODE_NOTHING ||
  76                                                                    reply == MSGCODE_RECEIVE_FAILED ||
  77                                                                    reply == MSGCODE_TIMEOUT_ERROR ||
  78                                                                    reply == MSGCODE_TRANSMIT_FAILED_ACK ||
  79                                                                    reply == MSGCODE_TRANSMIT_FAILED_LINE ||
  80                                                                    reply == MSGCODE_TRANSMIT_FAILED_TIMEOUT_DATA ||
  81                                                                    reply == MSGCODE_TRANSMIT_FAILED_TIMEOUT_LINE ||
  82                                                                    reply == MSGCODE_TRANSMIT_LINE_TIMEOUT; }
  83
  84     uint8_t                   maxTries;
  85     uint8_t                   tries;
  86     cec_adapter_messagecode   reply;
  87     cec_datapacket            packet;
  88     cec_adapter_message_state state;
  89     int32_t                   transmit_timeout;
  90     CMutex                    mutex;
  91     CCondition                condition;
  92   };
  93
  94   class CSerialPort;
  95   class CCECProcessor;
  96
  97   class CAdapterCommunication : private CThread
  98   {
  99   public:
 100     CAdapterCommunication(CCECProcessor *processor);
 101     virtual ~CAdapterCommunication();
 102
 103     bool Open(const char *strPort, uint16_t iBaudRate = 38400, uint32_t iTimeoutMs = 10000);
 104     bool Read(CCECAdapterMessage &msg, uint32_t iTimeout = 1000);
 105     bool Write(CCECAdapterMessage *data);
 106     bool PingAdapter(void);
 107     void Close(void);
 108     bool IsOpen(void) const;
 109     std::string GetError(void) const;
 110
 111     void *Process(void);
 112
 113     bool SetLineTimeout(uint8_t iTimeout);
 114     bool StartBootloader(void);
 115
 116   private:
 117     void SendMessageToAdapter(CCECAdapterMessage *msg);
 118     void WriteNextCommand(void);
 119     void AddData(uint8_t *data, uint8_t iLen);
 120     bool ReadFromDevice(uint32_t iTimeout);
 121
 122     CSerialPort *                    m_port;
 123     CCECProcessor *                  m_processor;
 124     CecBuffer<uint8_t>               m_inBuffer;
 125     CecBuffer<CCECAdapterMessage *>  m_outBuffer;
 126     CMutex                           m_mutex;
 127     CCondition                       m_rcvCondition;
 128     CCondition                       m_startCondition;
 129     uint8_t                          m_iLineTimeout;
 130   };
 131 };