Rw11CntlDEUNA.hpp

Go to the documentation of this file.

// $Id: Rw11CntlDEUNA.hpp 1185 2019-07-12 17:29:12Z 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
// 2017-04-14   875   0.5    Initial version (minimal functions, 211bsd ready)
// 2014-06-09   561   0.1    First draft 
// ---------------------------------------------------------------------------
 
 
#ifndef included_Retro_Rw11CntlDEUNA
#define included_Retro_Rw11CntlDEUNA 1
 
#include <deque>
 
#include "librtools/Rtime.hpp"
#include "librtools/RtimerFd.hpp"
 
#include "RethBuf.hpp"
 
#include "Rw11CntlBase.hpp"
#include "Rw11UnitDEUNA.hpp"
 
namespace Retro {
 
  class Rw11CntlDEUNA : public Rw11CntlBase<Rw11UnitDEUNA,1> {
    public:
 
                    Rw11CntlDEUNA();
                   ~Rw11CntlDEUNA();
 
      void          Config(const std::string& name, uint16_t base, int lam);
 
      virtual void  Start();
 
      virtual void  UnitSetup(size_t ind);
 
      void          SetType(const std::string& type);
      void          SetMacDefault(const std::string& mac);
      void          SetRxPollTime(const Rtime& time);
      void          SetRxQueLimit(size_t rxqlim);
 
      std::string   MacDefault() const;
      const Rtime&  RxPollTime() const;
      size_t        RxQueLimit() const;
 
      bool          Running() const;
 
      const char*   MnemoPcmd(uint16_t pcmd) const;
      const char*   MnemoFunc(uint16_t func) const;
      const char*   MnemoState(uint16_t state) const;
 
      bool          RcvCallback(RethBuf::pbuf_t& pbuf);
 
      virtual void  Dump(std::ostream& os, int ind=0, const char* text=0,
                         int detail=0) const;
 
    // some constants (also defined in cpp)
      static const uint16_t kIbaddr = 0174510; 
      static const int      kLam    = 9;       
 
      static const uint16_t kPR0 = 000;     
      static const uint16_t kPR1 = 002;     
      static const uint16_t kPR2 = 004;     
      static const uint16_t kPR3 = 006;     
 
      static const uint16_t kProbeOff = kPR0; 
      static const bool     kProbeInt = true;  
      static const bool     kProbeRem = true;  
 
      static const uint16_t kPR0_M_SERI = kWBit15; 
      static const uint16_t kPR0_M_PCEI = kWBit14; 
      static const uint16_t kPR0_M_RXI  = kWBit13; 
      static const uint16_t kPR0_M_TXI  = kWBit12; 
      static const uint16_t kPR0_M_DNI  = kWBit11; 
      static const uint16_t kPR0_M_RCBI = kWBit10; 
      static const uint16_t kPR0_M_BUSY = kWBit09; 
      static const uint16_t kPR0_M_USCI = kWBit08; 
      static const uint16_t kPR0_M_INTR = kWBit07; 
      static const uint16_t kPR0_M_INTE = kWBit06; 
      static const uint16_t kPR0_M_RSET = kWBit05; 
      static const uint16_t kPR0_M_BRST = kWBit04; 
      static const uint16_t kPR0_M_PCMD = 00017;   
 
      static const uint16_t kPR0_V_PCMDBP=    12;   
      static const uint16_t kPR0_B_PCMDBP= 00017;   
      static const uint16_t kPR0_M_PDMDWB= kWBit10; 
      static const uint16_t kPR0_M_PCWWB = kWBit08; 
 
      static const uint16_t kPCMD_NOOP    =   0;   
      static const uint16_t kPCMD_GETPCBB =   1;   
      static const uint16_t kPCMD_GETCMD  =   2;   
      static const uint16_t kPCMD_SELFTST =   3;   
      static const uint16_t kPCMD_START   =   4;   
      static const uint16_t kPCMD_BOOT    =   5;   
      static const uint16_t kPCMD_PDMD    = 010;   
      static const uint16_t kPCMD_HALT    = 016;   
      static const uint16_t kPCMD_STOP    = 017;   
 
      static const uint16_t kPR1_M_XPWR = kWBit15; 
      static const uint16_t kPR1_M_ICAB = kWBit14; 
      static const uint16_t kPR1_M_PCTO = kWBit07; 
      static const uint16_t kPR1_M_DELUA= kWBit04; 
      static const uint16_t kPR1_M_STATE= 0017;    
 
      static const uint16_t kSTATE_RESET  =   0;   
      static const uint16_t kSTATE_PLOAD  =   1;   
      static const uint16_t kSTATE_READY  =   2;   
      static const uint16_t kSTATE_RUN    =   3;   
      static const uint16_t kSTATE_UHALT  =   5;   
      static const uint16_t kSTATE_NHALT  =   6;   
      static const uint16_t kSTATE_NUHALT =   7;   
      static const uint16_t kSTATE_PHALT  =  010;  
      static const uint16_t kSTATE_SLOAD  =  017;  
 
      static const uint16_t kPC0_M_FUNC = 0x00ff;  
      static const uint16_t kPC0_M_MBZ  = 0xff00;  
 
      static const uint16_t kFUNC_NOOP   =   0;  
      static const uint16_t kFUNC_RDPA   =   2;  
      static const uint16_t kFUNC_RPA    =   4;  
      static const uint16_t kFUNC_WPA    =   5;  
      static const uint16_t kFUNC_RMAL   =   6;  
      static const uint16_t kFUNC_WMAL   =   7;  
      static const uint16_t kFUNC_RRF    = 010;  
      static const uint16_t kFUNC_WRF    = 011;  
      static const uint16_t kFUNC_RCTR   = 012;  
      static const uint16_t kFUNC_RCCTR  = 013;  
      static const uint16_t kFUNC_RMODE  = 014;  
      static const uint16_t kFUNC_WMODE  = 015;  
      static const uint16_t kFUNC_RSTAT  = 016;  
      static const uint16_t kFUNC_RCSTAT = 017;  
      static const uint16_t kFUNC_RSID   = 022;  
      static const uint16_t kFUNC_WSID   = 023;  
 
      static const uint16_t kSTAT_M_ERRS = kWBit15;
      static const uint16_t kSTAT_M_MERR = kWBit14;
      static const uint16_t kSTAT_M_BABL = kWBit13;
      static const uint16_t kSTAT_M_CERR = kWBit12;
      static const uint16_t kSTAT_M_TMOT = kWBit11;
      static const uint16_t kSTAT_M_RRNG = kWBit09;
      static const uint16_t kSTAT_M_TRNG = kWBit08;
      static const uint16_t kSTAT_M_PTCH = kWBit07;
      static const uint16_t kSTAT_M_RRAM = kWBit06;
      static const uint16_t kSTAT_M_RREV = 077;    
 
      static const uint16_t kMODE_M_PROM = kWBit15;
      static const uint16_t kMODE_M_ENAL = kWBit14;
      static const uint16_t kMODE_M_DRDC = kWBit13;
      static const uint16_t kMODE_M_TPAD = kWBit12;
      static const uint16_t kMODE_M_ECT  = kWBit11;
      static const uint16_t kMODE_M_DMNT = kWBit09;
      static const uint16_t kMODE_M_INTL = kWBit06;
      static const uint16_t kMODE_M_DTCR = kWBit03;
      static const uint16_t kMODE_M_LOOP = kWBit02;
      static const uint16_t kMODE_M_HDPX = kWBit00;
      static const uint16_t kMODE_M_MBZ_DEUNA = 0x05f2; 
      static const uint16_t kMODE_M_MBZ_DELUA = 0x05b2; 
 
      static const uint16_t kTXR2_M_OWN  = kWBit15; 
      static const uint16_t kTXR2_M_ERRS = kWBit14; 
      static const uint16_t kTXR2_M_MTCH = kWBit13; 
      static const uint16_t kTXR2_M_MORE = kWBit12; 
      static const uint16_t kTXR2_M_ONE  = kWBit11; 
      static const uint16_t kTXR2_M_DEF  = kWBit10; 
      static const uint16_t kTXR2_M_STF  = kWBit09; 
      static const uint16_t kTXR2_M_ENF  = kWBit08; 
      static const uint16_t kTXR2_M_SEGB = 00003;   
      static const uint16_t kTXR3_M_BUFL = kWBit15; 
      static const uint16_t kTXR3_M_UBTO = kWBit14; 
      static const uint16_t kTXR3_M_UFLO = kWBit13; 
      static const uint16_t kTXR3_M_LCOL = kWBit12; 
      static const uint16_t kTXR3_M_LCAR = kWBit11; 
      static const uint16_t kTXR3_M_RTRY = kWBit10; 
      static const uint16_t kTXR3_M_TDR  = 01777;   
 
      static const uint16_t kRXR2_M_OWN  = kWBit15; 
      static const uint16_t kRXR2_M_ERRS = kWBit14; 
      static const uint16_t kRXR2_M_FRAM = kWBit13; 
      static const uint16_t kRXR2_M_OFLO = kWBit12; 
      static const uint16_t kRXR2_M_CRC  = kWBit11; 
      static const uint16_t kRXR2_M_STF  = kWBit09; 
      static const uint16_t kRXR2_M_ENF  = kWBit08; 
      static const uint16_t kRXR2_M_SEGB = 000003;  
      static const uint16_t kRXR3_M_BUFL = kWBit15; 
      static const uint16_t kRXR3_M_UBTO = kWBit14; 
      static const uint16_t kRXR3_M_NCHN = kWBit13; 
      static const uint16_t kRXR3_M_OVRN = kWBit12; 
      static const uint16_t kRXR3_M_MLEN = 07777;   
 
      static const uint32_t kUBA_M    = 0x3fffe; 
      static const uint32_t kUBAODD_M = 0x3ffff; 
      static const uint16_t kDimMcast = 10;   
      static const uint16_t kDimCtrDeuna =  32; 
      static const uint16_t kDimCtrDelua =  34; 
      static const uint16_t kDimCtr      =  34; 
      static const uint16_t kDimPlt      = 100; 
 
    // statistics counter indices
      enum stats {
        kStatNPcmdNoop = Rw11Cntl::kDimStat,
        kStatNPcmdGetpcbb,
        kStatNPcmdGetcmd,
        kStatNPcmdSelftst,
        kStatNPcmdStart,
        kStatNPcmdPdmd,
        kStatNPcmdStop,
        kStatNPcmdHalt,
        kStatNPcmdRsrvd,
        kStatNPcmdUimpl,
        kStatNPcmdWBPdmd,
        kStatNPcmdWBOther,
        kStatNPdmdRestart,
        kStatNFuncNoop,
        kStatNFuncRdpa,
        kStatNFuncRpa,
        kStatNFuncWpa,
        kStatNFuncRmal,
        kStatNFuncWmal,
        kStatNFuncRrf,
        kStatNFuncWrf,
        kStatNFuncRctr,
        kStatNFuncRcctr,
        kStatNFuncRmode,
        kStatNFuncWmode,
        kStatNFuncRstat,
        kStatNFuncRcstat,
        kStatNFuncRsid,
        kStatNFuncWsid,
        kStatNFuncUimpl,
        kStatNRxFraSeen,
        kStatNRxFraFDst,
        kStatNRxFraFBcast,
        kStatNRxFraFMcast,
        kStatNRxFraFProm,
        kStatNRxFraFUDrop,
        kStatNRxFraFMDrop,
        kStatNRxFraQLDrop,
        kStatNRxFraNRDrop,
        kStatNRxFra,
        kStatNRxFraMcast,
        kStatNRxFraBcast,
        kStatNRxByt,
        kStatNRxBytMcast,
        kStatNRxFraLoInt,
        kStatNRxFraLoBuf,
        kStatNRxFraPad,
        kStatNTxFra,
        kStatNTxFraMcast,
        kStatNTxFraBcast,
        kStatNTxByt,
        kStatNTxBytMcast,
        kStatNTxFraAbort,
        kStatNTxFraPad,
        kStatNFraLoop,
        kDimStat
      };    
 
    protected:
 
      enum s_tx {
        kStateTxIdle = 0,
        kStateTxBusy
      };    
      enum s_rx {
        kStateRxIdle = 0,
        kStateRxBusy,
        kStateRxPoll
      };
 
      int           AttnHandler(RlinkServer::AttnArgs& args);
 
      void          ClearMacList();
      void          ClearCtr();
      void          ClearStatus();
 
      void          Reset();
      void          SetRunning(bool run);
      bool          ExecGetcmd(RlinkCommandList& clist);
 
      void          Wlist2UBAddr(const uint16_t wlist[2], uint32_t& addr);
      void          Wlist2UBAddrLen(const uint16_t wlist[2], 
                                    uint32_t& addr, uint16_t& len);
      void          UBAddrLen2Wlist(uint16_t wlist[2], 
                                    uint32_t addr, uint16_t len);
      void          SetupPrimClist();
 
      uint16_t      GetPr1() const;
 
      void          StartTxRing();
      void          StartTxRing(const uint16_t dsccur[4],
                                const uint16_t dscnxt[4]);
      void          StopTxRing();
 
      void          StartRxRing();
      void          StartRxRing(const uint16_t dsccur[4],
                                const uint16_t dscnxt[4]);
      void          StopRxRing();
 
      int           TxRingHandler();
      int           RxRingHandler();
      int           RxPollHandler(const pollfd& pfd);
 
      uint16_t      RingIndexNext(uint16_t index, uint16_t size, 
                                  uint16_t inc=1) const;
      uint16_t      TxRingIndexNext(uint16_t inc=1) const;
      uint16_t      RxRingIndexNext(uint16_t inc=1) const;
 
      uint32_t      RingDscAddr(uint32_t base, uint16_t elen, 
                                uint16_t index) const;
      uint32_t      TxRingDscAddr(uint16_t index) const;
      uint32_t      RxRingDscAddr(uint16_t index) const;
    
      int           MacFilter(uint64_t mac);
 
      void          UpdateStat16(uint32_t& stat, size_t ind, uint32_t inc=1);
      void          UpdateStat32(uint32_t& stat, size_t ind, uint32_t inc=1);
 
      void          LogMacFunc(const char* cmd, uint64_t mac);
      void          LogMcastFunc(const char* cmd);
      void          LogRingFunc(const char* cmd);
      void          LogFunc(const char* cmd, const char* tag1, uint16_t val1,
                            const char* tag2=nullptr, uint16_t val2=0);
      void          LogRingInfo(char rxtx, char rw);
      void          LogFrameInfo(char rxtx, const RethBuf& buf);
 
      static void   SetRingDsc(uint16_t dst[4], const uint16_t src[4]);
      static std::string RingDsc2String(const uint16_t dsc[4], char rxtx);
      static std::string RingDsc2OSEString(const uint16_t dsc[4], char fill=' ');
 
    protected:
      size_t        fPC_rdpr0;              
      size_t        fPC_rdpcb;              
      size_t        fPC_lapcb;              
      size_t        fPC_rdtxdsccur;         
      size_t        fPC_latxdsccur;         
      size_t        fPC_rdtxdscnxt;         
      size_t        fPC_latxdscnxt;         
      size_t        fPC_rdrxdsccur;         
      size_t        fPC_larxdsccur;         
      size_t        fPC_rdrxdscnxt;         
      bool          fPcbbValid;             
      uint32_t      fPcbb;                  
      uint16_t      fPcb[4];                
      bool          fRingValid;             
      uint32_t      fTxRingBase;            
      uint16_t      fTxRingSize;            
      uint16_t      fTxRingELen;            
      uint32_t      fRxRingBase;            
      uint16_t      fRxRingSize;            
      uint16_t      fRxRingELen;            
      uint64_t      fMacDefault;            
      uint64_t      fMacList[2+kDimMcast];  
      int           fMcastCnt;              
      uint16_t      fPr0Last;               
      bool          fPr1Pcto;               
      bool          fPr1Delua;              
      uint16_t      fPr1State;              
      bool          fRunning;               
      uint16_t      fMode;                  
      uint16_t      fStatus;                
      uint16_t      fTxRingIndex;           
      uint16_t      fRxRingIndex;           
      uint16_t      fTxDscCurPC[4];         
      uint16_t      fTxDscNxtPC[4];         
      uint16_t      fRxDscCurPC[4];         
      uint16_t      fRxDscNxtPC[4];         
      enum s_tx     fTxRingState;           
      uint16_t      fTxDscCur[4];           
      uint16_t      fTxDscNxt[4];           
      RethBuf       fTxBuf;                 
      size_t        fTxBufOffset;           
      enum s_rx     fRxRingState;           
      uint16_t      fRxDscCur[4];           
      uint16_t      fRxDscNxt[4];           
      Rtime         fRxPollTime;            
      size_t        fRxQueLimit;            
      RtimerFd      fRxPollTimer;           
      std::deque<RethBuf::pbuf_t> fRxBufQueue; 
      RethBuf::pbuf_t fRxBufCurr;           
      size_t        fRxBufOffset;           
      Rtime         fCtrTimeCleared;        
      uint32_t      fCtrRxFra;              
      uint32_t      fCtrRxFraMcast;         
      uint32_t      fCtrRxByt;              
      uint32_t      fCtrRxBytMcast;         
      uint32_t      fCtrRxFraLoInt;         
      uint32_t      fCtrRxFraLoBuf;         
      uint32_t      fCtrTxFra;              
      uint32_t      fCtrTxFraMcast;         
      uint32_t      fCtrTxByt;              
      uint32_t      fCtrTxBytMcast;         
      uint32_t      fCtrTxFraAbort;         
      uint32_t      fCtrFraLoop;            
 };
  
} // end namespace Retro
 
#include "Rw11CntlDEUNA.ipp"
 
#endif