wfjm.w11/tools/src/librlink/RlinkCommand.ipp

// $Id: RlinkCommand.ipp 983 2018-01-02 20:35:59Z mueller $
//
// Copyright 2011-2015 by Walter F.J. Mueller <W.F.J.Mueller@gsi.de>
//
// This program is free software; you may redistribute and/or modify it under
// the terms of the GNU General Public License as published by the Free
// Software Foundation, either version 3, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
// for complete details.
// 
// Revision History: 
// Date         Rev Version  Comment
// 2015-04-02   661   1.3    expect logic: add stat check, Print() without cntx
// 2014-11-02   600   1.2    new rlink v4 iface
// 2013-05-06   495   1.0.1  add RlinkContext to Print() args; drop oper<<()
// 2011-03-27   374   1.0    Initial version
// 2011-01-15   355   0.1    First draft
// ---------------------------------------------------------------------------

/*!
  \file
  \brief   Implemenation (inline) of class RlinkCommand.
*/

// all method definitions in namespace Retro
namespace Retro {

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::CmdRreg(uint16_t addr)
{
  SetCommand(kCmdRreg, addr);
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::CmdWreg(uint16_t addr, uint16_t data)
{
  SetCommand(kCmdWreg, addr, data);
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::CmdLabo()
{
  SetCommand(kCmdLabo);
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::CmdAttn()
{
  SetCommand(kCmdAttn);
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::CmdInit(uint16_t addr, uint16_t data)
{
  SetCommand(kCmdInit, addr, data);
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::SetSeqNumber(uint8_t snum)
{
  fRequest = (snum<<3) | (fRequest&0x07);
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::SetData(uint16_t data)
{
  fData = data;
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::SetBlockDone(uint16_t dcnt)
{
  fBlockDone = dcnt;
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::SetStatus(uint8_t stat)
{
  fStatus = stat;
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::SetFlagBit(uint32_t mask)
{
  fFlags |= mask;
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::ClearFlagBit(uint32_t mask)
{
  fFlags &= ~mask;
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::SetRcvSize(size_t rsize)
{
  fRcvSize = rsize;
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::SetExpectStatus(uint8_t stat, uint8_t statmsk)
{
  fExpectStatusSet = true;
  fExpectStatusVal = stat;
  fExpectStatusMsk = statmsk;
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline void RlinkCommand::SetExpectStatusDefault(uint8_t stat, uint8_t statmsk)
{
  fExpectStatusSet = false;
  fExpectStatusVal = stat;
  fExpectStatusMsk = statmsk;
  return;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint8_t RlinkCommand::Request() const
{
  return fRequest;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint8_t RlinkCommand::Command() const
{
  return fRequest & 0x07;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint8_t RlinkCommand::SeqNumber() const
{
  return fRequest>>3;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint16_t RlinkCommand::Address() const
{
  return fAddress;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint16_t RlinkCommand::Data() const
{
  return fData;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline const std::vector<uint16_t>&  RlinkCommand::Block() const
{
  return fBlock;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline bool RlinkCommand::IsBlockExt() const
{
  return fpBlockExt != 0;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint16_t* RlinkCommand::BlockPointer()
{
  return IsBlockExt() ? fpBlockExt : (fBlock.size() ? &fBlock[0] : 0);
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline const uint16_t* RlinkCommand::BlockPointer() const
{
  return IsBlockExt() ? fpBlockExt : (fBlock.size() ? &fBlock[0] : 0);
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline size_t RlinkCommand::BlockSize() const
{
  return IsBlockExt() ? fBlockExtSize : fBlock.size();
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline size_t RlinkCommand::BlockDone() const
{
  return fBlockDone;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint8_t RlinkCommand::Status() const
{
  return fStatus;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint32_t RlinkCommand::Flags() const
{
  return fFlags;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline bool RlinkCommand::TestFlagAny(uint32_t mask) const
{
  return (fFlags & mask) != 0;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline bool RlinkCommand::TestFlagAll(uint32_t mask) const
{
  return (fFlags & mask) == fFlags;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline size_t RlinkCommand::RcvSize() const
{
  return fRcvSize;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline RlinkCommandExpect* RlinkCommand::Expect() const
{
  return fpExpect;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint8_t RlinkCommand::ExpectStatusValue() const
{
  return fExpectStatusVal;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline uint8_t RlinkCommand::ExpectStatusMask() const
{
  return fExpectStatusMsk;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline bool RlinkCommand::ExpectStatusSet() const
{
  return fExpectStatusSet;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline bool RlinkCommand::StatusCheck() const
{
  return (fStatus & fExpectStatusMsk) == fExpectStatusVal;
}

//------------------------------------------+-----------------------------------
//! FIXME_docs

inline bool RlinkCommand::StatusIsChecked() const
{
  return fExpectStatusMsk != 0x0;
}

} // end namespace Retro