RlinkPacketBufRcv.hpp

Go to the documentation of this file.

// $Id: RlinkPacketBufRcv.hpp 1198 2019-07-27 19:08:31Z mueller $
// SPDX-License-Identifier: GPL-3.0-or-later
// Copyright 2014-2019 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
// 
// Revision History: 
// Date         Rev Version  Comment
// 2019-07-27  1198   1.2.1  add Nak handling
// 2018-12-08  1079   1.2    use ref not ptr for RlinkPort
// 2017-04-07   868   1.1.1  Dump(): add detail arg
// 2017-02-19   853   1.1    use Rtime
// 2014-12-25   621   1.0.1  Reorganize packet send/revd stats
// 2014-11-30   607   1.0    Initial version 
// 2014-11-02   600   0.1    First draft (re-organize PacketBuf for rlink v4)
// ---------------------------------------------------------------------------
 
 
#ifndef included_Retro_RlinkPacketBufRcv
#define included_Retro_RlinkPacketBufRcv 1
 
#include "RlinkPacketBuf.hpp"
#include "RlinkPort.hpp"
 
namespace Retro {
 
  class RlinkPacketBufRcv: public RlinkPacketBuf  {
    public:
 
                    RlinkPacketBufRcv();
                   ~RlinkPacketBufRcv();
 
      int           ReadData(RlinkPort& port, const Rtime& timeout, 
                             RerrMsg& emsg);
      bool          ProcessData();
      void          AcceptPacket();
      void          FlushRaw();
 
      enum pkt_state {
        kPktPend=0,                         
        kPktResp,                           
        kPktAttn,                           
        kPktError                           
      };
      pkt_state     PacketState();
 
      bool          CheckNak() const;
      bool          CheckSize(size_t nbyte) const;
      void          GetWithCrc(uint8_t& data);
      void          GetWithCrc(uint16_t& data);
      void          GetWithCrc(uint16_t* pdata, size_t count);
      bool          CheckCrc();
 
      int           NakIndex() const;
      uint8_t       NakCode() const;
 
      void          Dump(std::ostream& os, int ind=0, const char* text=0,
                         int detail=0) const;
 
   // statistics counter indices
      enum stats {
        kStatNRxPktByt=0,                   
        kStatNRxDrop,                       
        kStatNRxSop,                        
        kStatNRxEop,                        
        kStatNRxNak,                        
        kStatNRxAttn,                       
        kStatNRxEsc,                        
        kStatNRxClobber,                    
        kStatNRxNakCcrc,                    
        kStatNRxNakDcrc,                    
        kStatNRxNakFrame,                   
        kStatNRxNakUnused,                  
        kStatNRxNakCmd,                     
        kStatNRxNakCnt,                     
        kStatNRxNakRtOvlf,                  
        kStatNRxNakRtWblk,                  
        kStatNRxNakInval                    
      };
 
    protected:
      void          ProcessDataIdle();
      void          ProcessDataFill();
      uint8_t       GetEcode();
 
      enum rcv_state {
        kRcvIdle=0,                         
        kRcvFill,                           
        kRcvDone,                           
        kRcvError                           
      };
    
    protected: 
      uint8_t       fRawBuf[4096];          
      size_t        fRawBufSize;            
      size_t        fRawBufDone;            
      enum rcv_state       fRcvState;       
      size_t        fNDone;                 
      bool          fEscSeen;               
      int           fNakIndex;              
      uint8_t       fNakCode;               
      std::vector<uint8_t> fDropData;       
  };
  
} // end namespace Retro
 
#include "RlinkPacketBufRcv.ipp"
 
#endif